cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/constants/constants.rb

@@ -4,6 +4,596 @@
 # =========================================================================== #
 # require 'cyberweb/constants/constants.rb'
 # =========================================================================== #
-require 'cyberweb/requires/require_the_constants.rb'
+module Cyberweb
 
-Cyberweb.require_the_constants
+  require 'yaml'
+  require 'cyberweb/project/project.rb'
+
+  # ========================================================================= #
+  # === FILE_WEB_IMAGES
+  # ========================================================================= #
+  FILE_WEB_IMAGES = "#{yaml_directory?}web_images.yml"
+
+  # ========================================================================= #
+  # === REMOTE_URL
+  #
+  # This is for a default value for URLs.
+  # ========================================================================= #
+  REMOTE_URL = 'https://derstandard.at'
+
+  # ========================================================================= #
+  # === N
+  #
+  # Note that NL is an alias to this, but this may change eventually.
+  # (NL could be N+BR, actually).
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === NL
+  # ========================================================================= #
+  NL = N
+
+  # ========================================================================= #
+  # === ARRAY_IMAGES
+  #
+  # 4 image-types are defined in the following constant.
+  # ========================================================================= #
+  ARRAY_IMAGES = %w(
+    png
+    gif
+    jpg
+    jpeg
+  )
+
+  # ========================================================================= #
+  # === HTTP_STATUS_CODES
+  #
+  # HTTP status codes are defined here. OK (200) and Not Found (404) are
+  # probably the two most common status codes here.
+  #
+  # They can be used through this hash here such as:
+  #
+  #   HTTP_STATUS['OK'] # gives '200 OK'.
+  #
+  # ========================================================================= #
+  HTTP_STATUS_CODES = {
+    'OK'                  => '200 OK',
+    'PARTIAL_CONTENT'     => '206 Partial Content',
+    'MULTIPLE_CHOICES'    => '300 Multiple Choices',
+    'MOVED'               => '301 Moved Permanently',
+    'REDIRECT'            => '302 Found',
+    'NOT_MODIFIED'        => '304 Not Modified',
+    'BAD_REQUEST'         => '400 Bad Request',
+    'AUTH_REQUIRED'       => '401 Authorization Required',
+    'FORBIDDEN'           => '403 Forbidden',
+    'NOT_FOUND'           => '404 Not Found',
+    'METHOD_NOT_ALLOWED'  => '405 Method Not Allowed',
+    'NOT_ACCEPTABLE'      => '406 Not Acceptable',
+    'LENGTH_REQUIRED'     => '411 Length Required',
+    'PRECONDITION_FAILED' => '412 Precondition Failed',
+    'SERVER_ERROR'        => '500 Internal Server Error',
+    'NOT_IMPLEMENTED'     => '501 Method Not Implemented',
+    'BAD_GATEWAY'         => '502 Bad Gateway',
+    'VARIANT_ALSO_VARIES' => '506 Variant Also Negotiates'
+  }
+  HTTP_STATUS = HTTP_STATUS_CODES # === HTTP_STATUS
+
+  # ========================================================================= #
+  # === Cyberweb::ARRAY_LOCAL_CSS_FILES
+  #
+  # Local .css files can be stored in this constant.
+  #
+  # On my home system these .css files may reside here:
+  #
+  #   /home/x/programming/ruby/src/cyberweb/lib/cyberweb/cascading_style_sheets/colours.css
+  #
+  # ========================================================================= #
+  _ = ::Cyberweb.project_yaml_directory?+
+    'load_these_yaml_files_by_default.yml'
+  if File.exist? _
+    ARRAY_LOCAL_CSS_FILES = YAML.load_file(_)
+  else
+    ARRAY_LOCAL_CSS_FILES = %w(
+      border
+      code
+      colours
+      default
+      div
+      fonts
+      hover
+      links
+      margin
+      message_boxes
+      misc
+      popup
+      ruby_regexes
+      template2
+      random_glow_effects
+    )
+  end
+
+  # ========================================================================= #
+  # === @array_predefined_constants
+  #
+  # The following array defines which constants are available predefined.
+  # ========================================================================= #
+  @array_predefined_constants = []
+
+  # ========================================================================= #
+  # === Cyberweb.array_predefined_constants?
+  # ========================================================================= #
+  def self.array_predefined_constants?
+    @array_predefined_constants
+  end
+
+  # ========================================================================= #
+  # ==== Cyberweb.configuration_file?
+  #
+  # This helper method keeps track as to where the main configuration
+  # file for the cyberweb-project resides.
+  #
+  # For this to work, PROJECT_YAML_DIRECTORY must have been defined before,
+  # which is the case when we load the file 'project_yaml_directory.rb'.
+  #
+  # We may do this in this file here - see above.
+  #
+  # Usage example:
+  #
+  #   Cyberweb.config_file?
+  #
+  # ========================================================================= #
+  def self.configuration_file?
+    "#{project_yaml_directory?}project_configuration.yml"
+  end; self.instance_eval { alias config_file?                  configuration_file? } # === Cyberweb.config_file?
+       self.instance_eval { alias file_web_object_configuration configuration_file? } # === Cyberweb.file_web_object_configuration
+
+  # ========================================================================= #
+  # === CGI_DIRECTORY
+  # ========================================================================= #
+  CGI_DIRECTORY                   = "#{PROJECT_BASE_DIRECTORY}cgi/"
+
+  # ========================================================================= #
+  # === WEB_OBJECT_DIRECTORY
+  # ========================================================================= #
+  WEB_OBJECT_DIRECTORY            = "#{PROJECT_BASE_DIRECTORY}web_object/"
+
+  # ========================================================================= #
+  # === CONFIGURATION_DIRECTORY
+  # ========================================================================= #
+  CONFIGURATION_DIRECTORY         = "#{PROJECT_BASE_DIRECTORY}configuration/"
+
+  # ========================================================================= #
+  # === GENERATOR_DIRECTORY
+  # ========================================================================= #
+  GENERATOR_DIRECTORY             = "#{PROJECT_BASE_DIRECTORY}generator/"
+
+  # ========================================================================= #
+  # === PROJECT_CSS_DIRECTORY
+  # ========================================================================= #
+  PROJECT_CSS_DIRECTORY           = "#{PROJECT_BASE_DIRECTORY}cascading_style_sheets/"
+
+  # ========================================================================= #
+  # === TOPLEVEL_METHODS_DIRECTORY
+  # ========================================================================= #
+  TOPLEVEL_METHODS_DIRECTORY      = "#{PROJECT_BASE_DIRECTORY}toplevel_methods/"
+
+  # ========================================================================= #
+  # === HELP_DIRECTORY
+  # ========================================================================= #
+  HELP_DIRECTORY                  = "#{PROJECT_BASE_DIRECTORY}help/"
+
+  # ========================================================================= #
+  # === WEBMIN_DIRECTORY
+  # ========================================================================= #
+  WEBMIN_DIRECTORY                = "#{PROJECT_BASE_DIRECTORY}webmin/"
+
+  # ========================================================================= #
+  # === CHARTS_DIRECTORY
+  # ========================================================================= #
+  CHARTS_DIRECTORY                = "#{PROJECT_BASE_DIRECTORY}charts/"
+
+  # ========================================================================= #
+  # === JAVASCRIPT_DIRECTORY
+  #
+  # Keep a pointer towards the javascript/ subdirectory.
+  # ========================================================================= #
+  JAVASCRIPT_DIRECTORY            = "#{PROJECT_BASE_DIRECTORY}javascript/"
+
+  # ========================================================================= #
+  # === STANDALONE_CLASSES_DIRECTORY
+  # ========================================================================= #
+  STANDALONE_CLASSES_DIRECTORY    = "#{PROJECT_BASE_DIRECTORY}standalone_classes/"
+
+  # ========================================================================= #
+  # === HTML_TAGS_DIRECTORY
+  # ========================================================================= #  
+  HTML_TAGS_DIRECTORY             = "#{PROJECT_BASE_DIRECTORY}html_tags/"
+
+  # ========================================================================= #
+  # === OBJECTIFIED_HTML_TAGS_DIRECTORY
+  # ========================================================================= #  
+  OBJECTIFIED_HTML_TAGS_DIRECTORY = "#{PROJECT_BASE_DIRECTORY}objectified/html_tags/"
+
+  # ========================================================================= #
+  # === COLOURED_TAGS
+  # ========================================================================= #
+  COLOURED_TAGS                   = "#{PROJECT_BASE_DIRECTORY}coloured_tags/coloured_tags.rb"
+
+  # ========================================================================= #
+  # === DIRECTORY_WITH_CSS_FILES
+  # ========================================================================= #
+  DIRECTORY_WITH_CSS_FILES        = "#{PROJECT_BASE_DIRECTORY}cascading_style_sheets/"
+
+  # ========================================================================= #
+  # === DIRECTORY_IMAGES_BASE64_ENCODED
+  # ========================================================================= #
+  DIRECTORY_IMAGES_BASE64_ENCODED = "#{PROJECT_BASE_DIRECTORY}images_base64_encoded/"
+
+  # ========================================================================= #
+  # === REGISTERED_HTML_TAGS
+  #
+  # Note that this is manually copied from the README.gen file, at the
+  # objectified HTML tags.
+  # ========================================================================= #
+  REGISTERED_HTML_TAGS = %i(
+    a
+    abbr
+    blockquote
+    body
+    button
+    canvas
+    cite
+    div
+    embed
+    fieldset
+    figure
+    form
+    head
+    h1
+    h2
+    h3
+    h4
+    h5
+    h6
+    img
+    meta
+    object
+    p
+    pre
+    span
+    table
+    textarea
+    title
+  )
+
+  # ========================================================================= #
+  # === Cyberweb.is_a_registered_html_tag?
+  # ========================================================================= #
+  def self.is_a_registered_html_tag?(i)
+    REGISTERED_HTML_TAGS.include?(i.to_sym)
+  end
+
+  # ========================================================================= #
+  # === USER_X
+  # ========================================================================= #
+  USER_X = '/home/x/'
+
+  # ========================================================================= #
+  # === Cyberweb.home_x_dir?
+  # ========================================================================= #
+  def self.home_x_dir?
+    USER_X
+  end
+
+  # ========================================================================= #
+  # === HOME_X_DATA
+  #
+  # This constant refers to /home/x/data/.
+  # ========================================================================= #
+  HOME_X_DATA = "#{USER_X}data/"
+
+  # ========================================================================= #
+  # === Cyberweb.roebe_image_dir?
+  # ========================================================================= #
+  def self.roebe_image_dir?
+    "#{HOME_X_DATA}images/"
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.roebe_www_dir?
+  # ========================================================================= #
+  def self.roebe_www_dir?
+    "#{USER_X}programming/ruby/src/roebe/lib/roebe/www/"
+  end
+
+  # ========================================================================= #
+  # === BR
+  # ========================================================================= #
+  BR = '<br>'
+
+  # ========================================================================= #
+  # === NBR
+  # ========================================================================= #
+  NBR = "#{N}#{BR}"
+
+  # ========================================================================= #
+  # === NBSP
+  #
+  # You can use this constant via:
+  #
+  #   Cyberweb::NBSP
+  #
+  # ========================================================================= #
+  NBSP = '&nbsp;'
+
+  # ========================================================================= #
+  # === ALPHABET
+  # ========================================================================= #
+  ALPHABET = ('a'..'z').to_a
+
+  # ========================================================================= #
+  # === YOUR_IP
+  #
+  # The IP of the visitor who visits the website.
+  # ========================================================================= #
+  if ENV['REMOTE_ADDR']
+    YOUR_IP = ENV['REMOTE_ADDR']
+  else
+    YOUR_IP = 'localhost'
+  end
+
+  # ========================================================================= #
+  # === CSS_FILES
+  #
+  # List which .css files our project "understands" by default. These
+  # are stored in the subdirectory called cascading_style_sheets/.
+  # ========================================================================= #
+  CSS_FILES = %w(
+    cascading_style_sheets/default.css
+    cascading_style_sheets/border.css
+    cascading_style_sheets/code.css
+    cascading_style_sheets/colours.css
+    cascading_style_sheets/hover.css
+    cascading_style_sheets/template2.css
+    cascading_style_sheets/text_shadow.css
+    cascading_style_sheets/misc.css
+  )
+
+  # ========================================================================= #
+  # === MAIN_EDITOR_TO_USE
+  #
+  # This is mostly only useful for my home system.
+  # ========================================================================= #
+  MAIN_EDITOR_TO_USE = 'bluefish'
+
+  # ========================================================================= #
+  # === LINE_FEED
+  # ========================================================================= #
+  LINE_FEED = "\r#{N}"
+
+  # ========================================================================= #
+  # === PRE
+  # ========================================================================= #
+  PRE = '</pre>'
+
+  # ========================================================================= #
+  # === LF
+  #
+  # String for linefeed.
+  # ========================================================================= #
+  LF  = "\012"
+
+  # ========================================================================= #
+  # === CR
+  #
+  # String for carriage return.
+  # ========================================================================= #
+  CR = "\015"
+
+  # ========================================================================= #
+  # === EOL
+  #
+  # Standard internet newline sequence.
+  # ========================================================================= #
+  EOL = CR + LF
+
+  # ========================================================================= #
+  # === CONTENT_TYPE_HTML
+  #
+  # The variant with two newlines appears to work better.
+  # ========================================================================= #
+  CONTENT_TYPE_HTML = "Content-type: text/html#{CR}#{NL}#{CR}#{NL}"
+  # CONTENT_TYPE_HTML = "Content-type: text/html\n\n"
+
+  # ========================================================================= #
+  # === Cyberweb.content_type_html
+  # ========================================================================= #
+  def self.content_type_html
+    CONTENT_TYPE_HTML
+  end
+
+  # ========================================================================= #
+  # === CONTENT_TYPE_PLAIN
+  # ========================================================================= #
+  CONTENT_TYPE_PLAIN = "Content-type: text/plain#{CR}#{NL}#{CR}#{NL}"
+
+  # ========================================================================= #
+  # === RFC822_DAYS
+  #
+  # Abbreviated day-of-week names specified by RFC 822
+  # ========================================================================= #
+  RFC822_DAYS = %w(
+    Sun Mon Tue Wed Thu Fri Sat
+  )
+
+  # ========================================================================= #
+  # === RFC822_MONTHS
+  #
+  # Abbreviated month names specified by RFC 822
+  # ========================================================================= #
+  RFC822_MONTHS = %w(
+    Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
+  )
+
+  # ========================================================================= #
+  # === ARRAY_RANDOM_COLOUR
+  #
+  # For random colour macros, add to this array here.
+  # ========================================================================= #
+  ARRAY_RANDOM_COLOUR = %w(
+    RCOL RAND_COL RCOLOUR RANDOM_COLOUR RAND
+  )
+
+  # ========================================================================= #
+  # === ARRAY_INTERNAL_TAGS
+  #
+  # The ARRAY_INTERNAL_TAGS is used to denote extra tags which we use 
+  # internally. Just add the name of these tags without < or >.
+  #
+  # Eventually we might switch to class NewTags.
+  #
+  # <ud> means "underline" and equals to <span class="underline">.
+  # ========================================================================= #
+  ARRAY_INTERNAL_TAGS = %w(
+    ud
+  )
+
+  # ========================================================================= #
+  # === ARRAY_CSS_BORDER_STYLES
+  #
+  # Denote which CSS border-styles are known.
+  # ========================================================================= #
+  ARRAY_CSS_BORDER_STYLES = %w(
+    dashed
+    double
+    inset
+    groove
+    outset
+    ridge
+    solid
+  )
+
+  # ========================================================================= #
+  # === GERMAN_UMLAUTS
+  #
+  # German Umlauts will be registered here.
+  # ========================================================================= #
+  A_UMLAUT_LARGE = '&Auml;' # Ä
+  A_UMLAUT_SMALL = '&auml;' # ä
+  O_UMLAUT_LARGE = '&Ouml;' # Ö
+  O_UMLAUT_SMALL = '&ouml;' # ö
+  U_UMLAUT_LARGE = '&Uuml;' # Ü
+  U_UMLAUT_SMALL = '&uuml;' # ü
+
+  # ========================================================================= #
+  # === GERMAN_UMLAUTS
+  #
+  # Put the above Umlauts into an Array.
+  # ========================================================================= #
+  GERMAN_UMLAUTS = [
+    A_UMLAUT_LARGE,
+    A_UMLAUT_SMALL,
+    O_UMLAUT_LARGE,
+    O_UMLAUT_SMALL,
+    U_UMLAUT_LARGE,
+    U_UMLAUT_SMALL
+  ]
+
+  # ========================================================================= #
+  # === COPYRIGHT_SYMBOL
+  # ========================================================================= #
+  COPYRIGHT_SYMBOL = 'Copyright &#169;'
+
+  # ========================================================================= #
+  # === EURO_SYMBOL
+  #
+  # The "web-representation" for the EURO symbol
+  # ========================================================================= #
+  EURO_SYMBOL = '&euro;'
+    EURO = EURO_SYMBOL
+
+  # ========================================================================= #
+  # === ARRAY_REGISTERED_SITEMAPS
+  #
+  # The registered sitemap entries.
+  # ========================================================================= # 
+  ARRAY_REGISTERED_SITEMAPS = []
+
+  # ========================================================================= #
+  # === DEFAULT_FAVICON
+  #
+  # Default Favicon
+  # ========================================================================= #
+  DEFAULT_FAVICON = 'DEFAULT_FAVICON.png'
+
+  # ========================================================================= #
+  # === PI
+  #
+  # PI SYMBOL, für Kreisberechnungen.
+  # ========================================================================= #
+  PI = '&#960;'
+
+  # ========================================================================= #
+  # === HTML_MODE
+  #
+  # If HTML Mode == html5 then we simplify a few things in the generated 
+  # string. (We assume that html5 is less restrictive than html4).
+  # ========================================================================= #
+  HTML_MODE = :html5
+
+  # ========================================================================= #
+  # === HTTP_RESPONSE_HEADER
+  #
+  # The HTML response header. In August 2020 this was changed to the last
+  # variant; prior to that we sent HTTP/1.0 instead. The reason I changed
+  # this in 2020 was so that webrick works as well. In the long run this
+  # hack should be less of a hack, but for now it works and that's fine.
+  #
+  # See this listing:
+  #
+  #   https://en.wikipedia.org/wiki/List_of_HTTP_header_fields
+  #
+  # ========================================================================= #
+  HTTP_RESPONSE_HEADER =
+    # "HTTP/1.0 200 OK#{CR}#{NL}"
+    # "HTTP/1.0 200 OK\n"
+    "Content-Type: text/html\n"
+
+  # ========================================================================= #
+  # === Font Size
+  #
+  # If you desire to specify a default font-size to use for web-projects,
+  # please see the yaml directory, in particular the yaml configuration
+  # file of the Cyberweb project. You can set the font size there.
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === Cyberweb.file_amusement_park
+  # ========================================================================= #
+  def self.file_amusement_park
+    "#{Cyberweb.project_base_directory?}svg/standalone/amusement_park.svg"
+  end
+
+  # ========================================================================= #
+  # === RUBY_HEADER
+  #
+  # Here you can designate your main header to use for the autogenerated
+  # .cgi files.
+  # ========================================================================= #
+  RUBY_HEADER = '#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true'
+
+  # ========================================================================= #
+  # === PATH_SEPARATOR
+  #
+  # Path separators in different environments.
+  # ========================================================================= #
+  PATH_SEPARATOR = {
+    'UNIX'      => '/',
+    'WINDOWS'   => '\\',
+    'MACINTOSH' => ':'
+  }
+
+end

data/lib/cyberweb/controller/{webobject_controller.rb → controller.rb}

@@ -7,7 +7,7 @@
 #   class MainController < Cyberweb::Controller
 #
 # =========================================================================== #
-# require 'cyberweb/controller/webobject_controller.rb'
+# require 'cyberweb/controller/controller.rb'
 # =========================================================================== #
 require 'cyberweb/base/base.rb'