ftp_paradise 1.3.8

data/lib/ftp_paradise/connection/notify.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/notify.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  # ========================================================================= #
+  # === notify_the_user_about
+  #
+  # This method is a general "user notifier". It will notify the user
+  # about doing certain actions within the FtpParadise project.
+  # ========================================================================= #
+  def notify_the_user_about(
+      i, method
+    )
+    case method
+    # ======================================================================= #
+    # === :set_transfer_mode
+    # ======================================================================= #
+    when :set_transfer_mode
+      opnn; e "Setting mode to #{orange(i.to_s)} now."
+    # ======================================================================= #
+    # === :remove_remote_files
+    # ======================================================================= #
+    when :remove_remote_files
+      opnn; e "Deleting the remote file `#{sdir(i)}` now."
+    # ======================================================================= #
+    # === :upload_binary_file
+    # ======================================================================= #
+    when :upload_binary_file
+      opnn; e 'Now trying to upload the binary file `'+sfile(i)+'`'
+      opnn; e 'to the remote host `'+sfancy(remote_host?)+'`.'
+    # ======================================================================= #
+    # === :create_this_remote_directory
+    # ======================================================================= #
+    when :create_this_remote_directory
+      opnn; e 'Creating the remote directory `'+sdir(i)+'` now.'
+    # ======================================================================= #
+    # === :remote_cd
+    # ======================================================================= #
+    when :remote_cd
+      opnn; e 'Trying to remote-change directory into `'+sdir(i)+'`.'
+    # ======================================================================= #
+    # === :download_this_remote_file
+    # ======================================================================= #
+    when :download_this_remote_file
+      opnn; e "Downloading the remote file `#{sdir(i)}` now."
+    # ======================================================================= #
+    # === :upload_this_text_file
+    # ======================================================================= #
+    when :upload_this_text_file
+      opnn; e 'Uploading the local text file `'+sfile(i)+'` to '\
+              'the remote host at `'+sfancy(remote_pwd?)+'`.'
+    # ======================================================================= #
+    # === :create_remote_file
+    # ======================================================================= #
+    when :create_remote_file
+      opnn; e 'Creating the remote file `'+sdir(i)+'` now.'
+    # ======================================================================= #
+    # === :remove_remote_directory
+    # ======================================================================= #
+    when :remove_remote_directory
+      opnn; e 'Removing the remote directory `'+sdir(i)+'` now.'
+    end
+  end
+
+end; end

data/lib/ftp_paradise/connection/password.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/password.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  require 'ftp_paradise/toplevel_methods/password.rb'
+
+  # ========================================================================= #
+  # === password?
+  # ========================================================================= #
+  def password?
+    FtpParadise.password?.to_s
+  end; alias password password? # === password
+
+  # ========================================================================= #
+  # === set_password
+  #
+  # Use only this method when attempting to modify the @password.
+  #
+  # This @ivar keeps track of the password we will use.
+  # ========================================================================= #
+  def set_password(
+      i = :try_to_use_a_default_password
+    )
+    case i
+    when :try_to_use_a_default_password,
+         :default
+      if FtpParadise::RoebeFtpConstants::BPLACED
+        _ = FtpParadise::RoebeFtpConstants::BPLACED[2]
+        _.chop! if _.end_with? '_'
+        i = _
+      end
+    when :anonymous
+      i = nil
+    else
+      i = i.to_s
+    end
+    FtpParadise.set_password(i)
+    i # Return the password here as well, so that we can use it for assignments.
+  end; alias password= set_password # === password=
+
+end; end

data/lib/ftp_paradise/connection/port.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/port.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  require 'ftp_paradise/toplevel_methods/port.rb'
+  require 'ftp_paradise/connection/ftp_object.rb'
+
+  # ========================================================================= #
+  # === set_port
+  #
+  # Use this method to set the port. The port will be stored on the
+  # toplevel-"namespace".
+  # ========================================================================= #
+  def set_port(
+      i = DEFAULT_PORT
+    )
+    FtpParadise.set_port(i)
+  end
+
+  # ========================================================================= #
+  # === port?
+  # ========================================================================= #
+  def port?
+    FtpParadise.port?.to_s
+  end; alias port port? # === port
+
+end; end

