ftp_paradise 1.4.5 → 1.5.4

data/lib/ftp_paradise/connection/data.rb

@@ -1,164 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/data.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  require 'ftp_paradise/constants/roebe.rb'
-
-  # ========================================================================= #
-  # === set_data                                   (all in one, set_data tag)
-  #
-  # This method sets:
-  #
-  #   - host
-  #   - user name
-  #   - port and
-  #   - password
-  #
-  # This method is thus a nifty little convenience method. You can pass
-  # a hash to it too, which is the recommended way to use this method.
-  #
-  # You can also use an Array (with 4 elements), in which case we will
-  # process it one after the other. The reason for this procedure is
-  # because we can also use yaml files that way, that also use the
-  # exact order of elements.
-  #
-  # If you add a new entry to the case menu below, also add this to 
-  # ARRAY_AVAILABLE_HOSTS, please. That Array can be found in the
-  # file 'constants/roebe_ftp_constants.rb'.
-  # ========================================================================= #
-  def set_data(
-      i = 'default'
-    ) # set the default here.
-    if debug?
-      opnn; e 'We will debug next, as the @debug variable was set to true.'
-      pp i
-    end
-    # ======================================================================= #
-    # === Handle Hash as input first
-    # ======================================================================= #
-    if i.is_a? Hash # Hash is treated differently.
-
-      # ===================================================================== #
-      # === :host
-      # ===================================================================== #
-      if   i.has_key? :host
-        set_host i.fetch(:host)
-      elsif i.has_key? :remote_host
-        set_host i.fetch(:remote_host)
-      elsif i.has_key? :to # :to is an alias to :host.
-        set_host i.fetch(:to)
-      end      
-
-      # ===================================================================== #
-      # === :user_name
-      # ===================================================================== #
-      if    i.has_key? :user_name
-        set_user_name i.fetch(:user_name)
-      elsif i.has_key? :login_name
-        set_user_name i.fetch(:login_name)
-      end
-
-      # ===================================================================== #
-      # === :password
-      # ===================================================================== #
-      if i.has_key? :password
-        set_password i.fetch(:password)
-      elsif i.has_key? :login_password
-        set_password i.fetch(:login_password)
-      end
-
-      # ===================================================================== #
-      # === :port
-      # ===================================================================== #
-      if i.has_key? :port
-        set_port i.fetch(:port)
-      end
-    # ======================================================================= #
-    # === Handle Array as input next
-    # ======================================================================= #
-    elsif i.is_a? Array # Example-Array: ["ftp.byethost33.com", "b33_14144659", "1aaaaaa", 21]
-      set_host      i.first
-      set_user_name i[1]
-      set_password  i[2]
-      set_port      i[3]
-    # ======================================================================= #
-    # === Else, use simple toggle commands, such as 1,2,3,4,5 and so forth.
-    # ======================================================================= #
-    else # In the following case menu you can toggle your FTP.
-      case i.to_s # Work on strings only. Assumes shortcuts.
-      # ===================================================================== #
-      # === shevy
-      #
-      # This defaults to my home system.
-      # ===================================================================== #
-      when '6',
-           /shevy/i,
-           'square',
-           'square7',
-           'bplaced',
-           'podserver',
-           'default',
-           'top' # Current default.
-        _ = FILE_ROEBE_FTP
-        if File.exist? _
-          data = YAML.load_file(_)['podserver'] # 'bplaced'
-          set_host      data['url']
-          set_user_name data['user_name']
-          this_password = data['password']
-          this_password.chop! if this_password.end_with? '_'
-          set_password  this_password
-          set_port      data['port']
-        end
-      # ===================================================================== #
-      # === a1
-      # ===================================================================== #
-      when '1',
-           'a1',
-           'a1_ftp' # A1 FTP host. No longer in use but still kept.
-        set_host      A1.first
-        set_user_name A1[1]
-        set_password  A1[2]
-        set_port      A1[3]
-      # ===================================================================== #
-      # === zymix
-      # ===================================================================== #
-      when '2',
-           'zymix',
-           'standard'
-        set_host      ZYMIX.first
-        set_user_name ZYMIX[1]
-        set_password  ZYMIX[2]
-        set_port      ZYMIX[3]
-      # ===================================================================== #
-      # === uniwien
-      # ===================================================================== #
-      when '3',
-           'univie',
-           'uniwien' # Uni Wien FTP Account.
-        set_host      UNIVIE.first
-        set_user_name UNIVIE[1]
-        set_password  UNIVIE[2]
-        set_port      UNIVIE[3]
-      # ===================================================================== #
-      # === byte
-      # ===================================================================== #
-      when '4',
-           'byte',
-           'bytehost'
-        set_host      BYTEHOST.first
-        set_user_name BYTEHOST[1]
-        set_password  BYTEHOST[2]
-        set_port      BYTEHOST[3]
-      else
-        set_data(:default) # Go back to default again if not found.
-      end
-    end
-  end
-
-end; end

