module FtpParadise

# File lib/ftp_paradise/toplevel_methods/can_connect_to_remote_site.rb, line 17
def self.can_connect_to_remote_site?
  require 'ftp_paradise/connection/connection.rb'
  ftp = FtpParadise::Connection.new(:dont_run_yet) { :use_default_dataset }
  ftp.be_quiet
  return ftp.is_connected?
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 189
def self.chdir(i)
  @ftp_object.chdir(i)
end

# File lib/ftp_paradise/toplevel_methods/clear_user_dataset.rb, line 22
def self.clear_user_dataset
  FtpParadise.set_remote_url(nil)
  FtpParadise.set_user_name(nil)
  FtpParadise.set_password(nil)
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 126
def self.close
  @ftp_object.close
end

# File lib/ftp_paradise/configuration/configuration.rb, line 45
def self.config?
  @configuration
end

# File lib/ftp_paradise/toplevel_methods/connect.rb, line 17
def self.connect(
    where_to = {}
  )
  if where_to.is_a? Hash
    require 'ftp_paradise/connection/connection.rb'
    FtpParadise::Connection.new(where_to) # This ought to be a Hash anyway.
  end
end

# File lib/ftp_paradise/toplevel_methods/file_related_actions.rb, line 31
def self.create_file(i)
  FileUtils.touch(i)
end

# File lib/ftp_paradise/toplevel_methods/data.rb, line 19
def self.data?
  {
    user_name:  FtpParadise.username?,
    password:   FtpParadise.password?,
    remote_url: FtpParadise.remote_url?
  }
end

# File lib/ftp_paradise/toplevel_methods/file_related_actions.rb, line 40
def self.delete(i) # ← Added this method as of April 2014.
  i = i.to_s # We don't want nil-errors here.
  if File.exist? i
    File.delete(i)
  else
    e "No file at #{sfile(i)} appears to exist."
  end
end

# File lib/ftp_paradise/toplevel_methods/determine_user_dataset_from_this_hash.rb, line 20
def self.determine_user_dataset_from_this_hash(i)
  if i.is_a? Hash
    if i.has_key? 'url'
      _ = i.fetch('url')
      FtpParadise.set_remote_url(_)
    end
    if i.has_key? 'user_name'
      _ = i.fetch('user_name')
      FtpParadise.set_user_name(_)
    end
    if i.has_key? 'password'
      _ = i.fetch('password')
      FtpParadise.set_password(_)
    end
  end
end

# File lib/ftp_paradise/colours/use_colours.rb, line 44
def self.disable_colours
  FtpParadise.config?.use_colours = false
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 50
def self.do_login(
    use_this_as_the_remote_url = nil,
    user                       = :default,
    passwd                     = :default_or_nil,
    acct                       = nil
  )
  if use_this_as_the_remote_url and FtpParadise.ftp_object?.nil?
    FtpParadise.set_remote_url(use_this_as_the_remote_url)
  end
  case use_this_as_the_remote_url
  # ======================================================================= #
  # === :bytehost
  # ======================================================================= #
  when :bytehost
    FtpParadise.set_remote_url(:infer)
    use_this_as_the_remote_url = remote_url?
  end
  # ======================================================================= #
  # Sanitize the default user (user name aka login name).
  # ======================================================================= #
  case user
  # ======================================================================= #
  # === :default
  # ======================================================================= #
  when :default
    if is_on_roebe?
      set_login_name(:infer)
      user = login_name?
    else
      user = 'anonymous'
    end
  end
  # ======================================================================= #
  # Sanitize the given password next.
  # ======================================================================= #
  case passwd
  # ======================================================================= #
  # === :default_or_nil
  # ======================================================================= #
  when :default_or_nil
    if is_on_roebe?
      set_password(:infer)
      passwd = password?
    else
      passwd = nil
    end
  end
  # ======================================================================= #
  # puts "Debug: user name is: #{user} password is: #{passwd} account is: #{acct}"
  # ======================================================================= #
  @ftp_object.login(
    user, passwd, acct
  ) # Delegate to the main object here.
  return @ftp_object # And mandatory return here.
end

# File lib/ftp_paradise/gui/shared_code/ftp_paradise/ftp_paradise_module.rb, line 687
def self.do_start_gui
  opnn; puts 'We will next start the GUI.'
  FtpParadise::GUI::Gtk::FtpParadiseModule.start_gtk
end