data/lib/ftp_paradise/connection/remote_pwd.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/remote_pwd.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < FtpParadise::Base
+
+  require 'ftp_paradise/connection/remote_url.rb'
+
+  # ========================================================================= #
+  # === remote_pwd
+  # ========================================================================= #
+  def remote_pwd
+    ftp_object?.pwd
+  end; alias rpwd   remote_pwd # === rpwd
+       alias getdir remote_pwd # === getdir
+
+  # ========================================================================= #
+  # === return_remote_pwd
+  #
+  # This method will return the (remote) pwd, including the remote working
+  # directory - including the subpath..
+  #
+  # This method will ensure that a trailing '/' will be returned here.
+  #
+  # The official documentation can be seen here:
+  #   https://ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html#method-i-pwd
+  # ========================================================================= #
+  def return_remote_pwd
+    begin
+      if is_connected?
+        remote_pwd = remote_url?.dup
+        # ===================================================================== #
+        # Need to safeguard, in the event that we are not connected to a
+        # remote FTP server.
+        # ===================================================================== #
+        remote_pwd << ftp_object?.pwd.to_s if ftp_object?
+        remote_pwd << '/'
+        return rds(remote_pwd)
+      else
+        opnn; e 'No FTP connection is open.'
+        ''
+      end
+    rescue Net::FTPReplyError
+      opnn; e 'Error Net::FTPReplyError received. May be due to user interrupting.'
+      opnn; e 'Exiting now at once either way.'
+      exit
+    rescue SystemExit, Interrupt
+      opnn; e 'User requested to exit, thus exiting now.'
+      exit
+    end
+  end; alias pwd?                return_remote_pwd # === pwd?
+       alias pwd                 return_remote_pwd # === pwd (pwd tag)
+       alias getdir              return_remote_pwd # === get_dir
+       alias remote_pwd          return_remote_pwd # === remote_pwd
+       alias remote_pwd?         return_remote_pwd # === remote_pwd?
+       alias connected_to?       return_remote_pwd # === connected_to?
+       alias remote?             return_remote_pwd # === remote?
+       alias base_dir?           return_remote_pwd # === base_dir?
+       alias remote_directory?   return_remote_pwd # === remote_directory?
+       alias remote_dir?         return_remote_pwd # === remote_dir?
+       alias remote_path?        return_remote_pwd # === remote_path?
+       alias return_subdirectory return_remote_pwd # === return_subdirectory
+       alias current_directory   return_remote_pwd # === current_directory
+       alias return_remote_dir   return_remote_pwd # === return_remote_dir
+       alias get_remote_dir      return_remote_pwd # === get_remote_dir
+       alias remote_host?        return_remote_pwd # === remote_host?
+
+end; end

data/lib/ftp_paradise/connection/remote_url.rb

