cyberweb 0.12.35

data/lib/cyberweb/webrick/webrick_wrapper.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::WebrickWrapper
+#
+# This is just a small wrapper over webrick, to allow us to quickly fire
+# up webrick.
+#
+# Usage example:
+#
+#   Cyberweb::WebrickWrapper.new(ARGV)
+#
+# =========================================================================== #
+# require 'cyberweb/webrick/webrick_wrapper.rb'
+# Cyberweb.start_webrick
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebrickWrapper < ::Cyberweb::Base # === Cyberweb::WebrickWrapper
+
+  require 'webrick'
+  require 'cyberweb/webrick/servlets/parameters_servlet.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @use_this_port
+    # ======================================================================= #
+    @use_this_port = 2000
+    # ======================================================================= #
+    # === @use_this_document_root
+    # ======================================================================= #
+    @use_this_document_root = return_pwd
+  end
+
+  # ========================================================================= #
+  # === increment_the_port_number
+  # ========================================================================= #
+  def increment_the_port_number(by_this_amount = 1)
+    @use_this_port += by_this_amount
+  end
+
+  # ========================================================================= #
+  # === try_to_start_the_webrick_server
+  # ========================================================================= #
+  def try_to_start_the_webrick_server
+    server = WEBrick::HTTPServer.new(
+      Port:          @use_this_port,
+      DocumentRoot:  @use_this_document_root,
+      FancyIndexing: true # This looks better.
+    )
+    # ======================================================================= #
+    # Add images/ subdirectory:
+    # ======================================================================= #
+    # server.mount('/images', ImagesServlet)
+    server.mount('/parameters', Cyberweb::ParametersServlet)
+    trap('INT') { server.shutdown }
+    Thread.new {
+      sleep 1
+      Open.in_browser("http://localhost:#{use_this_port}")
+    }
+    server.start
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    try_to_require_the_open_gem
+    begin
+      try_to_start_the_webrick_server
+    rescue Errno::EADDRINUSE => _error
+      puts 'Address is already in use. Trying with the next address.'
+      increment_the_port_number
+      try_to_start_the_webrick_server
+    end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::WebrickWrapper[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Cyberweb.start_webrick
+# =========================================================================== #
+def self.start_webrick(i = ARGV)
+  Cyberweb::WebrickWrapper.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::WebrickWrapper.new(ARGV)
+end # webrickwrapper

data/lib/cyberweb/yaml/autogenerated_system_settings.yml

@@ -0,0 +1,14 @@
+---
+COOKBOOK_DIRECTORY: "/home/x/programming/ruby/src/rbt/lib/rbt/yaml/"
+REAL_COOKBOOK_DIRECTORY: "/home/x/programming/ruby/src/rbt/lib/rbt/yaml/cookbooks/"
+RBT_DIR: "/home/x/programming/ruby/src/rbt/lib/rbt/"
+PKGCONFIG_DIR: "/usr/lib/pkgconfig/"
+AUDIO_DIR: "/home/x/programming/ruby/src/roebe/lib/lib/roebe/www/"
+SYSTEM_DIR: "/System/"
+SYSLIB_DIR: "/usr/lib/"
+DEPOT_DIR: "/Depot/"
+SYSBIN_DIR: "/usr/bin/"
+TEMP_DIR: "/home/Temp/"
+SYSSHARE_DIR: "/System/Shared/"
+SYSLOGS: "/System/Logs/"
+PACKAGES_DIR: "/"

data/lib/cyberweb/yaml/custom_tags.yml

@@ -0,0 +1,9 @@
+# =========================================================================== #
+# === custom_tags.yml
+#
+# Here we will gather which html tags are custom defined and thus not
+# "official".
+# =========================================================================== #
+- ud # ud stands for underline
+
+- b_italic: <b class="italic"> # Shortcut for combining bold and italic.

data/lib/cyberweb/yaml/debug.yml

@@ -0,0 +1 @@
+--- false

data/lib/cyberweb/yaml/default_resolution.md

@@ -0,0 +1,2 @@
+width:  2560 # in px
+height: 1080 # in px

data/lib/cyberweb/yaml/html5_global_attributes.yml

@@ -0,0 +1,16 @@
+# =========================================================================== #
+# === html5_global_attributes.yml
+#
+# http://www.w3schools.com/html5/html5_ref_globalattributes.asp
+# =========================================================================== #
+# Attribute:
+# 
+#  Value: Description
+#
+# =========================================================================== #
+
+accesskey:
+ character: Specifies a shortcut key to access an element
+
+class:
+ classname: Refers to a class specified in a style sheet

data/lib/cyberweb/yaml/html5_new_elements.yml

@@ -0,0 +1,108 @@
+---
+# =========================================================================== #
+# Which HTML5 Tags are new? This file answers that question.
+#
+# Please sort alphabetically when adding to it.
+#
+# x = YAML.load_file('html5_new_elements.yml')
+# =========================================================================== #
+
+article: |
+ For external content, like text from a news-article, blog, forum, 
+ or any other content from an external source
+
+aside: |
+ For content aside from the content it is placed in. The aside 
+ content should be related to the surrounding content
+
+audio: |
+ For multimedia content, sounds, music or other audio streams
+
+command: |
+ A button, or a radiobutton, or a checkbox.
+
+details: |
+ For describing details about a document, or parts of a document.
+
+embed: |
+ For embedded content, such as a plug-in.
+
+ Differences Between HTML 4.01 and HTML5.
+
+figure: |
+ For grouping a section of stand-alone content, could be a video.
+
+figcaption: |
+ The caption of the figure section.
+
+footer: |
+ For a footer of a document or section, could include the name 
+ of the author, the date of the document, contact information, 
+ or copyright information.
+
+header: |
+ For an introduction of a document or section, could 
+ include navigation.
+
+hgroup: |
+ For a section of headings, using h1 to h6, where the largest is 
+ the main heading of the section, and the others are sub-headings.
+
+mark: |
+ For text that should be highlighted.
+
+meter: |
+ For a measurement, used only if the maximum and minimum values
+ are known.
+
+nav: |
+ For a section of navigation.
+
+progress: |
+ The state of a work in progress.
+
+ruby: |
+ For ruby annotation (Chinese notes or characters)
+
+rt: |
+ For explanation of the ruby annotation.
+
+rp: |
+ What to show browsers that do not support the ruby element
+
+section: |
+ For a section in a document. Such as chapters, headers, footers, 
+ or any other sections of the document.
+
+source: |
+ For media resources for media elements, defined inside video or
+ audio elements.
+
+summary: |
+ A caption, or summary, inside the details element.
+ 
+time: |
+ For defining a time or a date, or both
+
+wbr: |
+ Word break. For defining a line-break opportunity.
+
+video: |
+ For video content, such as a movie clip or other video streams
+
+# =========================================================================== #
+# New Form Elements:
+#
+# HTML5 offers new form elements, for more functionality.
+# =========================================================================== #
+datalist: |
+ Specifies a list of pre-defined options for input controls.
+
+keygen: |
+ Defines a key-pair generator field (for forms)
+
+# =========================================================================== #
+# https://www.w3schools.com/TAGs/tag_output.asp
+# =========================================================================== #
+output: |
+ Defines the result of a calculation.

data/lib/cyberweb/yaml/html_tag_legend.yml

@@ -0,0 +1,14 @@
+# ====================================================================== #
+# === html_tag_legend.yml
+#
+# The <legend> tag supports the following standard attributes:
+# ====================================================================== #
+
+- accesskey  # character        # Specifies a keyboard shortcut to access an element
+- class      # classname        # Specifies a classname for an element
+- dir        # rtl, ltr         # Specifies the text direction for the content in an element
+- id         # id               # Specifies a unique id for an element
+- lang       # language_code    # Specifies a language code for the content in an element
+- style      # style_definition # Specifies an inline style for an element
+- title      # text             # Specifies extra information about an element
+- xml:lang   # language_code    # Specifies a language code for the content in an element, in XHTML documents

data/lib/cyberweb/yaml/http_status_codes.yml

@@ -0,0 +1,44 @@
+# =========================================================================== #
+# x = YAML.load_file('http_status_codes.yml')
+# =========================================================================== #
+
+100: Continue
+101: Switching Protocols
+200: OK
+201: Created
+202: Accepted
+203: Non-Authoritative Information
+204: No Content
+205: Reset Content
+206: Partial Content
+207: Multi-Status # WebDAV; RFC 4918
+300: Multiple Choices
+301: Moved Permanently
+302: Moved Temporarily
+303: See Other
+304: Not Modified
+305: Use Proxy
+306: Switch Proxy # No longer used.
+307: Temporary Redirect # since HTTP/1.1
+400: Bad Request
+401: Unauthorized
+402: Payment Required
+403: Forbidden
+404: Not Found
+405: Method Not Allowed
+406: Not Acceptable
+407: Proxy Authentication Required
+408: Request Time-out
+409: Conflict
+410: Gone
+411: Length Required
+412: Precondition Failed
+413: Request Entity Too Large
+414: Request-URI Too Large
+415: Unsupported Media Type
+500: Internal Server Error
+501: Not Implemented
+502: Bad Gateway
+503: Service Unavailable
+504: Gateway Time-out
+505: HTTP Version not supported

data/lib/cyberweb/yaml/js_files_to_load.yml

@@ -0,0 +1,44 @@
+# =========================================================================== #
+# === js_files_to_load.yml
+#
+# All javascript files that should be loaded by default, ought to be
+# defined here in this file. Append more towards the end of this
+# file.
+# =========================================================================== #
+# pp x = YAML.load_file('js_files_to_load.yml')
+# =========================================================================== #
+
+# - timer.js
+# - simple_drag.js
+
+# =========================================================================== #
+# Now the libraries for the popup boxes:
+# =========================================================================== #
+# - wz_tooltip.js
+# - tip_centerwindow.js
+# - tip_followscroll.js
+# - http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
+# - http://js.nicedit.com/nicEdit-latest.js
+
+# =========================================================================== #
+# Disabled the following variants:
+#
+#    - select_all.js
+#    - my_jsgraphics
+#
+# =========================================================================== #
+
+# =========================================================================== #
+# === Begin here
+# =========================================================================== #
+- custom_functions.js
+- sleep.js
+# =========================================================================== #
+# The following two files were added to the cyberweb project as of
+# 18.10.2022; or, rather, all files past this point were added
+# past the mentioned date.
+# =========================================================================== #
+- copy_to_the_clipboard.js
+- math.js
+- simple_calculator.js
+- html_colours.js

data/lib/cyberweb/yaml/load_these_CSS_files_by_default.yml

@@ -0,0 +1,39 @@
+# =========================================================================== #
+# === load_these_yaml_files_by_default.yml
+#
+# This file can be used to specify which .css files should be included
+# by default. That way the user can change this at any moment in time
+# for his or her local installation of the cyberweb gem.
+#
+# class Cyberweb::HtmlTemplate specifically makes use of this .yml file
+# here.
+# =========================================================================== #
+
+- admonition.css
+- border.css
+# - css_reset.css
+- code.css
+- colours.css
+- cursors.css
+- default.css
+- display.css
+- div.css
+- drop_shadow.css
+- error_404_css_class.css
+- fonts.css
+- gradient_effects.css
+- glow_effects.css
+- hover.css
+- links.css
+- margin.css
+- message_boxes.css
+- menu.css
+- misc.css
+- padding.css
+- popup.css
+- ruby_regexes.css
+- shapes.css
+- template2.css
+- text_shadow.css
+- tooltip.css
+- width.css

data/lib/cyberweb/yaml/project_configuration/project_configuration.yml

@@ -0,0 +1,269 @@
+# =========================================================================== #
+# === project_configuration.yml
+# =========================================================================== #
+
+# =========================================================================== #
+# This file stores popular configuration options for the Cyberweb project.
+# =========================================================================== #
+# x = YAML.load_file(Cyberweb.file_web_object_configuration)
+# =========================================================================== #
+
+# =========================================================================== #
+# === base_directory
+#
+# If this option exists, then we will use it for our base directory.
+#
+# The base directory is the one from where content is served.
+#
+# You may want to change this setting to adapt to your own webserver,
+# if you use a local webserver that is. For my system setup at home
+# this is where all content will be served from.
+# =========================================================================== #
+base_directory: /home/x/
+
+# =========================================================================== #
+# === default_font_size
+#
+# Global font size to use for the project. Can be overruled on a
+# per-cgi setting.
+# =========================================================================== #
+default_font_size: 1.20 em # Or 1.00em.
+
+# =========================================================================== #
+# === default_larger_font_size
+# =========================================================================== #
+default_larger_font_size: 1.40 em
+
+# =========================================================================== #
+# === default_smaller_font_size
+#
+# This font size here should be smaller than the font size defined above.
+# =========================================================================== #
+default_smaller_font_size: 1.00 em
+
+# =========================================================================== #
+# === compress_main_string
+#
+# If this option is set to true then the cyberweb project will remove
+# all newlines from the string that is to be served.
+# =========================================================================== #
+compress_main_string: false
+
+# =========================================================================== #
+# === warnings
+#
+# If this option is set to verbose, then the cyberweb-framework will
+# provide verbose warnings whenever possible.
+# =========================================================================== #
+warnings: verbose
+
+# =========================================================================== #
+# === try_to_use_per_project_settings
+#
+# If this setting is set to true then we will search for a file called
+# base_dir.yml, in the subdirectory YAML/ or yaml/ and we will then
+# use this for the base directory.
+# =========================================================================== #
+try_to_use_per_project_settings: true
+
+# =========================================================================== #
+# === set_title_automatically
+#
+# If `set_title_automatically` is set to true then you can omit any
+# call to .title() - we will simply set the title automatically.
+#
+# This is equivalent to the following line of code:
+#
+#   web_object.title('SELF_NO_EXT')
+#
+# which means that we will set the title, without the extension
+# name. If you dislike this behaviour, setting it to false here
+# will disable it.
+#
+# I personally found myself in need for it because I usually was
+# doing SELF_NO_EXT anyway for the most part.
+#
+# Note that if you invoke .title() manually, then this will have
+# precedence over this option here, thus allowing you to
+# override the setting on a per-page setting.
+# =========================================================================== #
+set_title_automatically: true
+
+# =========================================================================== #
+# === may_show_source
+#
+# If this option is set to true, then we can make use of ?show_source
+# to a .cgi page, in order to display its source code.
+#
+# By default you may be inclined to want to keep this setting set to false
+# if you don't want to globally enable the possibility that every visitor
+# can read the source code.
+#
+# The code that will display this, is part of web_object.rb.
+# =========================================================================== #
+may_show_source: true
+
+# =========================================================================== #
+# === use_webimages
+#
+# If true (which is the default) then we will use the webimages project,
+# which consists of mostly small, cute icons.
+#
+# If set to false then we will not use the webimages at all.
+# =========================================================================== #
+use_webimages: true
+
+# =========================================================================== #
+# === use_in_dir_images
+#
+# If this configuration option is true, then we will use in-directory
+# images. Otherwise, we will use the base-directory of the project
+# and the name of the image directory towards it.
+# =========================================================================== #
+use_in_dir_images: false
+
+# =========================================================================== #
+# === use_dragula
+#
+# If this configuration option is set to true then we will use dragula
+# for advanced drag and drop support.
+#
+# The latest version for dragula can be found here:
+#
+#   https://raw.githubusercontent.com/bevacqua/dragula/master/dragula.js
+#
+# On November 2021 this was disabled. We may re-enable it again at a later
+# point, but for now it has to remain disabled.
+# =========================================================================== #
+use_dragula: false # true
+
+# =========================================================================== #
+# === use_dragula_for_these_tags
+#
+# The following should be an Array.
+#
+# We specify which HTML tags to drag-and-drop via dragula.
+#
+# This will only be honoured if the entry use_dragula has been
+# set to true.
+# =========================================================================== #
+use_dragula_for_these_tags:
+ - ul
+
+# =========================================================================== #
+# === print_cgi_exceptions
+#
+# If true then we will print out the CGI exceptions. That means that
+# whenever a big error happens, we will display said error on the
+# main page - similar to how .php files are being run.
+# =========================================================================== #
+print_cgi_exceptions: false
+
+# =========================================================================== #
+# === cgi_defaults_to
+#
+# This can either be :system_ruby or :web_object.
+#
+# Cyberweb includes a fork of ruby-cgi, but that fork is a bit buggy,
+# which is why I decided in 2018 to use system ruby's cgi by default
+# instead. At some later time this may change but for now, we will
+# use ruby's default cgi handler.
+# =========================================================================== #
+cgi_defaults_to: :system_ruby
+
+# =========================================================================== #
+# === is_on_roebe
+#
+# This entry point can be used to override any ENV variable.
+# =========================================================================== #
+is_on_roebe: true
+
+# =========================================================================== #
+# === view_file
+#
+# This allows you to view the content of a file. Only enable it if you
+# really want or need this functionality.
+# =========================================================================== #
+view_file: true
+
+# =========================================================================== #
+# === jquery_version
+#
+# Which variant of jquery to use. Has to be manually synced for now.
+#
+# Is also available via the following constant:
+#
+#   Cyberweb::JQUERY_VERSION
+#
+# =========================================================================== #
+jquery_version: 3.7.0
+
+# =========================================================================== #
+# === enable_jquery_for_every_page
+#
+# If this setting is true then we will enable jquery for every page,
+# without having to do so with a specific line.
+# =========================================================================== #
+enable_jquery_for_every_page: false
+
+# =========================================================================== #
+# === use_jquery
+#
+# Shall we use jquery? If yes then we try to load the respective files
+# as well.
+# =========================================================================== #
+use_jquery: true
+
+# =========================================================================== #
+# === jquery_ui_version
+#
+# This will specify which jquery-ui version is in use. Has to
+# be manually synced for now.
+# =========================================================================== #
+jquery_ui_version: 1.12.1
+
+# =========================================================================== #
+# === use_prawn
+#
+# Try to use prawn if prawn is available.
+# =========================================================================== #
+use_prawn: true
+
+# =========================================================================== #
+# === log_dir
+#
+# Since as of July 2023 the user can specify the log-directory here.
+#
+# Note that the value shown below is for my home setup - other users
+# are encouraged to modify this to their own preferences/use cases.
+# =========================================================================== #
+log_dir: /home/x/Temp/cyberweb/
+
+# =========================================================================== #
+# === use_this_relative_directory_for_custom_images
+#
+# In May 2023 this setting was added; the two older settings called
+# "default_image_directory" and "name_of_the_images_directory"
+# were deprecated as a consequence of adding this new entry.
+#
+# Note that this setting will NOT be sanitized, so you have to use a
+# trailing / here. The old code before that sanitized it, but it also
+# was calling a custom method to ensure that, and I felt it would be
+# better to require the user to set this one, important setting on
+# his or her own, specifically.
+#
+# Note that the full relative path would combine these two variants:
+#
+#   base_directory + use_this_relative_directory_for_custom_images
+#
+# In other words, on my home system, this will effectively become:
+#
+#   /home/x/data/images/
+#
+# because base_directory is "/home/x/" and 
+# use_this_relative_directory_for_custom_images is "data/images/".
+#
+# Which indeed is exactly the directory I use to store all my
+# custom images, as the base directory.
+# =========================================================================== #
+use_this_relative_directory_for_custom_images: data/images/