# File lib/ftp_paradise/toplevel_methods/upload_and_download.rb, line 67
def self.download(
    this_remote_file,
    use_this_ftp_object
  )
  use_this_ftp_object.gettextfile(
    this_remote_file
  )
end

# File lib/ftp_paradise/toplevel_methods/e.rb, line 12
def self.e(i = '')
  puts i
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 201
def self.ftp_object
  @ftp_object
end

# File lib/ftp_paradise/toplevel_methods/file_related_actions.rb, line 18
def self.get_files(
    from = '*'
  )
  entries = Dir[from]
  entries.select! {|entry| File.file?(entry) }
  entries
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 159
def self.getbinaryfile(
    a = 'nif.rb-0.91.gz',
    b = 'nif.gz',
    c = 1024
  )
  @ftp_object.getbinaryfile(a,b,c)
end

# File lib/ftp_paradise/gui/shared_code/ftp_paradise/ftp_paradise_module.rb, line 705
def self.gtk_widget
  FtpParadise::GUI::Gtk::FtpParadiseModule
end

# File lib/ftp_paradise/configuration/configuration.rb, line 26
def self.initialize
  if Object.const_defined? :Roebe
    # ===================================================================== #
    # Load up all .yml files from the path to the yaml directory:
    # ===================================================================== #
    @configuration = ::Roebe::Configuration::Configuration.new(FtpParadise.yaml_directory?)
  end
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 33
def self.initialize_ftp_object(use_this_url = nil)
  case use_this_url
  # ======================================================================= #
  # === :default
  # ======================================================================= #
  when :default
    use_this_url = YAML.load_file(FILE_ROEBE_FTP)['podserver']['url']
  end
  @ftp_object = Net::FTP.new(use_this_url)
end

# File lib/ftp_paradise/toplevel_methods/directory_related_actions.rb, line 17
def self.is_directory?(
    i,
    connect_to_this_host = :shevy
  )
  require 'ftp_paradise/connection/connection.rb'
  FtpParadise::Connection.new(
    i,
    connect_to_this_host: connect_to_this_host
  ).is_a_directory?(i)
end

# File lib/ftp_paradise/toplevel_methods/is_on_roebe.rb, line 12
def self.is_on_roebe?
  ENV['IS_ROEBE'].to_s == '1'
end

# File lib/ftp_paradise/colours/colours.rb, line 99
def self.lightyellow(i = '')
  if use_colours?
    return ::Colours.lightyellow(i)
  end
  return "#{Colours.yellow}#{i}#{Colours.rev}"
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 119
def self.list(i = 'n*')
  @ftp_object.list(i)
end

# File lib/ftp_paradise/toplevel_methods/login_name.rb, line 20
def self.login_name?
  @login_name
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 141
def self.mlsd(
    pathname = nil
  )
  @ftp_object.mlsd(pathname)
end

# File lib/ftp_paradise/toplevel_methods/connect.rb, line 31
def self.new(
    remote_host = :default,
    run_already = FtpParadise::Connection::RUN_ALREADY,
    &block
  )
  case remote_host
  when :dont_run_yet
    remote_host = :default
    run_already = false
  end
  if remote_host.is_a? Symbol
    run_already = remote_host
  end
  require 'ftp_paradise/connection/connection.rb'
  FtpParadise::Connection.new(
    remote_host, run_already, &block
  )
end

# File lib/ftp_paradise/toplevel_methods/opn.rb, line 18
def self.opn(
    i = { namespace: NAMESPACE }
  )
  Opn.opn(i) if Object.const_defined? :Opn
end

# File lib/ftp_paradise/toplevel_methods/password.rb, line 24
def self.password?
  @password
end

# File lib/ftp_paradise/toplevel_methods/port.rb, line 32
def self.port?
  @port
end

# File lib/ftp_paradise/project/project.rb, line 28
def self.project_base_dir?
  PROJECT_BASE_DIRECTORY
end

# File lib/ftp_paradise/project/project.rb, line 48
def self.project_yaml_dir?
  "#{PROJECT_BASE_DIRECTORY}yaml/"
end