@@ -0,0 +1,163 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/remote_url.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  require 'ftp_paradise/toplevel_methods/remote_url.rb'
+
+  # ========================================================================= #
+  # === remote_url?
+  #
+  # This method is guaranteed to return a String.
+  # ========================================================================= #
+  def remote_url?
+    begin
+      return FtpParadise.remote_url?.to_s
+    rescue Interrupt
+      exit # User interrupted, so we exit as requested.
+    rescue Exception => error
+      opnn; e 'We did encounter an error in the method '+
+              simp(__method__.to_s)
+      opnn; pp error
+      return error.to_s # Return that exception.
+    end
+  end; alias remote_host? remote_url? # === remote_host?
+       alias remote_url   remote_url? # === remote_url
+       alias url?         remote_url? # === url?
+       alias host?        remote_url? # === host?
+       alias host         remote_url? # === host
+
+  # ========================================================================= #
+  # === set_remote_url
+  #
+  # This method will do some sanitizing before it sets a proper and
+  # valid hostname. Remember to keep the 'default' entry at the
+  # current main FTP host you use.
+  # ========================================================================= #
+  def set_remote_url(
+      i          = :default,
+      be_verbose = true
+    )
+    i = :default? if i.nil?
+    if i.is_a? Hash # Handle Hash as input here.
+      if i.has_key?(:to)
+        i = i[:to]
+      end
+    end
+    # ======================================================================= #
+    # The next block is mostly for my custom constants.
+    # You can simply pass in your own Hash.
+    # ======================================================================= #
+    case i # Do some sanitizing. This is a String here. (case tag)
+    # ======================================================================= #
+    # === bplaced
+    # ======================================================================= #
+    when /^-?-?bplaced$/i,
+         'default'
+      set_data(BPLACED)
+      i = BPLACED.first
+    # ======================================================================= #
+    # === shevy
+    # ======================================================================= #
+    when /^-?-?shevy$/i
+      set_data(BPLACED)
+      i = BPLACED.first
+    # ======================================================================= #
+    # === ?
+    # ======================================================================= #
+    when '?'
+      feedback_login_hosts
+    # ======================================================================= #
+    # === uniwien_homepage
+    # ======================================================================= #
+    when /^uniwien_?homepage/
+      set_data(UNIWIEN_HOMEPAGE)
+      i = UNIWIEN_HOMEPAGE.first
+    # ======================================================================= #
+    # === unet
+    # ======================================================================= #
+    when 'unet','uni','uniftp'
+      set_data(UNIVIE)
+      i = UNIVIE.first   
+    # ======================================================================= #
+    # === a1
+    # ======================================================================= #
+    when /^a1/
+      set_data(A1)
+      i = A1.first
+    # ======================================================================= #
+    # === byte
+    # ======================================================================= #
+    when /^byte/ # This also includese bytehost.
+      set_data(BYTEHOST)
+      i = BYTEHOST.first
+    # ======================================================================= #
+    # === zerofees
+    # ======================================================================= #
+    when 'ZEROFEES','zero','ZERO'
+      set_data(ZEROFEES)
+      i = ZEROFEES.first
+    # ======================================================================= #
+    # === ucoz
+    # ======================================================================= #
+    when 'ucoz','UCOZ','LAST',/tanriel/i,
+         'last'
+      set_data(UCOZ)
+      i = UCOZ.first
+    end
+    case i.to_s
+    # ======================================================================= #
+    # === shevy
+    # ======================================================================= #
+    when 'shevy','5','default' # Current default entry.
+      i = SQUARE7.first
+    # ======================================================================= #
+    # === a1
+    # ======================================================================= #
+    when '1','a1'
+      i = A1.first
+    # ======================================================================= #
+    # === unet
+    # ======================================================================= #
+    when '2','unet','uni','uniftp'
+      i = UNIVIE.first
+    # ======================================================================= #
+    # === geas
+    # ======================================================================= #
+    when '3','geas'
+      i = GEAS.first
+    # ======================================================================= #
+    # === byte
+    # ======================================================================= #
+    when '4','byte'
+      i = BYTEHOST.first
+    end
+    i = i.to_s # Need a String here.
+    # ======================================================================= #
+    # === Provide more information to the user
+    # ======================================================================= #
+    if debug?
+      opnn; e "The remote URL was set to: #{sfancy(i)}"
+    end
+    if be_verbose
+      e "Setting url to #{sfancy(i)} now."
+    end
+    FtpParadise.set_remote_url(i)
+    # ======================================================================= #
+    # And we will always initialize a new ftp-object as well, whenever
+    # we call this method:
+    # ======================================================================= #
+    initialize_a_new_net_ftp_object_with_this_remote_url(i)
+  end; alias set_this_host   set_remote_url # === set_this_host
+       alias set_host        set_remote_url # === set_host
+       alias set_url         set_remote_url # === set_url
+       alias host=           set_remote_url # === host=
+       alias url=            set_remote_url # === url=
+       alias set_remote_host set_remote_url # === set_remote_host
+
+end; end

