ftp_paradise 1.4.5 → 1.5.3

data/lib/ftp_paradise/constants/roebe_ftp_constants.rb

@@ -1,233 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/constants/roebe_ftp_constants.rb'
-# include FtpParadise::RoebeFtpConstants
-# =========================================================================== #
-module FtpParadise # === FtpParadise::RoebeFtpConstants
-
-module RoebeFtpConstants
-
-  require 'ftp_paradise/constants/roebe.rb'
-  require 'yaml'
-
-  # ========================================================================= #
-  # === FtpParadise::RoebeFtpConstants::@hash_ftp_dataset
-  # ========================================================================= #
-  @hash_ftp_dataset = {}
-
-  # ========================================================================= #
-  # === FTP_DATASET
-  #
-  # Here we will load my custom ftp file, but only if this file exists.
-  #
-  # If it does not exist, then we will not load it, and we will not
-  # make use of it. That way others can ignore this file altogether.
-  #
-  # The location for my file is at:
-  #
-  #   bl $MY_FTP/YAML/roebe_ftp.yml
-  #
-  # ========================================================================= #
-  if File.exist? FILE_ROEBE_FTP
-    FTP_DATASET = FILE_ROEBE_FTP
-  else
-    begin
-      home_dir = File.expand_path('~')
-    rescue; end
-    home_dir = '/root' if home_dir.nil? # A safeguard here if ENV is unavailable.
-    FTP_DATASET = "#{home_dir}/roebe_ftp.yml"
-  end
-
-  # ========================================================================= #
-  # === FtpParadise::RoebeFtpConstants.file?
-  #
-  # Feedback where that file is.
-  # ========================================================================= #
-  def self.file?
-    FILE_ROEBE_FTP
-  end
-
-  # ========================================================================= #
-  # === FtpParadise::RoebeFtpConstants.hash_ftp_dataset?
-  # ========================================================================= #
-  def self.hash_ftp_dataset?
-    @hash_ftp_dataset
-  end; self.instance_eval { alias hash? hash_ftp_dataset? } # === FtpParadise::RoebeFtpConstants.hash_ftp_dataset?.hash?
-
-  # ========================================================================= #
-  # Next check whether the roebe_ftp.yml file exists. If it does then
-  # we will load it up.
-  # ========================================================================= #
-  if File.exist? file?
-    dataset = YAML.load_file(file?)
-    @hash_ftp_dataset.update(dataset) # Sync the dataset.
-    # ======================================================================= #
-    # The format of the dataset has to be uniform. We start with the
-    # remote URL, then the user name, the password, and then the port.
-    # ======================================================================= #
-
-    # ======================================================================= #
-    # === A1 TAG
-    # ======================================================================= #
-    _ = dataset['a1']
-    A1 = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === ZYMIX TAG
-    # ======================================================================= #
-    _ = dataset['zymix']
-    ZYMIX = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === Bytehost Tag
-    #
-    # bl $MY_FTP/YAML/roebe_ftp.yml
-    # ======================================================================= #
-    _ = dataset['bytehost']
-    BYTEHOST = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-    
-    # ======================================================================= #
-    # === UNIVIE
-    #
-    # Uni tag, Univie tag
-    # ======================================================================= #
-    _ = dataset['univie']
-    UNIVIE = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === Zerofees tag
-    # ======================================================================= #
-    _ = dataset['zerofees']
-    ZEROFEES = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === UCOZ tag
-    # ======================================================================= #
-    _ = dataset['ucoz']
-    UCOZ = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === UNIWIEN_HOMEPAGE tag
-    # ======================================================================= #
-    _ = dataset['uniwien_homepage']
-    UNIWIEN_HOMEPAGE = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === bplaced
-    # ======================================================================= #
-    _ = dataset['bplaced']
-    BPLACED = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === podserver
-    # ======================================================================= #
-    _ = dataset['podserver']
-    PODSERVER = [
-      _['url'],
-      _['user_name'],
-      _['password'],
-      _['port']
-    ]
-
-    # ======================================================================= #
-    # === RoebeFtpConstants::ARRAY_AVAILABLE_HOSTS
-    #
-    # All available hosts are kept in the following Array.
-    #
-    # It is always available when the roebe_ftp.yml file was found.
-    #
-    # Append to this Array if you add new entries above.
-    # ======================================================================= #
-    ARRAY_AVAILABLE_HOSTS = [
-      BYTEHOST.first,
-      A1.first,
-      ZYMIX.first,
-      UNIVIE.first,
-      ZEROFEES.first,
-      UCOZ.first,
-      UNIWIEN_HOMEPAGE.first,
-      PODSERVER.first
-    ]
-  end
-
-  # ========================================================================= #
-  # === RoebeFtpConstants.possible_hosts?
-  # ========================================================================= #
-  def self.possible_hosts?
-    ARRAY_AVAILABLE_HOSTS
-  end
-
-  # ========================================================================= #
-  # === RoebeFtpConstants.geas?
-  # ========================================================================= #
-  def self.geas?
-    GEAS
-  end
-
-  # ========================================================================= #
-  # === RoebeFtpConstants.return_user_name_based_on_given_host
-  #
-  # This method may return the proper user name.
-  # ========================================================================= #
-  def self.return_user_name_based_on_given_host(i)
-    if ARRAY_AVAILABLE_HOSTS.include? i
-      i = PODSERVER[1] # Hardcoded for now. [1] is the user-name.
-    end if FtpParadise.const_defined? :RoebeFtpConstants
-    i
-  end
-
-end; end
-
-if __FILE__ == $PROGRAM_NAME # Testing RoebeFtpConstants next.
-  require 'cliner'
-  require 'colours/colours_e_autoinclude.rb'
-  include RoebeFtpConstants
-  cliner
-  e RoebeFtpConstants.file?
-  cliner
-  pp RoebeFtpConstants.hash_ftp_dataset?
-  pp RoebeFtpConstants::GEAS
-  pp RoebeFtpConstants.geas?
-end # $FTP_PARADISE/roebe_ftp_constants.rb

