ftp_paradise 1.3.8

data/lib/ftp_paradise/interactive_ftp/misc.rb

@@ -0,0 +1,208 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/misc.rb'
+# =========================================================================== #
+require 'ftp_paradise/interactive_ftp/directory_handling.rb'
+
+module FtpParadise
+
+class InteractiveFtp < FtpParadise::Base
+
+  require 'ftp_paradise/toplevel_methods/determine_user_dataset_from_this_hash.rb'
+
+  # ========================================================================= #
+  # === set_editor
+  # ========================================================================= #
+  def set_editor(
+      i, be_verbose = true
+    )
+    i = i.first if i.is_a? Array
+    if be_verbose
+      opnn; e "Now using the editor called `#{sfancy(i)}`."
+    end
+    @use_this_editor = i
+  end
+
+  # ========================================================================= #
+  # === report_which_editor_is_in_use
+  # ========================================================================= #
+  def report_which_editor_is_in_use
+    opnn; e "The editor in use is `#{sfancy(@use_this_editor)}`."
+  end
+
+  # ========================================================================= #
+  # === open_this_file_in_editor           (edit tag, editor tag, open tag)
+  #
+  # If you pass as first argument to this method the string 'ALL', we
+  # will try to open the (local) project files in your editor.
+  #
+  # To test this, do:
+  #
+  #   open ALL
+  #   open YAML
+  #
+  # ========================================================================= #
+  def open_this_file_in_editor(
+      this_file = @file
+    )
+    this_file = ARRAY_PROJECT_FILES if this_file.nil?
+    if this_file.is_a? Array
+      this_file.each {|entry| open_this_file_in_editor(entry) }
+    else
+      this_file = this_file.to_s
+      if this_file == 'TODO'
+        this_file = ARRAY_PROJECT_FILES.select {|entry| entry.include? 'TODO' }[0]
+      end
+      if this_file.to_s =~ /^\d+$/ # If only numbers were given.
+        this_file = Dir['*'].sort[this_file.to_i - 1]
+      end
+      this_file = NAME_OF_THIS_FILE if this_file.empty?
+      if this_file == 'ALL' and ! File.exist?('ALL')
+        open_this_file_in_editor(ARRAY_PROJECT_FILES)
+      elsif this_file == 'YAML' and ! File.exist?('YAML')
+        open_this_file_in_editor(YAML_FILE)
+      else
+        _ = @use_this_editor+" #{this_file}"
+        if File.exist?(this_file) && File.file?(this_file)
+          unless has_unwanted_file_suffix?(this_file)
+            e 'Loading '+sfile(this_file)+' in editor '+
+              'now as '+simp('USE_THIS_EDITOR')+' was set '+
+              'to true:'
+            e '  '+_+' &'
+            `#{_}`
+          end
+          set_file(this_file) # Since 24.12.2011 we also assign it.
+        else
+          e swarn('But the file `')+sfile(this_file)+
+            swarn('` does not exist.')
+        end
+      end
+    end
+  end; alias open_in_editor open_this_file_in_editor # === open_in_editor
+
+  # ========================================================================= #
+  # === determine_user_dataset_from_this_hash
+  #
+  # This method can set relevant entries from an input Hash.
+  # ========================================================================= #
+  def determine_user_dataset_from_this_hash(
+      i,
+      optional_use_this_entry = :default
+    )
+    if optional_use_this_entry
+      case optional_use_this_entry
+      # ===================================================================== #
+      # === :default
+      # ===================================================================== #
+      when :default
+        optional_use_this_entry = :bplaced
+      end
+    end
+    FtpParadise.determine_user_dataset_from_this_hash(i)
+  end
+
+  # ========================================================================= #
+  # === set_password
+  # ========================================================================= #
+  def set_password(
+      i, be_verbose = be_verbose?
+    )
+    i = i.to_s
+    if be_verbose
+      e "Setting password to #{sfancy(i)} now."
+    end
+    FtpParadise.set_password(i)
+  end
+
+  # ========================================================================= #
+  # === pass_commandline_arguments_into_the_menu
+  # ========================================================================= #
+  def pass_commandline_arguments_into_the_menu
+    menu(@commandline_arguments)
+  end
+
+  # ========================================================================= #
+  # === set_port
+  #
+  # Use this method to set the port.
+  # ========================================================================= #
+  def set_port(
+      i = 21, be_verbose = false
+    )
+    if be_verbose
+      e "Setting port to #{sfancy(i)} now."
+    end
+    ftp?.set_port(i)
+  end
+
+  # ========================================================================= #
+  # === remote_url?
+  # ========================================================================= #
+  def remote_url?
+    FtpParadise.remote_url?
+  end; alias remote_host? remote_url? # === remote_host?
+
+  # ========================================================================= #
+  # === password?
+  # ========================================================================= #
+  def password?
+    FtpParadise.password?
+  end
+
+  # ========================================================================= #
+  # === remote_remove_file
+  # ========================================================================= #
+  def remote_remove_file(
+      i = @first_argument
+    )
+    if i.is_a? Array
+      i.each {|entry| remote_remove_file(entry) }
+    else
+      e "Trying to remove `#{sfile(i)}` next:"
+      @ftp.delete(i)
+    end
+  end; alias remote_remove_files remote_remove_file # === remote_remove_files
+
+  # ========================================================================= #
+  # === display_file
+  #
+  # Use this method to display a file in question.
+  # ========================================================================= #
+  def display_file(i)
+    if File.exist? i
+      _ = File.readlines(i).join
+      e _
+    else
+      ewarn "File #{sfile(i)} does not exist."
+    end
+  end
+
+  # ========================================================================= #
+  # === report_version
+  # ========================================================================= #
+  def report_version
+    e sfancy(FtpParadise::VERSION)
+  end
+
+  # ========================================================================= #
+  # === all_arguments?
+  #
+  # The alias a? may be an easier wrapper over @all_arguments.
+  # ========================================================================= #
+  def all_arguments?
+    @all_arguments
+  end; alias a? all_arguments? # === a?
+
+  # ========================================================================= #
+  # === try_to_chmod_this_remote_file
+  # ========================================================================= #
+  def try_to_chmod_this_remote_file(
+      filename, chmod_value_to_use = '0777'
+    )
+    e "Trying to chmod the remote file #{filename} next."
+    ftp?.sendcmd("SITE CHMOD #{chmod_value_to_use} #{filename}")
+  end
+
+end; end

