Class: Roebe::ApacheConfigurationMaker

Inherits:
Base show all
Defined in:
lib/roebe/classes/apache_configuration_maker.rb

Overview

Roebe::ApacheConfigurationMaker

Constant Summary collapse

APACHE_HOME_DIR =
#

APACHE_HOME_DIR

#
HOME_OF_THE_USER_CALLED_X+'DATA/PC/APACHE/'
HTTPD_CONF =
#

HTTPD_CONF

#
'httpd.conf'
TEMP =
#

TEMP

#
'/Depot/Temp/'
CONFIGURATION_DIR =
#

CONFIGURATION_DIR

This is the directory from where we will fetch the individual configuration files.

#
APACHE_HOME_DIR+'configuration/'

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(i = nil, run_already = true) ⇒ ApacheConfigurationMaker

#

initialize

#


48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 48

def initialize(
    i = nil, run_already = true
  )
  reset
  if i == :dont_run
    i = nil
    run_already = false
  end
  set_input(i)
  run if run_already
end

Instance Method Details

#append_file(i) ⇒ Object

#

append_file

#


112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 112

def append_file(i)
  opne 'Now adding '+sfancy(i.tr('_',' '))+' subsection.'
  i = i.dup if i.frozen?
  i << '.conf' unless i.include? '.'
  this_file = @configuration_dir+i
  if File.exist? this_file
    @_ << File.read(this_file)+N+N
  else
    opnewarn 'The file at '+sfile(this_file)+' does not exist.'
  end
end

#check_whether_target_file_already_exists ⇒ Object

#

check_whether_target_file_already_exists

#


154
155
156
157
158
159
160
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 154

def check_whether_target_file_already_exists
  if File.exist? @store_here
    opn; e "The target file at #{sfile(@store_here)} already exists."
    opn; e 'We will remove it now before continuing.'
    remove_file(@store_here) if File.file? @store_here
  end
end

#open_in_editor ⇒ Object

#

open_in_editor

#


95
96
97
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 95

def open_in_editor
  esystem('bluefish '+__FILE__)
end

#reset ⇒ Object

#

reset (reset tag)

#


63
64
65
66
67
68
69
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 63

def reset
  super()
  infer_the_namespace
  @_ = ''.dup # Store this string.
  set_configuration_dir
  set_store_here
end

#run ⇒ Object Also known as: generate

#

run (run tag)

#


187
188
189
190
191
192
193
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 187

def run
  begin
    run_everything
  rescue NameError => error
    ewarn 'We encountered this error: '+error.to_s
  end
end

#run_everything ⇒ Object

#

run_everything

#


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 165

def run_everything
  check_whether_target_file_already_exists
  append_server_root
  append_document_root # This will create the DocumentRoot.
  append_load_modules  # This here must come early, so the rest will work.
  append_unixd_module
  append_server_name
  append_email
  append_mime_module
  append_add_type
  append_proxy_html_module
  # append_php
  append_ruby
  append_error_log
  append_rewrite_rules
  append_autogenerated_rewrite_rules
  store_the_result
end

#set_configuration_dir(i = CONFIGURATION_DIR) ⇒ Object

#

set_configuration_dir

#


74
75
76
77
78
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 74

def set_configuration_dir(
    i = CONFIGURATION_DIR
  )
  @configuration_dir = i
end

#set_input(i = '') ⇒ Object

#

set_input

#


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 198

def set_input(i = '')
  i = i.first if i.is_a? Array
  i = i.to_s.dup if i
  case i # case tag
  # ======================================================================= #
  # === apaconfig PROGRAMS
  # ======================================================================= #
  when 'PROGRAMS','PROGRAM','APPDIR','appdirs','appdir','1'
    set_store_here('/Programs/Httpd/Current/conf/')
  when 'USR','CONF','2'
    set_store_here('/usr/conf/')
  when 'PWD','HERE',/^DIR/,'3'
    set_store_here return_pwd+HTTPD_CONF
  when 'HELP','?','HEL','HE','help'
    show_help
    exit
  when 'OPEN'
    open_in_editor
    exit
  end
  @input = i
end

#set_store_here(i = TEMP+HTTPD_CONF) ⇒ Object

#

set_store_here

#


83
84
85
86
87
88
89
90
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 83

def set_store_here(i = TEMP+HTTPD_CONF)
  if File.directory? i # If it is a directory, we append HTTPD_CONF
    i = i.dup if i.frozen?
    i << '/' unless i.end_with? '/'
    i << HTTPD_CONF
  end
  @store_here = i
end

#show_help ⇒ Object

#

show_help (help tag)

#


102
103
104
105
106
107
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 102

def show_help
  e
  eparse '  open # open this file in your editor'
  eparse "  PWD  # create the #{HTTPD_CONF} file in the current directory"
  e
end

#store_the_result ⇒ Object

#

store_the_result

#


224
225
226
227
228
 
# File 'lib/roebe/classes/apache_configuration_maker.rb', line 224

def store_the_result
  opne "Now generating #{sfile(HTTPD_CONF)} file in `"\
          "#{sfile(@store_here)}`."
  save_what_into(@_, @store_here)
end