data/lib/ftp_paradise/gui/gtk2/ftp_paradise.rb

@@ -1,34 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === FtpParadise::GUI::Gtk::FtpParadise
-# =========================================================================== #
-# require 'ftp_paradise/gui/gtk2/ftp_paradise.rb'
-# FtpParadise::GUI::Gtk::FtpParadise.run
-# =========================================================================== #
-require 'gtk_paradise/require_gtk2'
-
-module FtpParadise
-
-module GUI
-
-module Gtk
-
-class FtpParadise < ::Gtk::Box
-
-  require 'ftp_paradise/gui/shared_code/ftp_paradise/ftp_paradise_module.rb'
-  include ::FtpParadise::GUI::Gtk::FtpParadiseModule
-
-  # ========================================================================= #
-  # === FtpParadise::GUI::Gtk::FtpParadise.run
-  # ========================================================================= #
-  def self.run
-    ::FtpParadise::GUI::Gtk::FtpParadiseModule.run
-  end
-
-end; end; end; end
-
-if __FILE__ == $PROGRAM_NAME
-  FtpParadise::GUI::Gtk::FtpParadise.run
-end

data/lib/ftp_paradise/gui/gtk3/ftp_paradise.rb

@@ -1,34 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === FtpParadise::GUI::Gtk::FtpParadise
-# =========================================================================== #
-# require 'ftp_paradise/gui/gtk3/ftp_paradise.rb'
-# FtpParadise::GUI::Gtk::FtpParadise.run
-# =========================================================================== #
-require 'gtk_paradise/require_gtk3'
-
-module FtpParadise
-
-module GUI
-
-module Gtk
-
-class FtpParadise < ::Gtk::Box
-
-  require 'ftp_paradise/gui/shared_code/ftp_paradise/ftp_paradise_module.rb'
-  include ::FtpParadise::GUI::Gtk::FtpParadiseModule
-
-  # ========================================================================= #
-  # === FtpParadise::GUI::Gtk::FtpParadise.run
-  # ========================================================================= #
-  def self.run
-    ::FtpParadise::GUI::Gtk::FtpParadiseModule.run
-  end
-
-end; end; end; end
-
-if __FILE__ == $PROGRAM_NAME
-  FtpParadise::GUI::Gtk::FtpParadise.run
-end