data/lib/ftp_paradise/interactive_ftp/mode.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/mode.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp < FtpParadise::Base # === FtpParadise::InteractiveFtp
+
+  # ========================================================================= #
+  # === use_binary_mode
+  #
+  # This enables use the binary mode.
+  # ========================================================================= #
+  def use_binary_mode(
+      be_verbose = false
+    )
+    case be_verbose
+    when :be_quiet
+      be_verbose = false
+    when :be_verbose
+      be_verbose = true
+    end
+    e 'Using binary mode now.' if be_verbose
+    set_mode :binary
+  end; alias set_binary use_binary_mode # === set_binary
+
+  # ========================================================================= #
+  # === set_mode
+  #
+  # Set the mode here. We default to :ascii mode.
+  #
+  # There are only two valid modes:
+  #
+  #   :ascii
+  #   :binary
+  #
+  # ========================================================================= #
+  def set_mode(
+      i = :ascii
+    )
+    @mode = i
+    ftp?.set_transfer_mode(
+      @mode, :be_quiet # Cascade the variable down into ftp_lib.rb.
+    )
+  end
+
+  # ========================================================================= #
+  # === do_use_binary_mode
+  # ========================================================================= #
+  def do_use_binary_mode
+    use_binary_mode(:be_quiet)
+  end
+
+  # ========================================================================= #
+  # === change
+  #
+  # This method can be used to change the main transfer mode.
+  # ========================================================================= #
+  def change(i)
+    case i
+    # ======================================================================= #
+    # === mode
+    # ======================================================================= #
+    when 'mode' # Change the mode that we use.
+      use_binary_mode
+    end
+  end
+
+  # ========================================================================= #
+  # === set_run_mode
+  #
+  # This will set the run-mode. The run-mode can be either :standalone or
+  # :connected.
+  # ========================================================================= #
+  def set_run_mode(
+      i = :standalone
+    )
+    @run_mode = i
+  end
+
+  # ========================================================================= #
+  # === toggle_modes
+  # ========================================================================= #
+  def toggle_modes
+    if @mode == :ascii
+      set_mode :binary
+    else
+      set_mode :ascii
+    end
+    e mode?.to_s
+  end
+
+  # ========================================================================= #
+  # === use_ascii_mode
+  # ========================================================================= #
+  def use_ascii_mode(be_verbose = false)
+    e 'Using ascii mode now.' if be_verbose
+    set_mode :ascii
+  end
+
+  # ========================================================================= #
+  # === mode?
+  #
+  # @mode is a Symbol, hence we will not apply .to_s on it.
+  # ========================================================================= #
+  def mode?
+    return @mode
+  end
+
+  # ========================================================================= #
+  # === set_passive
+  # ========================================================================= #
+  def set_passive(
+      be_verbose = false
+    )
+    if be_verbose
+      e 'Enabling passive mode for FTP.'
+    end
+    ftp?.passive = true
+  end
+
+end; end