# File lib/ftp_paradise/toplevel_methods/rds.rb, line 14
def self.rds(i)
  i.squeeze '/'
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 170
def self.remote_host?
  if @ftp_object
    @ftp_object.remote_host?
  else
    nil
  end
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 224
def self.remote_mkdir(
    create_this_remote_directory,
    connection           = @ftp_object,
    connect_to_this_host = :shevy
  )
  if create_this_remote_directory.is_a? Array
    create_this_remote_directory.each {|name_of_the_remote_directory|
      remote_mkdir(
        name_of_the_remote_directory,
        connection,
        connect_to_this_host
      )
    }
  else
    create_this_remote_directory = create_this_remote_directory.to_s

    if connection.nil?
      require 'ftp_paradise/connection/connection.rb'
      connection = FtpParadise::Connection.new(connect_to_this_host) { :do_not_run_yet }
      connection.be_silent
      connection.do_login
    end

    begin
      connection.mkdir(create_this_remote_directory)
    rescue Net::FTPPermError => error
      pp error
      e "No directory called #{create_this_remote_directory}/ could be created"
      e 'as such a (remote) directory already exists.'
    end

  end
end

# File lib/ftp_paradise/toplevel_methods/remote_url.rb, line 21
def self.remote_url?
  @remote_url
end

# File lib/ftp_paradise/requires/require_the_toplevel_methods.rb, line 13
def self.require_the_toplevel_methods
  Dir["#{PROJECT_BASE_DIRECTORY}toplevel_methods/*.rb"].each {|this_file|
    require this_file
  }
end

# File lib/ftp_paradise/toplevel_methods/time.rb, line 14
def self.return_date
  Time.now.strftime('%d.%m.%Y')
end

# File lib/ftp_paradise/toplevel_methods/misc.rb, line 12
def self.return_pwd
  return ("#{Dir.pwd}/").squeeze('/')
end

# File lib/ftp_paradise/toplevel_methods/time.rb, line 30
def self.return_time
  Time.now.strftime('%H:%M:%S')
end

# File lib/ftp_paradise/colours/colours.rb, line 109
def self.royalblue(i = '')
  if use_colours?
    return ::Colours.royalblue(i)
  end
  return i
end

# File lib/ftp_paradise/colours/colours.rb, line 24
def self.sdir(i)
  return Colours.sdir(i) if use_colours?
  i
end

# File lib/ftp_paradise/toplevel_methods/login_name.rb, line 27
def self.set_login_name(
    i = :try_to_infer_automatically
  )
  case i
  # ======================================================================= #
  # === :try_to_infer_automatically
  # ======================================================================= #
  when :try_to_infer_automatically,
       :infer
    if File.exist? FILE_ROEBE_FTP
      i = YAML.load_file(FILE_ROEBE_FTP)['podserver']['user_name']
    end
  end
  @login_name = i
end

# File lib/ftp_paradise/toplevel_methods/password.rb, line 31
def self.set_password(
    i = :try_to_infer_automatically
  )
  case i
  # === :try_to_infer_automatically
  when :try_to_infer_automatically,
       :infer
    if File.exist? FILE_ROEBE_FTP
      i = YAML.load_file(FILE_ROEBE_FTP)['bytehost']['password']
    end
  end
  @password = i
end

# File lib/ftp_paradise/toplevel_methods/port.rb, line 17
def self.set_port(
    i = :try_to_infer_automatically
  )
  case i
  when :try_to_infer_automatically
    if File.exist? FILE_ROEBE_FTP
      i = YAML.load_file(FILE_ROEBE_FTP)['podcast']['port']
    end
  end
  @port = i
end

# File lib/ftp_paradise/toplevel_methods/remote_url.rb, line 33
def self.set_remote_url(
    i = :try_to_infer
  )
  case i
  when nil, :infer, :try_to_infer
    if is_on_roebe?
      if File.exist? FILE_ROEBE_FTP
        i = YAML.load_file(FILE_ROEBE_FTP)['bytehost']['url']
      end
    end
  end
  @remote_url = i
end

# File lib/ftp_paradise/colours/colours.rb, line 48
def self.sfancy(i)
  return Colours.sfancy(i) if use_colours? # Else we won't modify this at all.
  return i
end

# File lib/ftp_paradise/colours/colours.rb, line 40
def self.sfile(i)
  return Colours.sfile(i) if use_colours?
  return i
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 211
def self.show_list
  result = @ftp_object.list
  result.each {|line|
    e line unless line.end_with? '.'
  }
end

# File lib/ftp_paradise/colours/colours.rb, line 56
def self.simp(i)
  return Colours.simp(i) if use_colours? # Else we won't modify this.
  return i
end

# File lib/ftp_paradise/colours/colours.rb, line 119
def self.slateblue(i = '')
  if use_colours?
    return ::Colours.slateblue(i)
  end
  return i
end

