ftp_paradise 1.3.8

data/lib/ftp_paradise/connection/reset.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/reset.rb'
+# =========================================================================== #
+require 'ftp_paradise/connection/port.rb'
+require 'ftp_paradise/connection/set_array_available_hosts.rb'
+require 'ftp_paradise/connection/transfer_mode.rb'
+require 'ftp_paradise/connection/username.rb'
+
+module FtpParadise
+
+class Connection < Base
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @input
+    # ======================================================================= #
+    @input = nil
+    # ======================================================================= #
+    # === @ftp_object
+    # ======================================================================= #
+    @ftp_object = nil
+    populate_internal_hash_with_default_values
+    # ======================================================================= #
+    # The next method-call must come after
+    # populate_internal_hash_with_default_values().
+    # ======================================================================= #
+    set_be_verbose if BE_VERBOSE
+    set_port
+    set_array_available_hosts
+    set_default_transfer_mode :be_quiet
+    set_username
+  end
+
+  # ========================================================================= #
+  # === populate_internal_hash_with_default_values
+  # ========================================================================= #
+  def populate_internal_hash_with_default_values
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :port
+    #
+    # The internal Hash keeps track of some configure-settings and slots
+    # to be used that are of relevance to this class.
+    # ======================================================================= #
+    @internal_hash[:port] = nil     # Has to be nil initially.
+    @internal_hash[:be_verbose] = nil
+    @internal_hash[:raw_entries] = nil
+    @internal_hash[:file] = nil
+    @internal_hash[:transfer_mode] = :binary
+    @internal_hash[:show_full_names] = false # Is false on startup.
+    @internal_hash[:debug] = false
+    @internal_hash[:array_available_hosts] = []
+    # ======================================================================= #
+    # === :padding
+    # ======================================================================= #
+    @internal_hash[:padding] = '  ' # This padding value is used for remote directory listing.
+    # ======================================================================= #
+    # The following Array keeps track over the files that were uploaded 
+    # successfully. This gives us the possibility to query this from other
+    # classes.
+    # ======================================================================= #
+    @internal_hash[:uploaded_these_files] = []
+  end
+
+end; end

data/lib/ftp_paradise/connection/run.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/run.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < FtpParadise::Base
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    do_connect
+  end
+
+end; end

data/lib/ftp_paradise/connection/set_array_available_hosts.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/set_array_available_hosts.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  # ========================================================================= #
+  # === set_array_available_hosts
+  #
+  # Use this method if you wish to define the available hosts. This is
+  # useful whenever you already have some pre-defined hosts that you wish
+  # to use.
+  # ========================================================================= #
+  def set_array_available_hosts(i = nil)
+    if Object.const_defined? :RoebeFtpConstants
+      i = ARRAY_AVAILABLE_HOSTS
+    else
+      i = []
+    end
+    @internal_hash[:array_available_hosts] = i
+  end
+
+end; end

data/lib/ftp_paradise/connection/set_input.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/set_input.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < FtpParadise::Base
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i)
+    @input = i
+  end
+
+end; end

data/lib/ftp_paradise/connection/show.rb

