def get(self, remotepaths, localpath=''):
"""
Copies one or more files from the remote host to the local host.
"""
remotepaths = self._make_list(remotepaths)
localpath = localpath or os.getcwd()
globs = []
noglobs = []
for rpath in remotepaths:
if glob.has_magic(rpath):
globs.append(rpath)
else:
noglobs.append(rpath)
globresults = [self.glob(g) for g in globs]
remotepaths = noglobs
for globresult in globresults:
remotepaths.extend(globresult)
recursive = False
for rpath in remotepaths:
if not self.path_exists(rpath):
raise exception.BaseException(
"Remote file or directory does not exist: %s" % rpath)
for rpath in remotepaths:
if self.isdir(rpath):
recursive = True
break
try:
self.scp.get(remotepaths, local_path=localpath,
recursive=recursive)
except Exception, e:
log.debug("get failed: remotepaths=%s, localpath=%s",
str(remotepaths), localpath)
raise exception.SCPException(str(e))
def _set_time(self, cmd):
try:
times = cmd.split()
mtime = int(times[0])
atime = int(times[2]) or mtime
except:
self.channel.send('\x01')
raise exception.SCPException('Bad time format')
# save for later
self._utime = (atime, mtime)
def _recv_confirm(self):
# read scp response
msg = ''
try:
msg = self.channel.recv(512)
except SocketTimeout:
raise exception.SCPException('Timeout waiting for scp response')
if msg and msg[0] == '\x00':
return
elif msg and msg[0] == '\x01':
raise exception.SCPException(msg[1:])
elif self.channel.recv_stderr_ready():
msg = self.channel.recv_stderr(512)
raise exception.SCPException(msg)
elif not msg:
raise exception.SCPException('No response from server')
else:
raise exception.SCPException('Invalid response from server: ' +
msg)
def get(self,
remote_path,
local_path='',
recursive=False,
preserve_times=False):
"""
Transfer files from remote host to localhost
@param remote_path: path to retrieve from remote host. since this is
evaluated by scp on the remote host, shell wildcards and
environment variables may be used.
@type remote_path: str
@param local_path: path in which to receive files locally
@type local_path: str
@param recursive: transfer files and directories recursively
@type recursive: bool
@param preserve_times: preserve mtime and atime of transferred files
and directories.
@type preserve_times: bool
"""
self._recv_dir = local_path or os.getcwd()
if len(remote_path) == 1 and local_path != os.curdir:
if not os.path.isdir(local_path):
self._rename_dir = recursive
self._rename_file = not recursive
if len(remote_path) > 1:
if not os.path.exists(self._recv_dir):
msg = "Local path '%s' does not exist" % self._recv_dir
raise exception.SCPException(msg)
elif not os.path.isdir(self._recv_dir):
msg = "Local path '%s' is not a directory" % self._recv_dir
raise exception.SCPException(msg)
rcsv = ('', ' -r')[recursive]
prsv = ('', ' -p')[preserve_times]
self.channel = self.transport.open_session()
self.channel.settimeout(self.socket_timeout)
if isinstance(remote_path, (list, tuple)):
remote_path = ' '.join(remote_path)
self.channel.exec_command('scp%s%s -f %s' % (rcsv, prsv, remote_path))
self._recv_all()
if self.channel:
self.channel.close()
def _recv_pushd(self, cmd):
parts = cmd.split()
try:
mode = int(parts[0], 8)
path = os.path.join(self._recv_dir, parts[2])
if self._rename_dir:
path = self._recv_dir
except:
self.channel.send('\x01')
raise exception.SCPException('Bad directory format')
try:
if not os.path.exists(path):
os.mkdir(path, mode)
elif os.path.isdir(path):
os.chmod(path, mode)
else:
raise exception.SCPException('%s: Not a directory' % path)
self._dirtimes[path] = (self._utime)
self._utime = None
self._recv_dir = path
except (OSError, exception.SCPException), e:
self.channel.send('\x01' + e[0])
raise
def put(self, localpaths, remotepath='.'):
"""
Copies one or more files from the local host to the remote host.
"""
localpaths = self._make_list(localpaths)
recursive = False
for lpath in localpaths:
if os.path.isdir(lpath):
recursive = True
break
try:
self.scp.put(localpaths, remote_path=remotepath,
recursive=recursive)
except Exception, e:
log.debug("put failed: localpaths=%s, remotepath=%s",
str(localpaths), remotepath)
raise exception.SCPException(str(e))
def _recv_file(self, cmd):
chan = self.channel
parts = cmd.split()
try:
mode = int(parts[0], 8)
size = int(parts[1])
path = os.path.join(self._recv_dir, parts[2])
if self._rename_file:
path = self._recv_dir
except:
chan.send('\x01')
chan.close()
raise exception.SCPException('Bad file format')
try:
file_hdl = file(path, 'wb')
except IOError, e:
chan.send('\x01' + str(e))
chan.close()
raise
def _recv_all(self):
# loop over scp commands, and recive as necessary
command = {
'C': self._recv_file,
'T': self._set_time,
'D': self._recv_pushd,
'E': self._recv_popd
}
while not self.channel.closed:
# wait for command as long as we're open
self.channel.sendall('\x00')
msg = self.channel.recv(1024)
if not msg: # chan closed while recving
break
code = msg[0]
try:
command[code](msg[1:])
except KeyError:
raise exception.SCPException(str(msg).strip())
# directory times can't be set until we're done writing files
self._set_dirtimes()
class SCPClient(object):
"""
An scp1 implementation, compatible with openssh scp.
Raises SCPException for all transport related errors. Local filesystem
and OS errors pass through.
Main public methods are .put and .get
The get method is controlled by the remote scp instance, and behaves
accordingly. This means that symlinks are resolved, and the transfer is
halted after too many levels of symlinks are detected.
The put method uses os.walk for recursion, and sends files accordingly.
Since scp doesn't support symlinks, we send file symlinks as the file
(matching scp behavior), but we make no attempt at symlinked directories.
"""
def __init__(self,
transport,
buff_size=16384,
socket_timeout=5.0,
progress=None):
"""
Create an scp1 client.
@param transport: an existing ssh L{Transport}
@type transport: L{Transport}
@param buff_size: size of the scp send buffer.
@type buff_size: int
@param socket_timeout: channel socket timeout in seconds
@type socket_timeout: float
@param progress: callback - called with (filename, size, sent) during
transfers
@type progress: function(string, int, int)
"""
self.transport = transport
self.buff_size = buff_size
self.socket_timeout = socket_timeout
self.channel = None
self.preserve_times = False
self._progress = progress
self._recv_dir = ''
self._rename_file = False
self._rename_dir = False
self._utime = None
self._dirtimes = {}
def put(self,
files,
remote_path='.',
recursive=False,
preserve_times=False):
"""
Transfer files to remote host.
@param files: A single path, or a list of paths to be transferred.
recursive must be True to transfer directories.
@type files: string OR list of strings
@param remote_path: path in which to receive the files on the remote
host. defaults to '.'
@type remote_path: str
@param recursive: transfer files and directories recursively
@type recursive: bool
@param preserve_times: preserve mtime and atime of transferred files
and directories.
@type preserve_times: bool
"""
self.preserve_times = preserve_times
self.channel = self.transport.open_session()
self.channel.settimeout(self.socket_timeout)
scp_command = ('scp -t %s', 'scp -r -t %s')[recursive]
self.channel.exec_command(scp_command % remote_path)
self._recv_confirm()
if not isinstance(files, (list, tuple)):
files = [files]
if recursive:
self._send_recursive(files)
else:
self._send_files(files)
if self.channel:
self.channel.close()
def get(self,
remote_path,
local_path='',
recursive=False,
preserve_times=False):
"""
Transfer files from remote host to localhost
@param remote_path: path to retrieve from remote host. since this is
evaluated by scp on the remote host, shell wildcards and
environment variables may be used.
@type remote_path: str
@param local_path: path in which to receive files locally
@type local_path: str
@param recursive: transfer files and directories recursively
@type recursive: bool
@param preserve_times: preserve mtime and atime of transferred files
and directories.
@type preserve_times: bool
"""
self._recv_dir = local_path or os.getcwd()
if len(remote_path) == 1 and local_path != os.curdir:
if not os.path.isdir(local_path):
self._rename_dir = recursive
self._rename_file = not recursive
if len(remote_path) > 1:
if not os.path.exists(self._recv_dir):
msg = "Local path '%s' does not exist" % self._recv_dir
raise exception.SCPException(msg)
elif not os.path.isdir(self._recv_dir):
msg = "Local path '%s' is not a directory" % self._recv_dir
raise exception.SCPException(msg)
rcsv = ('', ' -r')[recursive]
prsv = ('', ' -p')[preserve_times]
self.channel = self.transport.open_session()
self.channel.settimeout(self.socket_timeout)
if isinstance(remote_path, (list, tuple)):
remote_path = ' '.join(remote_path)
self.channel.exec_command('scp%s%s -f %s' % (rcsv, prsv, remote_path))
self._recv_all()
if self.channel:
self.channel.close()
def _read_stats(self, name):
"""return just the file stats needed for scp"""
stats = os.stat(name)
mode = oct(stats.st_mode)[-4:]
size = stats.st_size
atime = int(stats.st_atime)
mtime = int(stats.st_mtime)
return (mode, size, mtime, atime)
def _send_files(self, files):
for name in files:
basename = os.path.basename(name)
(mode, size, mtime, atime) = self._read_stats(name)
if self.preserve_times:
self._send_time(mtime, atime)
file_hdl = file(name, 'rb')
self.channel.sendall('C%s %d %s\n' % (mode, size, basename))
self._recv_confirm()
file_pos = 0
buff_size = self.buff_size
chan = self.channel
while file_pos < size:
chan.sendall(file_hdl.read(buff_size))
file_pos = file_hdl.tell()
if self._progress:
self._progress(basename, size, file_pos)
if size == 0 and self._progress:
self._progress(basename, 1, 1)
chan.sendall('\x00')
file_hdl.close()
self._recv_confirm()
def _send_recursive(self, files):
single_files = []
for base in files:
lastdir = base
if not os.path.isdir(base):
single_files.append(base)
continue
for root, dirs, fls in os.walk(base):
# pop back out to the next dir in the walk
while lastdir != os.path.commonprefix([lastdir, root]):
self._send_popd()
lastdir = os.path.split(lastdir)[0]
self._send_pushd(root)
lastdir = root
self._send_files([os.path.join(root, f) for f in fls])
if single_files:
self._send_popd()
self._send_files(single_files)
def _send_pushd(self, directory):
(mode, size, mtime, atime) = self._read_stats(directory)
basename = os.path.basename(directory)
if self.preserve_times:
self._send_time(mtime, atime)
self.channel.sendall('D%s 0 %s\n' % (mode, basename))
self._recv_confirm()
def _send_popd(self):
self.channel.sendall('E\n')
self._recv_confirm()
def _send_time(self, mtime, atime):
self.channel.sendall('T%d 0 %d 0\n' % (mtime, atime))
self._recv_confirm()
def _recv_confirm(self):
# read scp response
msg = ''
try:
msg = self.channel.recv(512)
except SocketTimeout:
raise exception.SCPException('Timeout waiting for scp response')
if msg and msg[0] == '\x00':
return
elif msg and msg[0] == '\x01':
raise exception.SCPException(msg[1:])
elif self.channel.recv_stderr_ready():
msg = self.channel.recv_stderr(512)
raise exception.SCPException(msg)
elif not msg:
raise exception.SCPException('No response from server')
else:
raise exception.SCPException('Invalid response from server: ' +
msg)
def _recv_all(self):
# loop over scp commands, and recive as necessary
command = {
'C': self._recv_file,
'T': self._set_time,
'D': self._recv_pushd,
'E': self._recv_popd
}
while not self.channel.closed:
# wait for command as long as we're open
self.channel.sendall('\x00')
msg = self.channel.recv(1024)
if not msg: # chan closed while recving
break
code = msg[0]
try:
command[code](msg[1:])
except KeyError:
raise exception.SCPException(str(msg).strip())
# directory times can't be set until we're done writing files
self._set_dirtimes()
def _set_time(self, cmd):
try:
times = cmd.split()
mtime = int(times[0])
atime = int(times[2]) or mtime
except:
self.channel.send('\x01')
raise exception.SCPException('Bad time format')
# save for later
self._utime = (atime, mtime)
def _recv_file(self, cmd):
chan = self.channel
parts = cmd.split()
try:
mode = int(parts[0], 8)
size = int(parts[1])
path = os.path.join(self._recv_dir, parts[2])
if self._rename_file:
path = self._recv_dir
except:
chan.send('\x01')
chan.close()
raise exception.SCPException('Bad file format')
try:
file_hdl = file(path, 'wb')
except IOError, e:
chan.send('\x01' + str(e))
chan.close()
raise
buff_size = self.buff_size
pos = 0
chan.send('\x00')
try:
while pos < size:
# we have to make sure we don't read the final byte
if size - pos <= buff_size:
buff_size = size - pos
file_hdl.write(chan.recv(buff_size))
pos = file_hdl.tell()
if self._progress:
self._progress(path, size, pos)
if size == 0 and self._progress:
self._progress(path, 1, 1)
msg = chan.recv(512)
if msg and msg[0] != '\x00':
raise exception.SCPException(msg[1:])
except SocketTimeout:
chan.close()
raise exception.SCPException('Error receiving, socket.timeout')
file_hdl.truncate()
try:
os.utime(path, self._utime)
self._utime = None
os.chmod(path, mode)
# should we notify the other end?
finally:
file_hdl.close()
