cyberweb 0.4.174

data/lib/cyberweb/web_object/params.rb

@@ -0,0 +1,289 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/params.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  require 'cyberweb/toplevel_methods/params.rb'
+
+  # ========================================================================= #
+  # === obtain_the_parameters_passed
+  #
+  # This query-method will return which params have been passed into,
+  # for example, a .cgi page.parameters_as_string?
+  #
+  # Typical invocation may go like this:
+  #
+  #   w.obtain_the_parameters_passed
+  #
+  # ========================================================================= #
+  def obtain_the_parameters_passed
+    ::Cyberweb.params? # This is part of params.rb actually.
+  end; alias return_params_hash obtain_the_parameters_passed # === return_params_hash
+       alias web_params?        obtain_the_parameters_passed # === web_params?
+       alias web_params         obtain_the_parameters_passed # === web_params
+       alias params?            obtain_the_parameters_passed # === params?
+       alias params             obtain_the_parameters_passed # === params
+       alias params_as_string?  obtain_the_parameters_passed # === params_as_string?
+       # ^^^ Not yet sure if we can use this alias. I think we actually
+       #     can. I will add support for Sinatra via a module instead.
+
+  # ========================================================================= #
+  # === get_param_called
+  #   
+  # Use this method to obtain a specific parameter. The argument given
+  # should be the name of the formular in question.
+  # ========================================================================= #
+  def get_param_called(i)
+    i = i.to_s # Just in case.
+    _ = obtain_the_parameters_passed # Tap into the params() method.
+    if _.has_key? i # Should be a Hash.
+      i = _[i]
+      i = i.first if i.is_a? Array
+    end
+    return i # Return it.
+  end; alias get_param get_param_called # === get_param
+
+  # ========================================================================= #
+  # === query_string?
+  #
+  # This method will return the query-string that was passed via the URL.
+  # This refers to the part after the '?'.
+  # ========================================================================= #
+  def query_string?(i = cgi?)
+    i.query_string
+  end; alias env?                  query_string? # === env?
+       alias parameters_as_string? query_string? # === parameters_as_string?
+
+  # ========================================================================= #
+  # === show_known_params
+  #
+  # This method outputs the given params, which may be helpful when
+  # you want to debug.
+  # ========================================================================= #
+  def show_known_params(
+      use_this_css = 'red larger marl5em'
+    )
+    div {
+      h2 'These Parameters are known:'
+      cyberweb_params?
+    }
+  end
+
+  # ========================================================================= #
+  # === check_on_params                               (params tag, param tag)
+  #
+  # We check on the parameter issued here, and enable/disable certain
+  # functionality based on that.
+  #
+  # You can try these when you append a ? to the URL, such as:
+  #
+  #   ?disable_webimages
+  #   ?time
+  #   ?view_source
+  #
+  # ========================================================================= #
+  def check_on_params
+    _ = return_params_hash # Remember that this is a Hash.
+    unless _.empty?
+      # ===================================================================== #
+      # Grab the keys in String-form next.
+      # ===================================================================== #
+      keys = _.keys.join(' ').strip
+      # ===================================================================== #
+      # First, use a simpler case-menu to check for real keys.
+      # ===================================================================== #
+      case keys # case tag
+      # ===================================================================== #
+      # === time?
+      #
+      #   http://localhost/data/personal/fotos/fotos.cgi?time?
+      #
+      # ===================================================================== #
+      when /^time\??/i
+        result = Cyberweb::HtmlTemplate[
+          title: 'Show the current time',
+          body:  '<div class="BG_Black White" style="padding: 0.25em">Time: '+
+                 Time.now.strftime('%d.%m.%Y')+
+                 ' '+
+                 Time.now.strftime('%H:%M:%S')+
+                 '</div>'
+        ].to_s
+        print result
+        exit
+      # ===================================================================== #
+      # === jquery?
+      #
+      # Specific examples for this flag:
+      #
+      #   http://localhost/data/personal/fotos/fotos.cgi?jquery?
+      #   http://localhost/data/personal/fotos/fotos.cgi?jquery
+      #
+      # ===================================================================== #
+      when /^jquery\??$/i
+        e 'Is jquery used? '+
+           use_jquery?.to_s
+      # ===================================================================== #
+      # === config?
+      #
+      # Specific example for this flag:
+      #
+      #   http://localhost/data/personal/fotos/fotos.cgi?config?
+      #
+      # ===================================================================== #
+      when /^config\?/i,
+           /^quit/i
+        pp @config
+        exit
+      # ===================================================================== #
+      # === view_source
+      #
+      # Specific example for this:
+      #
+      #   http://localhost/data/video/play_this_video_file.cgi?source
+      #
+      # ===================================================================== #
+      when /^view(_|-)?source$/i,
+           /^source$/
+        do_show_source
+      # ===================================================================== #
+      # === debug
+      # ===================================================================== #
+      when 'debug' # ?debug
+        ::Cyberweb.enable_debug
+      # ===================================================================== #
+      # === view_file=ruby_todo
+      #
+      # This entry point can be used to view a file specifically,
+      # globally.
+      #
+      # Usage example:
+      #
+      #   http://localhost/data/misc/sitemap.cgi?view_file=ruby_todo
+      #
+      # ===================================================================== #
+      when /^view(_|-)?file/i
+        if view_file?
+          # ================================================================== #
+          # In this case the Hash may look like this:
+          #
+          #   {"view_file"=>["beautiful_url"]}
+          #
+          # ================================================================== #
+          result = _['view_file']
+          result = result.first if result.is_a? Array
+          result = ::Cyberweb.sanitize_url(result)
+          if result.start_with? 'http://localhost/'
+            result = result.dup if result.frozen?
+            result.sub!(/^http:\/\/localhost\//, USER_X)
+          end
+          read_and_display(result)
+        else
+          clear_the_main_string
+          print 'Viewing a file has been disabled in the configuration setting.'
+          serve
+          exit
+        end
+      # ===================================================================== #
+      # === redirect_to=ruby_todo
+      #
+      # This entry point can be used to redirect to another page.
+      #
+      # Usage example:
+      #
+      #   http://localhost/data/misc/sitemap.cgi?redirect_to=ruby_todo
+      #
+      # ===================================================================== #
+      when /^redirect(_|-)?to/i
+        # ==================================================================== #
+        # In this case the Hash may look like this:
+        #
+        #   {"redirect_to"=>["ruby_todo"]}
+        #
+        # ==================================================================== #
+        result = _['redirect_to']
+        result = result.first if result.is_a? Array
+        result = ::Cyberweb.sanitize_url(result)
+        redirect_to(result)
+      # ===================================================================== #
+      # === hello_world
+      # ===================================================================== #
+      when 'hello_world'
+        h2 'Hello World!'
+      else
+        # ===================================================================== #
+        # === use_jquery
+        #
+        # Ok, next use a somewhat more flexible if/else/elsif conditional.
+        #
+        # First, enable the use of jquery, if the user supplied use_jquery.
+        # ===================================================================== #
+        if keys.include? 'use_jquery' # This should be enough.
+          use_jquery
+        # ===================================================================== #
+        # === time
+        # ===================================================================== #
+        elsif keys.include? 'time'
+          result = Cyberweb::HtmlTemplate[
+          title: 'Show the current time',
+          body:  '<div class="BG_Black White" style="padding: 0.25em">Time: '+
+                 Time.now.strftime('%H:%M:%S')+
+                 '-'+
+                 Time.now.strftime('%d.%m.%Y')+
+                 '</div>'
+          ].to_s
+          print result
+          exit
+        # ===================================================================== #
+        # === ?show_source
+        # ===================================================================== #
+        elsif keys.include? 'show_source' or keys.include? 'source'
+          do_show_source # This allows us to display the source of a given file.
+        # ===================================================================== #
+        # === ?pdf
+        # ===================================================================== #
+        elsif keys.include? 'pdf'
+          if use_prawn?
+            try_to_generate_pdf_file # Bundled into this method here.
+          else
+            e 'You normally do not seem to want to use prawn.'
+            e 'Shall we override this? Not yet sure. (Stub).'
+          end
+        # ===================================================================== #
+        # === disable_webimages
+        # ===================================================================== #
+        elsif keys.include? 'disable_webimages'
+          disable_webimages
+        # ===================================================================== #
+        # === environment
+        # ===================================================================== #
+        elsif keys.include? 'environment'
+          display_environmental_variables
+        # ===================================================================== #
+        # === sys_information
+        # ===================================================================== #
+        elsif keys =~ /sys_information/ or keys =~ /sys/ or keys =~ /status/
+          display_system_information
+        else
+          # ================================================================= #
+          # Next, things did fail. If we are in debug mode, we
+          # show more information.
+          # ================================================================= #
+          if debug? # Ok, we may want to show more debug information.
+            e 'Showing more debug-information next (since '\
+              'Cyberweb.debug was set to true):'
+            pp params?
+            exit
+          end
+        end
+      end
+    end
+  end
+
+end; end

data/lib/cyberweb/web_object/reset.rb

@@ -0,0 +1,192 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/reset.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @internal_hash
+    #
+    # This Hash will keep a lot of internal data, which is primarily used
+    # to describe the state a given web_object.
+    #
+    # It should come first, even before the main String stored in :result.
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :listing_counter
+    #
+    # Keep track of the listing counter. This will have an initial value
+    # of 0.
+    # ======================================================================= #
+    reset_the_listing_counter
+    # ======================================================================= #
+    # === :result
+    #
+    # This is the main String of this class. All the HTML code, CSS stuff
+    # and so forth will be stored into this String.
+    # ======================================================================= #
+    @internal_hash[:result] = ''.dup
+    # ======================================================================= #
+    # === :already_served
+    #
+    # This variable keeps track whether we already served the webpage.
+    # ======================================================================= #
+    @internal_hash[:already_served] = false
+    # ======================================================================= #
+    # === :string_lateron
+    # ======================================================================= #
+    @internal_hash[:string_lateron] = ''.dup # ← Unsure if we still need this.
+    # ======================================================================= #
+    # === :show_source
+    #
+    # If true then we will show the source of a page.
+    # ======================================================================= #
+    @internal_hash[:show_source] = false
+    # ======================================================================= #
+    # === :is_a_sinatra_application
+    #
+    # If this is true then we are running a sinatra application; the custom
+    # extension that I use in this case is .sinatra.
+    # ======================================================================= #
+    @internal_hash[:is_a_sinatra_application] = false
+    # ======================================================================= #
+    # === :debug
+    # ======================================================================= #
+    @internal_hash[:debug] = ::Cyberweb.debug? # ← Must come before load_yaml_configuration().
+    # ======================================================================= #
+    # === :javascript
+    #
+    # This string will be appended onto the javascript string.
+    # ======================================================================= #
+    @internal_hash[:javascript] = ''.dup
+    # ======================================================================= #
+    # === :use_body_tag
+    #
+    # If this variable is false then we won't use the <body> tag.
+    #
+    # This is needed when we want to use framesets specifically.
+    # ======================================================================= #
+    @internal_hash[:use_body_tag] = true
+    # ======================================================================= #
+    # === :mail
+    #
+    # This variable keeps track as to whether we wish to use email or
+    # not.
+    # ======================================================================= #
+    @internal_hash[:mail] = nil
+    # ======================================================================= #
+    # === :register_the_constants
+    # ======================================================================= #
+    @internal_hash[:register_the_constants] = true
+    # ======================================================================= #
+    # === :use_unicode
+    # ======================================================================= #
+    @internal_hash[:use_unicode] = false
+    # ======================================================================= #
+    # === :language
+    #
+    # This variable keeps track as to which language a website is
+    # mostly written in. It defaults to english.
+    # ======================================================================= #
+    @internal_hash[:language] = :english
+    # ======================================================================= #
+    # === :frame_string
+    # ======================================================================= #
+    @internal_hash[:frame_string] = '' # The frame string.
+    # ======================================================================= #
+    # === :body_javascript
+    # ======================================================================= #
+    @internal_hash[:body_javascript] = ''.dup
+    # ======================================================================= #
+    # === :do_not_display_empty_files
+    # ======================================================================= #
+    @internal_hash[:do_not_display_empty_files] = false
+    # ======================================================================= #
+    # === :n_total_lines
+    #
+    # Keep track how many lines we generated in total.
+    # ======================================================================= #
+    @internal_hash[:n_total_lines]   = 0
+    # ======================================================================= #
+    # === :register_ids
+    # ======================================================================= #
+    @internal_hash[:register_ids] = []
+    # ======================================================================= #
+    # == :body_css_class
+    # ======================================================================= #
+    @internal_hash[:body_css_class] = nil
+    # ======================================================================= #
+    # === :body_css_style
+    # ======================================================================= #
+    @internal_hash[:body_css_style] = ''.dup
+    # ======================================================================= #
+    # === :database
+    #
+    # If we may wish to use a database. This must initially be nil,
+    # to designate that we have no interest in using a database.
+    # ======================================================================= #
+    @internal_hash[:database] = nil
+    # ======================================================================= #
+    # === :remove_newlines
+    #
+    # By default, we will keep newlines in the main String, so this
+    # variable defaults to false.
+    # ======================================================================= #
+    @internal_hash[:remove_newlines] = false
+    # ======================================================================= #
+    # === :enable_title_for_reading_files
+    #
+    # Empty Array by default.
+    # ======================================================================= #
+    @internal_hash[:enable_title_for_reading_files] = []
+    # ======================================================================= #
+    # === :encoding_to_use
+    # ======================================================================= #
+    @internal_hash[:encoding_to_use] = :default
+    # ======================================================================= #
+    # === :body_id
+    #
+    # Populate it as an empty String.
+    # ======================================================================= #
+    @internal_hash[:body_id] = ''.dup
+    # ======================================================================= #
+    # Now we have finished the initial loadup. We can continue to describe
+    # our web object. We do this by calling the proper base directory.
+    # ======================================================================= #
+    set_proper_base_directory # Initial setup.
+    # ======================================================================= #
+    # === The configuration dataset
+    #
+    # Load up the main configuration next.
+    # ======================================================================= #
+    load_yaml_configuration
+    # ======================================================================= #
+    # Some entries must come after the configuration has been loaded.
+    # One such method-call is the call to no-jquery. However had, since
+    # as of May 2021, we will simply let the configure file, the yaml
+    # file, determine whether jquery is used or whether it is not used.
+    # ======================================================================= #
+    # no_jquery # No jquery by default.
+    # ======================================================================= #
+    # But we overrule it if the user decided this in the configuration file.
+    # ======================================================================= #
+    if enable_jquery_for_every_page?
+      do_use_jquery
+    end
+    use_utf_encoding # Use ISO or UTF encoding. Current default is UTF.
+    use_commandline_mode
+    # add_http_response_header
+  end
+
+end; end

data/lib/cyberweb/web_object/run.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/run.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # add_html_and_head_start_tag # ← This will add the <html> and <head> tag.
+    # ======================================================================= #
+    # (1) Register all constants.
+    # ======================================================================= #
+    register_constants if register_the_constants?
+    # ======================================================================= #
+    # (2) This will load require-files that the user may want to
+    #     load up optionally, such as prawn.
+    # ======================================================================= #
+    consider_loading_addons_based_on_the_config_file
+    # ======================================================================= #
+    # (3) check whether we have to show the source code. This has to be
+    #     handled with care, as a user may not always want to show the
+    #     source code. Thus, we require a config variable for this to
+    #     work.
+    # ======================================================================= #
+    check_whether_to_show_the_source_code
+    # ======================================================================= #
+    # (4) check on params given through the webpage in question.
+    # ======================================================================= #
+    check_on_params
+    # ======================================================================= #
+    # (5) Add the @string_lateron String next to the @string String.
+    # ======================================================================= #
+    add_string_lateron
+  end
+
+end; end

data/lib/cyberweb/web_object/sinatra_related_functionality.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'cyberweb/web_object/sinatra_related_functionality.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class WebObject < Base # === Cyberweb::WebObject
+
+  # ========================================================================= #
+  # === is_a_sinatra_application?
+  # ========================================================================= #
+  def is_a_sinatra_application?
+    @internal_hash[:is_a_sinatra_application]
+  end; alias uses_sinatra?         is_a_sinatra_application? # === uses_sinatra?
+       alias are_we_using_sinatra? is_a_sinatra_application? # === are_we_using_sinatra?
+
+  # ========================================================================= #
+  # === is_a_sinatra_application
+  #
+  # Setter method to designate a given application as a sinatra-application.
+  # ========================================================================= #
+  def is_a_sinatra_application
+    @internal_hash[:is_a_sinatra_application] = true
+  end; alias enable_sinatra_application is_a_sinatra_application # === enable_sinatra_application
+
+end; end