ftp_paradise 1.4.5

data/lib/ftp_paradise/interactive_ftp/reset.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/reset.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp # === FtpParadise::InteractiveFtp
+
+  require 'ftp_paradise/interactive_ftp/misc.rb'
+  require 'ftp_paradise/interactive_ftp/readline.rb'
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  #
+  # Initialize and/or reset the variables used in this class.
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # The following check is for my home system.
+    # ======================================================================= #
+    if File.exist? FILE_ROEBE_FTP
+      dataset = YAML.load_file(FILE_ROEBE_FTP)
+      determine_user_dataset_from_this_hash(dataset, :default)
+    end
+    # ======================================================================= #
+    # === @user_input
+    #
+    # Must "initialize" @user_input.
+    # ======================================================================= #
+    @user_input = nil
+    # ======================================================================= #
+    # Which files we did download so far.
+    # ======================================================================= #
+    @array_downloaded_files = []
+    # ======================================================================= #
+    # === @array_all_input
+    # ======================================================================= #
+    @array_all_input = [] # Stores which was the input.
+    # ======================================================================= #
+    # === @history
+    # ======================================================================= #
+    @history = []
+    # ======================================================================= #
+    # === @array_history_remote_directories
+    #
+    # This array keeps a listing of all remote directories we rcd-ed into.
+    # ======================================================================= #
+    @array_history_remote_directories = []
+    # ======================================================================= #
+    # === @debug
+    #
+    # Whether we will debug or not, by default.
+    # ======================================================================= #
+    @debug = SHALL_WE_DEBUG
+    # ======================================================================= #
+    # === @are_we_connected
+    # ======================================================================= #
+    @are_we_connected = false
+    # ======================================================================= #
+    # === @pad
+    # ======================================================================= #
+    @pad = '  ' # The default padding to use.
+    # ======================================================================= #
+    # === @use_readline
+    #
+    # Initially we will try to make use of the Readline module.
+    # ======================================================================= #
+    @use_readline = true
+    # ======================================================================= #
+    # === @use_this_editor
+    #
+    # Specify which editor we may use - this can be overruled in the
+    # interactive menu by the user of the FtpParadise project.
+    # ======================================================================= #
+    @use_this_editor = USE_THIS_EDITOR
+    # ======================================================================= #
+    # Try to make use of the Readline module as well.
+    # ======================================================================= #
+    consider_using_the_readline_module
+    reset_instance_variables_that_hold_all_arguments
+    set_file
+    set_local_directory
+    load_config
+    initialize_ftp_object # Initialize the @ftp variable.
+  end
+
+end; end

data/lib/ftp_paradise/interactive_ftp/run.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/run.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp # === FtpParadise::InteractiveFtp
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    set_passive :be_verbose
+    pass_commandline_arguments_into_the_menu # <- Must come before startup_actions().
+    startup_actions
+    do_login # Next, login.
+    enter_main_loop
+  end
+
+end; end

data/lib/ftp_paradise/interactive_ftp/show.rb