data/lib/ftp_paradise/interactive_ftp/constants.rb

@@ -1,103 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# All constants for class Interactive shall be stored in this file here.
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/constants.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp # === FtpParadise::InteractiveFtp
-
-  require 'ftp_paradise/toplevel_methods/rds.rb'
-
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-  # ========================================================================= #
-  # === TITLE  
-  # ========================================================================= #
-  TITLE = 'Interactive FTP'
-
-  # ========================================================================= #
-  # === SHOW_REMOTE_FILES_UPON_SUCCESSFUL_LOGIN
-  #
-  # If this constant is true then we will show the remote file
-  # listing upon a successful (first) login action.
-  # ========================================================================= #
-  SHOW_REMOTE_FILES_UPON_SUCCESSFUL_LOGIN = false
-
-  # ========================================================================= #
-  # === SHALL_WE_DEBUG
-  # ========================================================================= #
-  SHALL_WE_DEBUG = true
-
-  # ========================================================================= #
-  # === PROMPT_TO_USE
-  #
-  # Which Prompt to use by default for the Interactive FTP component.
-  # ========================================================================= #
-  PROMPT_TO_USE = '> '
-
-  # ========================================================================= #
-  # === ARRAY_FORBIDDEN_HISTORY_COMMANDS
-  # ========================================================================= #
-  ARRAY_FORBIDDEN_HISTORY_COMMANDS = %w(
-    last
-  ) # Dont append last to the history.
-
-  # ========================================================================= #
-  # === OPEN_IN_DEFAULT_EDITOR
-  # ========================================================================= #
-  OPEN_IN_DEFAULT_EDITOR = true
-
-  # ========================================================================= #
-  # === USE_THIS_EDITOR
-  # ========================================================================= #
-  USE_THIS_EDITOR = ENV['EDITOR'].to_s
-
-  # ========================================================================= #
-  # === DEFAULT_LOCAL_DIRECTORY
-  # ========================================================================= #
-  DEFAULT_LOCAL_DIRECTORY = ::FtpParadise.rds("#{Dir.pwd}/") #  More flexible that way, I suppose.
-
-  # ========================================================================= #
-  # === NAME_OF_THIS_FILE
-  # ========================================================================= #
-  NAME_OF_THIS_FILE = "#{PROJECT_BASE_DIRECTORY}interactive_ftp.rb"
-
-  # ========================================================================= #
-  # === ARRAY_PROJECT_FILES
-  #
-  # The following files have to be opened when you wish to open the
-  # project files.
-  # ========================================================================= #
-  ARRAY_PROJECT_FILES = %w(
-    library.rb
-    interactive.rb
-    addon/constants/roebe_ftp_constants.rb
-    doc/TODO
-  ).map {|entry| PROJECT_BASE_DIRECTORY+entry}
-
-  # ========================================================================= #
-  # === DEFAULT_REMOTE_DIRECTORY
-  #
-  # The default remote directory.
-  # ========================================================================= #
-  DEFAULT_REMOTE_DIRECTORY = %q(
-    htdocs
-  ).delete("\n").strip # kill newlines and empty spaces.
-
-  # ========================================================================= #
-  # === DEFAULT_REMOTE_FILE
-  #
-  # The default remote file comes next.
-  # ========================================================================= #
-  DEFAULT_REMOTE_FILE = %q(
-    README.md
-  ).gsub(/\n/,'').strip
-
-end; end

data/lib/ftp_paradise/interactive_ftp/directory_handling.rb

