gtk_paradise 0.9.120 → 0.11.19

data/lib/gtk_paradise/widgets/gtk3/ping_widget/ping_widget.rb

@@ -4,27 +4,510 @@
 # =========================================================================== #
 # === Gtk::PingWidget
 # =========================================================================== #
-# require 'gtk_paradise/gui/gtk3/ping_widget/ping_widget.rb'
+# require 'gtk_paradise/widgets/gtk3/ping_widget/ping_widget.rb'
 # Gtk::PingWidget.run
 # =========================================================================== #
 require 'gtk_paradise/require_gtk3'
 
 module Gtk
 
-class PingWidget < ::Gtk::Box
+class PingWidget < ::Gtk::Box # === Gtk::PingWidget 
 
-  require 'gtk_paradise/widgets/shared_code/ping_widget/ping_widget_module.rb'
-  include ::Gtk::PingWidgetModule
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  begin
+    require 'net/ping'
+  rescue LoadError; end
+
+  begin
+    require 'verbose_truth'
+  rescue LoadError; end
+  
+  # ========================================================================= #
+  # === FILE_GREEN_CIRCLE
+  # ========================================================================= #
+  FILE_GREEN_CIRCLE = ::Gtk.base_directory?+'images/small/GREEN_CIRCLE.png'
+
+  # ========================================================================= #
+  # === RED_GREEN_CIRCLE
+  # ========================================================================= #
+  FILE_RED_CIRCLE  = ::Gtk.base_directory?+'images/small/RED_CIRCLE.png'
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Ping'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '35% or minimum 250px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '20% or minimum 150px'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :dejavu_condensed_19
+
+  # ========================================================================= #
+  # === USE_THIS_SMALLER_FONT
+  # ========================================================================= #
+  USE_THIS_SMALLER_FONT = :dejavu_condensed_17
+
+  # ========================================================================= #
+  # === ARRAY_PREDEFINED_REMOTE_URLS
+  # ========================================================================= #
+  ARRAY_PREDEFINED_REMOTE_URLS = %w(
+    https://github.com/AndyObtiva/
+    https://www.derstandard.at/
+    https://www.linuxfromscratch.org/blfs/view/svn/introduction/changelog.html
+    https://ftp.gnu.org/pub/gnu/?C=M;O=D
+    https://download.gnome.org/sources/?C=M;O=D
+  )
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    super(:vertical)
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    handle_CSS_rules 
+    infer_the_size_automatically
+    # ======================================================================= #
+    # === @array_we_pinged_these_remote_URLs
+    #
+    # Keep track of all pinged remote URLs. Perhaps we may save this one
+    # day. For now it is not in use otherwise, though.
+    # ======================================================================= #
+    @array_we_pinged_these_remote_URLs = []
+    # ======================================================================= #
+    # === @the_IP_is
+    # ======================================================================= #
+    @the_IP_is = nil
+    try_to_require_the_open_gem unless Object.const_defined?(:Open)
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    4
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === create_entries                               (entries tag, entry tag)
+  # ========================================================================= #
+  def create_entries
+    # ======================================================================= #
+    # === @entry_use_this_URL
+    # ======================================================================= #
+    @entry_use_this_URL = entry
+    @entry_use_this_URL.bblack2
+    @entry_use_this_URL.yellow_background
+    # @entry_use_this_URL.on_click_select_everything
+    # ^^^ this does not work that well.
+    @entry_use_this_URL.on_enter { do_the_ping_action }
+    @entry_use_this_URL.width_height(600, 50)
+    @entry_use_this_URL.respond_to_scroll_events
+    @entry_use_this_URL.use_this_font = return_smaller_font
+    @entry_use_this_URL.hint =
+      "Input a remote URL here, which will be the URL that we wish "\
+      "to check, via a ping-event.\n\n"+
+      "Additional information will then be shown in the area below "\
+      "this entry.\n"
+    if @entry_use_this_URL.respond_to? :shadow_hint=
+      # ===================================================================== #
+      # This here works only on ruby-gtk3.
+      # ===================================================================== #
+      @entry_use_this_URL.shadow_hint = 'Input a remote URL here.'
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_labels
+  # ========================================================================= #
+  def create_the_labels
+    # ======================================================================= #
+    # === @label_for_the_connection_status
+    # ======================================================================= #
+    @label_for_the_connection_status = label
+    @label_for_the_connection_status.make_selectable
+    @label_for_the_connection_status.use_this_font = return_smaller_font
+  end
+
+  # ========================================================================= #
+  # === return_smaller_font
+  # ========================================================================= #
+  def return_smaller_font
+    USE_THIS_SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton                                        (connect tag)
+  # ========================================================================= #
+  def connect_skeleton
+    abort_on_exception
+    create_the_labels
+    create_entries
+    hbox = gtk_hbox
+    image = image_network_cellular_connected_symbolic_symbolic
+    event_box = event_box(image)
+    event_box.on_clicked {
+      do_clear_the_main_entry
+    }
+    hbox.minimal(event_box, 10)
+    hbox.minimal(return_the_signal_image, 10)
+    @spinner = return_inactive_spinner
+    hbox.minimal(@spinner, 10)
+    # === Address
+    label = left_aligned_label('Address')
+    hbox.minimal(label, 10)
+    hbox.minimal(@entry_use_this_URL,         8)
+    hbox.minimal(@button_do_the_ping_action,  5)
+    hbox.minimal(@button_open_in_the_browser, 5)
+    minimal(hbox, 1)
+    hbox2 = gtk_hbox
+    hbox2.minimal(@label_for_the_connection_status, 15)
+    minimal(hbox2, 8)
+  end
+
+  # ========================================================================= #
+  # === is_it_up?
+  # ========================================================================= #
+  def is_it_up?(host)
+    if Object.const_defined? :Net
+      check = Net::Ping::External.new(host)
+      return check.ping?
+    else
+      use_this_text = gtk_text("Net::Ping::External is unavailable. "\
+        "Has the <b>net-ping gem</b> been installed?\n\n"\
+        "Consider installing it via:\n\n  <b>gem install net-ping</b>\n\n"\
+        "Alternatively click the button below, which will "\
+        "try to invoke that command.\n"
+      )
+      use_this_text.make_selectable
+      _ = popup_this_text_over_that_widget(
+        use_this_text,
+        entry_use_this_URL?
+      )
+      use_this_text.deselect
+      vbox = gtk_vbox
+      # === button_gem_install_net_ping
+      button_gem_install_net_ping = button('gem install net-ping')
+      button_gem_install_net_ping.on_clicked {
+        esystem button_gem_install_net_ping.text?
+        try_to_require_net_ping
+      }
+      vbox.add(button_gem_install_net_ping)
+      vbox.show_all
+      _.children.first.add(vbox)
+      _.margin = 6
+      _.bblack3
+      _.pad10px
+      _.use_this_font = :hack_18
+      _.popup
+    end
+  end
+
+  # ========================================================================= #
+  # === try_to_require_net_ping
+  # ========================================================================= #
+  def try_to_require_net_ping
+    begin
+      require 'net/ping'
+    rescue LoadError; end
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+  end
+
+  # ========================================================================= #
+  # === return_string_for_remote_address
+  # ========================================================================= #
+  def return_string_for_remote_address(
+      use_this_URL = remote_URL?
+    )
+    _ = ''.dup
+    result = `host -t a #{use_this_URL} 2>&1`
+    if result.include? 'command not found'
+      # Notify the user that host is not available.
+      popup_this_text_over_that_widget(
+        'The command "host" is not available.',
+        main_entry?
+      )
+    elsif result.include? ' '
+      @the_IP_is = result.split(' ').last.to_s
+      _ << " The remote IP associated with this URL\n"\
+           "is <span weight=\"bold\" color=\"darkgreen\">"\
+           "#{@the_IP_is}</span>."
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === entry_URL?
+  # ========================================================================= #
+  def entry_URL?
+    @entry_use_this_URL
+  end; alias entry_use_this_URL? entry_URL? # === entry_use_this_URL?
+       alias main_entry?         entry_URL? # === main_entry?
+
+  # ========================================================================= #
+  # === do_clear_the_main_entry
+  # ========================================================================= #
+  def do_clear_the_main_entry
+    entry_URL?.clear
+  end
+
+  # ========================================================================= #
+  # === set_main_URL
+  # ========================================================================= #
+  def set_main_URL(i)
+    entry_URL?.set_text(i.to_s)
+  end
+
+  # ========================================================================= #
+  # === do_open_in_the_browser                                     (open tag)
+  # ========================================================================= #
+  def do_open_in_the_browser(
+      use_this_url = @entry_use_this_URL.text?
+    )
+    begin
+      try_to_require_the_open_gem unless Object.const_defined?(:Open)
+      if use_this_url.empty?
+        notify_the_user_that_the_URL_may_not_be_empty
+      else
+        Open.in_browser(use_this_url)
+      end
+    rescue LoadError
+      e 'The open gem is not available. Please install it.'
+    end
+  end
+
+  # ========================================================================= #
+  # === notify_the_user_that_the_URL_may_not_be_empty
+  # ========================================================================= #
+  def notify_the_user_that_the_URL_may_not_be_empty
+    popup_this_text_over_that_widget(
+      ' Please provide a remote URL here. ',
+      entry_URL?
+    )
+  end
+
+  # ========================================================================= #
+  # === start_the_spinner
+  # ========================================================================= #
+  def start_the_spinner
+    @spinner.start_spinning
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+    create_the_buttons
+  end
+
+  # ========================================================================= #
+  # === remote_URL?
+  # ========================================================================= #
+  def remote_URL?
+    @entry_use_this_URL.text.to_s
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === @button_do_the_ping_action
+    # ======================================================================= #
+    @button_do_the_ping_action = button('_Ping')
+    @button_do_the_ping_action.on_clicked {
+      do_the_ping_action
+    }
+    # ======================================================================= #
+    # === @button_open_in_the_browser
+    # ======================================================================= #
+    @button_open_in_the_browser = button('_Open in the browser')
+    @button_open_in_the_browser.hint =
+      'This button will attempt to open the assigned entry in the '\
+      'browser. The browser that will be used is <b>'+
+      ::Open.use_which_browser?+'</b>.'
+    @button_open_in_the_browser.on_clicked {
+      do_open_in_the_browser
+    }
+    do_style_the_buttons_in_a_uniform_manner
+  end
+
+  # ========================================================================= #
+  # === do_style_the_buttons_in_a_uniform_manner
+  # ========================================================================= #
+  def do_style_the_buttons_in_a_uniform_manner
+    return_all_buttons.each {|this_button|
+      this_button.clear_background
+      this_button.on_hover(:lightblue)
+      this_button.bblack3
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    super()
+    let_the_main_entry_respond_to_scroll_events
+  end
+
+  # ========================================================================= #
+  # === let_the_main_entry_respond_to_scroll_events
+  # ========================================================================= #
+  def let_the_main_entry_respond_to_scroll_events
+    @entry_use_this_URL.on_scrolling {
+      sample_result = ARRAY_PREDEFINED_REMOTE_URLS.sample
+      set_main_URL(sample_result) 
+    }
+  end
 
   # ========================================================================= #
   # === Gtk::PingWidget.run
   # ========================================================================= #
-  def self.run(i = ARGV)
-    ::Gtk::PingWidgetModule.run(i)
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/app/app.rb'
+    _ = Gtk::PingWidget.new(i)
+    r = ::Gtk.run
+    r << _
+    r.automatic_size_then_automatic_title
+    r.enable_quick_exit
+    r.top_left_then_run
+  end
+
+  # ========================================================================= #
+  # === return_the_signal_image
+  # ========================================================================= #
+  def return_the_signal_image
+    @signal_image = image
+    the_signal_image_is_now_red
+    return @signal_image
+  end
+
+  # ========================================================================= #
+  # === the_signal_image_is_now_green
+  # ========================================================================= #
+  def the_signal_image_is_now_green
+    @signal_image.set_file(FILE_GREEN_CIRCLE)
+  end
+
+  # ========================================================================= #
+  # === the_signal_image_is_now_red
+  # ========================================================================= #
+  def the_signal_image_is_now_red
+    @signal_image.set_file(FILE_RED_CIRCLE)
+  end
+
+  # ========================================================================= #
+  # === return_information_obtained_via_curl
+  # ========================================================================= #
+  def return_information_obtained_via_curl(remote_URL)
+    result = ''.dup
+    cmd_to_use = "curl -I #{remote_URL} 2>&1"
+    _ = `#{cmd_to_use}`
+    if _
+      if result.include? 'HTTP'
+        result << _.scan(/^HTTP(.+)/).flatten.first.to_s+"\n"
+      end
+      if result.include? 'server'
+        result << _.scan(/^server:(.+)/).flatten.first.to_s+"\n"
+      end
+    end
+    return result
+  end
+
+  # ========================================================================= #
+  # === do_the_ping_action
+  # ========================================================================= #
+  def do_the_ping_action(
+      use_this_url = remote_URL?
+    )
+    start_the_spinner
+    Thread.new {
+      unless use_this_url.empty?
+        @array_we_pinged_these_remote_URLs << use_this_url
+      end
+      up_or_down = is_it_up?(use_this_url)
+      case up_or_down
+      when true,  :up
+        the_signal_image_is_now_green
+      when false, :down
+        the_signal_image_is_now_red
+      end
+      _ = 'Is a connection available to <b>'+
+          remote_URL?+'</b>? <span weight="bold" color="darkblue">'+
+          VerboseTruth[up_or_down].to_s+
+          '</span>'.dup
+      if up_or_down
+        _ << return_string_for_remote_address(remote_URL?)+"\n"
+      end
+      # _ << return_information_obtained_via_curl(@the_IP_is)
+      _ = 'Please assign a remote host in the input area above.' if use_this_url.empty?
+      @label_for_the_connection_status.set_text(_)
+      @label_for_the_connection_status.do_markify
+      @spinner.stop_spinning
+    }
   end
 
-end; end
+end
+
+# =========================================================================== #
+# === Gtk.ping_widget
+# =========================================================================== #
+def self.ping_widget
+  Gtk::PingWidget.new
+end
+
+end
 
 if __FILE__ == $PROGRAM_NAME
-  Gtk::PingWidget.run(i = ARGV)
+  Gtk::PingWidget.run
 end