class WinRM::FS::FileManager
Perform file transfer operations between a local machine and winrm endpoint
Public Class Methods
Source
# File lib/winrm-fs/file_manager.rb, line 28 def initialize(connection) @connection = connection @logger = connection.logger end
Creates a new FileManager
instance @param [WinRM::Connection] WinRM
web connection client
Public Instance Methods
Source
# File lib/winrm-fs/file_manager.rb, line 88 def _output_from_file(remote_path, chunk_size, index) script = WinRM::FS::Scripts.render('download', path: remote_path, chunk_size: chunk_size, index: index) ps_run(script) end
rubocop:enable Metrics/MethodLength
Source
# File lib/winrm-fs/file_manager.rb, line 93 def _write_file(tofd, output) contents = output.stdout.gsub('\n\r', '') out = Base64.decode64(contents) out = out[0, out.length - 1] if out.end_with? "\x00" return out if out.empty? tofd.write(out) out end
Source
# File lib/winrm-fs/file_manager.rb, line 37 def checksum(path, digest = 'SHA1') @logger.debug("checksum with #{digest}: #{path}") script = WinRM::FS::Scripts.render('checksum', path: path, digest: digest) ps_run(script).exitcode == 0 end
Gets the SHA1 checksum of the specified file if it exists, otherwise ” @param [String] The remote file path @parms [String] The digest method
Source
# File lib/winrm-fs/file_manager.rb, line 46 def create_dir(path) @logger.debug("create_dir: #{path}") script = WinRM::FS::Scripts.render('create_dir', path: path) ps_run(script).exitcode == 0 end
Create the specifed directory recursively @param [String] The remote dir to create @return [Boolean] True if successful, otherwise false
Source
# File lib/winrm-fs/file_manager.rb, line 55 def delete(path) @logger.debug("deleting: #{path}") script = WinRM::FS::Scripts.render('delete', path: path) ps_run(script).exitcode == 0 end
Deletes the file or directory at the specified path @param [String] The path to remove @return [Boolean] True if successful, otherwise False
Source
# File lib/winrm-fs/file_manager.rb, line 65 def download(remote_path, local_path, chunk_size = 1024 * 1024, first = true) @logger.debug("downloading: #{remote_path} -> #{local_path} #{chunk_size}") index = 0 output = _output_from_file(remote_path, chunk_size, index) return download_dir(remote_path, local_path, chunk_size, first) if output.exitcode == 2 return false if output.exitcode >= 1 File.open(local_path, 'wb') do |fd| out = _write_file(fd, output) index += out.length until out.empty? output = _output_from_file(remote_path, chunk_size, index) return false if output.exitcode >= 1 out = _write_file(fd, output) index += out.length end end true end
Downloads the specified remote file to the specified local path @param [String] The full path on the remote machine @param [String] The full path to write the file to locally rubocop:disable Metrics/MethodLength
Source
# File lib/winrm-fs/file_manager.rb, line 106 def exists?(path) @logger.debug("exists?: #{path}") script = WinRM::FS::Scripts.render('exists', path: path) ps_run(script).exitcode == 0 end
Checks to see if the given path exists on the target file system. @param [String] The full path to the directory or file @return [Boolean] True if the file/dir exists, otherwise false.
Source
# File lib/winrm-fs/file_manager.rb, line 115 def temp_dir @temp_dir ||= begin ps_run('$env:TEMP').stdout.chomp.tr('\\', '/') end end
Gets the current user’s TEMP directory on the remote system, for example ‘C:/Windows/Temp’ @return [String] Full path to the temp directory
Source
# File lib/winrm-fs/file_manager.rb, line 139 def upload(local_path, remote_path, &block) @connection.shell(:powershell) do |shell| file_transporter ||= WinRM::FS::Core::FileTransporter.new(shell) begin file_transporter.upload(local_path, remote_path, &block)[0] ensure file_transporter.close end end end
Upload one or more local files and directories to a remote directory @example copy a single file to a winrm endpoint
file_manager.upload('/Users/sneal/myfile.txt', 'c:/foo/myfile.txt')
@example copy a single directory to a winrm endpoint
file_manager.upload('c:/dev/my_dir', '$env:AppData')
@param [String] A path to a local directory or file that will be copied
to the remote Windows box.
@param [String] The target directory or file
This path may contain powershell style environment variables
@yieldparam [Fixnum] Number of bytes copied in current payload sent to the winrm endpoint @yieldparam [Fixnum] The total number of bytes to be copied @yieldparam [String] Path of file being copied @yieldparam [String] Target path on the winrm endpoint @return [Fixnum] The total number of bytes copied
Private Instance Methods
Source
# File lib/winrm-fs/file_manager.rb, line 161 def download_dir(remote_path, local_path, chunk_size, first) local_path = File.join(local_path, File.basename(remote_path.to_s)) if first FileUtils.mkdir_p(local_path) unless File.directory?(local_path) command = "Get-ChildItem #{remote_path} | Select-Object Name" @connection.shell(:powershell) { |e| e.run(command) }.stdout.strip.split(/\n/).drop(2).each do |file| download(File.join(remote_path.to_s, file.strip), File.join(local_path, file.strip), chunk_size, false) end end
Source
# File lib/winrm-fs/file_manager.rb, line 152 def ps_run(cmd) shell = @connection.shell(:powershell) begin shell.run(cmd) ensure shell.close end end