ftp_paradise 1.4.5 → 1.5.4

data/lib/ftp_paradise/connection/remote_url.rb

@@ -1,164 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/remote_url.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  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)
-    # ======================================================================= #
-    # === shevy
-    # ======================================================================= #
-    when /^-?-?shevy$/i,
-         'default'
-      set_data(PODSERVER)
-      i = PODSERVER.first
-    # ======================================================================= #
-    # === bplaced
-    # ======================================================================= #
-    when /^-?-?bplaced$/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

@@ -1,143 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/remove.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === 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

data/lib/ftp_paradise/connection/reset.rb

@@ -1,78 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/reset.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  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'
-
-  # ========================================================================= #
-  # === 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
-    # ======================================================================= #
-    # === :array_available_hosts
-    # ======================================================================= #
-    @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

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

data/lib/ftp_paradise/connection/set_array_available_hosts.rb

@@ -1,27 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/set_array_available_hosts.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === 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

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

data/lib/ftp_paradise/connection/show.rb

@@ -1,153 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/show.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === 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

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