@@ -1,216 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/directory_handling.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp
-
-  # ========================================================================= #
-  # === ftp_remote_directory?
-  # ========================================================================= #
-  def ftp_remote_directory?
-    ftp?.remote_directory?
-  end; alias return_remote_pwd ftp_remote_directory? # === return_remote_pwd
-
-  # ========================================================================= #
-  # === report_remote_directory
-  #
-  # This method will report the remote directory.
-  # ========================================================================= #
-  def report_remote_directory(
-      make_newline = true
-    )
-    if is_connected?
-      remote_dir = sdir(ftp_remote_directory?)
-      if make_newline
-        e 'The remote directory is: '
-        e "  #{sdir(remote_dir)}"
-      else
-        e 'The remote directory is: '+sdir(remote_dir)
-      end
-    else
-      e 'No connection is available. You may have to re-connect again.'
-    end
-  end; alias show_remote_directory report_remote_directory # === show_remote_directory
-
-  # ========================================================================= #
-  # === remote_directory?
-  # ========================================================================= #
-  def remote_directory?
-    @remote_directory
-  end
-
-  # ========================================================================= #
-  # === set_remote_directory
-  # ========================================================================= #
-  def set_remote_directory(i)
-    i = File.dirname(i) if ftp?.is_file?(i) # Get the base directory here.
-    @remote_directory = i
-    @array_history_remote_directories << @remote_directory
-  end
-
-  # ========================================================================= #
-  # === upload_directory
-  # ========================================================================= #
-  def upload_directory(i)
-    ftp?.upload_directory(i)
-  end
-
-  # ========================================================================= #
-  # === remote_change_directory
-  #
-  # This method can be used to change directory on the remote host.
-  #
-  # An argument such as :show_remote_file_listing can be passed as second
-  # argument to this method, in which case we will list the content of
-  # the remote directory after the cd-action.
-  #
-  # If readline is used, as determined by the instance variable @use_readline,
-  # then we will attempt to cd-<TAB>.
-  #
-  # Invocation example:
-  #
-  #   rcd htdocs
-  #
-  # ========================================================================= #
-  def remote_change_directory(
-      i                    = f?,
-      optional_instruction = nil,
-      be_verbose           = false
-    )
-    i = i.first if i.is_a? Array
-    i = '..' if i.nil? # <- Tiny "safeguard".
-    # ======================================================================= #
-    # We must first check whether we input only numbers,
-    # and whether such a directory does NOT exist. 
-    # ======================================================================= #
-    if (i =~ /^\d+$/) and !is_dir?(i)
-      ftp?.update_file_listing
-      i = ftp?.array_file_listing[i.to_i - 1]
-    end
-    if be_verbose
-      e "Trying to cd into the remote directory `#{sfancy(i)}`."
-    end
-    case i # case tag
-    when '?' # intercept ?
-      e 'You went into these remote directories so far:'
-      @array_history_remote_directories.each { |entry|
-        e "- #{entry}"
-      }
-    else # This is the default.
-      if i
-        i.squeeze!('/') if i.include? '//' # Get rid of multiple //.
-        e "Changing remote directory to `#{sdir(i)}` now."
-      end
-      begin
-        ftp?.chdir(i)
-        set_remote_directory(i)
-        if optional_instruction
-          case optional_instruction
-          when :show_remote_file_listing
-            show_remote_files
-          end
-        end
-      rescue Exception => error
-        pp error
-      end
-    end
-  end; alias remote_cd remote_change_directory # === remote_cd
-
-  # ========================================================================= #
-  # === change_local_and_remote_directories
-  #
-  # We combine local cd and remote cd here.
-  # ========================================================================= #
-  def change_local_and_remote_directories(
-      target = DEFAULT_LOCAL_DIRECTORY
-    )
-    change_directory(target, :be_silent) # Mandatory since as of 01.05.2011
-    if are_we_connected?
-      remote_change_directory(target) # Since as of August 2011.
-    end
-  end
-
-  # ========================================================================= #
-  # === set_start_directory=
-  # ========================================================================= #
-  def set_start_directory=(i) # set_start_directory=(i)
-    change_directory(i)
-  end
-
-  # ========================================================================= #
-  # === change_directory                                             (cd tag)
-  #
-  # This only changes for local directories, not remote directories.
-  # ========================================================================= #
-  def change_directory(
-      i          = DEFAULT_LOCAL_DIRECTORY,
-      be_verbose = true
-    )
-    i = '..' if i.nil?
-    be_verbose = false if be_verbose == :be_silent
-    i = i.to_s
-    i.gsub!(/; pwd/,'') if i.include? '; pwd'
-    begin
-      i = get_env_of(i) if i.include? '$'
-      if File.exist?(i)
-        # =================================================================== #
-        # Next, do the actual "change directory" action.
-        # =================================================================== #
-        Dir.chdir(i) # This will cd for local directories.
-        i = return_pwd if i == '..'
-        i = rds(return_pwd) unless i.include? '/'
-        set_local_directory(i) # Set the new pwd here.
-        report_local_directory if be_verbose
-      else # else, the directory does not exist.
-        e swarn('But the directory '+sdir(i)+' does not exist '\
-          'locally in '+sdir(return_pwd)+'.')
-      end
-    rescue Exception => error
-      e 'An exception occurred in '+swarn('change_directory()')
-      e "The directory `#{sdir(i)}` does not exist."
-      pp error # Should remove this and error perhaps.
-    end
-  end; alias cd change_directory # === cd
-
-  # ========================================================================= #
-  # === report_local_directory
-  #
-  # Use only this method when reporting the local directory.
-  # ========================================================================= #
-  def report_local_directory
-    e 'The local directory is: '+N+
-       @pad+sdir(return_pwd)
-  end; alias report_local_dir report_local_directory # === report_local_dir
-
-  # ========================================================================= #
-  # === remote_create_directory
-  # ========================================================================= #
-  def remote_create_directory(
-      i          = a?,
-      be_verbose = true
-    )
-    if i.is_a? Array
-      i.each {|entry| remote_create_directory(entry, be_verbose) }
-    else
-      # ===================================================================== #
-      # Delegate towards the respective module-method next.
-      # ===================================================================== #
-      if be_verbose
-        e "Creating the directory #{sdir(i)} next:"
-      end
-      FtpParadise.remote_create_directory(i, @ftp)
-    end
-  end
-
-  # ========================================================================= #
-  # === return_pwd
-  # ========================================================================= #
-  def return_pwd
-    ("#{Dir.pwd}/").squeeze '/'
-  end
-
-end; end

