ftp_paradise 1.4.5 → 1.5.4

data/lib/ftp_paradise/shell/shell.rb

@@ -0,0 +1,2321 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === FtpParadise::Shell
+#
+# This class can be used for an interactive usage of the FTP paradise
+# project. It can be used to connect to remote FTP hosts.
+#
+# This class provides a commandline variant of the FtpParadise project,
+# which allows you to interactively issue commands and instructions
+# to a remote FTP server.
+
+# Usage example:
+#
+#   FtpParadise::Shell.new(ARGV)
+# =========================================================================== #
+# The official source for Ruby-FTP can be found at:
+#
+#   https://www.ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html
+#
+# =========================================================================== #
+# require 'ftp_paradise/shell/shell.rb'
+# =========================================================================== #
+require 'ftp_paradise/requires/require_class_connection.rb'
+
+module FtpParadise
+
+class Shell # === FtpParadise::Shell
+
+  require 'ftp_paradise/base/base.rb'
+  include FtpParadise::Base
+
+  require 'ftp_paradise/shell/menu.rb'
+
+  require 'ftp_paradise/requires/require_the_toplevel_methods.rb'
+
+  require 'ftp_paradise/configuration/configuration.rb'
+
+  require 'ftp_paradise/version/version.rb'
+
+  begin
+    require 'verbose_truth'
+  rescue LoadError; end
+
+  begin
+    require 'readline'
+  rescue LoadError; end # Silent rescue.
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE  
+  # ========================================================================= #
+  TITLE = 'Interactive FTP shell'
+
+  # ========================================================================= #
+  # === SHOW_REMOTE_FILES_UPON_SUCCESSFUL_LOGIN
+  #
+  # If this constant is true then we will show the remote file
+  # listing upon a successful (first) login action.
+  # ========================================================================= #
+  SHOW_REMOTE_FILES_UPON_SUCCESSFUL_LOGIN = false
+
+  # ========================================================================= #
+  # === SHALL_WE_DEBUG
+  # ========================================================================= #
+  SHALL_WE_DEBUG = true
+
+  # ========================================================================= #
+  # === PROMPT_TO_USE
+  #
+  # Which Prompt to use by default for the Interactive FTP component.
+  # ========================================================================= #
+  PROMPT_TO_USE = '> '
+
+  # ========================================================================= #
+  # === ARRAY_FORBIDDEN_HISTORY_COMMANDS
+  # ========================================================================= #
+  ARRAY_FORBIDDEN_HISTORY_COMMANDS = %w(
+    last
+  ) # Dont append last to the history.
+
+  # ========================================================================= #
+  # === OPEN_IN_DEFAULT_EDITOR
+  # ========================================================================= #
+  OPEN_IN_DEFAULT_EDITOR = true
+
+  # ========================================================================= #
+  # === USE_THIS_EDITOR
+  # ========================================================================= #
+  USE_THIS_EDITOR = ENV['EDITOR'].to_s
+
+  # ========================================================================= #
+  # === DEFAULT_LOCAL_DIRECTORY
+  # ========================================================================= #
+  DEFAULT_LOCAL_DIRECTORY = ::FtpParadise.rds("#{Dir.pwd}/") #  More flexible that way, I suppose.
+
+  # ========================================================================= #
+  # === NAME_OF_THIS_FILE
+  # ========================================================================= #
+  NAME_OF_THIS_FILE = "#{PROJECT_BASE_DIRECTORY}shell/shell.rb"
+
+  # ========================================================================= #
+  # === ARRAY_PROJECT_FILES
+  #
+  # The following files have to be opened when you wish to open the
+  # project files.
+  # ========================================================================= #
+  ARRAY_PROJECT_FILES = %w(
+    library.rb
+    interactive.rb
+    addon/constants/ftp_constants.rb
+    doc/TODO
+  ).map {|entry| PROJECT_BASE_DIRECTORY+entry}
+
+  # ========================================================================= #
+  # === DEFAULT_REMOTE_DIRECTORY
+  #
+  # The default remote directory.
+  # ========================================================================= #
+  DEFAULT_REMOTE_DIRECTORY = %q(
+    htdocs
+  ).delete("\n").strip # kill newlines and empty spaces.
+
+  # ========================================================================= #
+  # === DEFAULT_REMOTE_FILE
+  #
+  # The default remote file comes next.
+  # ========================================================================= #
+  DEFAULT_REMOTE_FILE = %q(
+    README.md
+  ).gsub(/\n/,'').strip
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    register_sigint # Register sigint before calling reset().
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    set_run_mode(:standalone) # Purposely defined before run(). This way, we can change it.
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  #
+  # Initialize and/or reset the variables used in this class.
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {} unless instance_variable_defined?('@internal_hash')
+    # ======================================================================= #
+    # === :connection
+    # ======================================================================= #
+    @internal_hash[:connection] = FtpParadise::Connection.new(:dont_run_yet)
+    # ======================================================================= #
+    # === :try_to_use_readline
+    #
+    # This variable will instruct this shell to make use of readline, or
+    # not. It is initially set to true, meaning that we will try to 
+    # make use of the Readline module, if readline is available on
+    # the given computer system at hand.
+    # ======================================================================= #
+    @internal_hash[:try_to_use_readline] = true
+    # ======================================================================= #
+    # === :may_we_exit
+    #
+    # This variable determines whether we may exit from the interactive
+    # shell or whether we may not.
+    # ======================================================================= #
+    @internal_hash[:may_we_exit] = false
+    # ======================================================================= #
+    # === :use_this_editor
+    #
+    # Specify which editor we may use - this can be overruled in the
+    # interactive menu by the user of the FtpParadise project.
+    # ======================================================================= #
+    @internal_hash[:use_this_editor] = USE_THIS_EDITOR
+    # ======================================================================= #
+    # === :debug
+    #
+    # Whether we will debug or not, by default.
+    # ======================================================================= #
+    @internal_hash[:debug] = SHALL_WE_DEBUG
+    # ======================================================================= #
+    # === :padding_to_use
+    # ======================================================================= #
+    @internal_hash[:padding_to_use] = '  ' # The default padding to use.
+    # ======================================================================= #
+    # === :array_downloaded_files
+    #
+    # Which files we did download so far.
+    # ======================================================================= #
+    @internal_hash[:array_downloaded_files] = []
+    # ======================================================================= #
+    # === :history
+    # ======================================================================= #
+    @internal_hash[:history] = []
+    # ======================================================================= #
+    # === :user_input
+    #
+    # Must "initialize" the user_input variable to nil here.
+    # ======================================================================= #
+    @internal_hash[:user_input] = nil
+    # ======================================================================= #
+    # === :array_history_remote_directories
+    #
+    # This array keeps a listing of all remote directories we rcd-ed into.
+    # ======================================================================= #
+    @internal_hash[:array_history_remote_directories] = []
+    reset_instance_variables_that_hold_all_arguments
+    load_config
+    set_file
+    set_local_directory
+  end
+
+  # ========================================================================= #
+  # === show_ftp_docu
+  #
+  # This method will show where to find ruby's ftp docu.
+  # ========================================================================= #
+  def show_ftp_docu
+    e
+    e '  https://www.ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html'
+    e
+  end
+
+  # ========================================================================= #
+  # === set_active
+  # ========================================================================= #
+  def set_active
+    ftp_connection?.set_active
+  end
+
+  # ========================================================================= #
+  # === set_login
+  # ========================================================================= #
+  def set_login(i)
+    ftp_connection?.set_login_name(i)
+  end
+
+  # ========================================================================= #
+  # === login_name?
+  # ========================================================================= #
+  def login_name?
+    ftp_connection?.login_name?
+  end
+
+  # ========================================================================= #
+  # === show_available_connections
+  # ========================================================================= #
+  def show_available_connections(
+      i = ARRAY_AVAILABLE_HOSTS
+    )
+    i.each_with_index {|entry, index|
+      e "#{index} #{entry}"
+    } if Object.const_defined? :RoebeFtpConstants
+  end
+
+  # ========================================================================= #
+  # === connect_to_this_remote_url
+  # ========================================================================= #
+  def connect_to_this_remote_url(
+      i          = remote_url?,
+      be_verbose = :be_verbose
+    )
+    case be_verbose
+    when :be_verbose
+      be_verbose = true
+    end
+    if be_verbose
+      e "Connecting to this remote URL: #{sfancy(i)}" 
+    end
+    FtpParadise.use_this_as_ftp_object(
+      FtpParadise::Connection.new(i)
+    )
+    ftp_connection?.login(
+      FtpParadise.login_name?,
+      password?
+    )
+  end
+
+  # ========================================================================= #
+  # === download_remote_file                                 (download tag)
+  #
+  # This method will download a remote file. When we download a remote
+  # file, we will also set the remote base directory since Dec 2011.
+  # ========================================================================= #
+  def download_remote_file(
+      file = DEFAULT_REMOTE_FILE
+    )
+    file = DEFAULT_REMOTE_FILE if file.nil?
+    if file.include? '*'
+      file = ftp_connection?.find_matches_for(file)
+    end
+    if file.is_a? Array
+      file.each {|the_file| download_remote_file(the_file) }
+    else
+      if file =~ /^\d+$/ # if is a number. DEBUG HERE THOUGH.
+        ftp_connection?.update
+        file = ftp_connection?.array_file_listing[file.to_i - 1][0]
+      end
+      set_remote_directory(file)
+      unless file == '*'
+        opne 'Trying to download `'+sfile(file)+'` now.'
+        # return_value = ftp_connection?.download(file)
+        result = ftp_connection?.download(file) # Delegate to the parent class.
+        if result
+          @internal_hash[:array_downloaded_files] << file
+          set_file(File.basename(file)) # setting new again.
+          if open_in_default_editor? # Works on @file now, as we did set it before.
+            open_this_file_in_editor(file?)
+          end
+        else
+          opne 'An exception occurred - you probably lack permissions to'
+          opne 'download that remote file.'
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_www_component
+  # ========================================================================= #
+  def show_www_component
+    e 'Make sure to visit:'
+    path = '$RSRC/ftp_paradise/lib/ftp_paradise/www/sinatra_web_interface.rb'
+    e "  #{sfancy(path)}"
+    _ = get_env_of("ruby #{path}")
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === automatically_connect_on_startup_of_the_interactive_ftp_shell?
+  # ========================================================================= #
+  def automatically_connect_on_startup_of_the_interactive_ftp_shell?
+    _ = FILE_AUTOMATICALLY_CONNECT_ON_STARTUP_OF_THE_INTERACTIVE_FTP_SHELL
+    if File.exist? _
+      YAML.load_file(_)
+    else
+      false # In this case we default to false.
+    end
+  end
+
+  # ========================================================================= #
+  # === show_ftp_yaml_file
+  # ========================================================================= #
+  def show_ftp_yaml_file
+    e 'The yaml file in question can be found at:'
+    e
+    e "  #{sfile(FILE_ROEBE_FTP)}"
+    e
+  end
+
+  # ========================================================================= #
+  # === show_history
+  #
+  # This method can be used to display the input-history of the user.
+  # ========================================================================= #
+  def show_history # History tag.
+    e "The history for #{sfancy(return_title)} is:"
+    @internal_hash[:history].each_with_index { |key, index|
+      e '%3s' % (index+1).to_s+' '+key
+    }
+  end
+
+  # ========================================================================= #
+  # ==== history?
+  # ========================================================================= #
+  def history?
+    @internal_hash[:history]
+  end
+
+  # ========================================================================= #
+  # === use_readline?
+  # ========================================================================= #
+  def use_readline?
+    @internal_hash[:try_to_use_readline]
+  end; alias do_we_use_readline? use_readline? # === do_we_use_readline?
+
+  # ========================================================================= #
+  # === move_local_file
+  # ========================================================================= #
+  def move_local_file(from, to)
+    e 'Next moving (local) file from '+sfile(from)+' to '+sfile(to)+'.'
+    if File.exist? from
+      FileUtils.mv(from, to)
+    else
+      e 'No (local) file called '+sfile(from)+' could be found.' 
+    end
+  end
+
+  # ========================================================================= #
+  # === toggle_show_full_names
+  # ========================================================================= #
+  def toggle_show_full_names
+    config?.show_full_names = ! config?.show_full_names
+  end
+
+  # ========================================================================= #
+  # === do_not_show_full_names
+  # ========================================================================= #
+  def do_not_show_full_names
+    ftp_connection?.show_full_names = false
+    config?.show_full_names = false # Sync.
+  end
+
+  # ========================================================================= #
+  # === show_local_entries
+  # ========================================================================= #
+  def show_local_entries
+    show_local_files(false)
+  end
+
+  # ========================================================================= #
+  # === return_local_files
+  #
+  # Return local files. Directories will not be included here.
+  # ========================================================================= #
+  def return_local_files
+    entries = Dir['*']
+    entries = Dir[return_pwd+'*'] if show_full_names? # Overrule in this case.
+    entries.reject! {|entry| File.directory? entry }
+    return entries
+  end; alias file_listing return_local_files # === file_listing
+
+  # ========================================================================= #
+  # === report_file
+  #
+  # Here we simply report which file we would upload.
+  # ========================================================================= #
+  def report_file
+    if file?
+      e 'The file that we would upload is: '
+      e "  #{sfile(file?)}"
+    else
+      e 'No file was specified yet.'
+    end
+  end
+
+  # ========================================================================= #
+  # === do_not_use_readline
+  # ========================================================================= #
+  def do_not_use_readline
+    @internal_hash[:try_to_use_readline] = false
+  end
+
+  # ========================================================================= #
+  # === enable_readline
+  # ========================================================================= #
+  def enable_readline
+    @internal_hash[:try_to_use_readline] = true
+    try_to_use_readline
+  end
+
+  # ========================================================================= #
+  # === show_modtime_of
+  # ========================================================================= #
+  def show_modtime_of(i)
+    e "The modification time of #{sfile(i)} is:"
+    e
+    e '  '+sfancy(ftp_connection?.modification_time_of?(i))
+    e
+  end
+
+  # ========================================================================= #
+  # === debug_it
+  # ========================================================================= #
+  def debug_it # debug tag
+    ftp_connection?.debug(true)
+    # pp ftp_connection?.array_file_listing
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    @internal_hash[:debug]
+  end
+
+  # ========================================================================= #
+  # === set_local_directory
+  # ========================================================================= #
+  def set_local_directory(
+      i = return_pwd
+    )
+    i = i.to_s.dup
+    i << '/' unless i.end_with? '/'
+    i = FtpParadise.rds(i)
+    @internal_hash[:local_directory] = i
+  end
+
+  # ========================================================================= #
+  # === password?
+  # ========================================================================= #
+  def password?
+    FtpParadise.password?
+  end
+
+  # ========================================================================= #
+  # === toggle_modes
+  # ========================================================================= #
+  def toggle_modes
+    case ftp_transfer_mode?
+    when :ascii
+      set_transfer_mode :binary
+    else
+      set_transfer_mode :ascii
+    end
+    e transfer_mode?.to_s
+  end
+
+  # ========================================================================= #
+  # === this_remote_entry_exists?
+  # ========================================================================= #
+  def this_remote_entry_exists?(i)
+    does_it_exist = false
+    does_it_exist = true if is_dir?  i # This will also check whether it exists.
+    does_it_exist = true if is_file? i
+    return does_it_exist
+  end
+
+  # ========================================================================= #
+  # === show_date_sorted_entries
+  #
+  # This method will show the sorted entries of the given remote directory
+  # at hand.
+  # ========================================================================= #
+  def show_date_sorted_entries
+    dataset = ftp_connection?.array_file_listing?
+    reverse_sort_dateset = dataset.sort_by {|_a,_b_,_c, timestamp|
+      timestamp
+    }.reverse
+    ftp_connection?.show_remote_listing(reverse_sort_dateset)
+  end
+
+  # ========================================================================= #
+  # === upload                                                 (upload tag)
+  #
+  # Use this method to upload something locally to the remote site.
+  #
+  # You can also upload several files in one go - to do this, try
+  # one of these ways:
+  #
+  #   upload 7,8 # This would upload file position 7 and 8.
+  #   upload 1..293
+  #
+  # ========================================================================= #
+  def upload(
+      i = Dir['*']
+    )
+    # ======================================================================= #
+    # We will always work with an Array past the following point.
+    # ======================================================================= #
+    i = [i].flatten.compact # Safeguard against nil.
+    if i.empty?
+      i << file? if file?
+    end
+    i.map! {|entry|
+      if entry.include?('-') and !entry.include?('.') # Assume a range was given like 1-20.
+        splitted = entry.split('-')
+        entry = (splitted[0] .. splitted[1]).to_a
+      elsif entry.include?('..') # Assume a range such as: upload 1..25
+        entry =~ /(\d+)\.\.(\d+)/
+        start_position = $1.to_s.dup.to_i 
+        end_position   = $2.to_s.dup.to_i
+        entry = return_local_files[start_position, end_position]
+      elsif entry.include?(',')
+        splitted = i.split(',')
+        entry = (splitted[0] .. splitted[1]).to_a
+      elsif (entry == 'ALL') or (entry == '*')
+        entry = Dir['*']
+      elsif entry.include?('*.') or entry.include?('*')
+        entry = Dir[entry]
+      end
+      entry
+    }
+    i.flatten!
+    i.compact!
+    if on_roebe? and !is_connected?
+      connect_to :shevy
+    end
+    i.each {|this_file|
+      if this_file =~ /^\d+$/ # upload only a specific number.
+        sorted = Dir['*'].sort
+        if i.is_a? Array
+          i = i.first
+        end
+        this_file = sorted[i.to_i - 1]
+      end
+      _ = this_file # default to upload to 'all'
+      if File.exist?(_)
+
+        # =================================================================== #
+        # Next, some files will always be in binary mode. These are
+        # defined in the Array ARRAY_BINARY_FILES.
+        # =================================================================== #
+        if ARRAY_BINARY_FILES.include?(File.extname(_).delete('.')) and
+          (ftp_transfer_mode? != :binary)
+          use_binary_mode
+        end
+        case ftp_transfer_mode?
+        # =================================================================== #
+        # === :ascii
+        # =================================================================== #
+        when :ascii
+          set_file(_)
+          ftp_connection?.upload(_) # And now, call the functionality in the FTP lib.
+        else
+          ftp_connection?.upload_binary(_)
+        end
+      else
+        opne swarn('But the file `')+
+             sfile(_)+
+             swarn('` does not exist.')
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === display_configuration_options                       (show config tag)
+  #
+  # This method will show the configuration settings.
+  #
+  # You can invoke this in an interactive FTP session by doing this:
+  #
+  #   config?
+  #
+  # ========================================================================= #
+  def display_configuration_options # Config tag.
+    cliner {
+      if file?.to_s.empty?
+        e '@file is: unassigned as of yet'
+      else
+        e '@file is: '+sfancy(file?.to_s)
+      end
+      e '@internal_hash[:local_directory] is: '+
+         sfancy(@internal_hash[:local_directory].to_s)
+      e '@splitted is: '+sfancy(splitted?.to_s)
+      e 'Will we use the Readline module? '+
+        sfancy(verbose_truth(use_readline?))
+      e 'Will we show full names (with full path)? '+
+         sfancy(verbose_truth(show_full_names?))
+      e 'What is the base directory? '+
+         sfancy(config?.base_directory.to_s)
+    }
+  end
+
+  # ========================================================================= #
+  # === load_config
+  #
+  # This method will load the configuration for this class.
+  # ========================================================================= #
+  def load_config
+    #FtpParadise.yaml_directory?
+    # @config = ::Roebe::Configuration::Configuration.new(FtpParadise.yaml_directory?)
+    @internal_hash[:config] = FtpParadise.configuration?
+    @internal_hash[:open_in_default_editor] = OPEN_IN_DEFAULT_EDITOR
+    if config?.has_entry? 'open_in_default_editor'
+      @internal_hash[:open_in_default_editor] = config?.open_in_default_editor
+    end
+    if config?.respond_to? :debug
+      @internal_hash[:debug] = config?.debug # Obtain (or rather, overrule) the @debug variable.
+    end
+  end
+
+  # ========================================================================= #
+  # === open_in_default_editor?
+  # ========================================================================= #
+  def open_in_default_editor?
+    @internal_hash[:open_in_default_editor]
+  end
+
+  # ========================================================================= #
+  # === config?
+  # ========================================================================= #
+  def config?
+    @internal_hash[:config]
+  end
+
+  # ========================================================================= #
+  # === enable_anonymous_login
+  #
+  # We use this method to enable anonymous logins.
+  # ========================================================================= #
+  def enable_anonymous_login
+    opne 'We will enable anonymous login now.'
+    set_password :anonymous
+    set_user_name 'anonymous'
+  end
+
+  # ========================================================================= #
+  # === ftp_transfer_mode?
+  #
+  # ftp_transfer_mode is a Symbol, hence we will not apply .to_s on it.
+  # ========================================================================= #
+  def ftp_transfer_mode?
+    return @internal_hash[:ftp_transfer_mode]
+  end; alias mode? ftp_transfer_mode? # === mode?
+
+  # ========================================================================= #
+  # === disable
+  # ========================================================================= #
+  def disable(i = nil)
+    i = i.to_s.to_sym
+    case i
+    # ======================================================================= #
+    # === :base_directory
+    # ======================================================================= #
+    when :base_directory,
+         :full_names
+      do_not_show_full_names
+    # ======================================================================= #
+    # === :debug
+    # ======================================================================= #
+    when :debug
+      config?.debug = false
+      ftp_connection?.disable_debug
+      save_config
+    end
+    e 'Disabling '+sfancy(i.to_s)+' now.' unless i.to_s.empty?
+  end
+
+  # ========================================================================= #
+  # === show_which_files_we_did_download_so_far
+  # ========================================================================= #
+  def show_which_files_we_did_download_so_far
+    if array_downloaded_files?.empty?
+      e 'We did not yet download any file.'
+    else
+      e 'We downloaded these files so far:'
+      pp array_downloaded_files?
+    end
+  end
+
+  # ========================================================================= #
+  # === report_local_directory
+  #
+  # Use only this method when reporting the local directory.
+  # ========================================================================= #
+  def report_local_directory
+    e 'The local directory is: '+N+
+       @internal_hash[:padding_to_use]+
+       sdir(return_pwd)
+  end; alias report_local_dir report_local_directory # === report_local_dir
+
+  # ========================================================================= #
+  # === move_remote_file
+  #
+  # We expect an Array as input.
+  #
+  # To test this method, do:
+  #
+  #   rmv DONE_Prüfungsfragen_Hartig_Einheiten_2_3_5_9_10_11_12_15_16_21.pdf PDFs/
+  #   mmv vimrc vim
+  #
+  # ========================================================================= #
+  def move_remote_file(i)
+    from = i[0]
+    to   = i[1]
+    if is_directory?(to)
+      to << '/' unless to.end_with? '/'
+      to << File.basename(from)
+    end
+    e 'Next moving from '+sfancy(from)+' to '+sfancy(to)+'.'
+    ftp_connection?.move_file(from, to)
+  end
+
+  # ========================================================================= #
+  # === disconnect
+  #
+  # Disconnect the remote connection by invoking the quit() method on
+  # the FTP object.
+  # ========================================================================= #
+  def disconnect(be_verbose = true)
+    if ftp_connection?.did_we_connect?
+      e 'Disconnected from `'+coloured_remote_host?+'`.' if be_verbose
+    end
+    ftp_connection?.quit
+    exit
+  end
+
+  # ========================================================================= #
+  # === set_remote_directory
+  # ========================================================================= #
+  def set_remote_directory(i)
+    i = File.dirname(i) if ftp_connection?.is_file?(i) # Get the base directory here.
+    @internal_hash[:remote_directory] = i
+    @internal_hash[:array_history_remote_directories] << @internal_hash[:remote_directory]
+  end
+
+  # ========================================================================= #
+  # === remote_change_directory
+  #
+  # This method can be used to change directory on the remote host.
+  #
+  # An argument such as :show_remote_file_listing can be passed as second
+  # argument to this method, in which case we will list the content of
+  # the remote directory after the cd-action.
+  #
+  # If readline is used, as determined by the instance variabl
+  # @internal_hash[:try_to_use_readline] then we will attempt
+  # to cd-<TAB>.
+  #
+  # Invocation example:
+  #
+  #   rcd htdocs
+  #
+  # ========================================================================= #
+  def remote_change_directory(
+      i                    = f?,
+      optional_instruction = nil,
+      be_verbose           = false
+    )
+    i = i.first if i.is_a? Array
+    i = '..' if i.nil? # ← Tiny "safeguard".
+    # ======================================================================= #
+    # We must first check whether we input only numbers,
+    # and whether such a directory does NOT exist. 
+    # ======================================================================= #
+    if (i =~ /^\d+$/) and !is_dir?(i)
+      ftp_connection?.update_file_listing
+      i = ftp_connection?.array_file_listing[i.to_i - 1]
+    end
+    if be_verbose
+      e "Trying to cd into the remote directory `#{sfancy(i)}`."
+    end
+    case i # case tag
+    when '?' # intercept ?
+      e 'You went into these remote directories so far:'
+      @internal_hash[:array_history_remote_directories].each { |entry|
+        e "- #{entry}"
+      }
+    else # This is the default.
+      if i
+        i.squeeze!('/') if i.include? '//' # Get rid of multiple //.
+        e "Changing remote directory to `#{sdir(i)}` now."
+      end
+      begin
+        ftp_connection?.chdir(i)
+        set_remote_directory(i)
+        if optional_instruction
+          case optional_instruction
+          when :show_remote_file_listing
+            show_remote_files
+          end
+        end
+      rescue Exception => error
+        pp error
+      end
+    end
+  end; alias remote_cd remote_change_directory # === remote_cd
+
+  # ========================================================================= #
+  # === create_directory
+  #
+  # This method will create a local directory.
+  # ========================================================================= #
+  def create_directory(
+      i, be_verbose = false
+    )
+    be_verbose = true if be_verbose == :be_verbose
+    e 'Now creating local directory '+sdir(i)+'.' if be_verbose
+    FileUtils.mkdir_p(i)
+  end
+
+  # ========================================================================= #
+  # === show_colours
+  # ========================================================================= #
+  def show_colours # Use this to show the colours.
+    pp Colours.colours?
+  end
+
+  # ========================================================================= #
+  # === return_local_entries
+  #
+  # Returns all local entries.
+  # ========================================================================= #
+  def return_local_entries
+    entries = Dir['*']
+    entries = Dir[return_pwd+'*'] if show_full_names? # Overrule in this case.
+    return entries
+  end
+
+  # ========================================================================= #
+  # === remote_directory?
+  # ========================================================================= #
+  def remote_directory?
+    @internal_hash[:remote_directory]
+  end
+
+  # ========================================================================= #
+  # === upload_directory
+  # ========================================================================= #
+  def upload_directory(i)
+    ftp_connection?.upload_directory(i)
+  end
+
+  # ========================================================================= #
+  # === upload_this_file
+  # ========================================================================= #
+  def upload_this_file(
+      i = f?
+     )
+    if i.is_a? Array
+      i.each {|entry| upload_this_file(entry) }
+    else
+      e "Trying to upload this file `#{sfile(i)}` next:"
+      ftp_connection?.puttextfile(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === coloured_remote_host?
+  # ========================================================================= #
+  def coloured_remote_host?
+    sfancy(remote_host?)
+  end
+
+  # ========================================================================= #
+  # === stat_remote_file                                           (stat tag)
+  #
+  # This method can be called via '?33' for instance, or via 'stat 33'.
+  # ========================================================================= #
+  def stat_remote_file(i)
+    file = ftp_connection?[i] # Obtain that file.
+    matches = ftp_connection?.array_file_listing.select {|key,value| key == file }
+    matches.each { |entry|
+      e '  '+entry[0]+': '+sfancy(entry[2]+' KB')
+    }
+  end
+
+  # ========================================================================= #
+  # === has_unwanted_file_suffix?
+  #
+  # The following method will return true or false.
+  #
+  # I needed it so that the editor does not open every file that was
+  # thrown at it.
+  # ========================================================================= #
+  def has_unwanted_file_suffix?(i)
+    return_value = false
+    case File.extname(i).delete('.')
+    when 'xz'
+      return_value = true
+    end
+    return return_value
+  end
+
+  # ========================================================================= #
+  # === set_password
+  # ========================================================================= #
+  def set_password(
+      i, be_verbose = be_verbose?
+    )
+    i = i.to_s
+    if be_verbose
+      e "Setting password to #{sfancy(i)} now."
+    end
+    FtpParadise.set_password(i)
+  end
+
+  # ========================================================================= #
+  # === set_editor
+  # ========================================================================= #
+  def set_editor(
+      i, be_verbose = true
+    )
+    i = i.first if i.is_a? Array
+    if be_verbose
+      opnn; e "Now using the editor called `#{sfancy(i)}`."
+    end
+    @internal_hash[:use_this_editor] = i
+  end
+
+  # ========================================================================= #
+  # === use_this_editor?
+  # ========================================================================= #
+  def use_this_editor?
+    @internal_hash[:use_this_editor]
+  end
+
+  # ========================================================================= #
+  # === try_to_use_readline?
+  # ========================================================================= #
+  def try_to_use_readline?
+    @internal_hash[:try_to_use_readline]
+  end
+
+  # ========================================================================= #
+  # === connection?
+  # ========================================================================= #
+  def connection?
+    @internal_hash[:connection]
+  end; alias ftp?            connection? # === ftp?
+       alias ftp_object?     connection? # === ftp_object?
+       alias ftp_connection? connection? # === ftp_connection?
+
+  # ========================================================================= #
+  # === change_local_and_remote_directories
+  #
+  # We combine local cd and remote cd here.
+  # ========================================================================= #
+  def change_local_and_remote_directories(
+      target = DEFAULT_LOCAL_DIRECTORY
+    )
+    change_directory(target, :be_silent) # Mandatory since as of 01.05.2011
+    if are_we_connected?
+      remote_change_directory(target) # Since as of August 2011.
+    end
+  end
+
+  # ========================================================================= #
+  # === set_file
+  #
+  # Use only this method to assign the @instance_variable[:file]
+  # variable.
+  # ========================================================================= #
+  def set_file(i = nil)
+    if i # Safeguard against nil.
+      i = i.first if i.is_a? Array
+      i = i.to_s
+      i = return_pwd+i if !i.include?('/') # Since Dec 2011 we try to use only the absolute path.
+      unless File.exist?(i)
+        i << '.c' unless i.include? '.' # Append .c to files, unless the file exists.
+      end
+      i = FtpParadise.rds(i)
+    end
+    @internal_hash[:file] = i # This is the only allowed way to modify @file.
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    cliner_violet
+    e "Try one of these #{sfancy('help options')} for interactive-ftp:#{N}#{N}"
+    e parens(:assign)+'     '+pound_token+'Assign to the '\
+      '@internal_hash[:file] variable'
+    e parens(:help)+'       '+pound_token+'To see the help section'
+    e parens(:history)+'    '+pound_token+'To show the history'
+    e parens(:cd)+'         '+pound_token+'Change local directory'
+    e parens(:config)+'     '+pound_token+'Show the configuration'
+    e parens(:dated)+'      '+pound_token+'Display the remote directory '\
+      'content in a time-sorted manner'
+    e parens(:edit)+'       '+pound_token+'Edit this file here in your main editor'
+    e parens(:everything)+' '+pound_token+'Show everything (username, password, host and so on)'
+    e parens(:login)+'      '+pound_token+'Connect to the remote host (alias '\
+      'to connect_to exists)'
+    e parens(:list)+'       '+pound_token+'List remote files'
+    e parens(:last)+'       '+pound_token+'Repeat the last action (or show the last action)'
+    e parens(:rcd)+'        '+pound_token+'Change remote directory'
+    e parens(:remote?)+'    '+pound_token+'List where we are connected'
+    e parens(:stat)+'       '+pound_token+'Show information about a file'
+    e parens(:status?)+'    '+pound_token+'See the current status of the connection'
+    e parens(:file?)+'      '+pound_token+'Shows whether we have a '+
+      'default file set (which can be used to upload)'
+    e parens(:info)+'       '+pound_token+'Shows some information (debug)'
+    e parens(:set_port)+'   '+pound_token+'Set the port number'
+    e parens(:q)+'          '+pound_token+'To quit/exit'
+    e parens(:quit)+'       '+pound_token+'Quit the session'
+    if on_roebe? # Display it only for me.
+      e parens(:shevy)+'      '+pound_token+'Connect to shevy'
+    end
+    e parens(:lpwd)+'       '+pound_token+'Report the current remote directory'
+    e parens(:pwd)+'        '+pound_token+'Report the local directory'+N
+    e parens(:welcome)+'    '+pound_token+'Show the welcome-message of the remote FTP server'+N
+    e
+    cliner_violet
+  end; alias show_help_options show_help # === show_help_options
+
+  # ========================================================================= #
+  # === set_passive
+  # ========================================================================= #
+  def set_passive(
+      be_verbose = false
+    )
+    if be_verbose
+      e 'Enabling passive mode for FTP.'
+    end
+    ftp_object?.passive = true if are_we_connected?
+  end
+
+  # ========================================================================= #
+  # === connected_to?
+  #
+  # Feedback where we are connected to.
+  # ========================================================================= #
+  def connected_to?
+    if ftp_connection?.open?
+      report_where_we_are_connected_to
+      report_remote_directory # Added Dec 2011.
+      # report_local_dir
+      # unless ftp?.empty?
+      #   e 'The remote file listing is:'
+      #   show_remote_listing
+      # end # Disabled the above chunk as of Apr 2017.
+    else
+      e 'We are not connected to any remote FTP server currently.'
+    end
+  end
+
+  # ========================================================================= #
+  # === rename
+  #
+  # This will attempt a remote rename-action.
+  # ========================================================================= #
+  def rename(a, b)
+    begin
+      a = convert_number_to_file(a)
+      ftp_connection?.rename(a, b)
+    rescue Net::FTPPermError
+      e "The file at #{sfile(a)} does not seem to exist - thus, "\
+        "we can not rename it."
+    end
+  end
+
+  # ========================================================================= #
+  # === reset_instance_variables_that_hold_all_arguments
+  #
+  # Use this method to initialite the instance variables that will hold
+  # the arguments to methods, from the user input.
+  # ========================================================================= #    
+  def reset_instance_variables_that_hold_all_arguments
+    @internal_hash[:splitted] =
+      @internal_hash[:first_argument] = 
+        @internal_hash[:all_arguments] = nil
+  end
+
+  # ========================================================================= #
+  # === report_last_response_code
+  # ========================================================================= #
+  def report_last_response_code
+    e 'The last response code was: '+
+       simp(ftp_connection?.last_response_code.to_s)
+  end
+
+  # ========================================================================= #
+  # === do_show_full_names
+  # ========================================================================= #
+  def do_show_full_names
+    ftp_connection?.show_full_names = true
+    config?.show_full_names = true # Sync.
+  end
+
+  # ========================================================================= #
+  # === will_we_show_full_names
+  # ========================================================================= #
+  def will_we_show_full_names
+    e 'Will we now show full names? '+
+      verbose_truth(show_full_names?)
+  end
+
+  # ========================================================================= #
+  # === report_last_response
+  # ========================================================================= #
+  def report_last_response
+    e 'The last response was: '+
+      simp(ftp_connection?.last_response.to_s)
+  end
+
+  # ========================================================================= #
+  # === check_commandline_arguments                         (commandline tag)
+  #
+  # This is called from within method enter_loop().
+  # ========================================================================= #
+  def check_commandline_arguments(
+      i = @commandline_arguments
+    )
+    if i.is_a?(String) and i.include?(',') # Here we assume a chained-instruction.
+      i = i.split(',')
+    end
+    i = [i].flatten.compact
+    i.each {|entry|
+      case entry
+      when '',nil # Do nothing in this case.
+      when '--disable-colours','--disable-colors','nocolours','nocol',
+           /^-?-?nocol$/
+        e 'Now disabling colours.'
+        FtpParadise.disable_colours
+      when *ARRAY_HELP_OPTIONS
+        show_commandline_help
+        exit
+      when 'BINARY'
+        set_binary :be_verbose
+      else
+        entry = entry.to_s
+        if File.exist?(entry)
+          set_file(entry)
+          @commandline_arguments.reject! {|line|
+            line.include? entry
+          }
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === consider_reporting_file
+  # ========================================================================= #
+  def consider_reporting_file
+    if file?.empty?
+      e 'No file has been assigned yet.'
+      e 'You can set a specific file via '+simp('"set_file"')+'.'
+    else
+      report_file
+    end
+  end
+
+  # ========================================================================= #
+  # === all_arguments?
+  #
+  # The alias a? may be an easier wrapper over the variable
+  # @internal_hash[:all_arguments].
+  # ========================================================================= #
+  def all_arguments?
+    @internal_hash[:all_arguments]
+  end; alias a? all_arguments? # === a?
+
+  # ========================================================================= #
+  # === try_to_chmod_this_remote_file
+  # ========================================================================= #
+  def try_to_chmod_this_remote_file(
+      filename, chmod_value_to_use = '0777'
+    )
+    e "Trying to chmod the remote file #{filename} next."
+    ftp_connection?.sendcmd("SITE CHMOD #{chmod_value_to_use} #{filename}")
+  end
+
+  # ========================================================================= #
+  # === set_name
+  # ========================================================================= #
+  def set_name(i)
+    i = i.to_s
+    e 'Setting user-name to `'+sfancy(i)+'` now.'
+    ftp_connection?.set_user_name(i)
+  end; alias set_user_name set_name # === set_user_name
+
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = ARGV)
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === change_directory                                             (cd tag)
+  #
+  # This only changes for local directories, not remote directories.
+  # ========================================================================= #
+  def change_directory(
+      i          = DEFAULT_LOCAL_DIRECTORY,
+      be_verbose = true
+    )
+    i = '..' if i.nil?
+    be_verbose = false if be_verbose == :be_silent
+    i = i.to_s
+    i.gsub!(/; pwd/,'') if i.include? '; pwd'
+    begin
+      i = get_env_of(i) if i.include? '$'
+      if File.exist?(i)
+        # =================================================================== #
+        # Next, do the actual "change directory" action.
+        # =================================================================== #
+        Dir.chdir(i) # This will cd for local directories.
+        i = return_pwd if i == '..'
+        i = rds(return_pwd) unless i.include? '/'
+        set_local_directory(i) # Set the new pwd here.
+        report_local_directory if be_verbose
+      else # else, the directory does not exist.
+        e swarn('But the directory '+sdir(i)+' does not exist '\
+          'locally in '+sdir(return_pwd)+'.')
+      end
+    rescue Exception => error
+      e "An exception occurred in #{swarn('change_directory()')}"
+      e "The directory `#{sdir(i)}` does not exist."
+      pp error # Should remove this and error perhaps.
+    end
+  end; alias cd change_directory # === cd
+
+  # ========================================================================= #
+  # === remote_create_directory
+  # ========================================================================= #
+  def remote_create_directory(
+      i          = a?,
+      be_verbose = true
+    )
+    if i.is_a? Array
+      i.each {|entry| remote_create_directory(entry, be_verbose) }
+    else
+      # ===================================================================== #
+      # Delegate towards the respective module-method next.
+      # ===================================================================== #
+      if be_verbose
+        e "Creating the directory #{sdir(i)} next:"
+      end
+      FtpParadise.remote_create_directory(i, ftp_connection?)
+    end
+  end
+
+  # ========================================================================= #
+  # === set_start_directory=
+  # ========================================================================= #
+  def set_start_directory=(i) # set_start_directory=(i)
+    change_directory(i)
+  end
+
+  # ========================================================================= #
+  # === toplevel_login_name?
+  # ========================================================================= #
+  def toplevel_login_name?
+    FtpParadise.login_name?
+  end
+
+  # ========================================================================= #
+  # === remote_remove_file
+  # ========================================================================= #
+  def remote_remove_file(
+      i = first_argument_for_the_menu_interface?
+    )
+    if i.is_a? Array
+      i.each {|entry| remote_remove_file(entry) }
+    else
+      e "Trying to remove `#{sfile(i)}` next:"
+      ftp_connection?.delete(i)
+    end
+  end; alias remote_remove_files remote_remove_file # === remote_remove_files
+
+  # ========================================================================= #
+  # === show_local_files
+  #
+  # This method shows the local file listing. That is, all the entries in
+  # the given directory.
+  # ========================================================================= #
+  def show_local_files(show_only_directories = true)
+    _ = return_pwd
+    if Dir.entries(_).size == 2 # Dir.empty?, we assume that we have '.' and '..' only
+      e "The directory `#{sdir(_)}` is empty."
+    else
+      e 'Showing local files now from `'+sdir(_)+'`:'
+      e ('=' * 55)+' '+FtpParadise.yellow('LOCAL FILES')+' '+('=' * 12)
+      entries = return_local_entries
+      entries.reject! {|x| ! File.directory?(x) } if show_only_directories
+      entries.sort.each_with_index { |item, index|
+        case File.ftype(item)
+        when 'directory'
+          item = sdir(item+'/')
+        when 'file'
+          item = sfile(item)
+        end
+        e '('+('%2s' % (index+1).to_s)+') '+FtpParadise.rds(item)
+      }
+      cliner
+    end
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === first_argument_for_the_menu_interface?
+  # ========================================================================= #
+  def first_argument_for_the_menu_interface?
+    @internal_hash[:first_argument]
+  end
+
+  # ========================================================================= #
+  # === ftp_remote_directory?
+  # ========================================================================= #
+  def ftp_remote_directory?
+    ftp_connection?.remote_directory?
+  end; alias return_remote_pwd ftp_remote_directory? # === return_remote_pwd
+
+  # ========================================================================= #
+  # === remote_url?
+  # ========================================================================= #
+  def remote_url?
+    FtpParadise.remote_url?.to_s
+  end; alias remote_host? remote_url? # === remote_host?
+
+  # ========================================================================= #
+  # === show_remote_directories
+  # ========================================================================= #
+  def show_remote_directories
+    e "The remote directories at "\
+      "#{sdir(remote_host?)}#{sdir(return_remote_pwd)} are:"
+    e
+    ftp_connection?.return_remote_directories.each_with_index {|dir, index|
+      index += 1
+      e index.to_s.rjust(3)+') '+sdir(dir)
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === populate_the_ftp_dataset_with_default_values
+  # ========================================================================= #
+  def populate_the_ftp_dataset_with_default_values
+    FtpParadise.determine_user_dataset_from_this_hash(
+      YAML.load_file(FtpParadise.my_yaml_file), :default
+    )
+  end
+
+  # ========================================================================= #
+  # === try_to_use_readline
+  #
+  # This method will try to use the readline module.
+  #
+  # It ought to be called before the method menu() is invoked.
+  # ========================================================================= #
+  def try_to_use_readline
+    begin
+      require 'readline' # Using readline since August 2011.
+      setup_readline_completion
+    rescue LoadError
+      # ===================================================================== #
+      # In this case the user can not use the readline-module.
+      # ===================================================================== #
+      do_not_use_readline
+    end
+  end; alias consider_using_the_readline_module try_to_use_readline # === consider_using_the_readline_module
+
+  # ========================================================================= #
+  # === setup_readline_completion
+  #
+  # Call this method to invoke completion support.
+  # ========================================================================= #
+  def setup_readline_completion
+    Readline.completion_case_fold = true # Ignore case on tab-completion.
+    Readline.completer_word_break_characters = "\n"
+    Readline.completion_append_character = ' '
+    # ======================================================================= #
+    # Act on Readline's completion functionality here.         (readline tag)
+    #
+    # We will respond to these events specifically:
+    #
+    #   - rcd
+    #   - cd
+    #   - upload
+    #   - download
+    #
+    # ======================================================================= #
+    Readline.completion_proc = proc {|input|
+      _ = []
+      case input # case tag
+      # ===================================================================== #
+      # To test it, do:
+      #   rcd AUS<TAB>
+      # ===================================================================== #
+      when /^rcd/,
+           /^rcd /,
+           /^rc/,
+           'rchange_dir',
+           'lcd',
+           'remote_change_directory'
+        result = ftp_connection?.return_directories # This will return the remote directories only.
+        _ << result.map {|entry| input+' '+entry}
+      # ===================================================================== #
+      # === cd
+      # ===================================================================== #
+      when /^cd/,/^cd / # Fetch only directories.
+        _ << ftp_connection?.return_local_directories
+      when /^upload/    # Act on upload.
+        return_local_files.each { |array| _ << array }
+      when /^download/  # Act on download.
+        ftp_connection?.array_file_listing.each { |array| _ << array.first }
+      else # Default.
+        # _ << return_local_files # Disabled in June 2014 because it gives completions to things I did not ask for.
+      end
+      _ = _.flatten
+      _ # Return it here finally.
+    }
+  end
+
+  # ========================================================================= #
+  # === report_which_editor_is_in_use
+  # ========================================================================= #
+  def report_which_editor_is_in_use
+    opnn; e "The editor in use is `#{sfancy(use_this_editor?)}`."
+  end
+
+  # ========================================================================= #
+  # === set_port
+  #
+  # Use this method to set the port.
+  # ========================================================================= #
+  def set_port(
+      i = 21, be_verbose = false
+    )
+    if be_verbose
+      e "Setting port to #{sfancy(i)} now."
+    end
+    ftp_connection?.set_port(i)
+  end
+
+  # ========================================================================= #
+  # === display_file
+  #
+  # Use this method to quickly display a file in question.
+  # ========================================================================= #
+  def display_file(i)
+    if i and File.exist? i
+      e File.readlines(i).join
+    else
+      ewarn "File #{sfile(i)} does not exist."
+    end
+  end
+
+  # ========================================================================= #
+  # === report_version
+  # ========================================================================= #
+  def report_version
+    e sfancy(FtpParadise::VERSION)
+  end
+
+  # ========================================================================= #
+  # === set_url
+  # ========================================================================= #
+  def set_url(i)
+    ::FtpParadise.set_remote_host(i)
+  end
+
+  # ========================================================================= #
+  # === save_config
+  # ========================================================================= #
+  def save_config
+    config?.save
+  end
+
+  # ========================================================================= #
+  # === convert_number_to_file
+  #
+  # Use this to convert a number.
+  #
+  #   convert_number_to_file(i) if i =~ /^\d+$/
+  #
+  # ========================================================================= #
+  def convert_number_to_file(number)
+    number = number.to_s.chomp
+    if number =~ /^\d+$/ # if is a number
+      ftp_connection?.update_file_listing
+      number = ftp_connection?.array_file_listing[number.to_i - 1][0]
+    end
+    return number
+  end
+
+  # ========================================================================= #
+  # === ftp_dataset?
+  # ========================================================================= #
+  def ftp_dataset?
+    FtpParadise.dataset?
+  end
+
+  # ========================================================================= #
+  # === initialize_the_dataset_for_bplaced
+  # ========================================================================= #
+  def initialize_the_dataset_for_bplaced
+    FtpParadise.determine_user_dataset_from_this_hash(
+      YAML.load_file(FILE_ROEBE_FTP)['bplaced']
+    )
+  end
+
+  # ========================================================================= #
+  # === use_ascii_mode
+  # ========================================================================= #
+  def use_ascii_mode(
+      be_verbose = false
+    )
+    e 'Using ascii mode now.' if be_verbose
+    set_transfer_mode :ascii
+  end
+
+  # ========================================================================= #
+  # === s?
+  # ========================================================================= #
+  def s?
+    @internal_hash[:second_argument]
+  end
+
+  # ========================================================================= #
+  # === opne
+  # ========================================================================= #
+  def opne(message)
+    opnn; e message
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(i = {namespace: NAMESPACE, use_colours: use_colours?})
+    Opn.opn(i)
+  end
+
+  # ========================================================================= #
+  # === remote_remove
+  #
+  # Use this if you wish to remove a remote file or a remote directory.
+  # ========================================================================= #
+  def remote_remove(i)
+    if i.is_a? Array
+      i.each {|entry| remote_remove(entry) }
+    else
+      i = i.to_s.strip # Added as of July 2014.
+      i = File.basename(i) if i.include? '/'
+      # ===================================================================== #
+      # The user may input numbers. If the input is a number, we will try to
+      # find the corresponding entry - but only if no remote directory or
+      # remote file exists with that name. Some directories may be named,
+      # e. g. "123456".
+      # ===================================================================== #
+      unless this_remote_entry_exists? i
+        i = convert_number_to_file(i) if i =~ /^\d+$/
+      end
+      # ===================================================================== #
+      # Next check for user input. If the user did input a '*', then we
+      # will expand that.
+      # ===================================================================== #
+      if i.include?('*') or i.include?('*.')
+        i = ftp_connection?.array_file_listing.select {|entry|
+          entry[0].include? i.delete('*')
+        }
+        i.reject! {|line|
+          line == '.' or line == '..' # Reject '.' and '..' entries.
+        }
+        i.map! {|entry|
+          File.basename(entry)
+        } # ^^^ This is a bit hackish.
+        remote_remove(i)
+      else
+        # =================================================================== #
+        # We try to find out whether we have a directory or a file next.
+        # =================================================================== #
+        if is_dir?(i)
+          remove_remote_directory(i)
+        else # Assume it is a file. 
+          remove_remote_file(i)
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === remove_remote_file
+  #
+  # Use this method to attempt remove a remote file.
+  # ========================================================================= #
+  def remove_remote_file(i)
+    i[0,1] = ''.dup if i.start_with? '/' # We don't like starting "/" characters here.
+    e "Removing remote file `#{sfile(i)}` next." # We remove the remote file here.
+    begin
+      result = ftp_connection?.remove_file(i)
+      e "Successfully removed remote file `#{sfile(result)}`."
+    rescue Net::FTPPermError => error
+      e 'Can not remove file `'+sfile(i)+'` as you are not '\
+        'the owner. ('+simp('Net::FTPPermError')+')'
+      pp error
+    end
+  end
+
+  # ========================================================================= #
+  # === set_transfer_mode
+  #
+  # Set the mode here. We default to :ascii mode.
+  #
+  # There are only two valid modes:
+  #
+  #   :ascii
+  #   :binary
+  #
+  # ========================================================================= #
+  def set_transfer_mode(
+      i = :ascii
+    )
+    @internal_hash[:ftp_transfer_mode] = i
+    ftp_connection?.set_transfer_mode(
+      i, :be_quiet # Cascade the variable down into ftp_lib.rb.
+    )
+  end; alias set_mode set_transfer_mode # === set_mode
+
+  # ========================================================================= #
+  # === set_run_mode
+  #
+  # This will set the run-mode. The run-mode can be either :standalone or
+  # :connected.
+  # ========================================================================= #
+  def set_run_mode(
+      i = :standalone
+    )
+    @internal_hash[:run_mode] = i
+  end
+
+  # ========================================================================= #
+  # === change
+  #
+  # This method can be used to change the main transfer mode.
+  # ========================================================================= #
+  def change(i)
+    case i
+    # ======================================================================= #
+    # === mode
+    # ======================================================================= #
+    when 'mode' # Change the mode that we use.
+      use_binary_mode
+    end
+  end
+
+  # ========================================================================= #
+  # === use_binary_mode
+  #
+  # This enables use the binary mode.
+  # ========================================================================= #
+  def use_binary_mode(
+      be_verbose = false
+    )
+    case be_verbose
+    when :be_quiet
+      be_verbose = false
+    when :be_verbose
+      be_verbose = true
+    end
+    e 'Using binary mode now.' if be_verbose
+    set_transfer_mode :binary
+  end; alias set_binary use_binary_mode # === set_binary
+
+  # ========================================================================= #
+  # === do_use_binary_mode
+  # ========================================================================= #
+  def do_use_binary_mode
+    use_binary_mode(:be_quiet)
+  end
+
+  # ========================================================================= #
+  # === vte
+  # ========================================================================= #
+  def vt(i)
+    VerboseTruth[i].to_s
+  end
+
+  # ========================================================================= #
+  # === f?
+  # ========================================================================= #
+  def f?
+    @internal_hash[:first_argument] # First argument. Keep in mind that the second argument is stored in @s.
+  end; alias f f? # === f
+
+  # ========================================================================= #
+  # === show_remote_files
+  #
+  # Use this method to show all remote files on a FTP site.
+  # ========================================================================= #
+  def show_remote_files(
+      mode = nil
+    ) # Show the content of the remote host.
+    ftp_connection?.show_remote_files
+  end
+
+  # ========================================================================= #
+  # === show_hosts
+  # ========================================================================= #
+  def show_hosts
+    e "The available hosts are:#{N}#{N}"
+    ftp_connection?.array_available_hosts.each {|host|
+      e simp("  #{host}")
+    }; e
+  end
+
+  # ========================================================================= #
+  # === remove_local
+  # ========================================================================= #
+  def remove_local(i)
+    delete(i)
+  end
+
+  # ========================================================================= #
+  # === remove_remote_directory
+  #
+  # Use this method to remove a remote directory.
+  # ========================================================================= #
+  def remove_remote_directory(i)
+    e "Removing remote directory `#{sdir(i)}` next."
+    # ======================================================================= #
+    # Delegate to ftp?. :force_remove so we remove even non-empty directories.
+    # ======================================================================= #
+    ftp_connection?.remove_directory(i, :force_remove)
+  end
+
+  # ========================================================================= #
+  # === toggle                                                 (toggle tag)
+  #
+  # Simply toggle the value for whether we @config.show_full_names or not.
+  # ========================================================================= #
+  def toggle(
+      i = :names
+    )
+    i = i.to_s
+    i = 'mode' if i.empty? # Safeguard.
+    case i
+    # ======================================================================= #
+    # === mode
+    # ======================================================================= #
+    when 'mode'
+      case ftp_transfer_mode?
+      when :binary
+        use_ascii_mode
+      else
+        use_binary_mode
+      end
+    when 'names','name'
+      toggle_show_full_names
+      will_we_show_full_names
+    end
+    e 'We will now toggle '+sfancy(i)+' to '+simp(ftp_transfer_mode?.to_s)+'.'
+  end; alias show_full_names toggle # === show_full_names
+
+  # ========================================================================= #
+  # === show_user_and_password
+  # ========================================================================= #
+  def show_user_and_password
+    ftp_connection?.show_user_and_password
+  end
+
+  # ========================================================================= #
+  # === create_remote_directory
+  # ========================================================================= #
+  def create_remote_directory(i)
+    ftp_connection?.mkdir(i)
+  end
+
+  # ========================================================================= #
+  # === return_remote_files
+  #
+  # We call into FtpParadise::Connection here.
+  # ========================================================================= #
+  def return_remote_files(mode = nil)
+    ftp_connection?.show_full_names if show_full_names? # Display the full path here.
+    ftp_connection?.return_remote_files
+  end
+
+  # ========================================================================= #
+  # === display_prompt
+  # ========================================================================= #
+  def display_prompt
+    print PROMPT_TO_USE
+  end
+
+  # ========================================================================= #
+  # === download?
+  # ========================================================================= #
+  def download?
+    e 'The remote file we would download is: '
+    e
+    e "  #{sfile(DEFAULT_REMOTE_FILE)}"
+    e
+  end
+
+  # ========================================================================= #
+  # === do_login
+  #
+  # If the first argument is :dont_login_yet, which is the default,
+  # we will not yet connect.
+  # ========================================================================= #
+  def do_login(
+      i = :dont_login_yet
+    )
+    i = nil if i == :dont_login_yet
+    if i
+      # ===================================================================== #
+      # Next, feed this information to the ftp? object.
+      # ===================================================================== #
+      ftp_connection?.set_data(i)
+      ftp_connection?.do_login # bl $RUBY_FTP/ftp_library.rb
+      # @internal_hash[:are_we_connected] = true
+    end
+  end
+
+  # ========================================================================= #
+  # === report_remote_directory
+  #
+  # This method will report the remote directory.
+  # ========================================================================= #
+  def report_remote_directory(
+      make_newline = true
+    )
+    if is_connected?
+      remote_dir = sdir(ftp_remote_directory?)
+      if make_newline
+        e 'The remote directory is: '
+        e "  #{sdir(remote_dir)}"
+      else
+        e 'The remote directory is: '+sdir(remote_dir)
+      end
+    else
+      e 'No connection is available. You may have to re-connect again.'
+    end
+  end; alias show_remote_directory report_remote_directory # === show_remote_directory
+
+  # ========================================================================= #
+  # === show_host_user_name_port_and_password
+  # ========================================================================= #
+  def show_host_user_name_port_and_password
+    ftp_connection?.show_host_user_name_port_and_password
+  end
+
+  # ========================================================================= #
+  # === show_full_names?
+  # ========================================================================= #
+  def show_full_names?
+    config?.show_full_names
+  end
+
+  # ========================================================================= #
+  # === obtain_user_input
+  #  
+  # This method will obtain user input from the user, and assign it to
+  # the corresponding variable that keeps track of user input given.
+  # ========================================================================= #
+  def obtain_user_input(
+      shall_we_use_readline = try_to_use_readline?
+    )
+    if shall_we_use_readline
+      user_input = Readline.readline('', true)
+      Readline::HISTORY.pop if user_input.strip.empty?
+    else
+      user_input = $stdin.gets.chomp
+    end
+    # ======================================================================= #
+    # Get rid of potential '#' comments in the input next.
+    # ======================================================================= #
+    if user_input.include? '#'
+      user_input = user_input[0 .. user_input.index('#') - 1]
+    end
+    user_input.strip! # Get rid of ' ' empty characters.
+    unless user_input.empty? # append to history.
+      try_to_append_this_to_the_history(user_input)
+    end
+    # ======================================================================= #
+    # If the user did input a ';' character then we will assume that he
+    # wants to send multiple commands. We will however NOT assume so
+    # if the string also includes a 'http://' - in that case, we assume
+    # a HTTP URL instead. Since as of July 2022 we just check for the
+    # keyword "http".
+    # ======================================================================= #
+    if user_input.include?(';') and !user_input.include?('http')
+      user_input = user_input.split(';')
+    else
+      user_input = [user_input] # In this case simply turn it into an Array. 
+    end
+    # ======================================================================= #
+    # The @internal_hash[:user_input] variable should always be an Array.
+    # ======================================================================= #
+    @internal_hash[:user_input] = user_input
+  end; alias get_user_input   obtain_user_input # === get_user_input
+       alias fetch_user_input obtain_user_input # === fetch_user_input
+
+  # ========================================================================= #
+  # === user_input?
+  # ========================================================================= #
+  def user_input?
+    @internal_hash[:user_input]
+  end
+
+  # ========================================================================= #
+  # === return_title
+  # ========================================================================= #
+  def return_title
+    sfancy(TITLE)
+  end
+
+  # ========================================================================= #
+  # === try_to_append_this_to_the_history
+  #
+  # Right now only 'last' is a forbidden entry.
+  # ========================================================================= #
+  def try_to_append_this_to_the_history(i)
+    unless i.empty?
+      @internal_hash[:history] << i unless ARRAY_FORBIDDEN_HISTORY_COMMANDS.include? i
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_user_dataset_from_this_hash
+  #
+  # This method can set relevant entries from an input Hash.
+  # ========================================================================= #
+  def determine_user_dataset_from_this_hash(
+      i,
+      optional_use_this_entry = :default
+    )
+    FtpParadise.determine_user_dataset_from_this_hash(i, optional_use_this_entry)
+  end
+
+  # ========================================================================= #
+  # === enter_the_main_loop
+  # ========================================================================= #
+  def enter_the_main_loop(
+      shall_we_use_readline = try_to_use_readline?
+    )
+    check_commandline_arguments # ← This will also query the menu() method.
+    loop {
+      begin
+        # =================================================================== #
+        # Obtain the user input next:
+        # =================================================================== #
+        obtain_user_input
+      rescue Interrupt
+        e 'In order to quit, please use "'+
+          steelblue('q')+'" instead.'
+      end
+      menu(user_input?)
+      if @internal_hash[:may_we_exit]
+        break if exit_the_program_properly == :break
+      end
+    }
+  end; alias enter_loop enter_the_main_loop # === enter_loop
+
+  # ========================================================================= #
+  # === exit_the_program_properly                                  (exit tag)
+  # ========================================================================= #
+  def exit_the_program_properly # Use only this method to exit i-ftp.
+    e "Bye from #{return_title}!"
+    case @internal_hash[:run_mode]
+    when :standalone # Not embedded.
+      @internal_hash[:run_mode] = :exit
+      disconnect
+      exit
+    else
+      @internal_hash[:run_mode] = :break
+      return @internal_hash[:run_mode]
+    end
+  end
+
+  # ========================================================================= #
+  # === show_remote_listing
+  #
+  # This will display the remote file listing.
+  # ========================================================================= #
+  def show_remote_listing
+    ftp_connection?.show_remote_listing
+  end
+
+  # ========================================================================= #
+  # === report_where_we_are_connected_to
+  # ========================================================================= #
+  def report_where_we_are_connected_to
+    if are_we_connected?
+      e 'We are connected to: '+simp(ftp_connection?.remote?)
+    else
+      e 'We are not connected. Invoke "do_connect" to connect to a FTP host.'
+    end
+  end
+
+  # ========================================================================= #
+  # === are_we_connected?
+  # ========================================================================= #
+  def are_we_connected?
+    ftp_connection?.are_we_connected?
+  end; alias is_connected? are_we_connected? # === is_connected?
+
+  # ========================================================================= #
+  # === is_dir?
+  #
+  # Return true or false, depending on whether the input is a directory
+  # or whether it is not.
+  # ========================================================================= #
+  def is_dir?(i)
+    ftp_connection?.is_directory?(i)
+  end; alias is_directory? is_dir? # === is_directory?
+
+  # ========================================================================= #
+  # === is_file?
+  # ========================================================================= #
+  def is_file?(i)
+    ftp_connection?.is_file?(i)
+  end
+
+  # ========================================================================= #
+  # === show_status
+  # ========================================================================= #
+  def show_status
+    cliner {
+      # e
+      # show_help # ← Disabled as of May 2017.
+      e
+      report_where_we_are_connected_to
+      report_remote_directory # Added Dec 2011.
+      report_local_dir
+      # debug_it
+      e
+    }
+  end
+
+  # ========================================================================= #
+  # === show_title
+  #
+  # Use this method to give us the title
+  # ========================================================================= #
+  def show_title
+    e return_title
+  end
+
+  # ========================================================================= #
+  # === pass_commandline_arguments_into_the_menu
+  # ========================================================================= #
+  def pass_commandline_arguments_into_the_menu
+    menu(commandline_arguments?)
+  end
+
+  # ========================================================================= #
+  # === do_login_to_shevy_and_consider_showing_the_remote_files
+  # ========================================================================= #
+  def do_login_to_shevy_and_consider_showing_the_remote_files
+    do_login(:shevy)
+    if SHOW_REMOTE_FILES_UPON_SUCCESSFUL_LOGIN
+      show_remote_files :also_show_filesize # Also display this since as of March 2015.
+    end
+  end
+
+  # ========================================================================= #
+  # === show_commandline_help
+  #
+  # This method is different from "normal" help. The "normal" help will
+  # be displayed when we are already running in interactive mode. The
+  # commandline help however had will be run when we are invoking it
+  # from the commandline.
+  # ========================================================================= #
+  def show_commandline_help
+    opne 'These options are currently supported:'
+    opn(use_colours?); Colours.ecomment '  --disable-colours # Run without colours.'
+  end
+
+  # ========================================================================= #
+  # === show_welcome_message
+  #
+  # The initial startup message to welcome the user.
+  # ========================================================================= #
+  def show_welcome_message
+    e 'Welcome to the '+return_title+' shell.'
+    e 'Input '+sfancy('"help"')+' to show the help-section.' 
+    e 'Please input commands next:'
+  end
+
+  # ========================================================================= #
+  # === file?
+  #
+  # This may always be a String.
+  # ========================================================================= #
+  def file?
+    @internal_hash[:file].to_s
+  end
+
+  # ========================================================================= #
+  # === open_this_file_in_editor           (edit tag, editor tag, open tag)
+  #
+  # If you pass as first argument to this method the string 'ALL', we
+  # will try to open the (local) project files in your editor.
+  #
+  # To test this, do:
+  #
+  #   open ALL
+  #   open YAML
+  #
+  # ========================================================================= #
+  def open_this_file_in_editor(
+      this_file = file?
+    )
+    this_file = ARRAY_PROJECT_FILES if this_file.nil?
+    if this_file.is_a? Array
+      this_file.each {|entry| open_this_file_in_editor(entry) }
+    else
+      this_file = this_file.to_s
+      if this_file == 'TODO'
+        this_file = ARRAY_PROJECT_FILES.select {|entry| entry.include? 'TODO' }[0]
+      end
+      if this_file.to_s =~ /^\d+$/ # If only numbers were given.
+        this_file = Dir['*'].sort[this_file.to_i - 1]
+      end
+      this_file = NAME_OF_THIS_FILE if this_file.empty?
+      if this_file == 'ALL' and ! File.exist?('ALL')
+        open_this_file_in_editor(ARRAY_PROJECT_FILES)
+      elsif this_file == 'YAML' and ! File.exist?('YAML')
+        open_this_file_in_editor(YAML_FILE)
+      else
+        _ = use_this_editor?+" #{this_file}"
+        if File.exist?(this_file) && File.file?(this_file)
+          unless has_unwanted_file_suffix?(this_file)
+            e 'Loading '+sfile(this_file)+' in editor '+
+              'now as '+simp('USE_THIS_EDITOR')+' was set '+
+              'to true:'
+            e '  '+_+' &'
+            `#{_}`
+          end
+          set_file(this_file) # Since 24.12.2011 we also assign it.
+        else
+          e swarn('But the file `')+sfile(this_file)+
+            swarn('` does not exist.')
+        end
+      end
+    end
+  end; alias open_in_editor open_this_file_in_editor # === open_in_editor
+
+  # ========================================================================= #
+  # === report_port
+  # ========================================================================= #
+  def report_port
+    e 'The port in use is: '+sfancy(ftp?.port)
+  end
+
+  # ========================================================================= #
+  # === get_env_of
+  # ========================================================================= #
+  def get_env_of(i)
+    ConvertGlobalEnv.convert(i, ConvertGlobalEnv.report_errors?)
+  end
+
+  # ========================================================================= #
+  # === show_ftp_server_welcome
+  #
+  # Simply show the FTP server's welcome message.
+  # ========================================================================= #
+  def show_ftp_server_welcome
+    e ftp_connection?.welcome
+  end
+
+  # ========================================================================= #
+  # === try_to_connect
+  # ========================================================================= #
+  def try_to_connect
+    hash = FtpParadise.info?
+    connection?.connect_via_this_dataset(hash)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    try_to_create_a_temporary_log_directory_and_cd_into_it_or_the_temp_directory
+    shall_we_use_readline = try_to_use_readline? 
+    try_to_use_readline if shall_we_use_readline
+    if is_on_roebe?
+      populate_the_ftp_dataset_with_default_values
+      FtpParadise.use_this_as_ftp_object(ftp_connection?)
+      ftp_connection?.enable_debug if debug? # Set the @debug variable inside of @ftp to true.
+      if automatically_connect_on_startup_of_the_interactive_ftp_shell?
+        try_to_connect
+        set_passive
+        use_ascii_mode
+      end
+      # ===================================================================== #
+      # Enter the remote directory htdocs if we are on ftpupload.net
+      # or on a similar host.
+      # ===================================================================== #
+      if remote_url?.include?('ftpupload.net')
+        remote_cd 'htdocs', :be_verbose
+      elsif remote_url?.include?('shevy.bplaced.net')
+        remote_cd 'www', :be_verbose
+      end
+    end
+    # ======================================================================= #
+    # The welcome message should come before the main loop is started and
+    # before the prompt is shown.
+    # ======================================================================= #
+    show_welcome_message
+    pass_commandline_arguments_into_the_menu # ← Must come before startup_actions().
+    display_prompt # Must come once before we enter the main loop.
+    enter_the_main_loop
+  end
+
+  # ========================================================================= #
+  # === FtpParadise::Shell[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end; self.instance_eval { alias interactive_shell [] } # === FtpParadise.interactive_shell
+
+end
+
+# =========================================================================== #
+# === FtpParadise.shell
+#
+# This is a convenience method to instantiate a new class
+# FtpParadise::Shell instance.
+# =========================================================================== #
+def self.shell(i = ARGV)
+  FtpParadise::Shell.new(i)
+end; self.instance_eval { alias interactive shell } # === FtpParadise.interactive
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise::Shell.new(ARGV)
+end # iftp