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 (
53
register_urlparse_netloc_protocol,
62
except ImportError, e:
63
raise ParamikoNotPresent(e)
65
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
66
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
68
from paramiko.sftp_attr import SFTPAttributes
69
from paramiko.sftp_file import SFTPFile
72
register_urlparse_netloc_protocol('sftp')
75
# This is a weakref dictionary, so that we can reuse connections
76
# that are still active. Long term, it might be nice to have some
77
# sort of expiration policy, such as disconnect if inactive for
78
# X seconds. But that requires a lot more fanciness.
79
_connected_hosts = weakref.WeakValueDictionary()
82
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
83
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
84
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
87
def clear_connection_cache():
88
"""Remove all hosts from the SFTP connection cache.
90
Primarily useful for test cases wanting to force garbage collection.
92
_connected_hosts.clear()
95
class SFTPLock(object):
96
"""This fakes a lock in a remote location.
98
A present lock is indicated just by the existence of a file. This
99
doesn't work well on all transports and they are only used in
100
deprecated storage formats.
103
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
def __init__(self, path, transport):
106
assert isinstance(transport, SFTPTransport)
108
self.lock_file = None
110
self.lock_path = path + '.write-lock'
111
self.transport = transport
113
# RBC 20060103 FIXME should we be using private methods here ?
114
abspath = transport._remote_path(self.lock_path)
115
self.lock_file = transport._sftp_open_exclusive(abspath)
117
raise LockError('File %r already locked' % (self.path,))
120
"""Should this warn, or actually try to cleanup?"""
122
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
126
if not self.lock_file:
128
self.lock_file.close()
129
self.lock_file = None
131
self.transport.delete(self.lock_path)
132
except (NoSuchFile,):
133
# What specific errors should we catch here?
137
class SFTPUrlHandling(Transport):
138
"""Mix-in that does common handling of SSH/SFTP URLs."""
140
def __init__(self, base):
141
self._parse_url(base)
142
base = self._unparse_url(self._path)
145
super(SFTPUrlHandling, self).__init__(base)
147
def _parse_url(self, url):
149
self._username, self._password,
150
self._host, self._port, self._path) = self._split_url(url)
152
def _unparse_url(self, path):
153
"""Return a URL for a path relative to this transport.
155
path = urllib.quote(path)
156
# handle homedir paths
157
if not path.startswith('/'):
159
netloc = urllib.quote(self._host)
160
if self._username is not None:
161
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
162
if self._port is not None:
163
netloc = '%s:%d' % (netloc, self._port)
164
return urlparse.urlunparse((self._scheme, netloc, path, '', '', ''))
166
def _split_url(self, url):
167
(scheme, username, password, host, port, path) = split_url(url)
168
## assert scheme == 'sftp'
170
# the initial slash should be removed from the path, and treated
171
# as a homedir relative path (the path begins with a double slash
172
# if it is absolute).
173
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
174
# RBC 20060118 we are not using this as its too user hostile. instead
175
# we are following lftp and using /~/foo to mean '~/foo'.
176
# handle homedir paths
177
if path.startswith('/~/'):
181
return (scheme, username, password, host, port, path)
183
def abspath(self, relpath):
184
"""Return the full url to the given relative path.
186
@param relpath: the relative path or path components
187
@type relpath: str or list
189
return self._unparse_url(self._remote_path(relpath))
191
def _remote_path(self, relpath):
192
"""Return the path to be passed along the sftp protocol for relpath.
194
:param relpath: is a urlencoded string.
196
return self._combine_paths(self._path, relpath)
199
class SFTPTransport(SFTPUrlHandling):
200
"""Transport implementation for SFTP access."""
202
_do_prefetch = _default_do_prefetch
203
# TODO: jam 20060717 Conceivably these could be configurable, either
204
# by auto-tuning at run-time, or by a configuration (per host??)
205
# but the performance curve is pretty flat, so just going with
206
# reasonable defaults.
207
_max_readv_combine = 200
208
# Having to round trip to the server means waiting for a response,
209
# so it is better to download extra bytes.
210
# 8KiB had good performance for both local and remote network operations
211
_bytes_to_read_before_seek = 8192
213
# The sftp spec says that implementations SHOULD allow reads
214
# to be at least 32K. paramiko.readv() does an async request
215
# for the chunks. So we need to keep it within a single request
216
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
217
# up the request itself, rather than us having to worry about it
218
_max_request_size = 32768
220
def __init__(self, base, clone_from=None):
221
super(SFTPTransport, self).__init__(base)
222
if clone_from is None:
225
# use the same ssh connection, etc
226
self._sftp = clone_from._sftp
227
# super saves 'self.base'
229
def should_cache(self):
231
Return True if the data pulled across should be cached locally.
235
def clone(self, offset=None):
237
Return a new SFTPTransport with root at self.base + offset.
238
We share the same SFTP session between such transports, because it's
239
fairly expensive to set them up.
242
return SFTPTransport(self.base, self)
244
return SFTPTransport(self.abspath(offset), self)
246
def _remote_path(self, relpath):
247
"""Return the path to be passed along the sftp protocol for relpath.
249
relpath is a urlencoded string.
251
:return: a path prefixed with / for regular abspath-based urls, or a
252
path that does not begin with / for urls which begin with /~/.
254
# how does this work?
255
# it processes relpath with respect to
257
# firstly we create a path to evaluate:
258
# if relpath is an abspath or homedir path, its the entire thing
259
# otherwise we join our base with relpath
260
# then we eliminate all empty segments (double //'s) outside the first
261
# two elements of the list. This avoids problems with trailing
262
# slashes, or other abnormalities.
263
# finally we evaluate the entire path in a single pass
265
# '..' result in popping the left most already
266
# processed path (which can never be empty because of the check for
267
# abspath and homedir meaning that its not, or that we've used our
268
# path. If the pop would pop the root, we ignore it.
270
# Specific case examinations:
271
# remove the special casefor ~: if the current root is ~/ popping of it
272
# = / thus our seed for a ~ based path is ['', '~']
273
# and if we end up with [''] then we had basically ('', '..') (which is
274
# '/..' so we append '' if the length is one, and assert that the first
275
# element is still ''. Lastly, if we end with ['', '~'] as a prefix for
276
# the output, we've got a homedir path, so we strip that prefix before
277
# '/' joining the resulting list.
279
# case one: '/' -> ['', ''] cannot shrink
280
# case two: '/' + '../foo' -> ['', 'foo'] (take '', '', '..', 'foo')
281
# and pop the second '' for the '..', append 'foo'
282
# case three: '/~/' -> ['', '~', '']
283
# case four: '/~/' + '../foo' -> ['', '~', '', '..', 'foo'],
284
# and we want to get '/foo' - the empty path in the middle
285
# needs to be stripped, then normal path manipulation will
287
# case five: '/..' ['', '..'], we want ['', '']
288
# stripping '' outside the first two is ok
289
# ignore .. if its too high up
291
# lastly this code is possibly reusable by FTP, but not reusable by
292
# local paths: ~ is resolvable correctly, nor by HTTP or the smart
293
# server: ~ is resolved remotely.
295
# however, a version of this that acts on self.base is possible to be
296
# written which manipulates the URL in canonical form, and would be
297
# reusable for all transports, if a flag for allowing ~/ at all was
299
assert isinstance(relpath, basestring)
300
relpath = urlutils.unescape(relpath)
303
if relpath.startswith('/'):
304
# abspath - normal split is fine.
305
current_path = relpath.split('/')
306
elif relpath.startswith('~/'):
307
# root is homedir based: normal split and prefix '' to remote the
309
current_path = [''].extend(relpath.split('/'))
311
# root is from the current directory:
312
if self._path.startswith('/'):
313
# abspath, take the regular split
316
# homedir based, add the '', '~' not present in self._path
317
current_path = ['', '~']
318
# add our current dir
319
current_path.extend(self._path.split('/'))
320
# add the users relpath
321
current_path.extend(relpath.split('/'))
322
# strip '' segments that are not in the first one - the leading /.
323
to_process = current_path[:1]
324
for segment in current_path[1:]:
326
to_process.append(segment)
328
# process '.' and '..' segments into output_path.
330
for segment in to_process:
332
# directory pop. Remove a directory
333
# as long as we are not at the root
334
if len(output_path) > 1:
337
# cannot pop beyond the root, so do nothing
339
continue # strip the '.' from the output.
341
# this will append '' to output_path for the root elements,
342
# which is appropriate: its why we strip '' in the first pass.
343
output_path.append(segment)
345
# check output special cases:
346
if output_path == ['']:
348
output_path = ['', '']
349
elif output_path[:2] == ['', '~']:
350
# ['', '~', ...] -> ...
351
output_path = output_path[2:]
352
path = '/'.join(output_path)
355
def relpath(self, abspath):
356
scheme, username, password, host, port, path = self._split_url(abspath)
358
if (username != self._username):
359
error.append('username mismatch')
360
if (host != self._host):
361
error.append('host mismatch')
362
if (port != self._port):
363
error.append('port mismatch')
364
if (not path.startswith(self._path)):
365
error.append('path mismatch')
367
extra = ': ' + ', '.join(error)
368
raise PathNotChild(abspath, self.base, extra=extra)
370
return path[pl:].strip('/')
372
def has(self, relpath):
374
Does the target location exist?
377
self._sftp.stat(self._remote_path(relpath))
382
def get(self, relpath):
384
Get the file at the given relative path.
386
:param relpath: The relative path to the file
389
path = self._remote_path(relpath)
390
f = self._sftp.file(path, mode='rb')
391
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
394
except (IOError, paramiko.SSHException), e:
395
self._translate_io_exception(e, path, ': error retrieving')
397
def readv(self, relpath, offsets):
398
"""See Transport.readv()"""
399
# We overload the default readv() because we want to use a file
400
# that does not have prefetch enabled.
401
# Also, if we have a new paramiko, it implements an async readv()
406
path = self._remote_path(relpath)
407
fp = self._sftp.file(path, mode='rb')
408
readv = getattr(fp, 'readv', None)
410
return self._sftp_readv(fp, offsets, relpath)
411
mutter('seek and read %s offsets', len(offsets))
412
return self._seek_and_read(fp, offsets, relpath)
413
except (IOError, paramiko.SSHException), e:
414
self._translate_io_exception(e, path, ': error retrieving')
416
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
417
"""Use the readv() member of fp to do async readv.
419
And then read them using paramiko.readv(). paramiko.readv()
420
does not support ranges > 64K, so it caps the request size, and
421
just reads until it gets all the stuff it wants
423
offsets = list(offsets)
424
sorted_offsets = sorted(offsets)
426
# The algorithm works as follows:
427
# 1) Coalesce nearby reads into a single chunk
428
# This generates a list of combined regions, the total size
429
# and the size of the sub regions. This coalescing step is limited
430
# in the number of nearby chunks to combine, and is allowed to
431
# skip small breaks in the requests. Limiting it makes sure that
432
# we can start yielding some data earlier, and skipping means we
433
# make fewer requests. (Beneficial even when using async)
434
# 2) Break up this combined regions into chunks that are smaller
435
# than 64KiB. Technically the limit is 65536, but we are a
436
# little bit conservative. This is because sftp has a maximum
437
# return chunk size of 64KiB (max size of an unsigned short)
438
# 3) Issue a readv() to paramiko to create an async request for
440
# 4) Read in the data as it comes back, until we've read one
441
# continuous section as determined in step 1
442
# 5) Break up the full sections into hunks for the original requested
443
# offsets. And put them in a cache
444
# 6) Check if the next request is in the cache, and if it is, remove
445
# it from the cache, and yield its data. Continue until no more
446
# entries are in the cache.
447
# 7) loop back to step 4 until all data has been read
449
# TODO: jam 20060725 This could be optimized one step further, by
450
# attempting to yield whatever data we have read, even before
451
# the first coallesced section has been fully processed.
453
# When coalescing for use with readv(), we don't really need to
454
# use any fudge factor, because the requests are made asynchronously
455
coalesced = list(self._coalesce_offsets(sorted_offsets,
456
limit=self._max_readv_combine,
460
for c_offset in coalesced:
461
start = c_offset.start
462
size = c_offset.length
464
# We need to break this up into multiple requests
466
next_size = min(size, self._max_request_size)
467
requests.append((start, next_size))
471
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
472
len(offsets), len(coalesced), len(requests))
474
# Queue the current read until we have read the full coalesced section
477
cur_coalesced_stack = iter(coalesced)
478
cur_coalesced = cur_coalesced_stack.next()
480
# Cache the results, but only until they have been fulfilled
482
# turn the list of offsets into a stack
483
offset_stack = iter(offsets)
484
cur_offset_and_size = offset_stack.next()
486
for data in fp.readv(requests):
488
cur_data_len += len(data)
490
if cur_data_len < cur_coalesced.length:
492
assert cur_data_len == cur_coalesced.length, \
493
"Somehow we read too much: %s != %s" % (cur_data_len,
494
cur_coalesced.length)
495
all_data = ''.join(cur_data)
499
for suboffset, subsize in cur_coalesced.ranges:
500
key = (cur_coalesced.start+suboffset, subsize)
501
data_map[key] = all_data[suboffset:suboffset+subsize]
503
# Now that we've read some data, see if we can yield anything back
504
while cur_offset_and_size in data_map:
505
this_data = data_map.pop(cur_offset_and_size)
506
yield cur_offset_and_size[0], this_data
507
cur_offset_and_size = offset_stack.next()
509
# We read a coalesced entry, so mark it as done
511
# Now that we've read all of the data for this coalesced section
513
cur_coalesced = cur_coalesced_stack.next()
515
if cur_coalesced is not None:
516
raise errors.ShortReadvError(relpath, cur_coalesced.start,
517
cur_coalesced.length, len(data))
519
def put_file(self, relpath, f, mode=None):
521
Copy the file-like object into the location.
523
:param relpath: Location to put the contents, relative to base.
524
:param f: File-like object.
525
:param mode: The final mode for the file
527
final_path = self._remote_path(relpath)
528
self._put(final_path, f, mode=mode)
530
def _put(self, abspath, f, mode=None):
531
"""Helper function so both put() and copy_abspaths can reuse the code"""
532
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
533
os.getpid(), random.randint(0,0x7FFFFFFF))
534
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
538
fout.set_pipelined(True)
540
except (IOError, paramiko.SSHException), e:
541
self._translate_io_exception(e, tmp_abspath)
542
# XXX: This doesn't truly help like we would like it to.
543
# The problem is that openssh strips sticky bits. So while we
544
# can properly set group write permission, we lose the group
545
# sticky bit. So it is probably best to stop chmodding, and
546
# just tell users that they need to set the umask correctly.
547
# The attr.st_mode = mode, in _sftp_open_exclusive
548
# will handle when the user wants the final mode to be more
549
# restrictive. And then we avoid a round trip. Unless
550
# paramiko decides to expose an async chmod()
552
# This is designed to chmod() right before we close.
553
# Because we set_pipelined() earlier, theoretically we might
554
# avoid the round trip for fout.close()
556
self._sftp.chmod(tmp_abspath, mode)
559
self._rename_and_overwrite(tmp_abspath, abspath)
561
# If we fail, try to clean up the temporary file
562
# before we throw the exception
563
# but don't let another exception mess things up
564
# Write out the traceback, because otherwise
565
# the catch and throw destroys it
567
mutter(traceback.format_exc())
571
self._sftp.remove(tmp_abspath)
573
# raise the saved except
575
# raise the original with its traceback if we can.
578
def _put_non_atomic_helper(self, relpath, writer, mode=None,
579
create_parent_dir=False,
581
abspath = self._remote_path(relpath)
583
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
584
# set the file mode at create time. If it does, use it.
585
# But for now, we just chmod later anyway.
587
def _open_and_write_file():
588
"""Try to open the target file, raise error on failure"""
592
fout = self._sftp.file(abspath, mode='wb')
593
fout.set_pipelined(True)
595
except (paramiko.SSHException, IOError), e:
596
self._translate_io_exception(e, abspath,
599
# This is designed to chmod() right before we close.
600
# Because we set_pipelined() earlier, theoretically we might
601
# avoid the round trip for fout.close()
603
self._sftp.chmod(abspath, mode)
608
if not create_parent_dir:
609
_open_and_write_file()
612
# Try error handling to create the parent directory if we need to
614
_open_and_write_file()
616
# Try to create the parent directory, and then go back to
618
parent_dir = os.path.dirname(abspath)
619
self._mkdir(parent_dir, dir_mode)
620
_open_and_write_file()
622
def put_file_non_atomic(self, relpath, f, mode=None,
623
create_parent_dir=False,
625
"""Copy the file-like object into the target location.
627
This function is not strictly safe to use. It is only meant to
628
be used when you already know that the target does not exist.
629
It is not safe, because it will open and truncate the remote
630
file. So there may be a time when the file has invalid contents.
632
:param relpath: The remote location to put the contents.
633
:param f: File-like object.
634
:param mode: Possible access permissions for new file.
635
None means do not set remote permissions.
636
:param create_parent_dir: If we cannot create the target file because
637
the parent directory does not exist, go ahead and
638
create it, and then try again.
642
self._put_non_atomic_helper(relpath, writer, mode=mode,
643
create_parent_dir=create_parent_dir,
646
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
647
create_parent_dir=False,
651
self._put_non_atomic_helper(relpath, writer, mode=mode,
652
create_parent_dir=create_parent_dir,
655
def iter_files_recursive(self):
656
"""Walk the relative paths of all files in this transport."""
657
queue = list(self.list_dir('.'))
659
relpath = queue.pop(0)
660
st = self.stat(relpath)
661
if stat.S_ISDIR(st.st_mode):
662
for i, basename in enumerate(self.list_dir(relpath)):
663
queue.insert(i, relpath+'/'+basename)
667
def _mkdir(self, abspath, mode=None):
673
self._sftp.mkdir(abspath, local_mode)
675
self._sftp.chmod(abspath, mode=mode)
676
except (paramiko.SSHException, IOError), e:
677
self._translate_io_exception(e, abspath, ': unable to mkdir',
678
failure_exc=FileExists)
680
def mkdir(self, relpath, mode=None):
681
"""Create a directory at the given path."""
682
self._mkdir(self._remote_path(relpath), mode=mode)
684
def _translate_io_exception(self, e, path, more_info='',
685
failure_exc=PathError):
686
"""Translate a paramiko or IOError into a friendlier exception.
688
:param e: The original exception
689
:param path: The path in question when the error is raised
690
:param more_info: Extra information that can be included,
691
such as what was going on
692
:param failure_exc: Paramiko has the super fun ability to raise completely
693
opaque errors that just set "e.args = ('Failure',)" with
695
If this parameter is set, it defines the exception
696
to raise in these cases.
698
# paramiko seems to generate detailless errors.
699
self._translate_error(e, path, raise_generic=False)
700
if getattr(e, 'args', None) is not None:
701
if (e.args == ('No such file or directory',) or
702
e.args == ('No such file',)):
703
raise NoSuchFile(path, str(e) + more_info)
704
if (e.args == ('mkdir failed',)):
705
raise FileExists(path, str(e) + more_info)
706
# strange but true, for the paramiko server.
707
if (e.args == ('Failure',)):
708
raise failure_exc(path, str(e) + more_info)
709
mutter('Raising exception with args %s', e.args)
710
if getattr(e, 'errno', None) is not None:
711
mutter('Raising exception with errno %s', e.errno)
714
def append_file(self, relpath, f, mode=None):
716
Append the text in the file-like object into the final
720
path = self._remote_path(relpath)
721
fout = self._sftp.file(path, 'ab')
723
self._sftp.chmod(path, mode)
727
except (IOError, paramiko.SSHException), e:
728
self._translate_io_exception(e, relpath, ': unable to append')
730
def rename(self, rel_from, rel_to):
731
"""Rename without special overwriting"""
733
self._sftp.rename(self._remote_path(rel_from),
734
self._remote_path(rel_to))
735
except (IOError, paramiko.SSHException), e:
736
self._translate_io_exception(e, rel_from,
737
': unable to rename to %r' % (rel_to))
739
def _rename_and_overwrite(self, abs_from, abs_to):
740
"""Do a fancy rename on the remote server.
742
Using the implementation provided by osutils.
745
fancy_rename(abs_from, abs_to,
746
rename_func=self._sftp.rename,
747
unlink_func=self._sftp.remove)
748
except (IOError, paramiko.SSHException), e:
749
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
751
def move(self, rel_from, rel_to):
752
"""Move the item at rel_from to the location at rel_to"""
753
path_from = self._remote_path(rel_from)
754
path_to = self._remote_path(rel_to)
755
self._rename_and_overwrite(path_from, path_to)
757
def delete(self, relpath):
758
"""Delete the item at relpath"""
759
path = self._remote_path(relpath)
761
self._sftp.remove(path)
762
except (IOError, paramiko.SSHException), e:
763
self._translate_io_exception(e, path, ': unable to delete')
766
"""Return True if this store supports listing."""
769
def list_dir(self, relpath):
771
Return a list of all files at the given location.
773
# does anything actually use this?
775
# This is at least used by copy_tree for remote upgrades.
776
# -- David Allouche 2006-08-11
777
path = self._remote_path(relpath)
779
entries = self._sftp.listdir(path)
780
except (IOError, paramiko.SSHException), e:
781
self._translate_io_exception(e, path, ': failed to list_dir')
782
return [urlutils.escape(entry) for entry in entries]
784
def rmdir(self, relpath):
785
"""See Transport.rmdir."""
786
path = self._remote_path(relpath)
788
return self._sftp.rmdir(path)
789
except (IOError, paramiko.SSHException), e:
790
self._translate_io_exception(e, path, ': failed to rmdir')
792
def stat(self, relpath):
793
"""Return the stat information for a file."""
794
path = self._remote_path(relpath)
796
return self._sftp.stat(path)
797
except (IOError, paramiko.SSHException), e:
798
self._translate_io_exception(e, path, ': unable to stat')
800
def lock_read(self, relpath):
802
Lock the given file for shared (read) access.
803
:return: A lock object, which has an unlock() member function
805
# FIXME: there should be something clever i can do here...
806
class BogusLock(object):
807
def __init__(self, path):
811
return BogusLock(relpath)
813
def lock_write(self, relpath):
815
Lock the given file for exclusive (write) access.
816
WARNING: many transports do not support this, so trying avoid using it
818
:return: A lock object, which has an unlock() member function
820
# This is a little bit bogus, but basically, we create a file
821
# which should not already exist, and if it does, we assume
822
# that there is a lock, and if it doesn't, the we assume
823
# that we have taken the lock.
824
return SFTPLock(relpath, self)
826
def _sftp_connect(self):
827
"""Connect to the remote sftp server.
828
After this, self._sftp should have a valid connection (or
829
we raise an TransportError 'could not connect').
831
TODO: Raise a more reasonable ConnectionFailed exception
833
self._sftp = _sftp_connect(self._host, self._port, self._username,
836
def _sftp_open_exclusive(self, abspath, mode=None):
837
"""Open a remote path exclusively.
839
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
840
the file already exists. However it does not expose this
841
at the higher level of SFTPClient.open(), so we have to
844
WARNING: This breaks the SFTPClient abstraction, so it
845
could easily break against an updated version of paramiko.
847
:param abspath: The remote absolute path where the file should be opened
848
:param mode: The mode permissions bits for the new file
850
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
851
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
852
# However, there is no way to set the permission mode at open
853
# time using the sftp_client.file() functionality.
854
path = self._sftp._adjust_cwd(abspath)
855
# mutter('sftp abspath %s => %s', abspath, path)
856
attr = SFTPAttributes()
859
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
860
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
862
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
864
raise TransportError('Expected an SFTP handle')
865
handle = msg.get_string()
866
return SFTPFile(self._sftp, handle, 'wb', -1)
867
except (paramiko.SSHException, IOError), e:
868
self._translate_io_exception(e, abspath, ': unable to open',
869
failure_exc=FileExists)
871
def _can_roundtrip_unix_modebits(self):
872
if sys.platform == 'win32':
878
# ------------- server test implementation --------------
881
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
883
STUB_SERVER_KEY = """
884
-----BEGIN RSA PRIVATE KEY-----
885
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
886
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
887
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
888
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
889
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
890
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
891
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
892
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
893
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
894
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
895
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
896
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
897
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
898
-----END RSA PRIVATE KEY-----
902
class SocketListener(threading.Thread):
904
def __init__(self, callback):
905
threading.Thread.__init__(self)
906
self._callback = callback
907
self._socket = socket.socket()
908
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
909
self._socket.bind(('localhost', 0))
910
self._socket.listen(1)
911
self.port = self._socket.getsockname()[1]
912
self._stop_event = threading.Event()
915
# called from outside this thread
916
self._stop_event.set()
917
# use a timeout here, because if the test fails, the server thread may
918
# never notice the stop_event.
924
readable, writable_unused, exception_unused = \
925
select.select([self._socket], [], [], 0.1)
926
if self._stop_event.isSet():
928
if len(readable) == 0:
931
s, addr_unused = self._socket.accept()
932
# because the loopback socket is inline, and transports are
933
# never explicitly closed, best to launch a new thread.
934
threading.Thread(target=self._callback, args=(s,)).start()
935
except socket.error, x:
936
sys.excepthook(*sys.exc_info())
937
warning('Socket error during accept() within unit test server'
940
# probably a failed test; unit test thread will log the
942
sys.excepthook(*sys.exc_info())
943
warning('Exception from within unit test server thread: %r' %
947
class SocketDelay(object):
948
"""A socket decorator to make TCP appear slower.
950
This changes recv, send, and sendall to add a fixed latency to each python
951
call if a new roundtrip is detected. That is, when a recv is called and the
952
flag new_roundtrip is set, latency is charged. Every send and send_all
955
In addition every send, sendall and recv sleeps a bit per character send to
958
Not all methods are implemented, this is deliberate as this class is not a
959
replacement for the builtin sockets layer. fileno is not implemented to
960
prevent the proxy being bypassed.
964
_proxied_arguments = dict.fromkeys([
965
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
966
"setblocking", "setsockopt", "settimeout", "shutdown"])
968
def __init__(self, sock, latency, bandwidth=1.0,
971
:param bandwith: simulated bandwith (MegaBit)
972
:param really_sleep: If set to false, the SocketDelay will just
973
increase a counter, instead of calling time.sleep. This is useful for
974
unittesting the SocketDelay.
977
self.latency = latency
978
self.really_sleep = really_sleep
979
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
980
self.new_roundtrip = False
983
if self.really_sleep:
986
SocketDelay.simulated_time += s
988
def __getattr__(self, attr):
989
if attr in SocketDelay._proxied_arguments:
990
return getattr(self.sock, attr)
991
raise AttributeError("'SocketDelay' object has no attribute %r" %
995
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
998
def recv(self, *args):
999
data = self.sock.recv(*args)
1000
if data and self.new_roundtrip:
1001
self.new_roundtrip = False
1002
self.sleep(self.latency)
1003
self.sleep(len(data) * self.time_per_byte)
1006
def sendall(self, data, flags=0):
1007
if not self.new_roundtrip:
1008
self.new_roundtrip = True
1009
self.sleep(self.latency)
1010
self.sleep(len(data) * self.time_per_byte)
1011
return self.sock.sendall(data, flags)
1013
def send(self, data, flags=0):
1014
if not self.new_roundtrip:
1015
self.new_roundtrip = True
1016
self.sleep(self.latency)
1017
bytes_sent = self.sock.send(data, flags)
1018
self.sleep(bytes_sent * self.time_per_byte)
1022
class SFTPServer(Server):
1023
"""Common code for SFTP server facilities."""
1025
def __init__(self, server_interface=StubServer):
1026
self._original_vendor = None
1027
self._homedir = None
1028
self._server_homedir = None
1029
self._listener = None
1031
self._vendor = ssh.ParamikoVendor()
1032
self._server_interface = server_interface
1035
self.add_latency = 0
1037
def _get_sftp_url(self, path):
1038
"""Calculate an sftp url to this server for path."""
1039
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1041
def log(self, message):
1042
"""StubServer uses this to log when a new server is created."""
1043
self.logs.append(message)
1045
def _run_server_entry(self, sock):
1046
"""Entry point for all implementations of _run_server.
1048
If self.add_latency is > 0.000001 then sock is given a latency adding
1051
if self.add_latency > 0.000001:
1052
sock = SocketDelay(sock, self.add_latency)
1053
return self._run_server(sock)
1055
def _run_server(self, s):
1056
ssh_server = paramiko.Transport(s)
1057
key_file = pathjoin(self._homedir, 'test_rsa.key')
1058
f = open(key_file, 'w')
1059
f.write(STUB_SERVER_KEY)
1061
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1062
ssh_server.add_server_key(host_key)
1063
server = self._server_interface(self)
1064
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1065
StubSFTPServer, root=self._root,
1066
home=self._server_homedir)
1067
event = threading.Event()
1068
ssh_server.start_server(event, server)
1072
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1073
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1074
if sys.platform == 'win32':
1075
# Win32 needs to use the UNICODE api
1076
self._homedir = getcwd()
1078
# But Linux SFTP servers should just deal in bytestreams
1079
self._homedir = os.getcwd()
1080
if self._server_homedir is None:
1081
self._server_homedir = self._homedir
1083
if sys.platform == 'win32':
1085
self._listener = SocketListener(self._run_server_entry)
1086
self._listener.setDaemon(True)
1087
self._listener.start()
1090
"""See bzrlib.transport.Server.tearDown."""
1091
self._listener.stop()
1092
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1094
def get_bogus_url(self):
1095
"""See bzrlib.transport.Server.get_bogus_url."""
1096
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1097
# we bind a random socket, so that we get a guaranteed unused port
1098
# we just never listen on that port
1100
s.bind(('localhost', 0))
1101
return 'sftp://%s:%s/' % s.getsockname()
1104
class SFTPFullAbsoluteServer(SFTPServer):
1105
"""A test server for sftp transports, using absolute urls and ssh."""
1108
"""See bzrlib.transport.Server.get_url."""
1109
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1112
class SFTPServerWithoutSSH(SFTPServer):
1113
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1116
super(SFTPServerWithoutSSH, self).__init__()
1117
self._vendor = ssh.LoopbackVendor()
1119
def _run_server(self, sock):
1120
# Re-import these as locals, so that they're still accessible during
1121
# interpreter shutdown (when all module globals get set to None, leading
1122
# to confusing errors like "'NoneType' object has no attribute 'error'".
1123
class FakeChannel(object):
1124
def get_transport(self):
1126
def get_log_channel(self):
1130
def get_hexdump(self):
1135
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1136
root=self._root, home=self._server_homedir)
1138
server.start_subsystem('sftp', None, sock)
1139
except socket.error, e:
1140
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1141
# it's okay for the client to disconnect abruptly
1142
# (bug in paramiko 1.6: it should absorb this exception)
1146
except Exception, e:
1147
import sys; sys.stderr.write('\nEXCEPTION %r\n\n' % e.__class__)
1148
server.finish_subsystem()
1151
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1152
"""A test server for sftp transports, using absolute urls."""
1155
"""See bzrlib.transport.Server.get_url."""
1156
if sys.platform == 'win32':
1157
return self._get_sftp_url(urlutils.escape(self._homedir))
1159
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1162
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1163
"""A test server for sftp transports, using homedir relative urls."""
1166
"""See bzrlib.transport.Server.get_url."""
1167
return self._get_sftp_url("~/")
1170
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1171
"""A test servere for sftp transports, using absolute urls to non-home."""
1174
self._server_homedir = '/dev/noone/runs/tests/here'
1175
super(SFTPSiblingAbsoluteServer, self).setUp()
1178
def _sftp_connect(host, port, username, password):
1179
"""Connect to the remote sftp server.
1181
:raises: a TransportError 'could not connect'.
1183
:returns: an paramiko.sftp_client.SFTPClient
1185
TODO: Raise a more reasonable ConnectionFailed exception
1187
idx = (host, port, username)
1189
return _connected_hosts[idx]
1193
sftp = _sftp_connect_uncached(host, port, username, password)
1194
_connected_hosts[idx] = sftp
1197
def _sftp_connect_uncached(host, port, username, password):
1198
vendor = ssh._get_ssh_vendor()
1199
sftp = vendor.connect_sftp(username, password, host, port)
1203
def get_test_permutations():
1204
"""Return the permutations to be used in testing."""
1205
return [(SFTPTransport, SFTPAbsoluteServer),
1206
(SFTPTransport, SFTPHomeDirServer),
1207
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