# File lib/ftp_paradise/gui/shared_code/ftp_paradise/ftp_paradise_module.rb, line 695
def self.start_gtk
  FtpParadise::GUI::Gtk::FtpParadiseModule.run
end

# File lib/ftp_paradise/colours/colours.rb, line 32
def self.swarn(i)
  return Colours.swarn(i) if use_colours?
  return i
end

# File lib/ftp_paradise/colours/colours.rb, line 131
def self.testing_colours
  e 'We will now test some colours.'
  e "Will we use colours? #{FtpParadise.use_colours?.to_s}"
  e 'Testing '+sfancy('sfancy')+' next.'
end

# File lib/ftp_paradise/toplevel_methods/upload_and_download.rb, line 84
def self.upload(
    local_target,
    remote_target       = :short_variant,
    use_this_ftp_object = :shevy,
    &block
  )
  case remote_target
  when :short_variant
    remote_target = File.basename(local_target)
  end
  if use_this_ftp_object.is_a? Symbol
    require 'ftp_paradise/connection/connection.rb'
    use_this_ftp_object = FtpParadise::Connection.new(:dont_run_yet)
    opn; e "We will now connect to #{sfancy(use_this_ftp_object.to_s)}."
    use_this_ftp_object.connect_to
    use_this_ftp_object.upload(local_target)
  end
  use_this_ftp_object.put(
    local_target,
    remotefile = File.basename(localfile),
    &block
  )
end

# File lib/ftp_paradise/toplevel_methods/upload_and_download.rb, line 29
def self.upload_this_binary_file(
    file,
    be_verbose             = :be_silent,
    use_this_as_ftp_object = nil
  )
  yielded = nil
  yielded = yield if block_given?
  case yielded
  when :be_quiet
    be_verbose = false
  end
  case be_verbose
  when :be_silent
    be_verbose = false
  end
  unless use_this_as_ftp_object
    require 'ftp_paradise/connection/connection.rb'
    use_this_as_ftp_object = ::FtpParadise::Connection.new(:dont_run_yet) { :default_dataset }
    if be_verbose
      use_this_as_ftp_object.be_verbose
    else
      use_this_as_ftp_object.be_quiet
    end
    use_this_as_ftp_object.set_binary_mode
  end
  if yielded
    if yielded.is_a? Hash
      if yielded.has_key? :cd_into_this_directory
        use_this_as_ftp_object.remote_cd(yielded[:cd_into_this_directory])
      end
    end
  end
  use_this_as_ftp_object.upload(file, be_verbose) # Here, do the FTP upload finally.
end

# File lib/ftp_paradise/colours/use_colours.rb, line 30
def self.use_colours?
  if FtpParadise.respond_to?(:config?) and
     FtpParadise.config?.respond_to?(:use_colours)
    FtpParadise.config?.use_colours
  else
    true
  end
end

# File lib/ftp_paradise/toplevel_methods/ftp_object.rb, line 111
def self.use_this_as_ftp_object(i)
  @ftp_object = i
end

# File lib/ftp_paradise/toplevel_methods/time.rb, line 21
def return_date
  FtpParadise.return_date
end

# File lib/ftp_paradise/toplevel_methods/time.rb, line 37
def return_time
  FtpParadise.return_time
end

# File lib/ftp_paradise/colours/colours.rb, line 16
def rev
  return Colours.rev if use_colours?
  return ''
end

# File lib/ftp_paradise/colours/colours.rb, line 78
def sdir(i)
  FtpParadise.sdir(i)
end

# File lib/ftp_paradise/colours/colours.rb, line 64
def sfancy(i)
  FtpParadise.sfancy(i) # We can delegate here, because FtpParadise.sfancy() will take care of colours.
end

# File lib/ftp_paradise/colours/colours.rb, line 85
def sfile(i)
  FtpParadise.sfile(i)
end

# File lib/ftp_paradise/colours/colours.rb, line 71
def simp(i) # Link to FtpParadise.simp
  FtpParadise.simp(i) # We can delegate here, because FtpParadise.sfancy will take care of colours.
end

# File lib/ftp_paradise/colours/colours.rb, line 92
def swarn(i)
  FtpParadise.swarn(i)
end

# File lib/ftp_paradise/colours/use_colours.rb, line 53
def use_colours?
  FtpParadise.use_colours?
end

# File lib/ftp_paradise/project/project.rb, line 55
def yaml_directory?
  FtpParadise.yaml_directory?
end