1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Implementation of Transport over SFTP, using paramiko."""
20
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
21
# then raise TransportNotPossible, which will break remote access to any
22
# formats which rely on OS-level locks. That should be fine as those formats
23
# are pretty old, but these combinations may have to be removed from the test
24
# suite. Those formats all date back to 0.7; so we should be able to remove
25
# these methods when we officially drop support for those formats.
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
50
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.trace import mutter, warning
52
from bzrlib.transport import (
54
register_urlparse_netloc_protocol,
63
except ImportError, e:
64
raise ParamikoNotPresent(e)
66
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
67
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
69
from paramiko.sftp_attr import SFTPAttributes
70
from paramiko.sftp_file import SFTPFile
73
register_urlparse_netloc_protocol('sftp')
76
# This is a weakref dictionary, so that we can reuse connections
77
# that are still active. Long term, it might be nice to have some
78
# sort of expiration policy, such as disconnect if inactive for
79
# X seconds. But that requires a lot more fanciness.
80
_connected_hosts = weakref.WeakValueDictionary()
83
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
84
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
85
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
88
def clear_connection_cache():
89
"""Remove all hosts from the SFTP connection cache.
91
Primarily useful for test cases wanting to force garbage collection.
93
_connected_hosts.clear()
96
class SFTPLock(object):
97
"""This fakes a lock in a remote location.
99
A present lock is indicated just by the existence of a file. This
100
doesn't work well on all transports and they are only used in
101
deprecated storage formats.
104
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
106
def __init__(self, path, transport):
107
assert isinstance(transport, SFTPTransport)
109
self.lock_file = None
111
self.lock_path = path + '.write-lock'
112
self.transport = transport
114
# RBC 20060103 FIXME should we be using private methods here ?
115
abspath = transport._remote_path(self.lock_path)
116
self.lock_file = transport._sftp_open_exclusive(abspath)
118
raise LockError('File %r already locked' % (self.path,))
121
"""Should this warn, or actually try to cleanup?"""
123
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
127
if not self.lock_file:
129
self.lock_file.close()
130
self.lock_file = None
132
self.transport.delete(self.lock_path)
133
except (NoSuchFile,):
134
# What specific errors should we catch here?
138
class SFTPUrlHandling(Transport):
139
"""Mix-in that does common handling of SSH/SFTP URLs."""
141
def __init__(self, base):
142
self._parse_url(base)
143
base = self._unparse_url(self._path)
146
super(SFTPUrlHandling, self).__init__(base)
148
def _parse_url(self, url):
150
self._username, self._password,
151
self._host, self._port, self._path) = self._split_url(url)
153
def _unparse_url(self, path):
154
"""Return a URL for a path relative to this transport.
156
path = urllib.quote(path)
157
# handle homedir paths
158
if not path.startswith('/'):
160
netloc = urllib.quote(self._host)
161
if self._username is not None:
162
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
163
if self._port is not None:
164
netloc = '%s:%d' % (netloc, self._port)
165
return urlparse.urlunparse((self._scheme, netloc, path, '', '', ''))
167
def _split_url(self, url):
168
(scheme, username, password, host, port, path) = split_url(url)
169
## assert scheme == 'sftp'
171
# the initial slash should be removed from the path, and treated
172
# as a homedir relative path (the path begins with a double slash
173
# if it is absolute).
174
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
175
# RBC 20060118 we are not using this as its too user hostile. instead
176
# we are following lftp and using /~/foo to mean '~/foo'.
177
# handle homedir paths
178
if path.startswith('/~/'):
182
return (scheme, username, password, host, port, path)
184
def abspath(self, relpath):
185
"""Return the full url to the given relative path.
187
@param relpath: the relative path or path components
188
@type relpath: str or list
190
return self._unparse_url(self._remote_path(relpath))
192
def _remote_path(self, relpath):
193
"""Return the path to be passed along the sftp protocol for relpath.
195
:param relpath: is a urlencoded string.
197
return self._combine_paths(self._path, relpath)
200
class SFTPTransport(SFTPUrlHandling):
201
"""Transport implementation for SFTP access."""
203
_do_prefetch = _default_do_prefetch
204
# TODO: jam 20060717 Conceivably these could be configurable, either
205
# by auto-tuning at run-time, or by a configuration (per host??)
206
# but the performance curve is pretty flat, so just going with
207
# reasonable defaults.
208
_max_readv_combine = 200
209
# Having to round trip to the server means waiting for a response,
210
# so it is better to download extra bytes.
211
# 8KiB had good performance for both local and remote network operations
212
_bytes_to_read_before_seek = 8192
214
# The sftp spec says that implementations SHOULD allow reads
215
# to be at least 32K. paramiko.readv() does an async request
216
# for the chunks. So we need to keep it within a single request
217
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
218
# up the request itself, rather than us having to worry about it
219
_max_request_size = 32768
221
def __init__(self, base, clone_from=None):
222
super(SFTPTransport, self).__init__(base)
223
if clone_from is None:
226
# use the same ssh connection, etc
227
self._sftp = clone_from._sftp
228
# super saves 'self.base'
230
def should_cache(self):
232
Return True if the data pulled across should be cached locally.
236
def clone(self, offset=None):
238
Return a new SFTPTransport with root at self.base + offset.
239
We share the same SFTP session between such transports, because it's
240
fairly expensive to set them up.
243
return SFTPTransport(self.base, self)
245
return SFTPTransport(self.abspath(offset), self)
247
def _remote_path(self, relpath):
248
"""Return the path to be passed along the sftp protocol for relpath.
250
relpath is a urlencoded string.
252
:return: a path prefixed with / for regular abspath-based urls, or a
253
path that does not begin with / for urls which begin with /~/.
255
# how does this work?
256
# it processes relpath with respect to
258
# firstly we create a path to evaluate:
259
# if relpath is an abspath or homedir path, its the entire thing
260
# otherwise we join our base with relpath
261
# then we eliminate all empty segments (double //'s) outside the first
262
# two elements of the list. This avoids problems with trailing
263
# slashes, or other abnormalities.
264
# finally we evaluate the entire path in a single pass
266
# '..' result in popping the left most already
267
# processed path (which can never be empty because of the check for
268
# abspath and homedir meaning that its not, or that we've used our
269
# path. If the pop would pop the root, we ignore it.
271
# Specific case examinations:
272
# remove the special casefor ~: if the current root is ~/ popping of it
273
# = / thus our seed for a ~ based path is ['', '~']
274
# and if we end up with [''] then we had basically ('', '..') (which is
275
# '/..' so we append '' if the length is one, and assert that the first
276
# element is still ''. Lastly, if we end with ['', '~'] as a prefix for
277
# the output, we've got a homedir path, so we strip that prefix before
278
# '/' joining the resulting list.
280
# case one: '/' -> ['', ''] cannot shrink
281
# case two: '/' + '../foo' -> ['', 'foo'] (take '', '', '..', 'foo')
282
# and pop the second '' for the '..', append 'foo'
283
# case three: '/~/' -> ['', '~', '']
284
# case four: '/~/' + '../foo' -> ['', '~', '', '..', 'foo'],
285
# and we want to get '/foo' - the empty path in the middle
286
# needs to be stripped, then normal path manipulation will
288
# case five: '/..' ['', '..'], we want ['', '']
289
# stripping '' outside the first two is ok
290
# ignore .. if its too high up
292
# lastly this code is possibly reusable by FTP, but not reusable by
293
# local paths: ~ is resolvable correctly, nor by HTTP or the smart
294
# server: ~ is resolved remotely.
296
# however, a version of this that acts on self.base is possible to be
297
# written which manipulates the URL in canonical form, and would be
298
# reusable for all transports, if a flag for allowing ~/ at all was
300
assert isinstance(relpath, basestring)
301
relpath = urlutils.unescape(relpath)
304
if relpath.startswith('/'):
305
# abspath - normal split is fine.
306
current_path = relpath.split('/')
307
elif relpath.startswith('~/'):
308
# root is homedir based: normal split and prefix '' to remote the
310
current_path = [''].extend(relpath.split('/'))
312
# root is from the current directory:
313
if self._path.startswith('/'):
314
# abspath, take the regular split
317
# homedir based, add the '', '~' not present in self._path
318
current_path = ['', '~']
319
# add our current dir
320
current_path.extend(self._path.split('/'))
321
# add the users relpath
322
current_path.extend(relpath.split('/'))
323
# strip '' segments that are not in the first one - the leading /.
324
to_process = current_path[:1]
325
for segment in current_path[1:]:
327
to_process.append(segment)
329
# process '.' and '..' segments into output_path.
331
for segment in to_process:
333
# directory pop. Remove a directory
334
# as long as we are not at the root
335
if len(output_path) > 1:
338
# cannot pop beyond the root, so do nothing
340
continue # strip the '.' from the output.
342
# this will append '' to output_path for the root elements,
343
# which is appropriate: its why we strip '' in the first pass.
344
output_path.append(segment)
346
# check output special cases:
347
if output_path == ['']:
349
output_path = ['', '']
350
elif output_path[:2] == ['', '~']:
351
# ['', '~', ...] -> ...
352
output_path = output_path[2:]
353
path = '/'.join(output_path)
356
def relpath(self, abspath):
357
scheme, username, password, host, port, path = self._split_url(abspath)
359
if (username != self._username):
360
error.append('username mismatch')
361
if (host != self._host):
362
error.append('host mismatch')
363
if (port != self._port):
364
error.append('port mismatch')
365
if (not path.startswith(self._path)):
366
error.append('path mismatch')
368
extra = ': ' + ', '.join(error)
369
raise PathNotChild(abspath, self.base, extra=extra)
371
return path[pl:].strip('/')
373
def has(self, relpath):
375
Does the target location exist?
378
self._sftp.stat(self._remote_path(relpath))
383
def get(self, relpath):
385
Get the file at the given relative path.
387
:param relpath: The relative path to the file
390
path = self._remote_path(relpath)
391
f = self._sftp.file(path, mode='rb')
392
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
395
except (IOError, paramiko.SSHException), e:
396
self._translate_io_exception(e, path, ': error retrieving',
397
failure_exc=errors.ReadError)
399
def readv(self, relpath, offsets):
400
"""See Transport.readv()"""
401
# We overload the default readv() because we want to use a file
402
# that does not have prefetch enabled.
403
# Also, if we have a new paramiko, it implements an async readv()
408
path = self._remote_path(relpath)
409
fp = self._sftp.file(path, mode='rb')
410
readv = getattr(fp, 'readv', None)
412
return self._sftp_readv(fp, offsets, relpath)
413
mutter('seek and read %s offsets', len(offsets))
414
return self._seek_and_read(fp, offsets, relpath)
415
except (IOError, paramiko.SSHException), e:
416
self._translate_io_exception(e, path, ': error retrieving')
418
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
419
"""Use the readv() member of fp to do async readv.
421
And then read them using paramiko.readv(). paramiko.readv()
422
does not support ranges > 64K, so it caps the request size, and
423
just reads until it gets all the stuff it wants
425
offsets = list(offsets)
426
sorted_offsets = sorted(offsets)
428
# The algorithm works as follows:
429
# 1) Coalesce nearby reads into a single chunk
430
# This generates a list of combined regions, the total size
431
# and the size of the sub regions. This coalescing step is limited
432
# in the number of nearby chunks to combine, and is allowed to
433
# skip small breaks in the requests. Limiting it makes sure that
434
# we can start yielding some data earlier, and skipping means we
435
# make fewer requests. (Beneficial even when using async)
436
# 2) Break up this combined regions into chunks that are smaller
437
# than 64KiB. Technically the limit is 65536, but we are a
438
# little bit conservative. This is because sftp has a maximum
439
# return chunk size of 64KiB (max size of an unsigned short)
440
# 3) Issue a readv() to paramiko to create an async request for
442
# 4) Read in the data as it comes back, until we've read one
443
# continuous section as determined in step 1
444
# 5) Break up the full sections into hunks for the original requested
445
# offsets. And put them in a cache
446
# 6) Check if the next request is in the cache, and if it is, remove
447
# it from the cache, and yield its data. Continue until no more
448
# entries are in the cache.
449
# 7) loop back to step 4 until all data has been read
451
# TODO: jam 20060725 This could be optimized one step further, by
452
# attempting to yield whatever data we have read, even before
453
# the first coallesced section has been fully processed.
455
# When coalescing for use with readv(), we don't really need to
456
# use any fudge factor, because the requests are made asynchronously
457
coalesced = list(self._coalesce_offsets(sorted_offsets,
458
limit=self._max_readv_combine,
462
for c_offset in coalesced:
463
start = c_offset.start
464
size = c_offset.length
466
# We need to break this up into multiple requests
468
next_size = min(size, self._max_request_size)
469
requests.append((start, next_size))
473
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
474
len(offsets), len(coalesced), len(requests))
476
# Queue the current read until we have read the full coalesced section
479
cur_coalesced_stack = iter(coalesced)
480
cur_coalesced = cur_coalesced_stack.next()
482
# Cache the results, but only until they have been fulfilled
484
# turn the list of offsets into a stack
485
offset_stack = iter(offsets)
486
cur_offset_and_size = offset_stack.next()
488
for data in fp.readv(requests):
490
cur_data_len += len(data)
492
if cur_data_len < cur_coalesced.length:
494
assert cur_data_len == cur_coalesced.length, \
495
"Somehow we read too much: %s != %s" % (cur_data_len,
496
cur_coalesced.length)
497
all_data = ''.join(cur_data)
501
for suboffset, subsize in cur_coalesced.ranges:
502
key = (cur_coalesced.start+suboffset, subsize)
503
data_map[key] = all_data[suboffset:suboffset+subsize]
505
# Now that we've read some data, see if we can yield anything back
506
while cur_offset_and_size in data_map:
507
this_data = data_map.pop(cur_offset_and_size)
508
yield cur_offset_and_size[0], this_data
509
cur_offset_and_size = offset_stack.next()
511
# We read a coalesced entry, so mark it as done
513
# Now that we've read all of the data for this coalesced section
515
cur_coalesced = cur_coalesced_stack.next()
517
if cur_coalesced is not None:
518
raise errors.ShortReadvError(relpath, cur_coalesced.start,
519
cur_coalesced.length, len(data))
521
def put_file(self, relpath, f, mode=None):
523
Copy the file-like object into the location.
525
:param relpath: Location to put the contents, relative to base.
526
:param f: File-like object.
527
:param mode: The final mode for the file
529
final_path = self._remote_path(relpath)
530
self._put(final_path, f, mode=mode)
532
def _put(self, abspath, f, mode=None):
533
"""Helper function so both put() and copy_abspaths can reuse the code"""
534
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
535
os.getpid(), random.randint(0,0x7FFFFFFF))
536
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
540
fout.set_pipelined(True)
542
except (IOError, paramiko.SSHException), e:
543
self._translate_io_exception(e, tmp_abspath)
544
# XXX: This doesn't truly help like we would like it to.
545
# The problem is that openssh strips sticky bits. So while we
546
# can properly set group write permission, we lose the group
547
# sticky bit. So it is probably best to stop chmodding, and
548
# just tell users that they need to set the umask correctly.
549
# The attr.st_mode = mode, in _sftp_open_exclusive
550
# will handle when the user wants the final mode to be more
551
# restrictive. And then we avoid a round trip. Unless
552
# paramiko decides to expose an async chmod()
554
# This is designed to chmod() right before we close.
555
# Because we set_pipelined() earlier, theoretically we might
556
# avoid the round trip for fout.close()
558
self._sftp.chmod(tmp_abspath, mode)
561
self._rename_and_overwrite(tmp_abspath, abspath)
563
# If we fail, try to clean up the temporary file
564
# before we throw the exception
565
# but don't let another exception mess things up
566
# Write out the traceback, because otherwise
567
# the catch and throw destroys it
569
mutter(traceback.format_exc())
573
self._sftp.remove(tmp_abspath)
575
# raise the saved except
577
# raise the original with its traceback if we can.
580
def _put_non_atomic_helper(self, relpath, writer, mode=None,
581
create_parent_dir=False,
583
abspath = self._remote_path(relpath)
585
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
586
# set the file mode at create time. If it does, use it.
587
# But for now, we just chmod later anyway.
589
def _open_and_write_file():
590
"""Try to open the target file, raise error on failure"""
594
fout = self._sftp.file(abspath, mode='wb')
595
fout.set_pipelined(True)
597
except (paramiko.SSHException, IOError), e:
598
self._translate_io_exception(e, abspath,
601
# This is designed to chmod() right before we close.
602
# Because we set_pipelined() earlier, theoretically we might
603
# avoid the round trip for fout.close()
605
self._sftp.chmod(abspath, mode)
610
if not create_parent_dir:
611
_open_and_write_file()
614
# Try error handling to create the parent directory if we need to
616
_open_and_write_file()
618
# Try to create the parent directory, and then go back to
620
parent_dir = os.path.dirname(abspath)
621
self._mkdir(parent_dir, dir_mode)
622
_open_and_write_file()
624
def put_file_non_atomic(self, relpath, f, mode=None,
625
create_parent_dir=False,
627
"""Copy the file-like object into the target location.
629
This function is not strictly safe to use. It is only meant to
630
be used when you already know that the target does not exist.
631
It is not safe, because it will open and truncate the remote
632
file. So there may be a time when the file has invalid contents.
634
:param relpath: The remote location to put the contents.
635
:param f: File-like object.
636
:param mode: Possible access permissions for new file.
637
None means do not set remote permissions.
638
:param create_parent_dir: If we cannot create the target file because
639
the parent directory does not exist, go ahead and
640
create it, and then try again.
644
self._put_non_atomic_helper(relpath, writer, mode=mode,
645
create_parent_dir=create_parent_dir,
648
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
649
create_parent_dir=False,
653
self._put_non_atomic_helper(relpath, writer, mode=mode,
654
create_parent_dir=create_parent_dir,
657
def iter_files_recursive(self):
658
"""Walk the relative paths of all files in this transport."""
659
queue = list(self.list_dir('.'))
661
relpath = queue.pop(0)
662
st = self.stat(relpath)
663
if stat.S_ISDIR(st.st_mode):
664
for i, basename in enumerate(self.list_dir(relpath)):
665
queue.insert(i, relpath+'/'+basename)
669
def _mkdir(self, abspath, mode=None):
675
self._sftp.mkdir(abspath, local_mode)
677
self._sftp.chmod(abspath, mode=mode)
678
except (paramiko.SSHException, IOError), e:
679
self._translate_io_exception(e, abspath, ': unable to mkdir',
680
failure_exc=FileExists)
682
def mkdir(self, relpath, mode=None):
683
"""Create a directory at the given path."""
684
self._mkdir(self._remote_path(relpath), mode=mode)
686
def _translate_io_exception(self, e, path, more_info='',
687
failure_exc=PathError):
688
"""Translate a paramiko or IOError into a friendlier exception.
690
:param e: The original exception
691
:param path: The path in question when the error is raised
692
:param more_info: Extra information that can be included,
693
such as what was going on
694
:param failure_exc: Paramiko has the super fun ability to raise completely
695
opaque errors that just set "e.args = ('Failure',)" with
697
If this parameter is set, it defines the exception
698
to raise in these cases.
700
# paramiko seems to generate detailless errors.
701
self._translate_error(e, path, raise_generic=False)
702
if getattr(e, 'args', None) is not None:
703
if (e.args == ('No such file or directory',) or
704
e.args == ('No such file',)):
705
raise NoSuchFile(path, str(e) + more_info)
706
if (e.args == ('mkdir failed',)):
707
raise FileExists(path, str(e) + more_info)
708
# strange but true, for the paramiko server.
709
if (e.args == ('Failure',)):
710
raise failure_exc(path, str(e) + more_info)
711
mutter('Raising exception with args %s', e.args)
712
if getattr(e, 'errno', None) is not None:
713
mutter('Raising exception with errno %s', e.errno)
716
def append_file(self, relpath, f, mode=None):
718
Append the text in the file-like object into the final
722
path = self._remote_path(relpath)
723
fout = self._sftp.file(path, 'ab')
725
self._sftp.chmod(path, mode)
729
except (IOError, paramiko.SSHException), e:
730
self._translate_io_exception(e, relpath, ': unable to append')
732
def rename(self, rel_from, rel_to):
733
"""Rename without special overwriting"""
735
self._sftp.rename(self._remote_path(rel_from),
736
self._remote_path(rel_to))
737
except (IOError, paramiko.SSHException), e:
738
self._translate_io_exception(e, rel_from,
739
': unable to rename to %r' % (rel_to))
741
def _rename_and_overwrite(self, abs_from, abs_to):
742
"""Do a fancy rename on the remote server.
744
Using the implementation provided by osutils.
747
fancy_rename(abs_from, abs_to,
748
rename_func=self._sftp.rename,
749
unlink_func=self._sftp.remove)
750
except (IOError, paramiko.SSHException), e:
751
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
753
def move(self, rel_from, rel_to):
754
"""Move the item at rel_from to the location at rel_to"""
755
path_from = self._remote_path(rel_from)
756
path_to = self._remote_path(rel_to)
757
self._rename_and_overwrite(path_from, path_to)
759
def delete(self, relpath):
760
"""Delete the item at relpath"""
761
path = self._remote_path(relpath)
763
self._sftp.remove(path)
764
except (IOError, paramiko.SSHException), e:
765
self._translate_io_exception(e, path, ': unable to delete')
767
def external_url(self):
768
"""See bzrlib.transport.Transport.external_url."""
769
# the external path for SFTP is the base
773
"""Return True if this store supports listing."""
776
def list_dir(self, relpath):
778
Return a list of all files at the given location.
780
# does anything actually use this?
782
# This is at least used by copy_tree for remote upgrades.
783
# -- David Allouche 2006-08-11
784
path = self._remote_path(relpath)
786
entries = self._sftp.listdir(path)
787
except (IOError, paramiko.SSHException), e:
788
self._translate_io_exception(e, path, ': failed to list_dir')
789
return [urlutils.escape(entry) for entry in entries]
791
def rmdir(self, relpath):
792
"""See Transport.rmdir."""
793
path = self._remote_path(relpath)
795
return self._sftp.rmdir(path)
796
except (IOError, paramiko.SSHException), e:
797
self._translate_io_exception(e, path, ': failed to rmdir')
799
def stat(self, relpath):
800
"""Return the stat information for a file."""
801
path = self._remote_path(relpath)
803
return self._sftp.stat(path)
804
except (IOError, paramiko.SSHException), e:
805
self._translate_io_exception(e, path, ': unable to stat')
807
def lock_read(self, relpath):
809
Lock the given file for shared (read) access.
810
:return: A lock object, which has an unlock() member function
812
# FIXME: there should be something clever i can do here...
813
class BogusLock(object):
814
def __init__(self, path):
818
return BogusLock(relpath)
820
def lock_write(self, relpath):
822
Lock the given file for exclusive (write) access.
823
WARNING: many transports do not support this, so trying avoid using it
825
:return: A lock object, which has an unlock() member function
827
# This is a little bit bogus, but basically, we create a file
828
# which should not already exist, and if it does, we assume
829
# that there is a lock, and if it doesn't, the we assume
830
# that we have taken the lock.
831
return SFTPLock(relpath, self)
833
def _sftp_connect(self):
834
"""Connect to the remote sftp server.
835
After this, self._sftp should have a valid connection (or
836
we raise an TransportError 'could not connect').
838
TODO: Raise a more reasonable ConnectionFailed exception
840
self._sftp = _sftp_connect(self._host, self._port, self._username,
843
def _sftp_open_exclusive(self, abspath, mode=None):
844
"""Open a remote path exclusively.
846
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
847
the file already exists. However it does not expose this
848
at the higher level of SFTPClient.open(), so we have to
851
WARNING: This breaks the SFTPClient abstraction, so it
852
could easily break against an updated version of paramiko.
854
:param abspath: The remote absolute path where the file should be opened
855
:param mode: The mode permissions bits for the new file
857
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
858
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
859
# However, there is no way to set the permission mode at open
860
# time using the sftp_client.file() functionality.
861
path = self._sftp._adjust_cwd(abspath)
862
# mutter('sftp abspath %s => %s', abspath, path)
863
attr = SFTPAttributes()
866
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
867
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
869
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
871
raise TransportError('Expected an SFTP handle')
872
handle = msg.get_string()
873
return SFTPFile(self._sftp, handle, 'wb', -1)
874
except (paramiko.SSHException, IOError), e:
875
self._translate_io_exception(e, abspath, ': unable to open',
876
failure_exc=FileExists)
878
def _can_roundtrip_unix_modebits(self):
879
if sys.platform == 'win32':
885
# ------------- server test implementation --------------
888
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
890
STUB_SERVER_KEY = """
891
-----BEGIN RSA PRIVATE KEY-----
892
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
893
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
894
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
895
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
896
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
897
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
898
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
899
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
900
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
901
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
902
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
903
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
904
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
905
-----END RSA PRIVATE KEY-----
909
class SocketListener(threading.Thread):
911
def __init__(self, callback):
912
threading.Thread.__init__(self)
913
self._callback = callback
914
self._socket = socket.socket()
915
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
916
self._socket.bind(('localhost', 0))
917
self._socket.listen(1)
918
self.port = self._socket.getsockname()[1]
919
self._stop_event = threading.Event()
922
# called from outside this thread
923
self._stop_event.set()
924
# use a timeout here, because if the test fails, the server thread may
925
# never notice the stop_event.
931
readable, writable_unused, exception_unused = \
932
select.select([self._socket], [], [], 0.1)
933
if self._stop_event.isSet():
935
if len(readable) == 0:
938
s, addr_unused = self._socket.accept()
939
# because the loopback socket is inline, and transports are
940
# never explicitly closed, best to launch a new thread.
941
threading.Thread(target=self._callback, args=(s,)).start()
942
except socket.error, x:
943
sys.excepthook(*sys.exc_info())
944
warning('Socket error during accept() within unit test server'
947
# probably a failed test; unit test thread will log the
949
sys.excepthook(*sys.exc_info())
950
warning('Exception from within unit test server thread: %r' %
954
class SocketDelay(object):
955
"""A socket decorator to make TCP appear slower.
957
This changes recv, send, and sendall to add a fixed latency to each python
958
call if a new roundtrip is detected. That is, when a recv is called and the
959
flag new_roundtrip is set, latency is charged. Every send and send_all
962
In addition every send, sendall and recv sleeps a bit per character send to
965
Not all methods are implemented, this is deliberate as this class is not a
966
replacement for the builtin sockets layer. fileno is not implemented to
967
prevent the proxy being bypassed.
971
_proxied_arguments = dict.fromkeys([
972
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
973
"setblocking", "setsockopt", "settimeout", "shutdown"])
975
def __init__(self, sock, latency, bandwidth=1.0,
978
:param bandwith: simulated bandwith (MegaBit)
979
:param really_sleep: If set to false, the SocketDelay will just
980
increase a counter, instead of calling time.sleep. This is useful for
981
unittesting the SocketDelay.
984
self.latency = latency
985
self.really_sleep = really_sleep
986
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
987
self.new_roundtrip = False
990
if self.really_sleep:
993
SocketDelay.simulated_time += s
995
def __getattr__(self, attr):
996
if attr in SocketDelay._proxied_arguments:
997
return getattr(self.sock, attr)
998
raise AttributeError("'SocketDelay' object has no attribute %r" %
1002
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
1005
def recv(self, *args):
1006
data = self.sock.recv(*args)
1007
if data and self.new_roundtrip:
1008
self.new_roundtrip = False
1009
self.sleep(self.latency)
1010
self.sleep(len(data) * self.time_per_byte)
1013
def sendall(self, data, flags=0):
1014
if not self.new_roundtrip:
1015
self.new_roundtrip = True
1016
self.sleep(self.latency)
1017
self.sleep(len(data) * self.time_per_byte)
1018
return self.sock.sendall(data, flags)
1020
def send(self, data, flags=0):
1021
if not self.new_roundtrip:
1022
self.new_roundtrip = True
1023
self.sleep(self.latency)
1024
bytes_sent = self.sock.send(data, flags)
1025
self.sleep(bytes_sent * self.time_per_byte)
1029
class SFTPServer(Server):
1030
"""Common code for SFTP server facilities."""
1032
def __init__(self, server_interface=StubServer):
1033
self._original_vendor = None
1034
self._homedir = None
1035
self._server_homedir = None
1036
self._listener = None
1038
self._vendor = ssh.ParamikoVendor()
1039
self._server_interface = server_interface
1042
self.add_latency = 0
1044
def _get_sftp_url(self, path):
1045
"""Calculate an sftp url to this server for path."""
1046
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1048
def log(self, message):
1049
"""StubServer uses this to log when a new server is created."""
1050
self.logs.append(message)
1052
def _run_server_entry(self, sock):
1053
"""Entry point for all implementations of _run_server.
1055
If self.add_latency is > 0.000001 then sock is given a latency adding
1058
if self.add_latency > 0.000001:
1059
sock = SocketDelay(sock, self.add_latency)
1060
return self._run_server(sock)
1062
def _run_server(self, s):
1063
ssh_server = paramiko.Transport(s)
1064
key_file = pathjoin(self._homedir, 'test_rsa.key')
1065
f = open(key_file, 'w')
1066
f.write(STUB_SERVER_KEY)
1068
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1069
ssh_server.add_server_key(host_key)
1070
server = self._server_interface(self)
1071
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1072
StubSFTPServer, root=self._root,
1073
home=self._server_homedir)
1074
event = threading.Event()
1075
ssh_server.start_server(event, server)
1078
def setUp(self, backing_server=None):
1079
# XXX: TODO: make sftpserver back onto backing_server rather than local
1081
assert (backing_server is None or
1082
isinstance(backing_server, local.LocalURLServer)), (
1083
"backing_server should not be %r, because this can only serve the "
1084
"local current working directory." % (backing_server,))
1085
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1086
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1087
if sys.platform == 'win32':
1088
# Win32 needs to use the UNICODE api
1089
self._homedir = getcwd()
1091
# But Linux SFTP servers should just deal in bytestreams
1092
self._homedir = os.getcwd()
1093
if self._server_homedir is None:
1094
self._server_homedir = self._homedir
1096
if sys.platform == 'win32':
1098
self._listener = SocketListener(self._run_server_entry)
1099
self._listener.setDaemon(True)
1100
self._listener.start()
1103
"""See bzrlib.transport.Server.tearDown."""
1104
self._listener.stop()
1105
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1107
def get_bogus_url(self):
1108
"""See bzrlib.transport.Server.get_bogus_url."""
1109
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1110
# we bind a random socket, so that we get a guaranteed unused port
1111
# we just never listen on that port
1113
s.bind(('localhost', 0))
1114
return 'sftp://%s:%s/' % s.getsockname()
1117
class SFTPFullAbsoluteServer(SFTPServer):
1118
"""A test server for sftp transports, using absolute urls and ssh."""
1121
"""See bzrlib.transport.Server.get_url."""
1122
homedir = self._homedir
1123
if sys.platform != 'win32':
1124
# Remove the initial '/' on all platforms but win32
1125
homedir = homedir[1:]
1126
return self._get_sftp_url(urlutils.escape(homedir))
1129
class SFTPServerWithoutSSH(SFTPServer):
1130
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1133
super(SFTPServerWithoutSSH, self).__init__()
1134
self._vendor = ssh.LoopbackVendor()
1136
def _run_server(self, sock):
1137
# Re-import these as locals, so that they're still accessible during
1138
# interpreter shutdown (when all module globals get set to None, leading
1139
# to confusing errors like "'NoneType' object has no attribute 'error'".
1140
class FakeChannel(object):
1141
def get_transport(self):
1143
def get_log_channel(self):
1147
def get_hexdump(self):
1152
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1153
root=self._root, home=self._server_homedir)
1155
server.start_subsystem('sftp', None, sock)
1156
except socket.error, e:
1157
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1158
# it's okay for the client to disconnect abruptly
1159
# (bug in paramiko 1.6: it should absorb this exception)
1163
except Exception, e:
1164
# This typically seems to happen during interpreter shutdown, so
1165
# most of the useful ways to report this error are won't work.
1166
# Writing the exception type, and then the text of the exception,
1167
# seems to be the best we can do.
1169
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1170
sys.stderr.write('%s\n\n' % (e,))
1171
server.finish_subsystem()
1174
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1175
"""A test server for sftp transports, using absolute urls."""
1178
"""See bzrlib.transport.Server.get_url."""
1179
homedir = self._homedir
1180
if sys.platform != 'win32':
1181
# Remove the initial '/' on all platforms but win32
1182
homedir = homedir[1:]
1183
return self._get_sftp_url(urlutils.escape(homedir))
1186
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1187
"""A test server for sftp transports, using homedir relative urls."""
1190
"""See bzrlib.transport.Server.get_url."""
1191
return self._get_sftp_url("~/")
1194
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1195
"""A test server for sftp transports where only absolute paths will work.
1197
It does this by serving from a deeply-nested directory that doesn't exist.
1200
def setUp(self, backing_server=None):
1201
self._server_homedir = '/dev/noone/runs/tests/here'
1202
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1205
def _sftp_connect(host, port, username, password):
1206
"""Connect to the remote sftp server.
1208
:raises: a TransportError 'could not connect'.
1210
:returns: an paramiko.sftp_client.SFTPClient
1212
TODO: Raise a more reasonable ConnectionFailed exception
1214
idx = (host, port, username)
1216
return _connected_hosts[idx]
1220
sftp = _sftp_connect_uncached(host, port, username, password)
1221
_connected_hosts[idx] = sftp
1224
def _sftp_connect_uncached(host, port, username, password):
1225
vendor = ssh._get_ssh_vendor()
1226
sftp = vendor.connect_sftp(username, password, host, port)
1230
def get_test_permutations():
1231
"""Return the permutations to be used in testing."""
1232
return [(SFTPTransport, SFTPAbsoluteServer),
1233
(SFTPTransport, SFTPHomeDirServer),
1234
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