data/lib/ftp_paradise/interactive_ftp/help.rb

@@ -1,50 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/help.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp
-
-  # ========================================================================= #
-  # === show_help                                                  (help tag)
-  # ========================================================================= #
-  def show_help
-    cliner
-    e "Try one of these #{sfancy('help options')} for interactive-ftp:#{N}#{N}"
-    e parens(:assign)+'     '+pound_token+'Assign to the @file variable'
-    e parens(:help)+'       '+pound_token+'To see the help section'
-    e parens(:history)+'    '+pound_token+'To show the history'
-    e parens(:cd)+'         '+pound_token+'Change local directory'
-    e parens(:config)+'     '+pound_token+'Show the configuration'
-    e parens(:dated)+'      '+pound_token+'Display the remote directory '\
-      'content in a time-sorted manner'
-    e parens(:edit)+'       '+pound_token+'Edit this file here in your main editor'
-    e parens(:everything)+' '+pound_token+'Show everything (username, password, host and so on)'
-    e parens(:login)+'      '+pound_token+'Connect to the remote host (alias '\
-      'to connect_to exists)'
-    e parens(:list)+'       '+pound_token+'List remote files'
-    e parens(:last)+'       '+pound_token+'Repeat the last action (or show the last action)'
-    e parens(:rcd)+'        '+pound_token+'Change remote directory'
-    e parens(:remote?)+'    '+pound_token+'List where we are connected'
-    e parens(:stat)+'       '+pound_token+'Show information about a file'
-    e parens(:status?)+'    '+pound_token+'See the current status of the connection'
-    e parens(:file?)+'      '+pound_token+'Shows whether we have a '+
-      'default file set (which can be used to upload)'
-    e parens(:info)+'       '+pound_token+'Shows some information (debug)'
-    e parens(:set_port)+'   '+pound_token+'Set the port number'
-    e parens(:q)+'          '+pound_token+'To quit/exit'
-    e parens(:quit)+'       '+pound_token+'Quit the session'
-    if on_roebe? # Display it only for me.
-      e parens(:shevy)+'      '+pound_token+'Connect to shevy'
-    end
-    e parens(:lpwd)+'       '+pound_token+'Report the current remote directory'
-    e parens(:pwd)+'        '+pound_token+'Report the local directory'+N
-    e parens(:welcome)+'    '+pound_token+'Show the welcome-message of the remote FTP server'+N
-    e
-    cliner
-  end; alias show_help_options show_help # === show_help_options
-
-end; end