data/lib/ftp_paradise/connection/debug.rb

@@ -1,78 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/debug.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === set_debug
-  # ========================================================================= #
-  def set_debug(i = SHALL_WE_DEBUG)
-    @internal_hash[:debug] = i
-  end
-
-  # ========================================================================= #
-  # === enable_debug_mode
-  #
-  # When the debug mode is set to true, then all traffic to and from
-  # the server is written to $stdout. By default, this will NOT
-  # be the case.
-  # ========================================================================= #
-  def enable_debug_mode
-    ftp_object?.debug_mode = true
-  end
-
-  # ========================================================================= #
-  # === enable_debug
-  #
-  # Set the @debug variable to true, and also invoke enable_debug_mode().
-  # ========================================================================= #
-  def enable_debug
-    enable_debug_mode
-    set_debug(true)
-  end
-
-  # ========================================================================= #
-  # === debug?
-  # ========================================================================= #
-  def debug?
-    @internal_hash[:debug]
-  end
-
-  # ========================================================================= #
-  # === disable_debug
-  # ========================================================================= #
-  def disable_debug
-    ftp_object?.debug_mode = false
-    @internal_hash[:debug] = false
-  end
-
-  # ========================================================================= #
-  # === debug                                                     (debug tag)
-  #
-  # This method can be used for some debugging output.
-  # ========================================================================= #
-  def debug(
-      shall_we_debug = debug?
-    )
-    cliner {
-      pp ftp?
-      show_host_user_name_port_and_password
-      update_file_listing
-      if shall_we_debug
-        opnn; e 'File Listing:'
-        show_file_listing
-      end
-      if remote_file_listing?.empty?
-        opnn; e 'No file could be found. The remote directory '\
-                'is most likely empty.'
-      end
-    } if shall_we_debug
-  end; alias feedback debug # === feedback
-       alias report   debug # === report
-
-end; end

data/lib/ftp_paradise/connection/directory_handling.rb