data/lib/ftp_paradise/interactive_ftp/readline.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The Readline component will belong to class FtpParadise::InteractiveFtp.
+#
+# It would  not make any sense to use it elsewhere within the FtpParadise
+# project, as we don't have other interactive elements elsewhere.
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/readline.rb'
+# =========================================================================== #
+require 'ftp_paradise/base/prototype.rb'
+
+module FtpParadise
+
+class InteractiveFtp < Base # === FtpParadise::Interactive
+
+  begin
+    require 'readline'
+  rescue LoadError; end # Silent rescue.
+
+  # ========================================================================= #
+  # === use_readline?
+  # ========================================================================= #
+  def use_readline?
+    @use_readline
+  end; alias do_we_use_readline? use_readline? # === do_we_use_readline?
+
+  # ========================================================================= #
+  # === do_not_use_readline
+  # ========================================================================= #
+  def do_not_use_readline
+    @use_readline = false
+  end
+
+  # ========================================================================= #
+  # === enable_readline
+  # ========================================================================= #
+  def enable_readline
+    @use_readline = true
+    try_to_use_readline
+  end
+
+  # ========================================================================= #
+  # === try_to_use_readline
+  #
+  # This method ought to be called before we invoke the method menu().
+  # ========================================================================= #
+  def try_to_use_readline
+    if @use_readline
+      begin
+        require 'readline' # Using readline since August 2011.
+        setup_readline_completion
+      rescue LoadError
+        # =================================================================== #
+        # In this case the user can not use the readline-module.
+        # =================================================================== #
+        do_not_use_readline
+      end
+    end
+  end; alias consider_using_the_readline_module try_to_use_readline # === consider_using_the_readline_module
+
+  # ========================================================================= #
+  # === setup_readline_completion
+  #
+  # Call this method to invoke completion support.
+  # ========================================================================= #
+  def setup_readline_completion
+    Readline.completion_case_fold = true # Ignore case on tab-completion.
+    Readline.completer_word_break_characters = "\n"
+    Readline.completion_append_character = ' '
+    # ======================================================================= #
+    # Act on Readline's completion functionality here.         (readline tag)
+    #
+    # We will respond to these events specifically:
+    #
+    #   - rcd
+    #   - cd
+    #   - upload
+    #   - download
+    #
+    # ======================================================================= #
+    Readline.completion_proc = proc {|input|
+      _ = []
+      case input # case tag
+      # ===================================================================== #
+      # To test it, do:
+      #   rcd AUS<TAB>
+      # ===================================================================== #
+      when /^rcd/,
+           /^rcd /,
+           /^rc/,
+           'rchange_dir',
+           'lcd',
+           'remote_change_directory'
+        result = @_.return_directories # This will return the remote directories only.
+        _ << result.map {|entry| input+' '+entry}
+      # ===================================================================== #
+      # === cd
+      # ===================================================================== #
+      when /^cd/,/^cd / # Fetch only directories.
+        _ << @_.return_local_directories
+      when /^upload/    # Act on upload.
+        return_local_files.each { |array| _ << array }
+      when /^download/  # Act on download.
+        @_.array_file_listing.each { |array| _ << array.first }
+      else # Default.
+        # _ << return_local_files # Disabled in June 2014 because it gives completions to things I did not ask for.
+      end
+      _ = _.flatten
+      _ # Return it here finally.
+    }
+  end
+
+end; end

