open 0.1.30

data/lib/open/in_browser/in_browser.rb

@@ -0,0 +1,614 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Open::InBrowser
+#
+# This class can be used to open something in the browser.
+#
+# The correct browser to use is, by default, the one that is stored in
+# the yaml file called 'use_this_browser.yml'. This can, evidently,
+# only work if this file exists and can be found.
+#
+# If it is a local file then the absolute path will be used, determined
+# via File.absolute_path().
+#
+# Usage example for this class:
+#
+#   require 'open'
+#   Open::InBrowser.new(ARGV)
+#
+# =========================================================================== #
+# To open a remote webpage in firefox only, do:
+#
+#   use_this_browser = 'firefox -new-tab'
+#    _ = use_this_browser
+#    _ << ' "'+url.to_s+'"'
+#
+# =========================================================================== #
+# require 'open/in_browser/in_browser.rb'
+# =========================================================================== #
+require 'open/base/base.rb'
+
+module Open
+
+class InBrowser < Base # === Open::InBrowser
+
+  begin
+    require 'studium/requires/return_remote_homepage_of_this_lecture.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument becomes the target URL that will be opened.
+  # ========================================================================= #
+  def initialize(
+      target_url  = '',
+      run_already = true
+    )
+    register_sigint
+    reset
+    set_target_url(
+      target_url
+    )
+    # ======================================================================= #
+    # === Handle blocks given next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :no_localhost
+      #
+      # This entry point ensures that there will not be a "localhost"
+      # part of the opened URL.
+      # ===================================================================== #
+      when :no_localhost
+        @internal_hash[:use_localhost_URLs] = false
+      # ===================================================================== #
+      # === :try_to_use_localhost_URLs
+      # ===================================================================== #
+      when :try_to_use_localhost_URLs
+        @internal_hash[:use_localhost_URLs] = true
+      # ===================================================================== #
+      # === :open_in_background
+      # ===================================================================== #
+      when :open_in_background
+        set_open_in_background(true)
+      # ===================================================================== #
+      # === use_launchy
+      #
+      # This clause can be entered by code such as the following:
+      #
+      #   Open.open_in_browser(port: 8080,) { :use_launchy }
+      #
+      # ===================================================================== #
+      when :use_launchy
+        set_use_launchy(true)
+      # ===================================================================== #
+      # === be_silent
+      #
+      # This entry point will make this class be quiet, that is, not display
+      # the actual command that is used.
+      # ===================================================================== #
+      when :be_silent,
+           :be_quiet
+        @internal_hash[:show_the_sys_command_that_is_used] = false
+      else
+        # =================================================================== #
+        # Handle Hashes next:
+        # =================================================================== #
+        if yielded.is_a? Hash
+          # ================================================================= #
+          # === :use_this_browser
+          #
+          # Usage example for this clause:
+          #
+          #   Open.in_browser(remote_URL) {{ use_this_browser: :firefox }}
+          #
+          # ================================================================= #
+          if yielded.has_key? :use_this_browser
+            set_use_this_browser(yielded[:use_this_browser])
+          end
+        end
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :use_this_browser
+    #
+    # This variable will keep track as to which browser will be used.
+    # ======================================================================= #
+    @internal_hash[:use_this_browser] = ::Open.use_which_browser?
+    # ======================================================================= #
+    # === :open_in_background
+    # ======================================================================= #
+    @internal_hash[:open_in_background] = false
+    # ======================================================================= #
+    # === :use_launchy
+    #
+    # This variable will make use of the launchy gem rather than the
+    # class here. It has been added in February 2022 as an ad-hoc
+    # way, in particular for windows, to open remote URLs. That way
+    # we can query for the windows operating system and silently
+    # delegate onto the launchy gem, if need be. The default value
+    # is false, though, so most users of this class have to enable
+    # this on their own.
+    # ======================================================================= #
+    @internal_hash[:use_launchy] = false
+    # ======================================================================= #
+    # === :show_the_sys_command_that_is_used
+    # ======================================================================= #
+    @internal_hash[:show_the_sys_command_that_is_used] = true
+    # ======================================================================= #
+    # === :append_this_string
+    # ======================================================================= #
+    @internal_hash[:append_this_string] = ''.dup
+    # ======================================================================= #
+    # === :use_localhost_URLs
+    #
+    # By default we will not use localhost-URLs. If we are on a roebe-system,
+    # however had, we will use localhost URLs.
+    # ======================================================================= #
+    @internal_hash[:use_localhost_URLs] = false
+  end
+
+  # ========================================================================= #
+  # === set_open_in_background
+  # ========================================================================= #
+  def set_open_in_background(i = true)
+    @internal_hash[:open_in_background] = i
+  end
+
+  # ========================================================================= #
+  # === set_use_launchy
+  # ========================================================================= #
+  def set_use_launchy(i = false)
+    @internal_hash[:use_launchy] = i
+  end
+
+  # ========================================================================= #
+  # === show_the_sys_command_that_is_used?
+  # ========================================================================= #
+  def show_the_sys_command_that_is_used?
+    @internal_hash[:show_the_sys_command_that_is_used]
+  end
+
+  # ========================================================================= #
+  # === use_launchy?
+  # ========================================================================= #
+  def use_launchy?
+    @internal_hash[:use_launchy]
+  end
+
+  # ========================================================================= #
+  # === check_for_intralink
+  #
+  # The second optional argument specifies the token to use for replacing
+  # empty spaces, if we have passed an Array as argument.
+  # ========================================================================= #
+  def check_for_intralink(
+      i                                      = nil,
+      use_this_token_to_replace_empty_spaces = '_'
+    )
+    if i
+      if i.is_a? Array
+        i = i.join(' ').tr(' ', use_this_token_to_replace_empty_spaces)
+      end
+      i = i.to_s # Ensure that we have a String at this point.
+      unless i.empty?
+        @internal_hash[:append_this_string] << i
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === set_target_url                                              (URL tag)
+  #
+  # We prefer this to be an Array.
+  #
+  # Usage example:
+  #
+  #   Open::InBrowser.new('https://blog.fefe.de/') { :use_launchy }
+  #   Open::InBrowser.new('blog.fefe.de') { :use_launchy }
+  #
+  # ========================================================================= #
+  def set_target_url(
+      i = ''
+    )
+    if i.is_a? Array # This if-clause was added in May 2022.
+      i = i.join(' ').strip
+    end
+    possible_array = beautiful_url(i)
+    case i
+    # ======================================================================= #
+    # === rf HERE
+    # ======================================================================= #
+    when /HERE/
+      i = File.basename(return_pwd)
+      if is_on_roebe?
+        i = Studium.return_remote_homepage_of_this_lecture(i)
+      end
+    end
+    if possible_array.is_a?(Array) and (possible_array.size > 1)
+      i = possible_array
+    else
+      if i.is_a? Hash
+        # =================================================================== #
+        # === :use_launchy
+        # =================================================================== #
+        if i.has_key? :use_launchy
+          set_use_launchy(i.delete(:use_launchy))
+        end
+        # =================================================================== #
+        # === :with_localhost
+        #
+        # Example for this entry point:
+        #
+        #   Open::InBrowser.new(with_localhost: PORT_TO_USE)
+        #
+        # =================================================================== #
+        if i.has_key?(:with_localhost) and use_localhost_URLs?
+          i = "http://localhost:#{i.delete(:with_localhost)}/"
+        # =================================================================== #
+        # === :port
+        #
+        # Example for this entry point:
+        #
+        #   Open::InBrowser[port: 8080]
+        #
+        # =================================================================== #
+        elsif i.has_key? :port
+          i = "http://localhost:#{i.delete(:port)}/"
+        end
+      end
+    end
+    i = [i] unless i.is_a? Array
+    i.flatten! if i.is_a? Array
+    # ======================================================================= #
+    # Work over all members of this Array next.
+    # ======================================================================= #
+    i.map! {|entry|
+      case entry
+      when :default_sinatra_port
+        entry = 'http://localhost:4567/'
+      end
+      if Object.const_defined? :Studium
+        possible_link = Studium.return_remote_homepage_of_this_lecture(entry)
+        if possible_link == entry
+        else
+          entry = possible_link
+        end
+      end
+      if ::BeautifulUrl.is_a_local_link?(entry)
+        entry = ::BeautifulUrl.local_menu(entry)
+      else
+        entry = beautiful_url(entry).dup
+      end
+      entry = entry.first if entry.is_a? Array
+      if entry and File.exist?(entry)
+        entry = File.absolute_path(entry)
+      end
+      if entry and entry.start_with?('/home/x/') and !entry.include?('images/') and use_localhost_URLs?
+        entry.sub!(/\/home\/x\//,'http://localhost/')
+      end
+      # ===================================================================== #
+      # Perform some sanitize-operations next.
+      # ===================================================================== #
+      if entry and
+        ((entry.include?("'") and !entry.include?('"')) or
+          entry.include?(' ')
+        )
+        entry = '"'+entry+'"'
+      elsif entry and (entry.include?(';') or entry.include?('('))
+        entry = '"'+entry+'"'
+      end
+      unless entry and File.exist?(entry)
+        # =================================================================== #
+        # Try a trailing glob next. The idea here is to expand from e. g.
+        # "image3" towards "image3.jpg", if the latter file exists, and
+        # the former does NOT exist.
+        # =================================================================== #
+        possible_matches = Dir["#{entry}*"]
+        unless possible_matches.empty?
+          first = possible_matches.first
+          if File.exist? first
+            entry = first
+          end
+        end
+      end
+      entry
+    }
+    @internal_hash[:target_url] = i
+  end
+
+  # ========================================================================= #
+  # === target_url?
+  # ========================================================================= #
+  def target_url?
+    @internal_hash[:target_url]
+  end; alias target_URL? target_url? # === target_URL?
+       alias remote_URL? target_url? # === remote_URL?
+
+  # ========================================================================= #
+  # === first_remote_URL?
+  # ========================================================================= #
+  def first_remote_URL?
+    remote_URL?.first
+  end
+
+  # ========================================================================= #
+  # === set_use_this_browser
+  # ========================================================================= #
+  def set_use_this_browser(
+      i = ::Open.use_which_browser?
+    )
+    @internal_hash[:use_this_browser] = i.to_s
+  end
+
+  # ========================================================================= #
+  # === use_this_browser?
+  # ========================================================================= #
+  def use_this_browser?
+    @internal_hash[:use_this_browser]
+  end
+
+  # ========================================================================= #
+  # === open_in_background?
+  # ========================================================================= #
+  def open_in_background?
+    @internal_hash[:open_in_background]
+  end
+
+  # ========================================================================= #
+  # === append_this_string?
+  # ========================================================================= #
+  def append_this_string?
+    @internal_hash[:append_this_string]
+  end
+
+  # ========================================================================= #
+  # === use_localhost_URLs?
+  # ========================================================================= #
+  def use_localhost_URLs?
+    @internal_hash[:use_localhost_URLs]
+  end
+
+  # ========================================================================= #
+  # === open_in_browser
+  #
+  # This is the part that does the actual file-opening via the browser.
+  # ========================================================================= #
+  def open_in_browser(
+      optional_append_this_string = append_this_string?
+    )
+    _ = LOCATION_OF_BROWSER_YAML_FILE
+    browser = use_this_browser? # Use the generic browser by default.
+    # ======================================================================= #
+    # We must check first whether the file exists or not.
+    # ======================================================================= #
+    if File.exist? _
+      browser = YAML.load_file(_).strip.dup # This variable holds which browser to use.
+      if is_on_windows?
+        case browser
+        # =================================================================== #
+        # === palemoon
+        # =================================================================== #
+        when 'palemoon'
+          browser.prepend(
+            "C:\\Program Files\\Pale Moon\\palemoon.exe"
+          )
+        end
+      end
+      # ===================================================================== #
+      # Different browsers have different ways to open a new tab.
+      # ===================================================================== #
+      if browser.include? 'opera' # Perform some sanitizing in this case.
+        browser << ' -newtab'
+        # =================================================================== #
+        # Or alternatively:
+        #
+        #   opera --remote 'openURL(<url>, new-page)'
+        #
+        # =================================================================== #
+      elsif browser.include? 'firefox'
+        browser << ' -new-tab'
+      elsif browser.include?('chromium') or
+            browser.include?('thorium') or
+            browser.include?('chrome')
+        # =================================================================== #
+        # This is for chromium-based browsers, including chrome.
+        # =================================================================== #
+        browser << ' --no-sandbox --app-url '
+      end
+      [target_url?].flatten.each {|entry|
+        entry = entry.to_s.dup # .dup to avoid that it may be frozen.
+        real_filename = entry.dup
+        if real_filename.include?('#')
+          real_filename = real_filename[0 .. (real_filename.index('#')-1)]
+        end
+        if optional_append_this_string.size > 0
+          # ================================================================= #
+          # We prepend the '#' character, unless it starts with the
+          # '?' character.
+          # ================================================================= #
+          unless optional_append_this_string.start_with? '?'
+            optional_append_this_string.prepend '#'
+          end
+          entry << optional_append_this_string
+        end
+        # =================================================================== #
+        # Next, specifically handle the situation on my home system, when
+        # we are in a directory that includes a substring such as
+        # '/home/x/data/' and if the target file name ends with '.cgi'.
+        # =================================================================== #
+        if is_on_roebe? and
+           entry.end_with?('.cgi') and # Modify .cgi files
+          !entry.start_with?('http') and
+          !entry.start_with?('http://localhost/')
+          if return_pwd.include?(DATA_DIRECTORY_AT_HOME)
+            # ================================================================= #
+            # We need a target URL such as:
+            #   http://localhost/data/games/AITD/AITD.cgi
+            # in this case.
+            # ================================================================= #
+            unless entry.include? DATA_DIRECTORY_AT_HOME
+              entry.prepend(return_pwd)
+            end
+            entry.squeeze!('/')
+            quoted_regexp = Regexp.quote(DATA_DIRECTORY_AT_HOME)
+            entry.sub!(quoted_regexp, 'http://localhost/data/') if use_localhost_URLs?
+          elsif return_pwd.include?(PROGRAMMING_LANGUAGES_DIRECTORY_AT_HOME)
+            unless entry.include? PROGRAMMING_LANGUAGES_DIRECTORY_AT_HOME
+              entry.prepend(return_pwd)
+            end
+            entry.squeeze!('/')
+            quoted_regexp = Regexp.quote(PROGRAMMING_LANGUAGES_DIRECTORY_AT_HOME)
+            entry.sub!(quoted_regexp, 'http://localhost/programming/') if use_localhost_URLs?
+          end
+        end
+        if open_in_background?
+          entry << '&'
+        end
+        if File.exist?(real_filename) and
+           !real_filename.start_with?('file://') and
+           !entry.include?('http://localhost/')
+          entry = entry.dup
+          entry.prepend('file://')
+        end
+        if entry.include? '&'
+          entry = '"'+entry+'"' unless entry.start_with? '"'
+        end
+        # =================================================================== #
+        # Handle windows next:
+        # =================================================================== #
+        if is_on_windows?
+          # start firefox -new-tab www.howtogeek.com
+          this_command = "start #{browser} -new-tab #{entry}"
+        else
+          this_command = "#{browser} #{entry}"
+        end
+        if show_the_sys_command_that_is_used?
+          e this_command
+        end
+        unless entry.empty?
+          # ================================================================= #
+          # Finally run the system-command, unless we will use the
+          # launchy gem.
+          # ================================================================= #
+          if use_launchy?
+            cmd_to_use = 'launchy '+entry.to_s
+            e cmd_to_use
+            system(cmd_to_use)
+          else
+            system(this_command) # Here we always output.
+          end
+        end
+      } unless target_url?.nil?
+    else
+      browser = 'firefox' # Else, default to this here as a generic fallback.
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run 
+    open_in_browser
+  end
+
+  # ========================================================================= #
+  # === Open::InBrowser[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end; self.instance_eval { alias open_in_browser [] } # === Open::InBrowser.open_in_browser
+
+end
+
+  # ========================================================================= #
+  # === Open.open_in_browser
+  #
+  # Note that this method needs to be somewhat flexible, as we can provide
+  # varied input such as:
+  #
+  #   Open.open_in_browser(port: 8080)
+  #   Open.in_browser(remote_URL) {{ use_this_browser: :firefox }}
+  #
+  # ========================================================================= #
+  def self.open_in_browser(
+      i = ARGV,
+      &block
+    )
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      # ===================================================================== #
+      # === Handle Hashes next
+      # ===================================================================== #
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === Handle Hashes past this point
+        # =================================================================== #
+        # =================================================================== #
+        # === :delay
+        # =================================================================== #
+        if yielded.has_key? :delay
+          _ = yielded.delete(:delay)
+          if _.is_a? String
+            _ = _.sub(/ seconds/,'')
+            _ = _.sub(/ second/,'').to_f if _.include? ' second'
+            _ = _.to_f # Need a Float.
+          end
+          sleep(_)
+        end
+      end
+    # else
+    end
+    ::Open::InBrowser.new(i, &block)
+  end; self.instance_eval { alias in_browser open_in_browser } # === Open.in_browser
+       self.instance_eval { alias open       open_in_browser } # === Open.open
+
+end
+
+# =========================================================================== #
+# === open_in_browser
+#
+# This method will open an URL in firefox.
+#
+# Usage example in pure Ruby:
+#
+#   require 'open'; open_in_browser 'google.at'
+#
+# =========================================================================== #
+def open_in_browser(
+    url                = ARGV,
+    optional_intralink = nil,
+    &block
+  )
+  # ========================================================================= #
+  # Next, open the class that we defined above in this file here.
+  # ========================================================================= #
+  _ = Open::InBrowser.new(url, false, &block)
+  _.check_for_intralink(optional_intralink)
+  _.run
+end; alias oib open_in_browser # oib shortcut.
+
+if __FILE__ == $PROGRAM_NAME
+  open_in_browser(ARGV.first)
+end # inbrowser
+    # inbrowser https://distrowatch.com/dwres.php?resource=ratings&distro=antix