cyberweb 0.4.174

data/lib/cyberweb/toplevel_methods/misc.rb

@@ -0,0 +1,1398 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb
+#
+# There are a few standards employed in the Cyberweb project.
+#
+# Use this general rule when passing arguments to tags:
+#
+#   css_class, id, css_style
+#
+# In this very order. There shall be NO exception to this. Alternatively
+# you can use a Hash - then the order does not matter.
+#
+# Some tags allow you to use a hash, such as:
+#
+#   css_class: 'marl1em', css_style: 'border:1px solid red'
+#
+# Here you can obviously be more flexible.
+# =========================================================================== #
+# require 'cyberweb/toplevel_methods/misc.rb'
+# Cyberweb.return_dataset_without_any_comments
+# Cyberweb.right_arrow
+# Cyberweb.dropdown_box
+# Cyberweb.return_the_name
+# Cyberweb.colourize_ruby_code
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # Try to next include coderay, silently.
+  # ========================================================================= #
+  begin
+    require 'coderay'
+  rescue LoadError; end
+
+  require 'cyberweb/constants/project_constants.rb'
+  # ========================================================================= #
+  # Require the various web_object/toplevel_methods/ components next:
+  # ========================================================================= #
+  require 'cyberweb/images/images.rb'
+  require 'cyberweb/toplevel_methods/bold.rb'
+  require 'cyberweb/toplevel_methods/charsets.rb'
+  require 'cyberweb/toplevel_methods/cgi.rb'
+  require 'cyberweb/toplevel_methods/consider_serving_the_web_object.rb'
+  require 'cyberweb/toplevel_methods/ee.rb'
+  require 'cyberweb/toplevel_methods/hfin.rb'
+  require 'cyberweb/toplevel_methods/html_mode.rb'
+  require 'cyberweb/toplevel_methods/input.rb'
+  require 'cyberweb/toplevel_methods/last_modified.rb'
+  require 'cyberweb/toplevel_methods/padlem_and_marlem.rb'
+  require 'cyberweb/toplevel_methods/readlines.rb'
+  require 'cyberweb/toplevel_methods/remove_newlines.rb'
+  require 'cyberweb/toplevel_methods/return_html_to_head_start.rb'
+  require 'cyberweb/toplevel_methods/show_and_display.rb'
+  require 'cyberweb/toplevel_methods/string_body_start.rb'
+  require 'cyberweb/toplevel_methods/svg.rb'
+  require 'cyberweb/toplevel_methods/s2.rb'
+  require 'cyberweb/toplevel_methods/string_content.rb'
+  require 'cyberweb/toplevel_methods/write_what_into.rb'
+  require 'cyberweb/html_tags/option.rb'
+
+  # ========================================================================= #
+  # === Cyberweb.show_admin_icons
+  #
+  # Show all admin icons through this method.
+  # ========================================================================= #
+  def self.show_admin_icons
+    _ = ''.dup
+    ARRAY_LISTING_ALL_PROJECT_IMAGES.each { |entry|
+      use_this_id = File.basename(entry.to_s).to_s.downcase.delete('.')
+      _ << string_s2(entry, '','','s1px marl0_7em black')+
+           sg(
+             entry,
+             'bblack0',
+             use_this_id
+           )
+    }
+    return _
+  end
+
+  # ========================================================================= #
+  # === show_ruby_file
+  #
+  # Display a ruby file here.
+  # ========================================================================= #
+  def show_ruby_file(
+      i = '/home/x/programming/ruby/src/test/'
+    )
+    read_and_display_file_if_it_exists(i)
+  end
+
+  # ========================================================================= #
+  # === pre_htmlentities
+  # ========================================================================= #
+  def pre_htmlentities(text = '', css_class = '', the_id = '', css_style = '')
+    pre(
+      text,css_class,the_id,css_style, :remove_html
+    ) # :remove_html means that we strip HTML entries in the text.
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.response_header?
+  # ========================================================================= #
+  def self.response_header?
+    "HTTP/1.0 200 OK\r\n"
+  end
+
+  # ========================================================================= #
+  # === ebr
+  #
+  # Echo, then print content, then add a newline + '<br>' tag.
+  # ========================================================================= #
+  def ebr(input)
+    ee input+NL
+    nbr
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.right_arrow
+  # ========================================================================= #
+  def self.right_arrow
+    '&rarr;'
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.bruch
+  #
+  # This is a "bruch", aka a fraction. It is written in german mostly because
+  # I am quite lazy.
+  # ========================================================================= #
+  def self.bruch(a, b)
+    return "<sup>#{a}</sup>/<sub>#{b}</sub>"
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.dropdown_box
+  #
+  # This method will generate a <select><option> listing, a drop-down
+  # interface. The input to this method must be an Array.
+  # ========================================================================= #
+  def self.dropdown_box(input)
+    if input.is_a? Array # Ok.
+      _ = '<select>'.dup
+      input.each {|line|
+        _ << string_option(line)
+      }
+      _ << string_close(:select)
+      return _ # And return the result here.
+    else
+      raise 'The method dropdown_box() requires an Array as argument.'
+    end
+  end; self.instance_eval { alias www_dropdown_box  dropdown_box } # === Cyberweb.www_dropdown_box
+       self.instance_eval { alias html_dropdown_box dropdown_box } # === Cyberweb.html_dropdown_box
+
+  # ========================================================================= #
+  # === Cyberweb.return_the_name
+  #
+  # Some HTML tags will have a name identifier. This method here shall try
+  # to satisfy these tags.
+  # ========================================================================= #
+  def self.return_the_name(i = '')
+    _ = ' name="'+i.to_s+'"'
+    return _
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.colourize_ruby_code                              (ruby tag)
+  #
+  # Use this to colourize ruby code. Be careful when using this though
+  # and only use it when you (a) need it and (b) when you have ruby
+  # code in question.
+  # ========================================================================= #
+  def self.colourize_ruby_code(_)
+    _ = _.dup
+    _.gsub!(/class /,
+      '<span class="BG_Black pad1px lightgreen bold">class </span>')
+    _.gsub!(/require/,
+      '<span class="pad1px red FI bold">require</span>')
+    _.gsub!(/end$/,
+      '<span class="BG_Black pad1px red bold">end</span>')
+    _.gsub!(/else/,
+      '<span class="BG_Black pad1px red bold">else</span>')
+    _.gsub!(/if /,
+      '<span class="BG_Black pad1px red bold">if </span>')
+    _.gsub!(/elsif/,
+      '<span class="BG_Black pad1px red bold">elsif</span>')
+    _.gsub!(/__FILE__/,
+      '<span class="BG_Black pad1px pink bold">__FILE__</span>')
+    _.gsub!(/\$PROGRAM_NAME/,
+      '<span class="BG_Black pad1px lightgreen bold">$PROGRAM_NAME</span>')
+    _.gsub!(/class (\w+) </,'<span class="BG_Black pad1px yel bold">class</span> \\1 <')
+    _.gsub!(/super\(\)/,'<span class="BG_Black pad1px cyan bold">super()</span>')
+    _.gsub!(/#!\/System\/Executables\/ruby -w/,'<span class="BG_Black pad1px green bold">#!/System/Executables/ruby -w</span>')
+    _.gsub!(/def (.*)/,
+      '<span class="BG_Black pad1px orange bold">def </span><span class="BG_Black BO pad1px lightblue">\1</span>')
+    _.gsub!(/do/,
+      '<span class="BG_Black pad1px orange bold">do</span>')
+    return _
+  end
+
+  # ========================================================================= #
+  # === @css_object
+  #
+  # The @css_object instance variable.
+  # ========================================================================= #
+  @css_object = nil # Initialize it is nil.
+
+  # ========================================================================= #
+  # === @enable_title_for_reading_files
+  # ========================================================================= #
+  @enable_title_for_reading_files = false
+
+  # ========================================================================= #
+  # === @simple_form
+  # ========================================================================= #
+  @simple_form = nil
+
+  # ========================================================================= #
+  # === @listing_counter
+  #
+  # Initialize the counter for listings here.
+  # ========================================================================= #
+  @listing_counter = 0
+
+  # ========================================================================= #
+  # === Cyberweb.simple_form
+  # ========================================================================= #
+  def self.simple_form
+    @simple_form
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.simple_form=
+  # ========================================================================= #
+  def self.simple_form=(i)
+    @simple_form = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.css_object=
+  # ========================================================================= #
+  def self.css_object=(i)
+    @css_object = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.css_object?
+  # ========================================================================= #
+  def self.css_object?
+    @css_object
+  end; self.instance_eval { alias css_object css_object? }
+
+  # ========================================================================= #
+  # === Cyberweb.html_header
+  #
+  # Usage example:
+  #
+  #   Cyberweb.html_header( :title => entry )
+  #
+  # ========================================================================= #
+  def self.html_header(optional_hash = {})
+    _ = return_html_to_head_start.dup
+    if optional_hash.has_key? :title # In this case, also add the title.
+      _ << string_title(optional_hash.delete(:title))
+    end
+    _ << string_body_start
+    return _
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.display_environmental_variables
+  #
+  # Show all environmental variables.
+  # ========================================================================= #
+  def self.display_environmental_variables
+    div('pad1em TAL', id: 'environment_variables') {
+      h2 'The environmental variables are:','darkblue'
+      if ::Cyberweb::CGI.respond_to? :predefined_cgi_env_variables
+        array = CGI.predefined_cgi_env_variables
+        array.each {|entry|
+          e '<b class="larger">'+entry.to_s+'</b>: '+ENV[entry].to_s
+        }
+      end
+    }
+  end; self.instance_eval { alias show_environment display_environmental_variables } # === Cyberweb.show_environment
+       self.instance_eval { alias show_env         display_environmental_variables } # === Cyberweb.show_env
+
+  # ========================================================================= #
+  # === Cyberweb.logfile?
+  #
+  # For now, we will return the constant MISSING_IMAGES_ARE_STORED_HERE here.
+  # ========================================================================= #
+  def self.logfile?
+    MISSING_IMAGES_ARE_STORED_HERE
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.logging?
+  # 
+  # Convenience method to find out the amount of logging we will do.
+  # ========================================================================= # 
+  def self.logging?
+    config?['warnings'].to_s
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.to_css_directory
+  #
+  # This method will always give us the path towards the CSS/ directory.
+  # ========================================================================= #
+  def self.to_css_directory
+    "#{converted_path}cascading_style_sheets/"
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.load_webmin
+  # ========================================================================= #
+  def self.load_webmin
+    Dir["#{WEBMIN_DIRECTORY}*rb"].each {|file|
+      require WEBMIN_DIRECTORY+File.basename(file)
+    }
+  end; load_webmin
+
+  # ========================================================================= #
+  # === Cyberweb.start_server
+  #
+  # Start the webrick server through this method.
+  # ========================================================================= #
+  def self.start_server(
+      use_this_port = 3003
+    )
+    which_document_root_to_use = (Dir.pwd+'/').squeeze '/'
+    http_server = WEBrick::HTTPServer.new(
+      :Port         => use_this_port,
+      :DocumentRoot => which_document_root_to_use
+    )
+    Colours.e 'Will be serving on '+
+               Colours.sfancy('http://localhost:'+use_this_port.to_s)
+    http_server.start
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.load_standalone_classes
+  #
+  # Load all .rb files under standalone_classes/.
+  # ========================================================================= #
+  def self.load_standalone_classes
+    Dir[STANDALONE_CLASSES_DIRECTORY+'*rb'].each {|file|
+      require STANDALONE_CLASSES_DIRECTORY+File.basename(file)
+    }
+  end; load_standalone_classes
+
+  # ========================================================================= #
+  # === Cyberweb.load_css
+  # ========================================================================= #
+  def self.load_css
+    Dir[PROJECT_CSS_DIRECTORY+'*rb'].each {|file|
+      require PROJECT_CSS_DIRECTORY+File.basename(file)
+    }
+  end; load_css
+
+  # ========================================================================= #
+  # === Cyberweb.load_coloured_tags
+  #
+  # The coloured tags allow you to colourize your input.
+  #
+  # They are stored in the file coloured_tags.rb and can be
+  # autogenerated anew when necessary.
+  # 
+  # For instance:
+  #
+  #   green 'foo'
+  #
+  # Makes a green tag. Ideally, all coloured words should work that way.
+  # ========================================================================= #
+  def self.load_coloured_tags
+    require COLOURED_TAGS
+  end; load_coloured_tags
+
+  # ========================================================================= #
+  # === ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES
+  #
+  # Specify here which Javascript libraries are to be loaded on default.
+  #
+  # This will simply be all files specified in:
+  #
+  #   bl $CYBERWEB/yaml/js_files_to_load.yml
+  #
+  # ========================================================================= #
+  if File.exist? PROJECT_YAML_DIRECTORY+'js_files_to_load.yml' # MAIN_DIR is defined in web_requires.rb
+    ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES = YAML.load_file(
+      "#{PROJECT_YAML_DIRECTORY}js_files_to_load.yml" # bl $WEB_FOUNDATION/yaml/js_files_to_load.yml
+    )
+  else
+    ARRAY_DEFAULT_JAVASCRIPT_LIBRARIES = []
+  end
+
+  # ========================================================================= #
+  # === n
+  #
+  # This method will simply print a newline (ee is aliased to print).
+  # ========================================================================= #
+  def n
+    ee N
+  end unless defined? n
+
+  # ========================================================================= #
+  # === remove_html_tags                                       (no html tags)
+  #
+  # This method will simply remove all html tags from a string.
+  #
+  # We will make use of project RemoveHtml for this task, which
+  # will be used through Cyberweb.remove_html().
+  #
+  # Usage example:
+  #
+  #   Cyberweb.remove_html_tags("<span>foobar</span><br><b>test</b>")
+  #   "<span>foobar</span><b>test</b>".gsub(/\<.+\>/,'')
+  #   y = Cyberweb.remove_html_tags( x )
+  #   y = Cyberweb.remove_html_tags( readlines("LINUX_COMMANDS.html").join(' ') )
+  #   MyLogger.write_what_to(y,'/final.html')
+  #
+  # ========================================================================= #
+  def remove_html_tags(input)
+    ::Cyberweb.remove_html(input)
+  end; alias no_html     remove_html_tags # === no_html
+       alias de_html     remove_html_tags # === de_html
+       alias strip_html  remove_html_tags # === strip_html
+       alias remove_html remove_html_tags # === remove_html
+
+  # ========================================================================= #
+  # === create_directory
+  #
+  # Consistently use this method if you want to create a directory.
+  # So far this is only used in the file img.rb
+  # ========================================================================= #
+  def create_directory(d)
+    Dir.mkdir(d)
+  end
+
+  # ========================================================================= #
+  # === div_bord_1
+  # ========================================================================= #
+  def div_bord_1(css_class = '', the_id = '', css_style = '', javascript = '')
+    div(css_class, the_id, css_style+' RAND_BORD_1', javascript)
+  end; alias div_bord1px div_bord_1 # === div_bord1px
+
+  # ========================================================================= #
+  # === div_bord_2
+  # ========================================================================= #
+  def div_bord_2(css_class = '', the_id = '', css_style = '', javascript = '')
+    div(css_class, the_id, css_style+' RAND_BORD_2', javascript)
+  end; alias div_bord2px div_bord_2 # === div_bord2px
+
+  # ========================================================================= #
+  # === div_bord_3
+  # ========================================================================= #
+  def div_bord_3(css_class = '', the_id = '', css_style = '', javascript = '')
+    div(css_class, the_id, css_style+' RAND_BORD_3', javascript)
+  end; alias div_bord3px div_bord_3 # === div_bord3px
+
+  # ========================================================================= #
+  # === read_file_with_these_lines
+  #
+  # read_file_with_these_lines('ShebangFixer',1,5)
+  # ========================================================================= # 
+  def read_file_with_these_lines(
+      this_file,
+      starting_line = 1,
+      ending_line   = 5,
+      css_to_use    = ''
+    )
+    _ = read_file(this_file)
+    _ = _[starting_line, ending_line] if _
+    pre _, css_to_use
+  end
+
+  # ========================================================================= #
+  # === string_html_start
+  #
+  # Just start of <html>, optionally like <html lang="en">
+  # ========================================================================= #
+  def string_html_start(
+      optional_language = ''
+    )
+    _ = return_html_start.dup
+    _ << ' lang="'+optional_language+'"' unless optional_language.empty?
+    _ << "#{NL}#{NL}"
+    return _
+  end
+
+  # ========================================================================= #
+  # === return_html_start
+  # ========================================================================= #
+  def return_html_start
+    ::Cyberweb.return_html_start
+  end
+
+  # ========================================================================= #
+  # === div_blue
+  #
+  # This is used in hardware_information.rb.
+  # ========================================================================= #
+  def div_blue(c = 'Black pad1em',i='',s='background-color:#7676b3;border: 1px solid black')
+    div(c,i,s) { yield if block_given? }
+  end
+
+  # ========================================================================= #
+  # === create_thumbnails_page
+  #
+  # create a html file of current image dirs.
+  # ========================================================================= #
+  def create_thumbnails_page(of_this_input_dir)
+    _ = get_images(of_this_input_dir)
+    ee 'Creating thumbnails page next ...'
+  end
+
+  # ========================================================================= #
+  # === pnl
+  #
+  # Prints a new line.
+  # ========================================================================= #
+  def pnl
+    ee NL
+  end; alias newline pnl # === newline
+
+  # ========================================================================= #
+  # === print_head_start
+  # ========================================================================= #
+  def print_head_start
+    ee return_head_start
+  end
+
+  # ========================================================================= #
+  # === print_strict_doctype
+  #
+  # Print the doctype to use, by calling the method return_strict_doctype().
+  # ========================================================================= #
+  def print_strict_doctype
+    ee return_strict_doctype
+  end
+
+  # ========================================================================= #
+  # === print_the_name
+  #
+  # Prints a html name tag by invoking the method return_the_name().
+  # ========================================================================= #
+  def print_the_name(of_this_name)
+    ee return_the_name(of_this_name)
+  end
+
+  # ========================================================================= #
+  # === l_e
+  #
+  # This will use the css class marl0_5em.
+  # ========================================================================= #
+  def l_e(text, css_class = '', the_id = '', css_style = '')
+    e text,'marl0_5em '+css_class, the_id, css_style
+  end
+
+  # ========================================================================= #
+  # === output_content_type
+  #
+  # Use this method if you wish to output the content type.
+  # ========================================================================= #
+  def output_content_type
+    ee CONTENT_TYPE_PLAIN
+  end
+
+  # ========================================================================= #
+  # === output_response_header
+  # ========================================================================= #
+  def output_response_header
+    ee HTTP_RESPONSE_HEADER
+  end
+
+  # ========================================================================= #
+  # === div_note
+  #
+  # This method makes a little <div> tag. It makes use of a special CSS 
+  # file called admonition.css.
+  #
+  # Usage example:
+  #   div_note 'Note','Good requirements.'
+  # ========================================================================= #
+  def div_note(
+      title             = '',
+      paragraph_content = '',
+      optional_id       = ''
+    )
+    div('admonition',optional_id) {
+      p('p_title1') { e title }
+      p { e paragraph_content }
+    }
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.get_files_from
+  #
+  # This method returns all files from a given directory (first argument).
+  # ========================================================================= #
+  def self.get_files_from(
+      this_dir                             = Dir.pwd,
+      return_full_path                     = false,
+      traverse_into_subdirectories_as_well = false
+    )
+    unless this_dir.include? '*'
+      this_dir = this_dir.dup if this_dir.frozen?
+      this_dir << '*'
+    end
+    all_files = Dir[this_dir]
+
+    if traverse_into_subdirectories_as_well
+      this_dir << '/' unless this_dir.end_with? '/' # Let's ensure we have a directory here.
+      all_files = Dir[this_dir+'/*/**']
+    end
+
+    return all_files # Finally, return all of our results.
+  end; self.instance_eval { alias get_all_files_from get_files_from } # === Cyberweb.get_all_files_from
+       self.instance_eval { alias get_files          get_files_from } # === Cyberweb.get_files
+
+  # ========================================================================= #
+  # === make_row
+  #
+  # Use this method to make an entry. It is generally used within a form.
+  #
+  # Usage examples:
+  #
+  #   make_row 'Base Dir:','base_dir','BG_Black lightblue'
+  #   make_row 'Description:','description','BG_Black lightgreen'
+  # ========================================================================= #
+  def make_row(
+        description,
+        input_id,
+        optional_css = '',
+        colour_for_border = 'mediumslateblue'
+      )
+    trtd description
+      # s2 description
+    ctd
+    td
+      input_br :text,'','s0_1em mar1px pad1px s4px marl1_5em '+optional_css,
+               input_id, 'border:1px solid '+colour_for_border # RAND_COLOUR
+    ctdctr
+  end
+
+  # ========================================================================= #
+  # === ibr
+  #
+  # Italic with linebreak.
+  # ========================================================================= #
+  def ibr(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    text = sanitize_for_colours(text).to_s.dup
+    css_class = css_class.to_s.dup
+    i text, css_class, the_id, css_style
+    nbr
+  end
+
+  # ========================================================================= #
+  # === escaped_html
+  #
+  # Like escape_html(), but will output it. ehtml() is the more common
+  # variant.
+  # ========================================================================= #
+  def escaped_html(text)
+    ee escape_html(text)
+  end; alias ehtml escaped_html # === ehtml
+
+  # ========================================================================= #
+  # === colourize_nim_code
+  # ========================================================================= #
+  def colourize_nim_code(_)
+    _.gsub!(/discard/,
+      '<span class="BG_Black pad1px red bold">discard</span>')
+    _.gsub!(/^if/,
+      '<span class="BG_Black pad1px red bold">if</span>')
+    _.gsub!(/^else/,
+      '<span class="BG_Black pad1px red bold">else</span>')
+    _.gsub!(/#/,
+      '<span class="BG_Black pad1px grey bold">#</span>')
+    return _
+  end
+
+  # ========================================================================= #
+  # === return_random_image
+  #
+  # Default will be to return from Wallpaper directory.
+  # ========================================================================= #
+  def return_random_image(
+      directory = "#{IMAGE_DIRECTORY}/WALLPAPERS/"
+    )
+    directory = directory.dup if directory.frozen?
+    directory[0,0] = 'WALLPAPERS/' unless directory.include? 'WALLPAPERS'
+    return get_files_from(directory).sample
+  end
+
+  # ========================================================================= #
+  # === read_file                                             (read file tag)
+  #
+  # Reads in a file. Nothing more, nothing less. If you need only a
+  # specific range from that file, you need to manipulate the
+  # resulting array on your own.
+  # ========================================================================= #
+  def read_file(i)
+    if i.is_a? Symbol # Assume in this case that we want to use BeautifulUrl.
+      i = sanitize_url(i, true)
+    end
+    if File.directory?(i)
+      i = get_files_from(i, true)
+      i.each { |dir|
+        unless File.zero?(dir) # unless it is empty.
+          link dir, sg(:square_green,
+            'marr4px wid5px bblack1')+dir,1,'slateblue'
+        end
+      }
+    else
+      i = readlines(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === print_html_start
+  # ========================================================================= #
+  def print_html_start
+    ee return_html_start
+  end
+
+  # ========================================================================= #
+  # === print_html_to_head_start
+  # ========================================================================= #
+  def print_html_to_head_start
+    ee return_html_to_head_start 
+  end
+
+  # ========================================================================= #
+  # === return_head_start
+  # ========================================================================= #
+  def return_head_start
+    ::Cyberweb.return_head_start
+  end
+
+  # ========================================================================= #
+  # === bbrud
+  #
+  # This method combines bold (b), with breakline (br), and underline (ud).
+  #
+  # It is not often needed.
+  # ========================================================================= #
+  def bbrud(text, css_class = '', the_id = '', css_style = '')
+    boldbr(text, 'ud '+css_class, the_id, css_style)
+  end
+
+  # ========================================================================= #
+  # === read_and_display_for_ruby
+  #
+  # It is however unspecific to any programming language.
+  # ========================================================================= #
+  def read_and_display_for_ruby(f,
+      c              = 'bblack2',
+      i              = '',
+      style          = '', 
+      colourize_me   = true,
+      do_escape_html = false
+    )
+    read_and_display(f, c, i, style, colourize_me, do_escape_html)
+  end; alias read_display_with_ruby  read_and_display_for_ruby # === read_display_with_ruby
+       alias read_display_for_nimrod read_and_display_for_ruby # === read_display_for_nimrod
+       alias read_display_ruby       read_and_display_for_ruby # === read_display_ruby
+
+  # ========================================================================= #
+  # === add_ruby_code
+  #
+  # This method depends on CodeRay. It will simply parse some ruby code.
+  # ========================================================================= #
+  def add_ruby_code(i)
+    CodeRay.scan(i, :ruby).div
+  end
+
+  # ========================================================================= #
+  # === show_ip
+  #
+  # This shows the ip of the visitor, by invoking the method get_ip().
+  # ========================================================================= #
+  def show_ip
+    e 'The IP is:'
+    e get_ip,'yel'
+  end
+
+  # ========================================================================= #
+  # === localhost_to_data
+  #
+  # This will replace localhost with the corresponding entry.
+  # ========================================================================= #
+  def localhost_to_data(i)
+    i.sub(/localhost/, '/')
+  end
+
+  # ========================================================================= #
+  # === no_http
+  #
+  # Returns a variant without leading "http://" string. Please use this 
+  # method whenever getting rid of http.
+  # ========================================================================= #
+  def no_http(i)
+    return i.gsub(/^http:\/\//, '')
+  end
+
+  # ========================================================================= #
+  # === print_meta_collection
+  #
+  # Print meta stuff like robots info etc.
+  # ========================================================================= #
+  def print_meta_collection
+    ee return_meta_collection
+  end
+
+  # ========================================================================= #
+  # === show_image_checkbox
+  #
+  # This will display a small cute little checkbox. It omits the id tag
+  # because I think there is no point in using an id for such a small 
+  # checkbox.
+  #
+  # Usage example:
+  #
+  #   show_image_checkbox :on, 'posab','top:10em;right:18%'
+  #
+  # ========================================================================= #
+  def show_image_checkbox(
+      mode      = :on,
+      css_class = '',
+      css_style = ''
+    )
+    case mode
+    when :off
+      img 'STD/CHECKBOX_OFF.png',css_class, '', css_style
+    when :on
+      img 'STD/CHECKBOX_ON.png', css_class, '', css_style
+    end
+  end
+
+  # ========================================================================= #
+  # === navgroup
+  #
+  # Make a simple navgroup.
+  # ========================================================================= #
+  def navgroup(*args)
+    ee '<nav>'
+      ee '<ul>'
+      args.flatten.each { |i|
+        ee '<li><a href="#">'+i+'</a></li>'
+      }
+      cul
+    cnav
+  end
+
+  # ========================================================================= #
+  # === valid_html
+  #
+  # W3, valid, validator
+  #
+  # Usage example:
+  #
+  #   valid_html 's1em','s1px'
+  #
+  # ========================================================================= #
+  def valid_html(
+      div_class = '',
+      div_style = ''
+    )
+    div('FS0_8em Z100 '+div_class, '',div_style,'onmousedown="start_dragging(this)"'){
+      ee '<a href="http://validator.w3.org/check/referer">'
+        img 'STD/VALID_HTML.jpg','s1px','Valid_html_4.0'
+      c 'a'
+      ee '<a href="http://jigsaw.w3.org/css-validator/check/referer">'
+        img 'STD/VALID_CSS.jpg','s1px','Valid_css_4.0'
+      c 'a'
+    }
+  end
+
+  # ========================================================================= #
+  # === get_ip
+  #
+  # This returns the ip.  
+  # ========================================================================= #
+  def get_ip
+    ENV['REMOTE_ADDR']
+  end
+
+  # ========================================================================= #
+  # === display_environmental_variables
+  #
+  # Show the CGI variables.
+  # ========================================================================= #
+  def display_environmental_variables
+    ::Cyberweb.display_environmental_variables
+  end; alias show_environment display_environmental_variables # === show_environment
+
+  # ========================================================================= #
+  # === block
+  # ========================================================================= #
+  def block(text, css_class = '', the_id = '', css_style = '')
+    e text, 'BLOCK '+css_class, the_id, css_style
+  end
+
+  # ========================================================================= #
+  # === websave_what_to
+  #
+  # Use this method to save the file somewhere.
+  #   rfind web_foundation.log
+  # ========================================================================= #
+  def websave_what_to(
+      what,
+      where_to = "#{log_dir?}web_foundation.log",
+      mode = 'a+'
+    )
+    unless where_to.include? '/'
+      where_to = "#{log_dir?}#{where_to}"
+    end
+    # ======================================================================= #
+    # We may have to check for the file permissions first.
+    # ======================================================================= #
+    begin
+    if File.writable? where_to
+      File.open(where_to, mode) {|f| f.print(what, N) }
+    else
+      raise 'File not writable.'
+    end
+    rescue; end # silent rescue.
+  end; alias save_what    websave_what_to # === save_what
+       alias save_what_to websave_what_to # === save_what_to
+
+  # ========================================================================= #
+  # === send_email
+  #
+  # Use this method to send an email.
+  # ========================================================================= #
+  def send_email
+    w.mail.deliver
+  end
+
+  # ========================================================================= #
+  # === right
+  # ========================================================================= #
+  def right(i)
+    e i,'FLR'
+  end
+
+  # ========================================================================= #
+  # === brbr
+  # ========================================================================= #
+  def brbr
+    br; br
+  end
+
+  # ========================================================================= #
+  # === get_all_directories_from
+  #
+  # Obtain all directories from a target path.
+  # ========================================================================= #
+  def get_all_directories_from(
+      where = Dir.pwd,
+      return_full_path = false
+    )
+    return Dir["#{where}/*"].reject {|entry| ! File.directory? entry } 
+  end
+
+  # ========================================================================= #
+  # === warn
+  #
+  # A warning displayed via the <pre> tag.
+  # ========================================================================= #
+  def warn(i)
+    pre i,'red'
+  end; alias ewarn warn # === ewarn
+
+  # ========================================================================= #
+  # === rating
+  #
+  # Use this for a simple rating, so that we can display one star,
+  # two stars, three, four or five stars.
+  # ========================================================================= #
+  def rating(which_rating = 1)
+    case which_rating
+    when 0, 1, :one
+      _ = sg :one_star
+    when 2, :two
+      _ = sg :two_stars
+    when 3, :three
+      _ = sg :three_stars
+    when 4, :four
+      _ = sg :four_stars
+    when 5, :five
+      _ = sg :five_stars
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === content
+  #
+  # This is a nice little method, like I used to use e() in my old PHP
+  # scripts. An alias to it is cont().
+  # ========================================================================= #
+  def content(inp)
+    ee string_cont(inp)
+  end; alias cont content # === cont
+
+  # ========================================================================= #
+  # === object_frame
+  #
+  # This method generates an <object> tag, but in context of a passed src.
+  #
+  # Usage example:
+  #
+  #   object_frame('../index.html')
+  #   div('mart10em'){ object_frame('../PC/PC.cgi') }
+  #   div('mar4em'){ object_frame('../PC/OS/LINUX/LINUX_COMMANDS.cgi','800','400') }
+  #
+  # ========================================================================= #
+  def object_frame(
+      src,
+      optional_width  = '95%',
+      optional_height = '440',
+      optional_css_class = 'bblack1 pad0_5em',
+      optional_id = '',
+      optional_css_style = ''
+    )
+    if src.is_a? Symbol # Intercept symbols here.
+      src = sanitize_url(src)
+    end
+    if optional_width.is_a? Hash
+      optional_width = optional_width.delete(:width) if optional_width.has_key? :width 
+    end
+    ee '<object class="'+optional_css_class+'" data="'+src+
+        '" type="text/html" name="framesPage" width="'+
+        optional_width+'" height="'+optional_height+'" id="'+optional_id+'">'
+    ee '<a href="/html-tutorials/verticalframes.php">Missing '+src+' frameset.</a>' 
+    c :object
+  end; alias frame          object_frame # === frame
+       alias embedded_frame object_frame # We can also embed other pages.
+
+  # ========================================================================= #
+  # === clear_list
+  #
+  # This method resets the listing counter again. It makes use of
+  # web_object listing counter method.
+  # ========================================================================= #
+  def clear_list
+    web_object.reset_counter
+  end; alias reset_listing clear_list # === reset_listing
+
+  # ========================================================================= #
+  # === l4em
+  # ========================================================================= #
+  def l4em(text, css_class = '', the_id = '', css_style = '')
+    e text,'marl4em '+css_class, the_id, css_style
+  end; alias marl4em l4em # === marl4em
+       alias l4      l4em # === l4
+       alias le4     l4em # === le4
+
+  # ========================================================================= #
+  # === l5em
+  # ========================================================================= #
+  def l5em(text, css_class = '', the_id = '', css_style = '')
+    e text,'marl5em '+css_class, the_id, css_style
+  end; alias marl5em l5em # === marl5em
+       alias l5      l5em # === l5
+       alias le5     l5em # === le5
+
+  # ========================================================================= #
+  # === Cyberweb.name_of_served_page?
+  #
+  # This method will return the name of the page that is served, which
+  # is stored in the environment variable SCRIPT_NAME.
+  #
+  # The method will thus return something such as 'ADMIN.cgi'.
+  # ========================================================================= # 
+  def self.name_of_served_page?(return_full_path = false)
+    _ = ENV['SCRIPT_NAME'] # This value here will be returned.
+    case return_full_path
+    when :full_path
+      return_full_path = true
+    end
+    if return_full_path
+      ::Cyberweb.rds(server_directory?+_)
+    else
+      File.basename(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === name_of_served_page?
+  # ========================================================================= #
+  def name_of_served_page?(return_full_path = false)
+    ::Cyberweb.name_of_served_page?(return_full_path)
+  end; alias this_file? name_of_served_page? # === this_file?
+
+  # ========================================================================= #
+  # === embed
+  #
+  # Allows you to embed SVG files, for instance.
+  # ========================================================================= #
+  def embed(svg_src = '',width = '150',height = '150')
+    ee '<embed src="'+svg_src+'.svg" width="'+width+'" height="'+height+'">'
+  end
+
+  # ========================================================================= #
+  # === show_inhalt
+  #
+  # We show a file called INHALT here.
+  # ========================================================================= #
+  def show_inhalt(
+      css_to_use = ''
+    )
+    read_and_display 'INHALT.md', css_to_use
+  end
+
+  # ========================================================================= #
+  # === pfeil_rechts
+  # ========================================================================= #
+  def pfeil_rechts(use_this_css_class = 'marr4px') 
+    sg(:pfeil_rechts, use_this_css_class)
+  end
+
+  # ========================================================================= #
+  # === sysinfo_header
+  # ========================================================================= #
+  def sysinfo_header(
+      i, use_this_colour = 'cyan'
+    )
+    h2 sg(:chronik,'marr5px')+i, use_this_colour
+  end
+
+  # ========================================================================= #
+  # === l2em
+  # ========================================================================= #
+  def l2em(text, css_class = '', the_id = '', css_style = '')
+    e text,'marl2em '+css_class, the_id, css_style
+  end; alias marl2em l2em # === marl2em
+       alias l2      l2em # === l2
+       alias le2     l2em # === le2
+       alias lee     l2em # === lee
+
+  # ========================================================================= #
+  # === read_file_into_array
+  #
+  # Read a file into an Array.
+  # ========================================================================= #
+  def read_file_into_array(i)
+    result = []
+    if File.exist? i
+      result << readlines(i)
+    end
+    result.flatten
+  end
+
+  # ========================================================================= #
+  # === div_fin
+  #
+  # Supports yield since 29.11.2011.
+  # ========================================================================= #
+  def div_fin(
+      css_class  = '',
+      the_id     = '',
+      css_style  = '',
+      javascript = ''
+    )
+    div(css_class = '', the_id = '', css_style = '', javascript = '')
+    yield if block_given?
+    cdiv # close the div tag properly.
+    hfin
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.string_bold
+  # ========================================================================= #
+  def self.string_bold(
+      content    = '',
+      css_class  = '',
+      the_id     = '', 
+      css_style  = '',
+      javascript = ''
+    )
+    string_s(
+      content, 'b', css_class, the_id, css_style, javascript
+    )
+  end; self.instance_eval { alias string_b string_bold } # === Cyberweb.string_b
+
+  # ========================================================================= #
+  # === string_bold
+  # ========================================================================= #
+  def string_bold(
+      content    = '',
+      css_class  = '',
+      the_id     = '', 
+      css_style  = '',
+      javascript = ''
+    )
+    ::Cyberweb.string_s(
+      content, 'b', css_class, the_id, css_style, javascript
+    )
+  end; alias string_b string_bold # === string_b
+
+  # ========================================================================= #
+  # === Cyberweb.left_arrow
+  # ========================================================================= #
+  def self.left_arrow
+    '&larr;'
+  end
+
+  # ========================================================================= #
+  # === italic
+  # ========================================================================= #
+  def italic(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    if css_class.frozen?
+      css_class = css_class.dup
+    end
+    unless css_class.include? 'italic'
+      # ===================================================================== #
+      # In this case we will append 'italic'.
+      # ===================================================================== #
+      unless css_class.empty?
+        css_class << ' '
+      end
+      css_class << 'italic'
+    end
+    ee string_span(
+      text, css_class, the_id, css_style
+    )
+  end
+
+  # ========================================================================= #
+  # === italicbrlem
+  # ========================================================================= #
+  def italicbrlem(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    italicbr(text, css_class+' padl1em', the_id, css_style)
+  end
+
+  # ========================================================================= #
+  # === italicbr
+  # ========================================================================= #
+  def italicbr(
+      text,
+      css_class = '',
+      the_id    = '',
+      css_style = ''
+    )
+    italic(text, css_class, the_id, css_style)
+    br
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.arrow_right
+  # ========================================================================= #
+  def self.arrow_right
+    '→'
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.generate_simple_webpage
+  #
+  # This ad-hoc method will just generate a .html page with all images
+  # in this directory.
+  # ========================================================================= #
+  def self.generate_simple_webpage(
+      from_this_directory = Dir.pwd
+    )
+    require 'cyberweb/toplevel_methods/images.rb'
+    all_images = Dir["#{from_this_directory}/*"].select {|entry|
+      File.file?(entry) and is_this_an_image?(entry)
+    }
+    _ = "<html><head><title>Simple Webpage</title></head><body><div>\n\n".dup
+    _ << "<h2>All the images</h2>\n"
+    all_images.each {|this_image|
+      basename = File.basename(this_image)
+      _ << '<img src="'+basename+'" alt="'+basename.downcase+'">'+"\n" 
+    }
+    _ << '</div></body></html>'
+    what = _
+    into = 'simple_webpage.html'
+    puts 'Creating the file '+into+' next.'
+    write_what_into(what, into)
+    if is_on_roebe?
+      require 'open'
+      Open.in_browser(into)
+    end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.return_dataset_without_any_comments
+  #
+  # Note that this method will return a String.
+  # ========================================================================= #
+  def self.return_dataset_without_any_comments(i)
+    i = i.split(N).map {|entry|
+      if entry.include? ' #'
+        entry = entry[0 .. (entry.index(' #') - 1)]
+      end
+      if entry.start_with? '#'
+        entry = nil
+      end
+      entry
+    }.compact.join(N) # The .compact is necessary since the code may return nil values.
+    return i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.path_to_the_internal_javascript_directory?
+  # ========================================================================= #
+  def self.path_to_the_internal_javascript_directory?
+    Cyberweb.project_base_directory?+'javascript_code/'
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.try_to_open_this_URL_via_the_browser
+  #
+  # Usage example:
+  #
+  #   Cyberweb.try_to_open_this_URL_via_the_browser(target, USE_THIS_PORT)
+  #
+  # ========================================================================= #
+  def self.try_to_open_this_URL_via_the_browser(
+      target, use_this_port = '4567'
+    )
+    begin
+      require 'open'
+      target = "http://localhost:#{use_this_port}/"
+      if block_given? and (yield == :be_quiet)
+      else
+        puts ::Colours.sfancy(target)
+      end
+      Thread.new {
+        Open.in_browser(target) {{ delay: '1.0 seconds' }}
+      }
+    rescue LoadError => error
+      pp error
+    end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.window                                          (window tag)
+  #
+  # This method is ultimately just a wrapper over a <div> element with
+  # a specified width and height setting. It is assumed to be used
+  # in conjunction with the SimpleWidgets project.
+  #
+  # Usage example:
+  #
+  #   x = Cyberweb.window
+  #
+  # ========================================================================= #
+  def self.window(
+      optional_title  = 'Test',
+      optional_width  = 1024,
+      optional_height =  800,
+      options         = {} # Additional options. Currently not in use. 
+    )
+    style_content = 'width: '+optional_width.to_s+'px; height: '+optional_height.to_s+'px;'.dup
+    # ======================================================================= #
+    # === Handle Hashes next
+    # ======================================================================= #
+    if options.is_a? Hash
+      # ===================================================================== #
+      # === :css_style
+      # ===================================================================== #
+      if options.has_key? :css_style
+        style_content << " #{options[:css_style]};".squeeze(';')
+      end
+    end
+    result = '<div style="'+style_content+'">'+"\n"+
+             '</div>'+"\n"
+    return result
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb.generate_simple_webpage
+end # webobjectmisc