@@ -0,0 +1,153 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/show.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  # ========================================================================= #
+  # === show_remote_directory_listing
+  #
+  # This will simply show the content of a remote directory.
+  #
+  # Invocation examples:
+  #
+  #   show_remote_directory_listing
+  #   show_remote_directory_listing :default, :show_only_directories
+  #
+  # ========================================================================= #
+  def show_remote_directory_listing(
+      i             = list,
+      array_options = []
+    )
+    unless array_options.is_a? Array
+      array_options = [array_options]
+    end
+    case i
+    when :default
+      i = list
+    end
+    if i.is_a? Array
+      # ===================================================================== #
+      # Get rid of '.' and '..'.
+      # ===================================================================== #
+      i.reject! {|entry| entry.end_with?('..') or entry.end_with?('.') }
+      # ===================================================================== #
+      # First, turn them into entries.
+      # ===================================================================== #
+      i.map! {|entry| FtpParadise::Entry.new(entry) }
+      # ===================================================================== #
+      # Next, we can use different behaviours.
+      # ===================================================================== #
+      if array_options.include? :show_only_directories
+        i.select! {|entry| entry.is_a_directory? }
+      end
+      i.each {|entry| entry.show_the_line }
+    end
+  end; alias show_remote_files show_remote_directory_listing # === show_remote_files
+
+  # ========================================================================= #
+  # === show_full_names?
+  # ========================================================================= #
+  def show_full_names?
+    @internal_hash[:show_full_names]
+  end
+
+  # ========================================================================= #
+  # === show_remote_listing
+  #
+  # Use this method whenever you want to show the remote entries.
+  #
+  # As of June 2016, you can pass in your own dataset into this method
+  # as well. It must conform to the Array with the four entries, which
+  # is also returned via the method sanitized_remote_directory_content?.
+  # ========================================================================= #
+  def show_remote_listing(
+      dataset    = sanitized_remote_directory_content?,
+      be_verbose = be_verbose?
+    )
+    n_rjust = 10
+    _ = dataset
+    if show_full_names?
+      _.map! {|entry|
+        filename = entry[0]
+        entry[0] = remote_pwd?+filename # This is the file size.
+        entry
+      }
+    end
+    _.each_with_index { |array, index|
+      if be_verbose # Display only when in verbose mode, which is the default.
+        file_or_directory = array[1]
+        name_of_the_file = array.first
+        # =================================================================== #
+        # Get a pointer to the filesize as well.
+        # =================================================================== #
+        filesize = array[2].to_s.rjust(n_rjust)
+        if file_or_directory == 'directory'
+          name_of_the_file << '/' unless name_of_the_file.end_with? '/'
+        end
+        # =================================================================== #
+        # === Put a proper padding to the index
+        # =================================================================== #
+        new_index = (index+1).to_s.rjust(_.size.to_s.size)
+        n_pad = 125
+        case file_or_directory
+        when 'directory' # Display for directories.
+          name_of_the_file = sdir(name_of_the_file)
+          e (padding?+sdir(new_index+') ')+name_of_the_file).ljust(n_pad)+' '+
+            filesize
+        else
+          e (padding?+sfancy(new_index+') ')+sfancy(name_of_the_file)).ljust(n_pad)+' '+
+            filesize
+        end
+      end
+    }
+  end; alias show_file_listing        show_remote_listing # === show_file_listing
+       alias show_remote_file_listing show_remote_listing # === show_remote_file_listing
+
+  # ========================================================================= #
+  # === show_remote_directories
+  # ========================================================================= #
+  def show_remote_directories
+    show_remote_directory_listing :default, :show_only_directories
+  end
+
+  # ========================================================================= #
+  # === show_full_names=
+  # ========================================================================= #
+  def show_full_names=(i = true)
+    @internal_hash[:show_full_names] = i
+  end; alias show_full_names show_full_names= # === show_full_names
+
+  # ========================================================================= #
+  # === show_user_and_password
+  # ========================================================================= #
+  def show_user_and_password
+    ljust = 12
+    e
+    e ('User-Name: ').ljust(ljust)+sfancy(user_name?.to_s)
+    e ('Password: ' ).ljust(ljust)+sfancy(password?)
+    e
+  end; alias show_user_name_and_password show_user_and_password # === show_user_name_and_password
+
+  # ========================================================================= #
+  # === show_host_user_name_port_and_password
+  #
+  # Inform us about the basic settings.
+  # ========================================================================= #
+  def show_host_user_name_port_and_password(
+      do_use_spacer_around_the_output = true
+    )
+    ljust = 15
+    e if do_use_spacer_around_the_output
+    e ('Host: '     ).ljust(ljust)+sfancy(host?)
+    e ('User-Name: ').ljust(ljust)+sfancy(user_name?.to_s)
+    e ('Port: '     ).ljust(ljust)+sfancy(port?)
+    e ('Password: ' ).ljust(ljust)+sfancy(password?)
+    e if do_use_spacer_around_the_output
+  end
+
+end; end

data/lib/ftp_paradise/connection/sync_ftp_object_onto_the_main_namespace.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/sync_ftp_object_onto_the_main_namespace.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < FtpParadise::Base
+
+  require 'ftp_paradise/connection/ftp_object.rb'
+  require 'ftp_paradise/toplevel_methods/ftp_object.rb'
+
+  # ========================================================================= #
+  # === sync_ftp_object_onto_the_main_namespace
+  #
+  # Invoke this method only after having made sure that ftp_object?
+  # returns a non-nil object.
+  # ========================================================================= #
+  def sync_ftp_object_onto_the_main_namespace
+    FtpParadise.ftp_object = self
+  end
+
+end; end