data/lib/ftp_paradise/interactive_ftp/remove.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/interactive_ftp/remove.rb'
+# =========================================================================== #
+module FtpParadise
+
+class InteractiveFtp < Base
+
+  # ========================================================================= #
+  # === remove_local
+  # ========================================================================= #
+  def remove_local(i)
+    delete(i)
+  end
+
+  # ========================================================================= #
+  # === remove_remote_directory
+  #
+  # Use this method to remove a remote directory.
+  # ========================================================================= #
+  def remove_remote_directory(i)
+    e "Removing remote directory `#{sdir(i)}` next."
+    # ======================================================================= #
+    # Delegate to ftp?. :force_remove so we remove even non-empty directories.
+    # ======================================================================= #
+    ftp?.remove_directory(i, :force_remove)
+  end
+
+  # ========================================================================= #
+  # === remote_remove
+  #
+  # Use this if you wish to remove a remote file or a remote directory.
+  # ========================================================================= #
+  def remote_remove(i)
+    if i.is_a? Array
+      i.each {|entry| remote_remove(entry) }
+    else
+      i = i.to_s.strip # Added as of July 2014.
+      i = File.basename(i) if i.include? '/'
+      # ===================================================================== #
+      # The user may input numbers. If the input is a number, we will try to
+      # find the corresponding entry - but only if no remote directory or
+      # remote file exists with that name. Some directories may be named,
+      # e. g. "123456".
+      # ===================================================================== #
+      unless this_remote_entry_exists? i
+        i = convert_number_to_file(i) if i =~ /^\d+$/
+      end
+      # ===================================================================== #
+      # Next check for user input. If the user did input a '*', then we
+      # will expand that.
+      # ===================================================================== #
+      if i.include?('*') or i.include?('*.')
+        i = ftp?.array_file_listing.select {|entry|
+          entry[0].include? i.delete('*')
+        }
+        i.reject! {|line|
+          line == '.' or line == '..' # Reject '.' and '..' entries.
+        }
+        i.map! {|entry|
+          File.basename(entry)
+        } # ^^^ This is a bit hackish.
+        remote_remove(i)
+      else
+        # =================================================================== #
+        # We try to find out whether we have a directory or a file next.
+        # =================================================================== #
+        if is_dir?(i)
+          remove_remote_directory(i)
+        else # Assume it is a file. 
+          remove_remote_file(i)
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === remove_remote_file
+  #
+  # Use this method to attempt remove a remote file.
+  # ========================================================================= #
+  def remove_remote_file(i)
+    i[0,1] = ''.dup if i.start_with? '/' # We don't like starting "/" characters here.
+    e "Removing remote file `#{sfile(i)}` next." # We remove the remote file here.
+    begin
+      result = ftp?.remove_file(i)
+      e "Successfully removed remote file `#{sfile(result)}`."
+    rescue Net::FTPPermError => error
+      e 'Can not remove file `'+sfile(i)+'` as you are not '\
+        'the owner. ('+simp('Net::FTPPermError')+')'
+      pp error
+    end
+  end
+
+end; end