cyberweb 0.4.174

data/lib/cyberweb/constants/nl.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/constants/nl.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === 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
+
+end

data/lib/cyberweb/constants/project_constants.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# This file depends on the constant PROJECT_BASE_DIRECTORY, so we have
+# to add a dependency onto that file.
+#
+# This file will have references to subdirectories of the
+# cyberweb-project.
+# =========================================================================== #
+# require 'cyberweb/constants/project_constants.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/project/project.rb'
+
+  # ========================================================================= #
+  # === 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/"
+
+end

data/lib/cyberweb/constants/roebe.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file stores code that is only useful on my home system.
+# =========================================================================== #
+# require 'cyberweb/constants/roebe.rb'
+# =========================================================================== #
+module Cyberweb
+
+  # ========================================================================= #
+  # === USER_X
+  # ========================================================================= #
+  USER_X = '/home/x/'
+
+  # ========================================================================= #
+  # === HOME_X_DATA
+  # ========================================================================= #
+  HOME_X_DATA = "#{USER_X}data/"
+
+  # ========================================================================= #
+  # === Cyberweb.roebe_image_dir?
+  # ========================================================================= #
+  def self.roebe_image_dir?
+    "#{HOME_X_DATA}images/"
+  end
+
+end

data/lib/cyberweb/constants/standalone_constants.rb

@@ -0,0 +1,309 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The file here is only allowed to make use of standalone constants
+# that do not depend on any other file. Composite constants that are
+# defined within the file, are also allowed if they are only confined
+# to the file here.
+#
+# Method-definitions in this file are allowed if they refer to constants
+# in this file alone - not to other constants.
+# =========================================================================== #
+# require 'cyberweb/constants/standalone_constants.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/constants/array_images.rb'
+  require 'cyberweb/constants/array_predefined_constants.rb'
+  require 'cyberweb/constants/nl.rb'
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === my_ip?
+  # ========================================================================= #
+  def my_ip?
+    e "The IP is: <b>#{YOUR_IP}</b>"
+  end
+
+  # ========================================================================= #
+  # === is_localhost?
+  # ========================================================================= #
+  def is_localhost?
+    return ('127.0.0.1' == YOUR_IP)
+  end
+
+  # ========================================================================= #
+  # === 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"
+
+  # ========================================================================= #
+  # === 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
+  )
+
+  # ========================================================================= #
+  # === 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/code.css
+    cascading_style_sheets/template2.css
+    cascading_style_sheets/text_shadow.css
+    cascading_style_sheets/border.css
+    cascading_style_sheets/colours.css
+    cascading_style_sheets/misc.css
+  )
+
+  # ========================================================================= #
+  # === 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.
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === 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/README.md

@@ -0,0 +1,4 @@
+This directory is my first attempt to add routing-support as a
+first-class citizen to the web_object project. It is presently
+unfinished - no idea if and when this may be finished or
+more usable.

data/lib/cyberweb/controller/webobject_controller.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# How to subclass from this class:
+#
+#   class MainController < Cyberweb::Controller
+#
+# =========================================================================== #
+# require 'cyberweb/controller/webobject_controller.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class Controller < Base
+
+  # ========================================================================= #
+  # === @route_to_use
+  # ========================================================================= #
+  @route_to_use = '/'
+
+  # ========================================================================= #
+  # === Controller.map
+  # ========================================================================= #
+  def self.map(i)
+    @route_to_use = i
+  end
+  
+  # map '/'
+
+  # ========================================================================= #
+  # === index
+  # ========================================================================= #
+  def index(i = 'Hello, World!')
+    i
+  end
+
+end
+
+# =========================================================================== #
+# === Cyberweb.start
+#
+# Start a new controller.
+# =========================================================================== #
+def self.start
+  ::Cyberweb::Controller.new
+end
+
+end

data/lib/cyberweb/csv/README.md

@@ -0,0 +1,2 @@
+This directoy collects .csv related methods. This will allow us 
+to display .csv data on a webpage.

data/lib/cyberweb/csv/csv.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/csv/csv.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'csv'
+  require 'cyberweb/html_tags/table.rb'
+
+  # ========================================================================= #
+  # === DEFAULT_CSV_FILE
+  # ========================================================================= #
+  DEFAULT_CSV_FILE =
+    '/home/x/STUDIUM/BOKU_WIEN/INDIVIDUELLES_STUDIUM/'\
+    'Alle_Lehrveranstaltungen_tabulator_08.04.2016.csv'
+
+  # ========================================================================= #
+  # === Cyberweb.csv_to_table
+  #
+  # This method will convert a csv file to a HTML table data structure.
+  #
+  # Usage example:
+  #
+  #    Cyberweb.csv_to_table
+  #
+  # ========================================================================= #
+  def self.csv_to_table(
+      this_file          = DEFAULT_CSV_FILE,
+      optional_css_class = nil
+    )
+    case this_file
+    when :default_file
+      this_file = DEFAULT_CSV_FILE
+    end
+    dataset = CSV.read(
+      this_file, { col_sep: '|', encoding: ISO_ENCODING }
+    ).reject {|entry|
+      entry = entry.join if entry.is_a? Array
+      entry.to_s.empty?
+    }
+    dataset.shift
+    if dataset.is_a? Array
+      dataset.map! {|entry|
+        entry = entry.join(' | ').strip.squeeze(' ') if entry.is_a? Array # Yes, it should be an Array.
+        entry
+      }
+    end
+    # ======================================================================= #
+    # === Check for given CSS classes, via Table-specific methods
+    # ======================================================================= #
+    Table.set_css_class(optional_css_class) if optional_css_class
+    ::Cyberweb.parse_table(dataset)
+    Table.clear if optional_css_class
+  end
+
+end

data/lib/cyberweb/cybersprawl

@@ -0,0 +1 @@
+webmin

data/lib/cyberweb/debug/debug.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/debug/debug.rb'
+# =========================================================================== #
+module Cyberweb
+
+  require 'cyberweb/configuration/load_the_configuration_file.rb'
+
+  # ========================================================================= #
+  # === DEBUG
+  #
+  # Map the debug.yml file onto this constant, if it exists.
+  #
+  # You can access this via:
+  #
+  #   Cyberweb::DEBUG
+  #
+  # ========================================================================= #
+  path_to_the_debug_file = "#{config_directory?}debug.yml"
+  if File.exist? path_to_the_debug_file
+    DEBUG = YAML.load_file(path_to_the_debug_file)
+  else # else we will not debug by default.
+    DEBUG = false
+  end
+  
+  # ========================================================================= #
+  # === @debug
+  #
+  # Prefer this variable over the above variant with the constant.
+  # ========================================================================= #
+  @debug = ::Cyberweb::DEBUG
+
+  # ========================================================================= #
+  # === Cyberweb.set_debug
+  #
+  # Setter method towards the toplevel instance variable @debug.
+  # ========================================================================= #
+  def self.set_debug(
+      i = true
+    )
+    @debug = i
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.enable_debug  
+  # ========================================================================= #
+  def self.enable_debug
+    ::Cyberweb.set_debug true
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.disable_debug
+  # ========================================================================= #
+  def self.disable_debug
+    ::Cyberweb.set_debug false
+  end
+
+  # ========================================================================= #
+  # === Cyberweb.debug?
+  #
+  # Use this method to query the value of the toplevel @debug variable.
+  # ========================================================================= #
+  def self.debug?
+    @debug # This used to be Cyberweb::DEBUG.
+  end
+
+end