data/lib/ftp_paradise/connection/transfer_mode.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/transfer_mode.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  # ========================================================================= #
+  # === set_passive_mode
+  #
+  # Use this when modifying the passive setting.
+  # ========================================================================= #
+  def set_passive_mode
+    set_transfer_mode :ascii
+    ftp_object?.passive = true if ftp_object?
+  end; alias set_passive set_passive_mode # === set_passive
+
+  # ========================================================================= #
+  # === set_default_transfer_mode
+  # ========================================================================= #
+  def set_default_transfer_mode(
+      be_verbose = :be_quiet
+    )
+    set_transfer_mode(DEFAULT_TRANSFER_MODE, be_verbose)
+  end
+
+  # ========================================================================= #
+  # === set_transfer_mode
+  #
+  # This method will set to either one of two different possibles modes:
+  #
+  #   (1) :ascii
+  #   (2) :binary
+  #   (3) :passive
+  #
+  # Note that :passive "mode" is ascii, with an additional invocation to
+  # change the transfer mode to .passive.
+  #
+  # It will also change passive mode. The argument :default will default
+  # to the more commonly used ASCII mode.
+  #
+  # When would you want to use ASCII mode?
+  #
+  # Use ascii mode for:
+  #
+  #   txt, rtf, html, php
+  #
+  # Use binary mode for:
+  #
+  #   images, videos and similar.
+  #
+  # ========================================================================= #
+  def set_transfer_mode(
+      i          = DEFAULT_TRANSFER_MODE, # Will usually default to :ascii
+      be_verbose = be_verbose?
+    )
+    case be_verbose
+    when :be_verbose
+      be_verbose = true
+    when :be_quiet
+      be_verbose = false
+    end
+    i = :ascii if i == :default
+    case i
+    # ======================================================================= #
+    # === :ascii
+    # ======================================================================= #
+    when :ascii
+      notify_the_user_about(i, __method__) if be_verbose
+      @internal_hash[:transfer_mode] = :ascii
+      ftp_object?.binary = false if ftp_object?
+    # ======================================================================= #
+    # === :binary
+    # ======================================================================= #
+    when :binary
+      notify_the_user_about(i, __method__) if be_verbose
+      @internal_hash[:transfer_mode] = :binary
+    # ======================================================================= #
+    # === :passive
+    # ======================================================================= #
+    when :passive, :pass
+      notify_the_user_about(i, __method__) if be_verbose
+      @internal_hash[:transfer_mode] = :ascii
+      ftp_object?.passive = true if ftp_object?
+    else
+      opnn; e swarn('Not found the following mode: ')+
+              sfancy(i.to_s)
+    end
+  end; alias mode_to_use= set_transfer_mode # === mode_to_use=
+       alias set_mode     set_transfer_mode # === set_mode
+
+  # ========================================================================= #
+  # === report_transfer_mode_in_use
+  # ========================================================================= #
+  def report_transfer_mode_in_use
+    e "Transfer mode: #{sfancy(transfer_mode?.to_s)}"
+  end
+
+  # ========================================================================= #
+  # === set_active
+  # ========================================================================= #
+  def set_active
+    ftp_object?.passive = false
+  end
+  
+  # ========================================================================= #
+  # === passive_transfer?
+  # ========================================================================= #
+  def passive_transfer?
+    ftp_object?.passive
+  end; alias passive? passive_transfer? # === passive?
+
+  # ========================================================================= #
+  # === transfer_mode?
+  #
+  # This method will return the currently used transfer_mode. This mode
+  # can be either :binary, or :ascii. By default it will be :binary.
+  #
+  # The transfer mode can be :binary or :text. :ascii is an alias to
+  # :text.
+  # ========================================================================= #
+  def transfer_mode?
+    @internal_hash[:transfer_mode]
+  end; alias transfer_mode transfer_mode? # === transfer_mode
+       alias mode?         transfer_mode? # === mode?
+       alias type          transfer_mode? # === type
+       alias type?         transfer_mode? # === type?
+
+  # ========================================================================= #
+  # === set_ascii
+  #
+  # Easier wrapper method.
+  # ========================================================================= #
+  def set_ascii
+    set_transfer_mode :ascii
+  end; alias set_ascii_mode set_ascii # === set_ascii_mode
+
+  # ========================================================================= #
+  # === binary?
+  #
+  # When this is true, then then all FTP-transfers will be performed in
+  # binary mode.
+  #
+  # Deaults to true.
+  # ========================================================================= #
+  def binary?
+    ftp_object?.binary
+  end; alias binary binary? # === binary
+
+  # ========================================================================= #
+  # === set_binary_mode
+  # ========================================================================= #
+  def set_binary_mode
+    set_transfer_mode :binary
+    ftp_object?.binary = true
+  end; alias set_binary         set_binary_mode # === set_binary
+       alias set_to_binary_mode set_binary_mode # === set_to_binary_mode
+
+end; end