@@ -0,0 +1,184 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/show.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp
+
+  # ========================================================================= #
+  # === show_remote_directories
+  # ========================================================================= #
+  def show_remote_directories
+    e "The remote directories at #{sdir(return_remote_pwd)} are:"
+    e
+    ftp?.return_remote_directories.each_with_index {|dir, index|
+      index += 1
+      e index.to_s.rjust(3)+') '+sdir(dir)
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === 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?.show_remote_files
+  end
+
+  # ========================================================================= #
+  # === show_hosts
+  # ========================================================================= #
+  def show_hosts
+    e "The available hosts are:#{N}#{N}"
+    ftp?.array_available_hosts.each {|host|
+      e simp("  #{host}")
+    }; e
+  end
+
+  # ========================================================================= #
+  # === show_remote_listing
+  #
+  # This will display the remote file listing.
+  # ========================================================================= #
+  def show_remote_listing
+    ftp?.show_remote_listing
+  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
+
+  # ========================================================================= #
+  # === 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:"
+    @history.each_with_index { |key, index|
+      e '%3s' % (index+1).to_s+' '+key
+    }
+  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
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === 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_modtime_of
+  # ========================================================================= #
+  def show_modtime_of(i)
+    e "The modification time of #{sfile(i)} is:"
+    e
+    e '  '+sfancy(ftp?.modification_time_of?(i))
+    e
+  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 '@local_directory is: '+sfancy(@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
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === 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
+
+end; end

data/lib/ftp_paradise/interactive_ftp/upload.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/upload.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp # === FtpParadise::Interactive
+
+  # ========================================================================= #
+  # === 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
+          (@mode != :binary)
+          use_binary_mode
+        end
+        case @mode
+        when :ascii
+          set_file(_)
+          ftp?.upload(_) # And now, call the functionality in the FTP lib.
+        else
+          ftp?.upload_binary(_)
+        end
+      else
+        opne swarn('But the file `')+
+             sfile(i)+
+             swarn('` does not exist.')
+      end
+    }
+  end
+
+end; end

data/lib/ftp_paradise/interactive_ftp/user_input.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/user_input.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp # === FtpParadise::InteractiveFtp
+
+  # ========================================================================= #
+  # === obtain_user_input
+  #  
+  # This method will obtain user input, and assign it to the variable
+  # @user_input.
+  # ========================================================================= #
+  def obtain_user_input
+    if @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.
+    # ======================================================================= #
+    if user_input.include? '#'
+      user_input = user_input[0 .. user_input.index('#')-1]
+    end
+    user_input.strip! # Get rid of ' ' empty characters.
+    _ = user_input
+    unless _.empty? # append to history.
+      try_to_append_this_to_the_history(_)
+    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.
+    # ======================================================================= #
+    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 @user_input variable should always be an Array.
+    # ======================================================================= #
+    @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
+
+end; end

data/lib/ftp_paradise/project/project.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# require 'ftp_paradise/project/project.rb'
+# =========================================================================== #
+module FtpParadise
+
+  _ = File.absolute_path("#{__dir__}/..")+'/'
+ 
+  # ========================================================================= #
+  # === PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  begin # We need to make it failsafe.
+    PROJECT_BASE_DIRECTORY = (
+      File.realpath(_)+'/'
+    ).squeeze '/'
+  rescue
+    puts 'An error happened. We will hardcode the constant towards -> '+_
+    PROJECT_BASE_DIRECTORY = # Else default to my directory.
+      '/home/x/DATA/PROGRAMMING_LANGUAGES/RUBY/src/'\
+      'ftp_paradise/lib/ftp_paradise/'
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    PROJECT_BASE_DIRECTORY
+  end
+
+  # ========================================================================= #
+  # === PROJECT_YAML_DIRECTORY
+  #
+  # This constant specifies where the project-specific yaml/ directory
+  # will be kept at for the ftp_paradise project. Ideally you should
+  # use the method rather than this constant, though.
+  # ========================================================================= #
+  PROJECT_YAML_DIRECTORY = "#{PROJECT_BASE_DIRECTORY}yaml/"
+          YAML_DIRECTORY = PROJECT_YAML_DIRECTORY
+
+  # ========================================================================= #
+  # === FtpParadise.project_yaml_dir?
+  #
+  # This method here must be defined before FtpParadise.initialize()
+  # is to be invoked.
+  # ========================================================================= #
+  def self.project_yaml_dir?
+    "#{PROJECT_BASE_DIRECTORY}yaml/"
+  end; self.instance_eval { alias yaml_directory? project_yaml_dir? } # === FtpParadise.yaml_directory?
+
+  # ========================================================================= #
+  # === yaml_directory?
+  # ========================================================================= #
+  def yaml_directory?
+    FtpParadise.yaml_directory?
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp FtpParadise.project_base_dir?
+  pp FtpParadise.project_yaml_dir?
+end