ftp_paradise 1.4.5

data/lib/ftp_paradise/connection/directory_handling.rb

@@ -0,0 +1,271 @@
+#!/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

@@ -0,0 +1,108 @@
+#!/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

data/lib/ftp_paradise/connection/download.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/download.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection
+
+  # ========================================================================= #
+  # === download_binary_file
+  #
+  # Use this method to download a binary file, by calling the method
+  # getbinaryfile(). You can download as many files as you want to
+  # through this method, but we expect this method to be a binary
+  # file.
+  #
+  # Specific usage example:
+  #
+  #   ftp?.download_binary_file('photos_2009-03-29.zip', 'ftp_photos/photos.zip')
+  #
+  # ========================================================================= #
+  def download_binary_file(
+      i,
+      be_verbose = be_verbose?
+    )
+    if i.is_a? Array
+      i.each {|entry| download_binary_file(entry) }
+    else
+      ftp?.getbinaryfile(i) # Delegate towards .getbinaryfile()
+      if be_verbose
+        e "Downloaded file #{sfile(i)}."
+      end
+    end
+  end; alias getbinaryfile download_binary_file # === getbinaryfile
+
+  # ========================================================================= #
+  # === download_remote_file                                   (download tag)
+  #
+  # Use this method to download a remote file. If you are sure to have
+  # a binary file, the method download_binary_file() could be used
+  # instead.
+  #
+  # gettextfile(remotefile, localfile = File.basename(remotefile)) {|line| ...}
+  # ========================================================================= #
+  def download_remote_file(
+      i, be_verbose = be_verbose?
+    )
+    if i.is_a? Array # Handle arrays first.
+      i.each {|entry| download_remote_file(entry, be_verbose) }
+    else
+      if i =~ /^\d+$/ # if is a number
+        update_file_listing
+        i = return_remote_files[i.to_i - 1].first
+      end
+      if i == '*' # Here we want to download all files, as we passed in '*'.
+        i = []
+        update_file_listing
+        return_remote_files.each { |a,b| i << FtpParadise.rds(a) }
+      end
+      if be_verbose
+        notify_the_user_about(i, __method__)
+      end
+      set_file(i) # This assigns to @internal_hash[:file].
+      begin # We can use @file because we called set_file() before.
+        ftp_object?.gettextfile(file?)
+        basename = File.basename(file?)
+        e "Finished downloading `#{sandybrown(file?)}`"
+        e 'into `'+sdir(rds(Dir.pwd+'/'+basename))+'`.'
+        return file?
+      rescue Net::FTPPermError => error
+        pp error
+        e 'An exception occurred in the method '+sfancy('download()')+'.'
+        e 'The error was a '+sfancy('Permission Error')+', the input '\
+          'to the method was: `'+simp(i)+'`.'
+        e 'Is the file that you are trying to download really '\
+          'existing on the remote server?'
+        return false
+      end
+    end
+  end; alias download                  download_remote_file # === download
+       alias download_this_remote_file download_remote_file # === download_this_remote_file
+       alias download_this_file        download_remote_file # === download_this_file
+
+end; end