ftp_paradise 1.3.8

data/lib/ftp_paradise/gui/gtk/constants.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+begin
+  require 'gtk_paradise'
+rescue LoadError; end
+
+module FtpParadise # === FtpParadise
+
+module Gtk # === FtpParadise::Gtk
+
+class Ftp < ::Gtk::Frame
+
+  begin
+    require 'cyberweb/web_images/web_images.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === SHALL_WE_DEBUG
+  # ========================================================================= #
+  SHALL_WE_DEBUG = false
+
+  # ========================================================================= #
+  # === MY_TEMP
+  # ========================================================================= #
+  if ENV['MY_TEMP']
+    MY_TEMP = ENV['MY_TEMP'].to_s+'/'
+  else
+    MY_TEMP = '/tmp/'
+  end
+
+  # ========================================================================= #
+  # === USE_THIS_HOST
+  # ========================================================================= # 
+  USE_THIS_HOST  = 'square'
+
+  # ========================================================================= #
+  # === MAIN_BG_COLOUR
+  # ========================================================================= #
+  MAIN_BG_COLOUR = ::Gtk::Colours::BEIGE
+
+  # ========================================================================= #
+  # === MAIN_BG_COLOUR_PRELIGHT
+  # ========================================================================= #
+  MAIN_BG_COLOUR_PRELIGHT = ::Gtk::Colours::BLANCHEDALMOND
+  # ========================================================================= #
+  # === COLOUR_OF_BORDER
+  # ========================================================================= #
+  COLOUR_OF_BORDER = 'darkgreen' # DARKBLUE
+  USE_THIS_FONT    = 'Sans 16' # Size tag.
+  TITLE = 'FTP Client'
+  IMG = ENV['IMG'].to_s+'/'
+  STOCK_ITEMS   = IMG+'GUI/GTK/STOCK_ITEMS/'
+  DOWNLOAD_ICON = IMG+WebImages[:download2]
+  UPLOAD_ICON   = IMG+WebImages[:upload2]
+  
+end; end; end

data/lib/ftp_paradise/gui/gtk/ftp_bindings.rb