@@ -1,271 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/directory_handling.rb' 
-# =========================================================================== #
-module FtpParadise
-         
-class Connection
-
-  require 'ftp_paradise/connection/remote_pwd.rb'
-  require 'ftp_paradise/connection/file_handling.rb'
-
-  # ========================================================================= #
-  # === report_current_remote_dir
-  #
-  # Gives you the current dir.
-  # ========================================================================= #
-  def report_current_remote_dir(
-      be_verbose = be_verbose?
-    )
-    begin
-      if be_verbose
-        opnn; e 'The remote directory is:'
-        e "  #{sdir(return_remote_pwd)}"
-      end
-    rescue Exception => error
-      opnn; e error.class
-      opnn; e error
-    end
-  end; alias report_remote_directory report_current_remote_dir # === report_remote_directory
-       alias dir?                    report_current_remote_dir # === dir?
-       alias report_remote_pwd       report_current_remote_dir # === report_remote_pwd
-
-  # ========================================================================= #
-  # === remote_chdir                                      (cd tag, chdir tag)
-  #
-  # This method allows us to cd to another remote directory, on the
-  # remote FTP server (our main connection). 
-  #
-  # The method must be able to check whether we are connected to the
-  # remote host.
-  # ========================================================================= #
-  def remote_chdir(
-      i,
-      be_verbose = be_verbose?
-    )
-    i = i.dup if i.frozen?
-    # ======================================================================= #
-    # Sanitize odd entries ending with ':'
-    # ======================================================================= #
-    i[-1,1] = '/' if i.end_with? ':'
-    i = rds("#{i}/") # <- Always ensure that a '/' is the last character.
-    if be_verbose
-      notify_the_user_about(i, __method__)
-    end
-    if is_connected?
-      # ===================================================================== #
-      # If we cd to a non-existing target, the exception Net::FTPPermError
-      # will be raised.
-      # ===================================================================== #
-      begin
-        ftp_object?.chdir(i)
-        update_remote_file_listing
-      # ===================================================================== #
-      # The user may have insufficient permissions:
-      # ===================================================================== #
-      rescue Net::FTPPermError => error
-        pp error
-      rescue Net::ReadTimeout => error
-        opnn; e 'An error was encountered in the method '\
-                'remote_chdir().'
-        opnn; e 'The error-class was Net::ReadTimeout.'
-        e
-        opnn; e 'The specific error will be displayed next.'
-        e
-        pp error
-      end
-    else
-      opnn; e 'We are not connected to a remote host right now.'
-      opnn; e 'Thus we can not change the directory.'
-    end
-    report_current_remote_dir if be_verbose # right now mandatory
-  end; alias rcd                           remote_chdir # === rcd
-       alias remote_cd                     remote_chdir # === remote_cd
-       alias chdir                         remote_chdir # === chdir
-       alias cd                            remote_chdir # === cd
-       alias chdir                         remote_chdir # === chdir
-       alias rcd                           remote_chdir # === rcd
-       alias change_directory              remote_chdir # === change_directory
-       alias change_remote_directory       remote_chdir # === change_remote_directory
-       alias cd_into_this_remote_directory remote_chdir # === cd_into_this_remote_directory
-       alias remote_change_directory       remote_chdir # === remote_change_directory
-
-  # ========================================================================= #
-  # === return_remote_directories
-  #
-  # Give us a list of (remote) directories - only directories, not
-  # files.
-  #
-  # An Array will be returned as a result.
-  # ========================================================================= #
-  def return_remote_directories
-    _ = []
-    update_file_listing # Populate the file listing anew, so we will always get proper results back.
-    raw_listing?.each {|entry|
-      entry = FtpParadise::Entry.new(entry)
-      _ << rds(entry.return_name) if entry.is_a_directory?
-    }
-    # ======================================================================= #
-    # Directories must end with '/'. Ensure this to be the case next.
-    # ======================================================================= #
-    _.map! {|entry|
-      entry << '/' unless entry.end_with? '/'
-      entry
-    }
-    return _
-  end; alias directories?       return_remote_directories # === directories?
-       alias return_directories return_remote_directories # === return_directories
-
-  # ========================================================================= #
-  # === return_remote_directory_content
-  #
-  # This method will return ALL remote entries, no matter if file or
-  # directory.
-  # ========================================================================= #
-  def return_remote_directory_content
-    raw_entries = raw_entries?
-    if raw_entries.nil?
-      populate_raw_entries
-      raw_entries = raw_entries?
-    end
-    if raw_entries
-      _ = raw_entries.reject {|line|
-        line.empty?
-      }.map {|entry|
-        FtpParadise::Entry.new(entry).name?
-      }
-    end
-    return _
-  end; alias array_file_listing?      return_remote_directory_content # === array_file_listing?
-       alias array_file_listing       return_remote_directory_content # === array_file_listing
-       alias remote_directory_content return_remote_directory_content # === remote_directory_content
-       alias list?                    return_remote_directory_content # === list?
-
-  # ========================================================================= #
-  # === is_a_directory?
-  #
-  # This method queries whether the given input is a (remote) directory.
-  # For this to work, the given input must obviously exist as file or
-  # directory.
-  # ========================================================================= #
-  def is_a_directory?(i)
-    update_file_listing
-    candidates = file_listing_as_entries?.select {|entry|
-      entry.is_a_directory?
-    }.map(&:last)
-    candidates.include? i
-  end; alias is_directory?                 is_a_directory? # === is_directory?
-       alias is_a_directory?               is_a_directory? # === is_a_directory?
-       alias this_remote_directory_exists? is_a_directory? # === this_remote_directory_exists?
-       alias is_dir?                       is_a_directory? # === is_dir?
-
-  # ========================================================================= #
-  # === remote_directory_is_empty?
-  #
-  # This method will return a Boolean - true if the remote directory
-  # is empty, and false otherwise.
-  # ========================================================================= #
-  def remote_directory_is_empty?
-    _ = return_remote_directory_content
-    _.reject! {|entry|
-      (entry == '.') or (entry == '..')
-    }
-    _.empty?
-  end
-
-  # ========================================================================= #
-  # === create_this_remote_directory                              (mkdir tag)
-  #
-  # This method will attempt to create a remote directory.
-  #
-  # A Net::FTPPermError may result if the permission does not allow for
-  # that action.
-  # ========================================================================= #
-  def create_this_remote_directory(
-      i, be_verbose = be_verbose?
-    )
-    if i.is_a? Array
-      i.each {|entry| create_this_remote_directory(entry, be_verbose) }
-    else
-      i = rds(i+'/')
-      if be_verbose
-        notify_the_user_about(i, __method__)
-        if is_directory?(i)
-          opnn; e swarn('Warning - the remote directory ')+
-                  sdir(i)+swarn(' already exists.')
-          opnn; e swarn('We thus can not create a new directory.')
-        end
-      end
-      begin
-        ftp_object?.mkdir(i)
-      rescue Net::FTPConnectionError
-        opnn; e 'Not connected - is the network down/available?'
-      rescue Net::FTPPermError
-        opnn; e "Net::FTPPermError: Can not create the remote "\
-                "directory `#{remote_path?}#{sdir(i)}`"
-        opnn; e 'as it - or a file with the same name - already exists.'
-      end
-    end
-  end; alias mkdir                           create_this_remote_directory # === mkdir
-       alias rmkdir                          create_this_remote_directory # === rmkdir
-       alias remote_mkdir                    create_this_remote_directory # === remote_mkdir
-       alias create_directory                create_this_remote_directory # === create_directory
-       alias create_these_remote_directories create_this_remote_directory # === create_these_remote_directories
-       alias remote_create_directory         create_this_remote_directory # === remote_create_directory
-       alias create_remote_directory         create_this_remote_directory # === create_remote_directory
-
-  # ========================================================================= #
-  # === sanitize_remote_directory_content
-  #
-  # The purpose of this method is to clean up the remote dataset.
-  #
-  # Keep in mind that the output comes in something like:
-  #
-  #    "-rw-rw-rw-   1 web      netscape     6820 May 30  2011 AppendToCookbook.rb"
-  #    "drwxrwxrwx   2 web      netscape     8192 Oct 29  2007 CSS"
-  #    "-rw-rw-rw-   1 web      netscape    10548 May 30  2011 Chained.rb" 
-  #    "-rw-r--r--   1 330        330      237904 Jun  9 14:24 11.03.2003_UniWien_Biologie_EinfuehrungInDieMikrobiologie.jpg",
-  #
-  # This should contain all the information that is needed.
-  # ========================================================================= #
-  def sanitize_remote_directory_content
-    _ = []
-    raw_entries?.each { |e|
-      next if e.empty?
-      entry = FtpParadise::Entry.new(e)
-      filesize  = entry.filesize?
-      timestamp = entry.parsed_timestamp?
-      # ===================================================================== #
-      # === Exclude 3 entries next
-      # ===================================================================== #
-      next if e.include? 'total' or
-              entry.name? == '.' or
-              entry.name? == '..' # Batch next.
-      # ===================================================================== #
-      # === Build up the final Array
-      #
-      # Our Array will have four entries:
-      #
-      #   (1) Filename
-      #   (2) File or Directory (String)
-      #   (3) Filesize
-      #   (4) Timestamp
-      #
-      # ===================================================================== #
-      _ << [ rds(entry.filename?), entry.file_or_directory, filesize, timestamp ]
-    }
-    @internal_hash[:sanitized_remote_directory_content] = _ #.compact
-  end
-
-  # ========================================================================= #
-  # === sanitized_remote_directory_content?
-  # ========================================================================= #
-  def sanitized_remote_directory_content?
-    update_remote_file_listing
-    sanitize_remote_directory_content
-    @internal_hash[:sanitized_remote_directory_content]
-  end
-
-end; end