data/lib/ftp_paradise/connection/remove.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/remove.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection < Base
+
+  # ========================================================================= #
+  # === remove                                                   (remove tag)
+  # ========================================================================= #
+  def remove(i)
+    if i.is_a? Array
+      i.each {|entry| remove(entry) }
+    else
+      if is_a_directory?(i)
+        remove_remote_directory(i)
+      elsif is_a_file?(i)
+        remove_remote_file(i, be_verbose?)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === remove_remote_file
+  #
+  # Remove a (remote) file, via the delete() method of the FTP protocol.
+  #
+  # Note that this method will only delete files.
+  #
+  # The official documentation for the Ruby-FTP delete() method can be
+  # found here:
+  #
+  #   https://www.ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html#method-i-delete
+  #
+  # ========================================================================= #
+  def remove_remote_file(
+      i,
+      be_verbose = be_verbose?
+    )
+    case be_verbose
+    when :be_verbose
+      be_verbose = true
+    end
+    if i.is_a? Array
+      i.each {|entry| remove_remote_file(entry, be_verbose) }
+    else
+      if does_this_remote_file_exist?(File.basename(i))
+        i = File.basename(i)
+        if i =~ /^\d+$/ # if is a number
+          update_file_listing
+          _ = return_remote_file_listing[i.to_i - 1].first
+          _ = File.basename(_)
+          e "Performing a substitution of #{sfancy(i)}"\
+            " to #{simp(_)}."
+          i = _
+        end
+        if be_verbose
+          notify_the_user_about(i, __method__)
+        end
+        ftp_object?.delete(i)
+        update_file_listing
+        return i # Also return the file that was deleted.
+      else
+        opnn; e "No remote file called `#{sfile(i)}` was "\
+                "found at `#{sfancy(remote_pwd)}`."
+      end
+    end
+  end; alias remote_remove       remove_remote_file # === remote_remove
+       alias remote_remove_files remove_remote_file # === remote_remove_files
+       alias remote_remove_file  remove_remote_file # === remote_remove_files
+       alias delete              remove_remote_file # === delete
+       alias remove_file         remove_remote_file # === remove_file
+       alias rm_file             remove_remote_file # === rm_file
+       alias rmfile              remove_remote_file # === rmfile
+
+  # ========================================================================= #
+  # === original_delete
+  #
+  # This method will remove the file, without doing any additional
+  # checks.
+  # ========================================================================= #
+  def original_delete(i)
+    ftp_object?.delete(i)
+  end
+
+  # ========================================================================= #
+  # === remove_remote_directory
+  #
+  # This method will remove a remote directory. For this to work, as
+  # operation, the remote directory has to exist.
+  #
+  # This operation may fail e. g. when the remote directory is not empty.
+  # This explains why we attempt to rescue some errors.
+  # ========================================================================= #
+  def remove_remote_directory(
+      i,
+      be_verbose   = be_verbose?,
+      force_remove = false
+    )
+    case force_remove
+    when :force_remove
+      force_remove = true
+    when :do_not_force_remove
+      force_remove = false
+    end
+    if i.is_a? Array
+      i.each {|entry| remove_remote_directory(entry, be_verbose) }
+    else
+      if be_verbose
+        notify_the_user_about(i, __method__)
+      end
+      if is_a_directory? i
+        begin
+          ftp_object?.rmdir(i)
+        rescue Net::FTPPermError => error
+          opnn; e swarn('We could not remove the remote directory at ')+
+                  sdir(i)+swarn(' as it is not empty.')
+          pp error
+          if force_remove
+            opnn; e 'We will now try to enter into this directory'
+            opnn; e 'and then remove all files of that directory.'
+            rcd(this_dir)
+            update_file_listing
+            all_remote_files?.each {|file| remove(file) } # Now it should be removed.
+            rcd('..') # Go back again.
+            rmdir(i, be_verbose, :do_not_force_remove) # But we won't force again, to avoid recursive loops.
+            opnn; e "The remote directory at #{sdir(i)} has been removed."
+          end
+        end
+      else
+        if be_verbose
+          opnn; e "The given input #{sfancy(i)} is not a directory."
+        end
+      end
+    end
+  end; alias rmdir                           remove_remote_directory # === rmdir
+       alias remove_these_remote_directories remove_remote_directory # === remove_these_remote_directories
+       alias remove_directory                remove_remote_directory # === remove_directory
+
+end; end