@@ -0,0 +1,1149 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# === FtpParadise::Gtk::Ftp
+#
+# The Purpose of this class is to provide GTK-FTP Client.
+#
+# Usage examples:
+#
+#   FtpParadise::Gtk::Ftp.new
+#
+# =========================================================================== #
+# require 'ftp_paradise/gui/ftp_bindings.rb'
+# =========================================================================== #
+require 'ftp_paradise/requires/common_basic_requires.rb'
+require 'ftp_paradise/requires/common_external_requires.rb'
+require 'ftp_paradise/ftp_connection/connection.rb'
+require 'ftp_paradise/constants/file_constants.rb'
+require 'ftp_paradise/gui/gtk/constants.rb'
+require 'gtk_paradise'
+
+module FtpParadise # === FtpParadise
+
+module Gtk # === FtpParadise::Gtk
+
+class Ftp < ::Gtk::Frame # === FtpParadise::Gtk::Ftp.new
+
+  include ::Gtk::BaseModule
+
+  module WidthHeight
+
+    # ======================================================================= #
+    # === FTP_MAIN_ICON
+    # ======================================================================= #
+    FTP_MAIN_ICON = HOME_DIRECTOY_OF_USER_X+'DATA/IMG/PC/FTP/FTP.png'
+
+    # ======================================================================= #
+    # WIDTH and HEIGHT settings.
+    # ======================================================================= #
+
+    # ======================================================================= #
+    # === HEIGHT
+    # ======================================================================= #
+    HEIGHT = 680 # WidthHeight::HEIGHT
+
+    # ======================================================================= #
+    # === WIDTH
+    # ======================================================================= #
+    WIDTH  = 740 # WidthHeight::WIDTH
+
+  end
+
+  include ::Gtk
+  include ::Gtk::Colours
+  include Colours # We require the Colours module here. Always.
+  include FtpParadise
+  include WidthHeight
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    super(TITLE)
+    set_font
+    set_background
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === initialize_ftp_object                       (ftp tag, initialize tag)
+  #
+  # This method is called from within reset() method.
+  # ========================================================================= #
+  def initialize_ftp_object
+    @_ = FtpParadise::Connection.new(:dont_run_yet) # Our main ftp client.
+    @_.be_verbose = false # for now, let's be verbose.
+  end
+
+  # ========================================================================= #
+  # === set_background
+  #
+  # This method actually sets the colour of the border.
+  # ========================================================================= #
+  def set_background
+    self.modify_bg(STATE_NORMAL,
+      validate_gtk_colour(COLOUR_OF_BORDER)
+    )
+  end
+
+  # ========================================================================= #
+  # === set_font
+  # ========================================================================= #
+  def set_font(
+      i = USE_THIS_FONT
+    )
+    set_font_in_use_for_this_application(i)
+  end
+
+  # ========================================================================= #
+  # === create_renderer
+  # ========================================================================= #
+  def create_renderer
+    @cell_renderer_text = gtk_cell_renderer_text
+    @cell_renderer_text.set_property('background', 'lavender')
+    @cell_renderer_text.set_property('foreground', 'black')
+  end
+
+  # ========================================================================= #
+  # === add_status_message
+  #
+  # Use this to append to the Statusbar.
+  # ========================================================================= #
+  def add_status_message(i)
+    @status_bar.push @status_bar_context_id, i
+  end
+
+  # ========================================================================= #
+  # === create_gtk_liststore
+  #
+  # Uses Gtk::ListStore. These lists contain the local and 
+  # remote files.
+  # ========================================================================= #
+  def create_gtk_liststore
+    @list_store_local_files  = ::Gtk::ListStore[
+      String, ::GdkPixbuf::Pixbuf
+    ]
+    @list_store_remote_files = ::Gtk::ListStore[
+      String, ::GdkPixbuf::Pixbuf
+    ]
+  end
+
+  # ========================================================================= #
+  # === create_accel_groups
+  # ========================================================================= #
+  def create_accel_groups
+    @accel_group = gtk_accel_group
+    self.add_accel_group(@accel_group)
+    @accel_group.connect( Gdk::Keyval::GDK_Q, 
+    Gdk::Window::CONTROL_MASK, ACCEL_VISIBLE) {
+      e 'Global quit key issued. Quitting.'
+      efancy 'Bye!'
+      Gtk.main_quit
+    }
+  end
+
+  # ========================================================================= #
+  # === update_local_files
+  # ========================================================================= #
+  def update_local_files(
+      be_verbose = false
+    )
+    @list_store_local_files.clear
+    @tree_view_local_files.remove_column(
+      @tree_view_column_local_files
+    )
+    @tree_view_column_local_files = TreeViewColumn.new('Local Files', 
+      @cell_renderer_text, {:text => 0})
+    update_array_with_local_files
+    fill_up_iter_for_local_files
+    @tree_view_local_files.append_column(@tree_view_column_local_files)
+    colour_to_use = 'darkblue'
+    _ = "<markup><span weight=\"bold\" foreground=\""+colour_to_use+"\">LocalDir: #{return_current_directory}</span></markup>"
+    @label_local_dir.set_markup(_, true) 
+    if be_verbose
+      e 'Reporting in '+sdir(Dir.pwd)+':'
+      pp @array_file_listing_local
+    end
+  end
+
+  # ========================================================================= #
+  # === return_current_directory
+  # ========================================================================= #
+  def return_current_directory
+    return rds(Dir.pwd+'/')
+  end
+
+  # ========================================================================= #
+  # === update_everything                                        (update tag)
+  # ========================================================================= #
+  def update_everything
+    e ' => Updating content of remote and local files now.'
+    update_local_files(false)
+    update_remote_files
+  end
+
+  # ========================================================================= #
+  # === check_for_file_uploading
+  #
+  # Also checks if there is a directory but it wont change dir.
+  # ========================================================================= #
+  def check_for_file_uploading(i = '..')
+    if i.is_a? String
+      opn; e "Now uploading the file `#{sfile(i)}` to `#{simp(host?)}`."
+      if File.directory? i
+        e sdir(i)+' is a dir - dont wanna upload it. Instead, '+
+          'we will enter it now.'
+        cd i
+        update_local_files(false)      
+      elsif File.symlink? i
+        # pass thru
+        e i+' is a symlink - dont wanna upload'
+      else # If we assume a file here, then we upload the file.
+        output_coloured_line ' => Uploading file:'
+        e sfile(i)+' is a file, so we upload it:'
+        @_.upload(i)
+        update_everything
+      end
+    else
+      opn; e 'The input is not a string. Instead, it is of '+
+             'class '+simp(i.class.to_s)+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === set_current_dir
+  #
+  # Use only this method to modify the @current_dir.
+  # ========================================================================= #
+  def set_current_dir(i = Dir.pwd+'/')
+    i << '/' unless i.end_with? '/'
+    @current_dir = i # tracks the current dir
+  end; alias set_local_dir set_current_dir # === set_local_dir
+
+  # ========================================================================= #
+  # === update_array_with_local_files
+  #
+  # Here we update the local file listing.
+  # ========================================================================= #
+  def update_array_with_local_files
+    _ = Dir['*'].sort
+    _.unshift '..' # Add .. to beginning of the Array.
+    # Since 10.12.2011 we use only the basename.
+    _.map! {|entry| File.basename(entry) }
+    @array_file_listing_local = _
+  end
+
+  # ========================================================================= #
+  # === set_login_name
+  # ========================================================================= #
+  def set_login_name(i = '')
+    @login_name = i
+    update_login_name # Sync it here.
+  end
+
+  # ========================================================================= #
+  # === set_password
+  # ========================================================================= #
+  def set_password(i = '1aaaaaa')
+    @password = i
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    @label_remote_dir = nil
+    @colour_for_label = 'darkblue'
+    set_remote_dir(nil)
+    # ======================================================================= #
+    # Use the available hosts next.
+    # ======================================================================= #
+    if FtpParadise.const_defined? :RoebeFtpConstants
+      @array_possible_hosts = FtpParadise::RoebeFtpConstants.possible_hosts?
+      @array_possible_hosts.reject! {|entry| entry.include? 'geas' }
+    end
+    @entry_user_name = nil
+    @debug = SHALL_WE_DEBUG
+    set_password
+    initialize_ftp_object
+    set_host # wrapper
+    if Dir.pwd.include? '/Users/x'
+      cd MY_TEMP if MY_TEMP
+    end
+    @button_ftp_target = ''
+    @array_file_listing_local  = []
+    @array_file_listing_remote = []
+    # ======================================================================= #
+    # We also must keep an updated list of allowed hosts.
+    # ======================================================================= #
+    if Object.const_defined? :RoebeFtpConstants
+      @_.set_data 'square' # MY_FTP['geas']['url'] # prepend to the array.
+    end
+    @v_box = VBox.new
+    @h_box_ftp_entry = HBox.new
+    @h_box_ftp_entry.border_width = 5
+    update_array_with_local_files
+    set_login_name '0fe_14741968'
+  end
+  
+  # ========================================================================= #
+  # === create_statusbar
+  #
+  # Create the Statusbar.
+  # ========================================================================= #
+  def create_statusbar
+    @status_bar = gtk_statusbar
+    @status_bar.has_resize_grip = true
+    @status_bar_context_id = @status_bar.get_context_id('Gtk Ftp Client') 
+  end
+
+  # ========================================================================= #
+  # === create_hboxes
+  #
+  # The buttons must exist before calling this method.
+  # ========================================================================= #
+  def create_hboxes
+    @hbox_for_buttons = gtk_hbox
+    @hbox_for_buttons.pack_start(
+      @button_debug, true, true, 5)
+    @hbox_for_buttons.pack_start(
+      @button_update_listing, true, true, 5)
+    @hbox_for_dirs = gtk_hbox
+    @hbox_for_dirs.pack_start(
+      @label_local_dir = ::Gtk.modify_bold_label(
+        'LocalDir: '+@current_dir, 'darkblue'), true, false, 1)
+    @hbox_for_dirs.pack_start(
+      @label_remote_dir = gtk_label, true, false,1
+    )
+    set_remote_dir
+    @hbox_for_arrows = gtk_hbox # Add both buttons to the hbox for arrows.
+    @hbox_for_arrows.add(@button_upload)
+    @hbox_for_arrows.add(@button_download)
+  end
+
+  # ========================================================================= #
+  # === create_boxes
+  #
+  # Used for?
+  # When we call this method, @scrolled_window_local_files must already
+  # exist.
+  # ========================================================================= #
+  def create_boxes
+    @h_box_file_listing = HBox.new(true, 0)
+    @h_box_file_listing.add(@scrolled_window_local_files)
+    @h_box_file_listing.add(@scrolled_window_remote_files)
+  end
+
+  # ========================================================================= #
+  # === create_status_icon
+  # ========================================================================= #
+  def create_status_icon
+    @status_icon = StatusIcon.new
+    @status_icon.pixbuf = Gdk::Pixbuf.new(FTP_MAIN_ICON)
+    @status_icon.tooltip = 'StatusIcon'
+  end
+
+  # ========================================================================= #
+  # === delete_remote_file
+  #
+  # Wrapper to delete a remote file.
+  # ========================================================================= #
+  def delete_remote_file
+    ewarn 'Deleting this remote file:'
+    efancy selection?(:right)
+    @_.remove_file( selection?(:right) )
+    update_everything
+  end
+
+  # ========================================================================= #
+  # === enable_dragging
+  #
+  # Enables dragging for local and remote files.
+  # ========================================================================= #
+  def enable_dragging
+    [
+      @tree_view_local_files, @tree_view_remote_files
+    ].each { |tree_view|
+      tree_view.enable_model_drag_source(Gdk::Window::BUTTON1_MASK,
+        [ ['GTK_TREE_MODEL_ROW', 0, 0] ], 
+        Gdk::DragContext::ACTION_COPY|Gdk::DragContext::ACTION_MOVE)
+      tree_view.enable_model_drag_dest(
+        [ ['GTK_TREE_MODEL_ROW', 0, 0] ],
+        Gdk::DragContext::ACTION_COPY|Gdk::DragContext::ACTION_MOVE)
+    }
+  end
+
+  # ========================================================================= #
+  # === hook_up_tree_view_clicks
+  #
+  # Connect our tree views with mouse clicks.
+  # ========================================================================= #
+  def hook_up_tree_view_clicks
+    @tree_view_local_files.signal_connect(:button_release_event) { |widget, event|
+      ewarn selection?(:left)
+      check_for_file_uploading(selection?(:left))
+    }
+    # Nun die remote files.
+    @tree_view_remote_files.signal_connect(:button_release_event) { |widget, event| 
+      selected = selection?(:right).to_s
+      e 'The selected file is: `'+sfancy(selected)+'`'
+      e 'Is '+selected+' a directory? '+@_.is_directory?(selected).to_s
+e swarn('-> TODO (FIXME): if it is a file, download, if it is a directory, enter directory.')
+      if @_.is_a_directory?(selected) # If it is a directory, change into it.
+        change_remote_directory(selected)
+      else
+        set_remote_dir
+        download_files(selected)
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === fill_up_iter_for_local_files
+  #
+  # Now iterate through our file listing.
+  # ========================================================================= #
+  def fill_up_iter_for_local_files
+    _ = '/Users/x/DATA/IMG/STD/UHR.png'
+    @array_file_listing_local.each { |file|
+      next if file == '..' && (Dir.pwd == '/')
+      file << '/' if File.directory?(file) # append if is directory.
+      iter = @list_store_local_files.append
+      iter.set_value(0, file)
+      if File.exist? _
+        iter.set_value(1, GdkPixbuf::Pixbuf.new(_)) # Uhr Icon.
+      else
+        ewarn 'File at '+sfile(_)+' does not exist.'
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === change_remote_directory
+  # ========================================================================= #
+  def change_remote_directory(i)
+    @_.change_remote_directory(i)
+    update_remote_files
+  end
+
+  # ========================================================================= #
+  # === change_dir_and_report
+  #
+  # Use this method if you want to change the local directory. It will also
+  # assign to a new @current_dir, via the method set_current_dir()
+  # ========================================================================= #
+  def change_dir_and_report(input = '..')
+    Dir.chdir(input)
+    e 'Current directory: '+sdir(Dir.pwd)
+    set_current_dir
+  end; alias cd change_dir_and_report # === cd
+
+  # ========================================================================= #
+  # === create_main_table
+  #
+  # @main_table tag.
+  # ========================================================================= #
+  def create_main_table
+    n_rows = 10
+    @main_table = Table.new(n_rows, 2, true)
+    @main_table.set_column_spacings(2)
+    @main_table.set_row_spacings(2)
+    fill_main_table
+  end
+
+  # ========================================================================= #
+  # === create_gtk_buttons                                      (buttons tag)
+  #
+  # This method will create all the different buttons.
+  # ========================================================================= # 
+  def create_gtk_buttons
+    create_debug_button
+    create_update_button
+    # ======================================================================= #
+    # This button is a ComboBox which has all of our default FTP hosts.
+    # ======================================================================= #
+    @button_ftp_site = ComboBoxEntry.new(true) # True for text-only.
+    # The remote-file removal button.
+    @button_delete_remote_file = gtk_button('_DeleteRemoteFile')
+    @button_delete_remote_file.signal_connect(:clicked) {
+      delete_remote_file
+    }
+    @button_ftp_site.modify_bg( ::Gtk::StateType::NORMAL,   GREY)
+    @button_ftp_site.modify_bg( ::Gtk::StateType::PRELIGHT, GREY)
+    @button_ftp_site.modify_bg( ::Gtk::StateType::ACTIVE,   GREY) 
+
+    name_tip = 'Use this when you wish to remove a remote file.'
+    ::Gtk::Tooltips.new.set_tip(
+      @button_delete_remote_file, name_tip, nil
+    )
+    # ======================================================================= #
+    # The Drop down combo box. Dropdown combo box.             (Dropdown tag)
+    # ======================================================================= #
+    @array_possible_hosts.each {|val|
+      @button_ftp_site.append_text(val)
+    }
+    # ======================================================================= #
+    # Assign to the last entry.
+    # ======================================================================= #
+    set_host(default_host?)
+    @button_ftp_site.active = @array_possible_hosts.size - 1
+    # ======================================================================= #
+    # The connect-button on the right side will be created next.
+    # ======================================================================= #
+    create_connect_button
+    # ======================================================================= #
+    # === Upload Button                                            (left tag)
+    #
+    # The upload button with the right arrow.
+    # ======================================================================= #
+    @button_upload = gtk_button
+    _ = STOCK_ITEMS+'stock_right_arrow_24.png'
+    left = Image.new(_)
+    @button_upload.signal_connect(:clicked) {
+      output_coloured_line('Uploading file(s)')
+      check_for_file_uploading
+    }
+    hbox = gtk_hbox
+    hbox.add gtk_image(UPLOAD_ICON)
+    hbox.add left
+    @button_upload.add(hbox)
+    name_tip = 'Upload the selected files/directories.'
+    ::Gtk::Tooltips.new.set_tip(@button_upload, name_tip, nil) 
+    # ======================================================================= #
+    # === Download Button
+    #
+    # The download button with the left arrow.
+    # ======================================================================= #
+    @button_download = gtk_button
+    right = Image.new(STOCK_ITEMS+'stock_left_arrow_24.png')
+    @button_download.signal_connect(:clicked) {
+      output_coloured_line('Download file(s)')
+      download_files
+    }
+    hbox = gtk_hbox
+    hbox.add right
+    hbox.add gtk_image(DOWNLOAD_ICON)
+    @button_download.add(hbox)
+    name_tip = 'Download the selected (remote) files/directories.'
+    ::Gtk::Tooltips.new.set_tip(@button_download, name_tip, nil)
+    # ======================================================================= #
+    # Lets spice it up, and use some colours for our buttons.
+    # ======================================================================= #
+    [
+      @button_ftp_site,
+      @button_connect,
+      @button_debug,
+      @button_update_listing,
+      @button_delete_remote_file,
+      @button_download
+    ].each { |a_button|
+      a_button.modify_bg( StateType::ACTIVE,   CORAL )
+      a_button.modify_bg( StateType::NORMAL,   CORNFLOWERBLUE )
+      a_button.modify_bg( StateType::PRELIGHT, DARKVIOLET )
+    }
+    # ======================================================================= #
+    # Here come buttons which shouldnt highlight that awfully.
+    # ======================================================================= #
+    [
+      @button_upload, @button_download
+    ].each { |a_button|
+      a_button.modify_bg( StateType::ACTIVE,   MAIN_BG_COLOUR )
+      a_button.modify_bg( StateType::NORMAL,   MAIN_BG_COLOUR )
+      a_button.modify_bg( StateType::PRELIGHT, MAIN_BG_COLOUR_PRELIGHT)
+      a_button.set_border_width(14)
+    }
+  end
+
+  # ========================================================================= #
+  # === fill_up_iter_for_remote_files
+  # ========================================================================= #
+  def fill_up_iter_for_remote_files
+    if @debug
+      cliner { pp @array_file_listing_remote }
+    end 
+    @array_file_listing_remote.each {|file|
+      if @debug
+        opn; e "THE REMOTE FILE WAS: `#{file}`"
+      end
+      # file = file + '/' if  File.directory?(file)
+      iter = @list_store_remote_files.append
+      begin
+        _ = file.first
+        if file[1] == 'directory'
+          _ << '/' unless _.end_with? '/'
+        end
+        iter.set_value(0, _)
+      rescue Exception => error
+        opn; e 'An exception happened at line: '+__LINE__.to_s
+        cliner {pp file}
+        pp error
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === create_debug_button                         (debug tag, debug button)
+  # ========================================================================= #
+  def create_debug_button
+    @button_debug = gtk_button('_Debug') # The debug-button.
+    @button_debug.signal_connect(:clicked) {
+      e 'Debugging FTP Client.'
+      efancy '  '+@entry_search.text
+      output_coloured_line(@button_ftp_site.active_text)
+      pp @_.array_file_listing
+      e
+      e 'The current directory is: '+sdir(@current_dir.to_s)
+      e
+      ecomment ('The password is: ').ljust(20)+password?, token: ':'
+      ecomment 'The login name is: '+@login_name, token: ':'
+    }
+  end
+
+  # ========================================================================= #
+  # === password?
+  # ========================================================================= #
+  def password?
+    @_.password?
+  end
+
+  # ========================================================================= #
+  # === do_ftp_login
+  #
+  # Wrapper towards the FTP Connection. Call from within initialize(). 
+  # ========================================================================= #
+  def do_ftp_login
+    @_.set_ascii
+    @_.set_passive
+    @_.do_connect
+  end
+
+  # ========================================================================= #
+  # === download_files
+  #
+  # Use this to download one or several files.
+  # ========================================================================= #
+  def download_files(i)
+    if i.is_a? Array
+      i.each {|entry| download_files(entry) }
+    else
+      e 'We will now try to download '+sfile(i)+'.'
+      @_.download_remote_file(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === create_entries
+  # ========================================================================= #
+  def create_entries
+    create_search_entry
+    create_user_name_entry
+  end
+
+  # ========================================================================= #
+  # === create_search_entry
+  # ========================================================================= #
+  def create_search_entry
+    # The search entry box at bottom (ganz unten...)
+    @entry_search = gtk_entry
+    @entry_search.signal_connect(:key_press_event) { |w,event|
+      e Gdk::Keyval.to_name(event.keyval)
+    }
+    @entry_search.set_text('Input file filter here:')
+    @entry_search.set_focus(true)
+    @entry_search.signal_connect(:button_press_event) { |widget, event|
+      @entry_search.set_focus(true)
+      @entry_search.select_region(0, -1)
+    }
+  end
+
+  # ========================================================================= #
+  # === user_name?
+  # ========================================================================= #
+  def user_name?
+    @entry_user_name.text
+  end
+
+  # ========================================================================= #
+  # === update_login_name
+  # ========================================================================= #
+  def update_login_name
+    if @entry_user_name
+      @entry_user_name.text = @login_name
+    end
+  end
+
+  # ========================================================================= #
+  # === show_startup_message
+  # ========================================================================= #
+  def show_startup_message
+    cliner {
+      e ' => Starting GTK2 FTP Client '\
+        '(Height: '+sfancy(height?.to_s)+', '\
+        'Width: '+sfancy(width?.to_s)+')'
+    }
+  end
+
+  # ========================================================================= #
+  # === height?
+  # ========================================================================= #
+  def height?
+    WidthHeight::HEIGHT
+  end
+
+  # ========================================================================= #
+  # === width?
+  # ========================================================================= #
+  def width?
+    WidthHeight::WIDTH
+  end
+
+  # ========================================================================= #
+  # === sanitize_file_listing
+  #
+  # Sanitizes file listing of the remote computer.
+  # ========================================================================= #
+  def sanitize_file_listing
+    unless @_.array_file_listing.nil?
+      @array_file_listing_remote = @_.array_file_listing
+      update_array_with_remote_files
+    end
+  end; alias update_remote_file_listing sanitize_file_listing # === update_remote_file_listing
+
+  # ========================================================================= #
+  # === update_array_with_remote_files
+  # ========================================================================= #
+  def update_array_with_remote_files
+    output_coloured_line ' > Updating array for remote files'
+    if @_.is_connected?
+      @_.get_listing
+      @_.report_current_remote_dir
+    end
+    @array_file_listing_remote = @_.array_file_listing
+    @array_file_listing_remote.unshift(
+      ['../','directory', '0']
+    ) # Add '..' to beginning of the Array.
+    if debug?
+      opn; e 'Debugging @array_file_listing_remote next:'
+      pp @array_file_listing_remote
+    end
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    @debug
+  end
+
+  # ========================================================================= #
+  # === create_update_button                              (update button tag)
+  #
+  # This is the update button.
+  # ========================================================================= #
+  def create_update_button
+    # ======================================================================= #
+    # The Update button comes next.
+    # ======================================================================= #
+    @button_update_listing = Button.new('_Update')
+    @button_update_listing.signal_connect(:clicked) {
+      output_coloured_line('Updating remote file listing')
+      update_remote_files
+    }
+    name_tip = 'Use this when you wish to update the remote file listing.'
+    ::Gtk::Tooltips.new.set_tip(@button_update_listing, name_tip, nil)
+  end
+
+  # ========================================================================= #
+  # === create_connect_button                                   (connect tag)
+  # ========================================================================= #
+  def create_connect_button
+    @button_connect = Button.new(Stock::CONNECT)
+    name_tip = 'Connect to the remote site by clicking this button.'
+    ::Gtk::Tooltips.new.set_tip(@button_connect, name_tip, nil)
+    @button_connect.signal_connect(:clicked) {
+      set_host(@button_ftp_site.active_text)
+      @_.set_password(@password)
+      @_.set_login_name(user_name?) # This is the user name.
+      cliner {
+        e 'Connecting to:'+sfancy('  '+host?)
+      }
+      @_.show_host_user_name_port_and_password
+      begin
+        connect_to_remote_host # Use this wrapper to login.
+        update_remote_file_listing
+        update_remote_files # This is for the GUI component.
+      rescue SocketError => error
+        e 'A small Error (SocketError) occurred:'
+        e error
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === host?
+  # ========================================================================= #
+  def host?
+    @host
+  end
+
+  # ========================================================================= #
+  # === set_host
+  # ========================================================================= #
+  def set_host(i = default_host?)
+    @host = i
+    @_.set_host(i) if @_
+  end
+
+  # ========================================================================= #
+  # === default_host?
+  # ========================================================================= #
+  def default_host?
+    @array_possible_hosts[-1]
+  end
+
+  # ========================================================================= #
+  # === connect_to_remote_host
+  #
+  # Use this method when connecting to the remote host.
+  # ========================================================================= #
+  def connect_to_remote_host(this_host = host?)
+    this_host = this_host.to_s
+    @_.connect_to this_host, :be_verbose
+    add_status_message 'Connecting to '+this_host.to_s+' now.'
+    try_to_sync_label_remote_dir
+  end
+
+  # ========================================================================= #
+  # === create_scrolled_windows
+  #
+  # We use two scrolled windows - the left side has our local files and
+  # the right side holds our remote files.
+  # ========================================================================= #
+  def create_scrolled_windows
+    @scrolled_window_local_files = ScrolledWindow.new
+    @scrolled_window_local_files.set_window_placement(CORNER_BOTTOM_RIGHT)
+    @scrolled_window_local_files.set_policy(POLICY_AUTOMATIC, POLICY_ALWAYS)
+    @scrolled_window_local_files.add(@tree_view_local_files)
+    @scrolled_window_remote_files = ScrolledWindow.new
+    @scrolled_window_remote_files.set_policy(POLICY_AUTOMATIC, POLICY_ALWAYS)
+    @scrolled_window_remote_files.add(@tree_view_remote_files)
+    @scrolled_window_local_files.set_window_placement(CORNER_TOP_LEFT)
+  end
+
+  # ========================================================================= #
+  # === create_gtk_treeview
+  #
+  # We must attach the ListStore to our tree view.
+  #
+  # Local files is to the left, remote files is to the right.
+  # ========================================================================= #
+  def create_gtk_treeview
+    @tree_view_local_files  = TreeView.new(@list_store_local_files)
+    @tree_view_local_files.modify_bg(STATE_NORMAL, DARKBLUE)
+    @tree_view_column_local_files = TreeViewColumn.new('Local Files', 
+      @cell_renderer_text, {:text => 0})
+    @tree_view_local_files.append_column(@tree_view_column_local_files)
+    @tree_view_local_files.selection.mode  = SELECTION_SINGLE
+    # ======================================================================= #
+    # Now work on the remote files. They are on the right side of
+    # the main widget.
+    # ======================================================================= #
+    @tree_view_remote_files = TreeView.new(@list_store_remote_files)
+    @tree_view_remote_files.modify_bg(STATE_NORMAL, DARKBLUE)
+    @tree_view_column_remote_files = TreeViewColumn.new('Remote Files', 
+      @cell_renderer_text, {:text => 0})
+    @tree_view_remote_files.append_column(@tree_view_column_remote_files)
+    @tree_view_remote_files.selection.mode = SELECTION_SINGLE
+    enable_dragging
+    hook_up_tree_view_clicks
+    fill_up_iter_for_local_files
+    fill_up_iter_for_remote_files
+    # create scrolled window before continuing
+  end
+
+  # ========================================================================= #
+  # === update_remote_files                                (upd tag. UP TAG.)
+  #
+  # Use this method to update the remove files.
+  # ========================================================================= #
+  def update_remote_files
+    @list_store_remote_files.clear
+    @tree_view_remote_files.remove_column(@tree_view_column_remote_files)
+    @tree_view_column_remote_files = TreeViewColumn.new(
+      'Remote Files', @cell_renderer_text, {:text => 0})
+    update_array_with_remote_files
+    fill_up_iter_for_remote_files
+    @tree_view_remote_files.append_column(
+      @tree_view_column_remote_files
+    )
+  end
+
+  # ========================================================================= #
+  # === output_coloured_line
+  #
+  # Makes a nicely coloured line.
+  # ========================================================================= #
+  def output_coloured_line(
+      input, optional_colour = 'yelb'
+    )
+    cliner {
+      e sfancy(input)
+    }
+  end
+
+  # ========================================================================= #
+  # === fill_main_table
+  #
+  # Fill our table with the various smaller widgets.
+  # ========================================================================= #
+  def fill_main_table
+    @main_table.attach_defaults(@h_box_ftp_entry,   0,2,0,1)
+    # ======================================================================= #
+    # The following hbox has 4 buttons.
+    # ======================================================================= #
+    @main_table.attach_defaults(@hbox_for_buttons,  0,2,1,2)
+    # ======================================================================= #
+    # Next an entry and the delete button.
+    # ======================================================================= #
+    _ = ::Gtk::HBox.new
+    host_label = ::Gtk::Label.new('Login Name:')
+    host_label.set_markup(
+      %Q[<markup><span weight="bold">Login Name:</span></markup>], true
+    )
+    name_tip = 'The login name you will use should come here.'
+    ::Gtk::Tooltips.new.set_tip(host_label, name_tip, nil)
+    _.pack_start(host_label,true,true, 1)
+    _.pack_start(@entry_user_name,true,true, 1)
+    @main_table.attach_defaults(_, 0,1,2,3)
+    @main_table.attach_defaults(@button_delete_remote_file,1,2,2,3)
+    @main_table.attach_defaults(@hbox_for_arrows,   0,2,3,4)
+    @main_table.attach_defaults(@hbox_for_dirs,     0,2,4,5)
+    @main_table.attach_defaults(@h_box_file_listing,0,2,5,8)
+    # @main_table.attach_defaults(@entry_search,      0,2,8,9)
+    @main_table.attach(@entry_search, 0,2,8,9,
+      ::Gtk::EXPAND|::Gtk::FILL,::Gtk::EXPAND|::Gtk::FILL,2,2)
+  end
+
+  # ========================================================================= #
+  # === create_user_name_entry
+  #
+  # This is the user-name.
+  # ========================================================================= #
+  def create_user_name_entry
+    @entry_user_name = ::Gtk::Entry.new
+    @entry_user_name.set_max_length(70)
+    @entry_user_name.text = return_default_user_name_based_on_selected_host
+    # ======================================================================= #
+    # When the user clicks on it, we select the whole thing.
+    # ======================================================================= #
+    @entry_user_name.signal_connect(:button_press_event) {|widget, event|
+      @entry_user_name.set_focus(true)
+      @entry_user_name.select_region(0, -1)
+    }
+  end
+
+  # ========================================================================= #
+  # === return_default_user_name_based_on_selected_host
+  # ========================================================================= #
+  def return_default_user_name_based_on_selected_host
+    selected_host = host?
+    selected_host = FtpParadise::RoebeFtpConstants.return_user_name_based_on_given_host(selected_host)
+    return selected_host
+  end
+
+  # ========================================================================= #
+  # === try_to_sync_label_remote_dir
+  # ========================================================================= #
+  def try_to_sync_label_remote_dir
+    if @label_remote_dir
+      set_remote_dir { :do_not_sync }
+      colour_to_use = @colour_for_label
+      @label_remote_dir.set_markup(
+        %Q[<markup><span weight="bold" foreground="#{colour_to_use}">
+        RemoteDir: #{remote_dir?}
+        </span></markup>], true)
+    end
+  end
+
+  # ========================================================================= #
+  # === remote_dir?
+  # ========================================================================= #
+  def remote_dir?
+    @remote_dir
+  end
+
+  # ========================================================================= #
+  # === set_remote_dir
+  #
+  # Use this to set the path of the remote dir in the label.
+  #
+  # If we have the String 'not connected' then we will not append a '/'
+  # character.
+  # ========================================================================= #
+  def set_remote_dir(i = @_.remote_directory?)
+    i = i.to_s
+    unless i.include? 'not connected'
+      i << '/' unless i.end_with? '/'
+    end
+    @remote_dir = i
+    # Try to sync the label next, unless a block was given.
+    if block_given?
+      try_to_sync_label_remote_dir unless yield == :do_not_sync
+    else
+      try_to_sync_label_remote_dir
+    end
+  end
+
+  # ========================================================================= #
+  # === set_title_for_frame
+  #
+  # Set the title for the Gtk::Frame via markup. This is the top-left
+  # title.
+  # ========================================================================= #
+  def set_title_for_frame
+    colour_to_use = 'darkblue'
+    _ = '<markup><span weight="bold" style="italic" size="x-large" foreground="'+colour_to_use+'"> FTP Client </span></markup>'
+    self.label_widget.set_markup(_)
+  end
+
+  # ========================================================================= #
+  # === create_gtk_skeleton                                    (skeleton tag)
+  # ========================================================================= #
+  def create_gtk_skeleton
+    colour_to_use = '#3456a5'
+    set_title_for_frame
+    # @v_box.pack_start(HSeparator.new, false, true, 0)
+    create_renderer
+    create_gtk_liststore
+    create_gtk_treeview
+    create_entries
+    create_scrolled_windows # Must come after treeview initialization.
+    create_boxes
+    create_statusbar
+    create_gtk_buttons # This must be called before we can call create_hboxes()
+    create_hboxes
+    create_main_table
+    _ = ::Gtk::HBox.new
+    # ======================================================================= #
+    # Add the host label next:
+    # ======================================================================= #
+    name_tip = 'The (remote) host we will connect to. This should be '+
+      'a valid ftp site.'
+    host_label = ::Gtk::Label.new('Host:')
+    host_label.set_markup(
+      %Q[<markup><span weight="bold">Host:</span></markup>], true
+    )
+    ::Gtk::Tooltips.new.set_tip(host_label, name_tip, nil)
+    # Now comes the host label, and then the button ftp site.
+    _.pack_start(host_label,true,true, 1)
+    _.pack_start(@button_ftp_site,true,true, 1)
+    @h_box_ftp_entry.add(_)
+    @h_box_ftp_entry.add(@button_connect) # Add the connect-button here.
+    # ======================================================================= #
+    # Now connect things.
+    # ======================================================================= #
+    _ = VBox.new
+    @label_title = Label.new.set_markup(%Q[<span weight="bold" size="x-large" foreground="#{colour_to_use}">
+      #{TITLE}</span>], false)
+    _.pack_start(@label_title, false, true, 1) # false for shrinking.
+    _.pack_start(@main_table,  true,  true, 1)
+    _.pack_start(@status_bar,  true,  true, 1)
+    self.add _ 
+    self.signal_connect(:delete_event) { main_quit }
+    show_all
+    sanitize_file_listing
+    update_everything # also populate the remote file listing, to the right.
+  end
+
+  # ========================================================================= #
+  # === selection?
+  #
+  # gives you what was selected.
+  #
+  # Alternative way would be:
+  #   name = @tree_view_local_files.selection.selected[0]
+  # ========================================================================= #
+  def selection?(which_side = :left)
+    case which_side
+    when :left
+      @tree_view_local_files.selection.selected_each { |model, path, iter| 
+        iter.first
+      }
+    when :right
+      @tree_view_remote_files.selection.selected_each { |model, path, iter| 
+        iter.first
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === FtpParadise::Gtk::Ftp.run
+  # ========================================================================= #
+  def self.run
+    _ = self.new
+    # ======================================================================= #
+    # Next, proper our Gtk::Runner class for display.
+    # ======================================================================= #
+    r = ::Gtk.run('60%', '95%')
+    r.icon = FTP_MAIN_ICON
+    r.title = 'FTP Client'
+    r.padding = 8
+    r.add(_)
+    r.set_window_position(::Gtk::Window::POS_NONE)
+    r.add_shortcut(1, 'focus(:left)', :alt)
+    r.run
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    reset
+    show_startup_message
+    set_current_dir # Do this after the startup message.
+    create_gtk_skeleton
+  end
+
+end if defined? ::Gtk # Safeguard if the user does not have Gtk installed.
+
+end
+
+# =========================================================================== #
+# === FtpParadise.do_start_gui
+#
+# This will output what will be done, then start the GUI bindings.
+#
+# This method can be invoked via:
+#   ftpparadise --gui
+# =========================================================================== #
+def self.do_start_gui
+  opnn; puts 'We will next start the GUI.'
+  FtpParadise.start_gtk
+end
+
+# =========================================================================== #
+# === FtpParadise.start_gtk
+# =========================================================================== #
+def self.start_gtk
+  FtpParadise::Gtk::Ftp.run
+end
+
+# =========================================================================== #
+# === FtpParadise.gtk_widget
+#
+# This method will return a useable GTK widget that can be embedded into
+# other applications.
+# =========================================================================== #
+def self.gtk_widget
+  FtpParadise::Gtk::Ftp
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise.start_gtk
+end # gtkftp