cyberweb 0.4.174 → 0.5.225

data/lib/cyberweb/utility_scripts/fix_incorrect_links_to_locally_existing_images_in_this_file.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::FixIncorrectLinksToLocallyExistingImagesInThisFile
+#
+# Note that this class currently (May 2022) does not work properly.
+# It may have to be rewritten at a later time.
+#
+# Usage example:
+#
+#   Cyberweb::FixIncorrectLinksToLocallyExistingImagesInThisFile.new(ARGV)
+#
+# =========================================================================== #
+# require 'cyberweb/utility_scripts/fix_incorrect_links_to_locally_existing_images_in_this_file.rb'
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class FixIncorrectLinksToLocallyExistingImagesInThisFile < Base # === Cyberweb::FixIncorrectLinksToLocallyExistingImagesInThisFile
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === LOCAL_PATH_TO_THE_IMAGES
+  #
+  # This constant is probably not needed, but it is kept here just in case.
+  # ========================================================================= #
+  LOCAL_PATH_TO_THE_IMAGES = '/home/x/data/images/'
+
+  # ========================================================================= #
+  # === 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()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = ''.dup
+    if first? and File.exist?(first?)
+      dataset = File.readlines(first?)
+      dataset.each {|line|
+        if line.include?('<img src')
+          # ================================================================= #
+          # The next regex is also kept at rubular.com:
+          #
+          #   https://rubular.com/r/6V83P5NiG8pyO9
+          #
+          # ================================================================= #
+          regex_to_use = /<img src="(.+?)"/
+          line =~ regex_to_use
+          match = $1.to_s.dup # ← This may be a String such as "../../../data/images/STD/DOT_06.png".
+puts "DEBUG INFORMATION: match was #{Colours.steelblue(match)}"
+          # ================================================================= #
+          # Next check whether the image-file exists. If not we can modify
+          # this link.
+          # ================================================================= #
+          unless File.exist? match
+            # =============================================================== #
+            # Do rewrite the line now using another regex.
+            # =============================================================== #
+            if match.include? 'data/images'
+              regex_to_use = /([.\/]+data\/images\/)/ # See: https://rubular.com/r/usU0d1a0ouhtEm
+            else # else use another regex, the one
+              regex_to_use = /<img src="(.+?)"/
+            end
+            new_target = rds(
+              '../' * (return_pwd.count('/') - 1)+
+              LOCAL_PATH_TO_THE_IMAGES
+            )
+            line.gsub!(regex_to_use, new_target)
+          end
+        end
+        _ << "#{line}" # And append it.
+      }
+    end
+    unless _.empty?
+      into = 'foobar.html'
+      puts 'Storing into '+sfile(into)+'.'
+      write_what_into(_, into)
+    end
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::FixIncorrectLinksToLocallyExistingImagesInThisFile[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::FixIncorrectLinksToLocallyExistingImagesInThisFile.new(ARGV)
+end # fixincorrectlinkstolocallyexistingimagesinthisfile

data/lib/cyberweb/utility_scripts/html_to_cyberweb_converter.rb

@@ -0,0 +1,235 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Cyberweb::HtmlToCyberwebConverter
+#
+# The main idea behind this class is to take an existing .html page and
+# turn it into a "cyberweb"-page. This currently works on .cgi files
+# only, though.
+#
+# Usage example:
+#
+#   Cyberweb::HtmlToCyberwebConverter.new(ARGV)
+#
+# =========================================================================== #
+# require 'cyberweb/utility_scripts/html_to_cyberweb_converter.rb'
+# Cyberweb::HtmlToCyberwebConverter.new(ARGV)
+# =========================================================================== #
+require 'cyberweb/base/base.rb'
+
+module Cyberweb
+
+class HtmlToCyberwebConverter < Base # === Cyberweb::HtmlToCyberwebConverter
+
+  require 'cyberweb/web_object/web_object.rb'
+
+  begin
+    require 'cyberweb/requires/require_the_html_template.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === 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()
+    set_commandline_mode
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :path_to_the_html_file
+    # ======================================================================= #
+    @internal_hash[:path_to_the_html_file] = nil
+    # ======================================================================= #
+    # === :cyberweb_object
+    # ======================================================================= #
+    @internal_hash[:cyberweb_object] = Cyberweb::WebObject.new
+  end
+
+  # ========================================================================= #
+  # === cyberweb_object?
+  # ========================================================================= #
+  def cyberweb_object?
+    @internal_hash[:cyberweb_object]
+  end; alias cyberweb_object cyberweb_object? # === cyberweb_object
+       alias cyberweb?       cyberweb_object? # === cyberweb?
+
+  # ========================================================================= #
+  # === set_title
+  # ========================================================================= #
+  def set_title(i)
+    cyberweb_object?.set_title(i)
+  end
+
+  # ========================================================================= #
+  # === try_to_parse_the_html_file
+  # ========================================================================= #
+  def try_to_parse_the_html_file
+    _ = @internal_hash[:path_to_the_html_file].to_s
+    if _ and File.exist?(_)
+      set_dataset(File.read(_))
+      look_for_the_title
+      look_for_the_body_tag
+    else
+      e "No file exists at `#{_}`."
+    end
+  end
+
+  # ========================================================================= #
+  # === look_for_the_title
+  # ========================================================================= #
+  def look_for_the_title(
+      in_which_dataset = dataset?,
+      regex_to_use     = /<title>([A-Za-z\?\s]+)<\/title>/ # See: https://rubular.com/r/gWITDMvlqOJKVa
+    )
+    in_which_dataset =~ regex_to_use
+    if $1 and !$1.to_s.empty?
+      set_title($1.to_s)
+    end
+  end
+
+  # ========================================================================= #
+  # === look_for_the_body_tag
+  # ========================================================================= #
+  def look_for_the_body_tag(
+      in_which_dataset = dataset?,
+      regex_to_use     = /<body>([A-Za-z\?\s]+)<\/body>/ # See: https://rubular.com/r/gWITDMvlqOJKVa
+    )
+    in_which_dataset =~ regex_to_use
+    if $1 and !$1.to_s.empty?
+      set_title($1.to_s)
+    end
+  end
+
+  # ========================================================================= #
+  # === dataset?
+  # ========================================================================= #
+  def dataset?
+    @internal_hash[:dataset]
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  # ========================================================================= #
+  def set_dataset(i)
+    @internal_hash[:dataset] = i
+  end
+
+  # ========================================================================= #
+  # === set_path_to_the_html_file
+  # ========================================================================= #
+  def set_path_to_the_html_file(i)
+    if i.is_a? Array
+      i = i.first
+    end
+    i = File.absolute_path(i)
+    @internal_hash[:path_to_the_html_file] = i
+  end; alias set_work_on_this_html_file set_path_to_the_html_file # === set_work_on_this_html_file
+
+  # ========================================================================= #
+  # === path_to_the_html_file?
+  # ========================================================================= #
+  def path_to_the_html_file?
+    @internal_hash[:path_to_the_html_file]
+  end
+
+  # ========================================================================= #
+  # === infer_the_new_name_from_the_path
+  # ========================================================================= #
+  def infer_the_new_name_from_the_path
+    _ = @internal_hash[:path_to_the_html_file]
+    _ = 'new_'+File.basename(_)
+    return _
+  end
+
+  # ========================================================================= #
+  # === title?
+  # ========================================================================= #
+  def title?
+    cyberweb_object?.title?
+  end
+
+  # ========================================================================= #
+  # === body?
+  # ========================================================================= #
+  def body?(
+      use_this_regex = /<body>([0-9A-Za-z\s?!\/<>]+)<\/body>/, # See: https://rubular.com/r/yHvvEtuaPFxs2W
+      dataset        = dataset?
+    )
+    unless dataset.include? '</body>'
+      e 'Warning (notice): the input data contains no closing </body> tag.'
+    end
+    scanned = dataset.scan(
+      use_this_regex
+    )
+    result = scanned.flatten.first.to_s
+    if result.start_with?("\n")
+      result[0,1] = ''
+    end
+    if result.end_with?("\n")
+      result[-1,1] = ''
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === save_into_a_new_html_file
+  # ========================================================================= #
+  def save_into_a_new_html_file
+    # cyberweb_object?.do_serve(:do_not_display_anything)
+    what = Cyberweb::HtmlTemplate[
+      # css_class: 'darkgreen',
+      title: title?.strip,
+      body:  body?
+    ].to_s
+    into = infer_the_new_name_from_the_path
+    e 'Storing into `'+sfile(into)+'` next.'
+    write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    set_work_on_this_html_file(first?)
+    try_to_parse_the_html_file
+    save_into_a_new_html_file
+  end
+
+  # ========================================================================= #
+  # === Cyberweb::HtmlToCyberwebConverter[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Cyberweb::HtmlToCyberwebConverter.new(ARGV)
+end # htmltocyberwebconverter