data/lib/ftp_paradise/connection/do_login.rb

@@ -1,108 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/do_login.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  require 'ftp_paradise/toplevel_methods/remote_url.rb'
-
-  require 'ftp_paradise/connection/initialize_a_new_net_ftp_object_with_this_url.rb'
-  require 'ftp_paradise/connection/is_connected.rb'
-  require 'ftp_paradise/connection/password.rb'
-  require 'ftp_paradise/connection/sync_ftp_object_onto_the_main_namespace.rb'
-
-  # ========================================================================= #
-  # === do_login
-  #
-  # This method is responsible for the login-action.
-  #
-  # The method signature for the net-ftp class' .login() is:
-  #
-  #   login(user = "anonymous", passwd = nil, acct = nil)
-  #
-  # This method here accepts a Hash as first argument.
-  #
-  # For official information about .login(), see here:
-  #
-  #   https://ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html#method-i-login
-  #
-  # ========================================================================= #
-  def do_login(
-      to_this_url          = nil,         # The remote URL.
-      use_this_as_username = username?,   # The login-name.
-      use_this_as_password = password?,   # The password for that user.
-      be_verbose           = be_verbose?
-    )
-    if to_this_url.nil?
-      to_this_url = FtpParadise.remote_url?
-    elsif to_this_url.is_a? Hash
-    end
-    # ======================================================================= #
-    # Rescue nil-passwords here.
-    # ======================================================================= #
-    if use_this_as_password.to_s.empty?
-      use_this_as_password = set_password(:try_to_use_a_default_password)
-    end
-    if be_verbose
-      # ===================================================================== #
-      # Display some info to the user here.
-      # ===================================================================== #
-      e; cliner
-      opnn; e "Using the URL #{royalblue(to_this_url)} (remote FTP host)."
-      e
-      e "  Username: #{slateblue(use_this_as_username)}"
-      e "  Password: #{slateblue(use_this_as_password)}"
-      e
-      report_transfer_mode_in_use
-      e
-      cliner
-    end
-    if ftp_object?.nil? and !to_this_url.nil?
-      initialize_a_new_net_ftp_object_with_this_url(to_this_url)
-    end
-    use_this_as_username = use_this_as_username.to_s
-    # ======================================================================= #
-    # The following code must be rescued because the login() method
-    # may fail in various ways.
-    # ======================================================================= #
-    begin
-      ftp_object?.login(
-        use_this_as_username,
-        use_this_as_password
-      )
-      # =================================================================== #
-      # Next, assign towards the toplevel reference to the ftp-connection.
-      # =================================================================== #
-      sync_ftp_object_onto_the_main_namespace if ftp_object?
-      if be_verbose and is_connected?
-        e
-        cliner {
-          e "- #{sfancy('Successfully')} logged into "\
-            "the remote FTP host at `#{simp(to_this_url)}`"
-        }
-      end
-    rescue Net::FTPPermError => error
-      opnn; e "We could not connect and login to `#{sfancy(to_this_url)}`."
-      opnn; e 'It may be that you lack the proper permissions.'
-      opnn; e 'This may happen because the user/password combination was'
-      opnn; e 'incorrect. User and password combination will be shown next:'
-      show_user_and_password
-      opnn; e "Feedbacking that error next, of class #{error.class.to_s}:"
-      opnn; e orange(error.to_s)
-    rescue Net::FTPConnectionError => error
-      opnn; e 'We do not seem to be connected. An error happened.'
-      pp error
-      pp error.class
-    end
-  end; alias do_connect do_login # === do_connect
-       alias connect_to do_login # === connect_to
-       alias connect    do_login # === connect
-       alias login      do_login # === login
-       alias login_to   do_login # === login_to
-       alias reconnect  do_login # === reconnect
-
-end; end