module ZTK::SSH::Download

SSH Download Functionality

Public Instance Methods

download(remote, local, options={}) click to toggle source

Downloads a remote file to the local host.

@example Download a file:

$logger = ZTK::Logger.new(STDOUT)
ssh = ZTK::SSH.new
ssh.config do |config|
  config.user = ENV["USER"]
  config.host_name = "127.0.0.1"
end
local = File.expand_path(File.join(ZTK::Locator.root, "tmp", "id_rsa.pub"))
remote = File.expand_path(File.join(ENV['HOME'], ".ssh", "id_rsa.pub"))
ssh.download(remote, local)

@param [String] remote The remote file/path you with to download from. @param [String] local The local file/path you wish to download to. @param [Hash] options An optional hash of options. @option options [Boolean] :recursive (false) Whether or not to

recursively download files and directories.  By default this looks at
the local target and if it is a directory this is set to *true*
otherwise it will default to *false*.

@option options [Boolean] :use_scp (false) If set to true, the file will

be transfered using SCP instead of SFTP.  The default behaviour is to
use SFTP.  *WARNING: Recursive downloads are handled in differing
manners between SCP and SFTP!*

@return [Boolean] True if successful.

# File lib/ztk/ssh/download.rb, line 32
def download(remote, local, options={})
  options = {
    :recursive => ::File.directory?(local),
    :use_scp => false
  }.merge(options)
  options = OpenStruct.new(config.send(:table).merge(options))

  options.ui.logger.debug { "config=#{config.send(:table).inspect}" }
  options.ui.logger.debug { "options=#{options.send(:table).inspect}" }
  options.ui.logger.info { "download(#{remote.inspect}, #{local.inspect})" }

  ZTK::RescueRetry.try(:ui => config.ui, :tries => ZTK::SSH::RESCUE_RETRY_ATTEMPTS, :on_retry => method(:on_retry)) do
    if (options.use_scp == true)
      scp_download(remote, local, options)
    else
      sftp_download(remote, local, options)
    end
  end

  true
end

Private Instance Methods

scp_download(remote, local, options={}) click to toggle source
# File lib/ztk/ssh/download.rb, line 79
def scp_download(remote, local, options={})
  opened = false
  args = []

  scp.download!(remote.to_s, local.to_s, options.send(:table)) do |ch, name, sent, total|
    args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]

    opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))

    options.ui.logger.debug { "get(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
    options.on_progress.nil? or options.on_progress.call(:get, args)
  end

  options.ui.logger.debug { "finish" }
  options.on_progress.nil? or options.on_progress.call(:finish, args)
end
sftp_download(remote, local, options={}) click to toggle source
# File lib/ztk/ssh/download.rb, line 57
def sftp_download(remote, local, options={})
  sftp.download!(remote.to_s, local.to_s, options.send(:table)) do |event, downloader, *args|
    case event
    when :open
      options.ui.logger.debug { "download(#{args[0].remote} -> #{args[0].local})" }
      options.on_progress.nil? or options.on_progress.call(:open, args)
    when :close
      options.ui.logger.debug { "close(#{args[0].local})" }
      options.on_progress.nil? or options.on_progress.call(:close, args)
    when :mkdir
      options.ui.logger.debug { "mkdir(#{args[0]})" }
      options.on_progress.nil? or options.on_progress.call(:mkdir, args)
    when :get
      options.ui.logger.debug { "get(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
      options.on_progress.nil? or options.on_progress.call(:get, args)
    when :finish
      options.ui.logger.debug { "finish" }
      options.on_progress.nil? or options.on_progress.call(:finish, args)
    end
  end
end