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.
46
from bzrlib.errors import (FileExists,
47
NoSuchFile, PathNotChild,
53
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
54
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, warning
58
from bzrlib.transport import (
67
# Disable one particular warning that comes from paramiko in Python2.5; if
68
# this is emitted at the wrong time it tends to cause spurious test failures
69
# or at least noise in the test case::
71
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
72
# test_permissions.TestSftpPermissions.test_new_files
73
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
74
# self.packet.write(struct.pack('>I', n))
75
warnings.filterwarnings('ignore',
76
'integer argument expected, got float',
77
category=DeprecationWarning,
78
module='paramiko.message')
82
except ImportError, e:
83
raise ParamikoNotPresent(e)
85
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
86
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
88
from paramiko.sftp_attr import SFTPAttributes
89
from paramiko.sftp_file import SFTPFile
92
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
93
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
94
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
97
class SFTPLock(object):
98
"""This fakes a lock in a remote location.
100
A present lock is indicated just by the existence of a file. This
101
doesn't work well on all transports and they are only used in
102
deprecated storage formats.
105
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
107
def __init__(self, path, transport):
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 _SFTPReadvHelper(object):
138
"""A class to help with managing the state of a readv request."""
140
# See _get_requests for an explanation.
141
_max_request_size = 32768
143
def __init__(self, original_offsets, relpath):
144
"""Create a new readv helper.
146
:param original_offsets: The original requests given by the caller of
148
:param relpath: The name of the file (if known)
150
self.original_offsets = list(original_offsets)
151
self.relpath = relpath
153
def _get_requests(self):
154
"""Break up the offsets into individual requests over sftp.
156
The SFTP spec only requires implementers to support 32kB requests. We
157
could try something larger (openssh supports 64kB), but then we have to
158
handle requests that fail.
159
So instead, we just break up our maximum chunks into 32kB chunks, and
160
asyncronously requests them.
161
Newer versions of paramiko would do the chunking for us, but we want to
162
start processing results right away, so we do it ourselves.
164
# TODO: Because we issue async requests, we don't 'fudge' any extra
165
# data. I'm not 100% sure that is the best choice.
167
# The first thing we do, is to collapse the individual requests as much
168
# as possible, so we don't issues requests <32kB
169
sorted_offsets = sorted(self.original_offsets)
170
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
171
limit=0, fudge_factor=0))
173
for c_offset in coalesced:
174
start = c_offset.start
175
size = c_offset.length
177
# Break this up into 32kB requests
179
next_size = min(size, self._max_request_size)
180
requests.append((start, next_size))
183
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
184
self.relpath, len(sorted_offsets), len(coalesced),
188
def request_and_yield_offsets(self, fp):
189
"""Request the data from the remote machine, yielding the results.
191
:param fp: A Paramiko SFTPFile object that supports readv.
192
:return: Yield the data requested by the original readv caller, one by
195
requests = self._get_requests()
196
offset_iter = iter(self.original_offsets)
197
cur_offset, cur_size = offset_iter.next()
198
# paramiko .readv() yields strings that are in the order of the requests
199
# So we track the current request to know where the next data is
200
# being returned from.
206
# This is used to buffer chunks which we couldn't process yet
207
# It is (start, end, data) tuples.
209
# Create an 'unlimited' data stream, so we stop based on requests,
210
# rather than just because the data stream ended. This lets us detect
212
data_stream = itertools.chain(fp.readv(requests),
213
itertools.repeat(None))
214
for (start, length), data in itertools.izip(requests, data_stream):
216
if cur_coalesced is not None:
217
raise errors.ShortReadvError(self.relpath,
218
start, length, len(data))
219
if len(data) != length:
220
raise errors.ShortReadvError(self.relpath,
221
start, length, len(data))
223
# This is the first request, just buffer it
224
buffered_data = [data]
225
buffered_len = length
227
elif start == last_end:
228
# The data we are reading fits neatly on the previous
229
# buffer, so this is all part of a larger coalesced range.
230
buffered_data.append(data)
231
buffered_len += length
233
# We have an 'interrupt' in the data stream. So we know we are
234
# at a request boundary.
236
# We haven't consumed the buffer so far, so put it into
237
# data_chunks, and continue.
238
buffered = ''.join(buffered_data)
239
data_chunks.append((input_start, buffered))
241
buffered_data = [data]
242
buffered_len = length
243
last_end = start + length
244
if input_start == cur_offset and cur_size <= buffered_len:
245
# Simplify the next steps a bit by transforming buffered_data
246
# into a single string. We also have the nice property that
247
# when there is only one string ''.join([x]) == x, so there is
249
buffered = ''.join(buffered_data)
250
# Clean out buffered data so that we keep memory
254
# TODO: We *could* also consider the case where cur_offset is in
255
# in the buffered range, even though it doesn't *start*
256
# the buffered range. But for packs we pretty much always
257
# read in order, so you won't get any extra data in the
259
while (input_start == cur_offset
260
and (buffered_offset + cur_size) <= buffered_len):
261
# We've buffered enough data to process this request, spit it
263
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
264
# move the direct pointer into our buffered data
265
buffered_offset += cur_size
266
# Move the start-of-buffer pointer
267
input_start += cur_size
268
# Yield the requested data
269
yield cur_offset, cur_data
270
cur_offset, cur_size = offset_iter.next()
271
# at this point, we've consumed as much of buffered as we can,
272
# so break off the portion that we consumed
273
if buffered_offset == len(buffered_data):
274
# No tail to leave behind
278
buffered = buffered[buffered_offset:]
279
buffered_data = [buffered]
280
buffered_len = len(buffered)
282
buffered = ''.join(buffered_data)
284
data_chunks.append((input_start, buffered))
286
mutter('SFTP readv left with %d out-of-order bytes',
287
sum(map(lambda x: len(x[1]), data_chunks)))
288
# We've processed all the readv data, at this point, anything we
289
# couldn't process is in data_chunks. This doesn't happen often, so
290
# this code path isn't optimized
291
# We use an interesting process for data_chunks
292
# Specifically if we have "bisect_left([(start, len, entries)],
294
# If start == qstart, then we get the specific node. Otherwise we
295
# get the previous node
297
idx = bisect.bisect_left(data_chunks, (cur_offset,))
298
if data_chunks[idx][0] == cur_offset: # The data starts here
299
data = data_chunks[idx][1][:cur_size]
301
# The data is in a portion of a previous page
303
sub_offset = cur_offset - data_chunks[idx][0]
304
data = data_chunks[idx][1]
305
data = data[sub_offset:sub_offset + cur_size]
307
# We are missing the page where the data should be found,
310
if len(data) != cur_size:
311
raise AssertionError('We must have miscalulated.'
312
' We expected %d bytes, but only found %d'
313
% (cur_size, len(data)))
314
yield cur_offset, data
315
cur_offset, cur_size = offset_iter.next()
318
class SFTPTransport(ConnectedTransport):
319
"""Transport implementation for SFTP access."""
321
_do_prefetch = _default_do_prefetch
322
# TODO: jam 20060717 Conceivably these could be configurable, either
323
# by auto-tuning at run-time, or by a configuration (per host??)
324
# but the performance curve is pretty flat, so just going with
325
# reasonable defaults.
326
_max_readv_combine = 200
327
# Having to round trip to the server means waiting for a response,
328
# so it is better to download extra bytes.
329
# 8KiB had good performance for both local and remote network operations
330
_bytes_to_read_before_seek = 8192
332
# The sftp spec says that implementations SHOULD allow reads
333
# to be at least 32K. paramiko.readv() does an async request
334
# for the chunks. So we need to keep it within a single request
335
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
336
# up the request itself, rather than us having to worry about it
337
_max_request_size = 32768
339
def __init__(self, base, _from_transport=None):
340
super(SFTPTransport, self).__init__(base,
341
_from_transport=_from_transport)
343
def _remote_path(self, relpath):
344
"""Return the path to be passed along the sftp protocol for relpath.
346
:param relpath: is a urlencoded string.
348
relative = urlutils.unescape(relpath).encode('utf-8')
349
remote_path = self._combine_paths(self._path, relative)
350
# the initial slash should be removed from the path, and treated as a
351
# homedir relative path (the path begins with a double slash if it is
352
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
353
# RBC 20060118 we are not using this as its too user hostile. instead
354
# we are following lftp and using /~/foo to mean '~/foo'
355
# vila--20070602 and leave absolute paths begin with a single slash.
356
if remote_path.startswith('/~/'):
357
remote_path = remote_path[3:]
358
elif remote_path == '/~':
362
def _create_connection(self, credentials=None):
363
"""Create a new connection with the provided credentials.
365
:param credentials: The credentials needed to establish the connection.
367
:return: The created connection and its associated credentials.
369
The credentials are only the password as it may have been entered
370
interactively by the user and may be different from the one provided
371
in base url at transport creation time.
373
if credentials is None:
374
password = self._password
376
password = credentials
378
vendor = ssh._get_ssh_vendor()
381
auth = config.AuthenticationConfig()
382
user = auth.get_user('ssh', self._host, self._port)
383
connection = vendor.connect_sftp(self._user, password,
384
self._host, self._port)
385
return connection, (user, password)
388
"""Ensures that a connection is established"""
389
connection = self._get_connection()
390
if connection is None:
391
# First connection ever
392
connection, credentials = self._create_connection()
393
self._set_connection(connection, credentials)
396
def has(self, relpath):
398
Does the target location exist?
401
self._get_sftp().stat(self._remote_path(relpath))
406
def get(self, relpath):
408
Get the file at the given relative path.
410
:param relpath: The relative path to the file
413
path = self._remote_path(relpath)
414
f = self._get_sftp().file(path, mode='rb')
415
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
418
except (IOError, paramiko.SSHException), e:
419
self._translate_io_exception(e, path, ': error retrieving',
420
failure_exc=errors.ReadError)
422
def _readv(self, relpath, offsets):
423
"""See Transport.readv()"""
424
# We overload the default readv() because we want to use a file
425
# that does not have prefetch enabled.
426
# Also, if we have a new paramiko, it implements an async readv()
431
path = self._remote_path(relpath)
432
fp = self._get_sftp().file(path, mode='rb')
433
readv = getattr(fp, 'readv', None)
435
return self._sftp_readv(fp, offsets, relpath)
436
mutter('seek and read %s offsets', len(offsets))
437
return self._seek_and_read(fp, offsets, relpath)
438
except (IOError, paramiko.SSHException), e:
439
self._translate_io_exception(e, path, ': error retrieving')
441
def recommended_page_size(self):
442
"""See Transport.recommended_page_size().
444
For SFTP we suggest a large page size to reduce the overhead
445
introduced by latency.
449
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
450
"""Use the readv() member of fp to do async readv.
452
And then read them using paramiko.readv(). paramiko.readv()
453
does not support ranges > 64K, so it caps the request size, and
454
just reads until it gets all the stuff it wants
456
helper = _SFTPReadvHelper(offsets, relpath)
457
return helper.request_and_yield_offsets(fp)
459
def put_file(self, relpath, f, mode=None):
461
Copy the file-like object into the location.
463
:param relpath: Location to put the contents, relative to base.
464
:param f: File-like object.
465
:param mode: The final mode for the file
467
final_path = self._remote_path(relpath)
468
return self._put(final_path, f, mode=mode)
470
def _put(self, abspath, f, mode=None):
471
"""Helper function so both put() and copy_abspaths can reuse the code"""
472
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
473
os.getpid(), random.randint(0,0x7FFFFFFF))
474
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
478
fout.set_pipelined(True)
479
length = self._pump(f, fout)
480
except (IOError, paramiko.SSHException), e:
481
self._translate_io_exception(e, tmp_abspath)
482
# XXX: This doesn't truly help like we would like it to.
483
# The problem is that openssh strips sticky bits. So while we
484
# can properly set group write permission, we lose the group
485
# sticky bit. So it is probably best to stop chmodding, and
486
# just tell users that they need to set the umask correctly.
487
# The attr.st_mode = mode, in _sftp_open_exclusive
488
# will handle when the user wants the final mode to be more
489
# restrictive. And then we avoid a round trip. Unless
490
# paramiko decides to expose an async chmod()
492
# This is designed to chmod() right before we close.
493
# Because we set_pipelined() earlier, theoretically we might
494
# avoid the round trip for fout.close()
496
self._get_sftp().chmod(tmp_abspath, mode)
499
self._rename_and_overwrite(tmp_abspath, abspath)
502
# If we fail, try to clean up the temporary file
503
# before we throw the exception
504
# but don't let another exception mess things up
505
# Write out the traceback, because otherwise
506
# the catch and throw destroys it
508
mutter(traceback.format_exc())
512
self._get_sftp().remove(tmp_abspath)
514
# raise the saved except
516
# raise the original with its traceback if we can.
519
def _put_non_atomic_helper(self, relpath, writer, mode=None,
520
create_parent_dir=False,
522
abspath = self._remote_path(relpath)
524
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
525
# set the file mode at create time. If it does, use it.
526
# But for now, we just chmod later anyway.
528
def _open_and_write_file():
529
"""Try to open the target file, raise error on failure"""
533
fout = self._get_sftp().file(abspath, mode='wb')
534
fout.set_pipelined(True)
536
except (paramiko.SSHException, IOError), e:
537
self._translate_io_exception(e, abspath,
540
# This is designed to chmod() right before we close.
541
# Because we set_pipelined() earlier, theoretically we might
542
# avoid the round trip for fout.close()
544
self._get_sftp().chmod(abspath, mode)
549
if not create_parent_dir:
550
_open_and_write_file()
553
# Try error handling to create the parent directory if we need to
555
_open_and_write_file()
557
# Try to create the parent directory, and then go back to
559
parent_dir = os.path.dirname(abspath)
560
self._mkdir(parent_dir, dir_mode)
561
_open_and_write_file()
563
def put_file_non_atomic(self, relpath, f, mode=None,
564
create_parent_dir=False,
566
"""Copy the file-like object into the target location.
568
This function is not strictly safe to use. It is only meant to
569
be used when you already know that the target does not exist.
570
It is not safe, because it will open and truncate the remote
571
file. So there may be a time when the file has invalid contents.
573
:param relpath: The remote location to put the contents.
574
:param f: File-like object.
575
:param mode: Possible access permissions for new file.
576
None means do not set remote permissions.
577
:param create_parent_dir: If we cannot create the target file because
578
the parent directory does not exist, go ahead and
579
create it, and then try again.
583
self._put_non_atomic_helper(relpath, writer, mode=mode,
584
create_parent_dir=create_parent_dir,
587
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
588
create_parent_dir=False,
592
self._put_non_atomic_helper(relpath, writer, mode=mode,
593
create_parent_dir=create_parent_dir,
596
def iter_files_recursive(self):
597
"""Walk the relative paths of all files in this transport."""
598
queue = list(self.list_dir('.'))
600
relpath = queue.pop(0)
601
st = self.stat(relpath)
602
if stat.S_ISDIR(st.st_mode):
603
for i, basename in enumerate(self.list_dir(relpath)):
604
queue.insert(i, relpath+'/'+basename)
608
def _mkdir(self, abspath, mode=None):
614
self._get_sftp().mkdir(abspath, local_mode)
616
# chmod a dir through sftp will erase any sgid bit set
617
# on the server side. So, if the bit mode are already
618
# set, avoid the chmod. If the mode is not fine but
619
# the sgid bit is set, report a warning to the user
620
# with the umask fix.
621
stat = self._get_sftp().lstat(abspath)
622
mode = mode & 0777 # can't set special bits anyway
623
if mode != stat.st_mode & 0777:
624
if stat.st_mode & 06000:
625
warning('About to chmod %s over sftp, which will result'
626
' in its suid or sgid bits being cleared. If'
627
' you want to preserve those bits, change your '
628
' environment on the server to use umask 0%03o.'
629
% (abspath, 0777 - mode))
630
self._get_sftp().chmod(abspath, mode=mode)
631
except (paramiko.SSHException, IOError), e:
632
self._translate_io_exception(e, abspath, ': unable to mkdir',
633
failure_exc=FileExists)
635
def mkdir(self, relpath, mode=None):
636
"""Create a directory at the given path."""
637
self._mkdir(self._remote_path(relpath), mode=mode)
639
def open_write_stream(self, relpath, mode=None):
640
"""See Transport.open_write_stream."""
641
# initialise the file to zero-length
642
# this is three round trips, but we don't use this
643
# api more than once per write_group at the moment so
644
# it is a tolerable overhead. Better would be to truncate
645
# the file after opening. RBC 20070805
646
self.put_bytes_non_atomic(relpath, "", mode)
647
abspath = self._remote_path(relpath)
648
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
649
# set the file mode at create time. If it does, use it.
650
# But for now, we just chmod later anyway.
653
handle = self._get_sftp().file(abspath, mode='wb')
654
handle.set_pipelined(True)
655
except (paramiko.SSHException, IOError), e:
656
self._translate_io_exception(e, abspath,
658
_file_streams[self.abspath(relpath)] = handle
659
return FileFileStream(self, relpath, handle)
661
def _translate_io_exception(self, e, path, more_info='',
662
failure_exc=PathError):
663
"""Translate a paramiko or IOError into a friendlier exception.
665
:param e: The original exception
666
:param path: The path in question when the error is raised
667
:param more_info: Extra information that can be included,
668
such as what was going on
669
:param failure_exc: Paramiko has the super fun ability to raise completely
670
opaque errors that just set "e.args = ('Failure',)" with
672
If this parameter is set, it defines the exception
673
to raise in these cases.
675
# paramiko seems to generate detailless errors.
676
self._translate_error(e, path, raise_generic=False)
677
if getattr(e, 'args', None) is not None:
678
if (e.args == ('No such file or directory',) or
679
e.args == ('No such file',)):
680
raise NoSuchFile(path, str(e) + more_info)
681
if (e.args == ('mkdir failed',) or
682
e.args[0].startswith('syserr: File exists')):
683
raise FileExists(path, str(e) + more_info)
684
# strange but true, for the paramiko server.
685
if (e.args == ('Failure',)):
686
raise failure_exc(path, str(e) + more_info)
687
mutter('Raising exception with args %s', e.args)
688
if getattr(e, 'errno', None) is not None:
689
mutter('Raising exception with errno %s', e.errno)
692
def append_file(self, relpath, f, mode=None):
694
Append the text in the file-like object into the final
698
path = self._remote_path(relpath)
699
fout = self._get_sftp().file(path, 'ab')
701
self._get_sftp().chmod(path, mode)
705
except (IOError, paramiko.SSHException), e:
706
self._translate_io_exception(e, relpath, ': unable to append')
708
def rename(self, rel_from, rel_to):
709
"""Rename without special overwriting"""
711
self._get_sftp().rename(self._remote_path(rel_from),
712
self._remote_path(rel_to))
713
except (IOError, paramiko.SSHException), e:
714
self._translate_io_exception(e, rel_from,
715
': unable to rename to %r' % (rel_to))
717
def _rename_and_overwrite(self, abs_from, abs_to):
718
"""Do a fancy rename on the remote server.
720
Using the implementation provided by osutils.
723
sftp = self._get_sftp()
724
fancy_rename(abs_from, abs_to,
725
rename_func=sftp.rename,
726
unlink_func=sftp.remove)
727
except (IOError, paramiko.SSHException), e:
728
self._translate_io_exception(e, abs_from,
729
': unable to rename to %r' % (abs_to))
731
def move(self, rel_from, rel_to):
732
"""Move the item at rel_from to the location at rel_to"""
733
path_from = self._remote_path(rel_from)
734
path_to = self._remote_path(rel_to)
735
self._rename_and_overwrite(path_from, path_to)
737
def delete(self, relpath):
738
"""Delete the item at relpath"""
739
path = self._remote_path(relpath)
741
self._get_sftp().remove(path)
742
except (IOError, paramiko.SSHException), e:
743
self._translate_io_exception(e, path, ': unable to delete')
745
def external_url(self):
746
"""See bzrlib.transport.Transport.external_url."""
747
# the external path for SFTP is the base
751
"""Return True if this store supports listing."""
754
def list_dir(self, relpath):
756
Return a list of all files at the given location.
758
# does anything actually use this?
760
# This is at least used by copy_tree for remote upgrades.
761
# -- David Allouche 2006-08-11
762
path = self._remote_path(relpath)
764
entries = self._get_sftp().listdir(path)
765
except (IOError, paramiko.SSHException), e:
766
self._translate_io_exception(e, path, ': failed to list_dir')
767
return [urlutils.escape(entry) for entry in entries]
769
def rmdir(self, relpath):
770
"""See Transport.rmdir."""
771
path = self._remote_path(relpath)
773
return self._get_sftp().rmdir(path)
774
except (IOError, paramiko.SSHException), e:
775
self._translate_io_exception(e, path, ': failed to rmdir')
777
def stat(self, relpath):
778
"""Return the stat information for a file."""
779
path = self._remote_path(relpath)
781
return self._get_sftp().stat(path)
782
except (IOError, paramiko.SSHException), e:
783
self._translate_io_exception(e, path, ': unable to stat')
785
def lock_read(self, relpath):
787
Lock the given file for shared (read) access.
788
:return: A lock object, which has an unlock() member function
790
# FIXME: there should be something clever i can do here...
791
class BogusLock(object):
792
def __init__(self, path):
796
return BogusLock(relpath)
798
def lock_write(self, relpath):
800
Lock the given file for exclusive (write) access.
801
WARNING: many transports do not support this, so trying avoid using it
803
:return: A lock object, which has an unlock() member function
805
# This is a little bit bogus, but basically, we create a file
806
# which should not already exist, and if it does, we assume
807
# that there is a lock, and if it doesn't, the we assume
808
# that we have taken the lock.
809
return SFTPLock(relpath, self)
811
def _sftp_open_exclusive(self, abspath, mode=None):
812
"""Open a remote path exclusively.
814
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
815
the file already exists. However it does not expose this
816
at the higher level of SFTPClient.open(), so we have to
819
WARNING: This breaks the SFTPClient abstraction, so it
820
could easily break against an updated version of paramiko.
822
:param abspath: The remote absolute path where the file should be opened
823
:param mode: The mode permissions bits for the new file
825
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
826
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
827
# However, there is no way to set the permission mode at open
828
# time using the sftp_client.file() functionality.
829
path = self._get_sftp()._adjust_cwd(abspath)
830
# mutter('sftp abspath %s => %s', abspath, path)
831
attr = SFTPAttributes()
834
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
835
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
837
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
839
raise TransportError('Expected an SFTP handle')
840
handle = msg.get_string()
841
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
842
except (paramiko.SSHException, IOError), e:
843
self._translate_io_exception(e, abspath, ': unable to open',
844
failure_exc=FileExists)
846
def _can_roundtrip_unix_modebits(self):
847
if sys.platform == 'win32':
853
# ------------- server test implementation --------------
856
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
858
STUB_SERVER_KEY = """
859
-----BEGIN RSA PRIVATE KEY-----
860
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
861
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
862
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
863
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
864
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
865
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
866
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
867
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
868
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
869
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
870
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
871
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
872
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
873
-----END RSA PRIVATE KEY-----
877
class SocketListener(threading.Thread):
879
def __init__(self, callback):
880
threading.Thread.__init__(self)
881
self._callback = callback
882
self._socket = socket.socket()
883
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
884
self._socket.bind(('localhost', 0))
885
self._socket.listen(1)
886
self.port = self._socket.getsockname()[1]
887
self._stop_event = threading.Event()
890
# called from outside this thread
891
self._stop_event.set()
892
# use a timeout here, because if the test fails, the server thread may
893
# never notice the stop_event.
899
readable, writable_unused, exception_unused = \
900
select.select([self._socket], [], [], 0.1)
901
if self._stop_event.isSet():
903
if len(readable) == 0:
906
s, addr_unused = self._socket.accept()
907
# because the loopback socket is inline, and transports are
908
# never explicitly closed, best to launch a new thread.
909
threading.Thread(target=self._callback, args=(s,)).start()
910
except socket.error, x:
911
sys.excepthook(*sys.exc_info())
912
warning('Socket error during accept() within unit test server'
915
# probably a failed test; unit test thread will log the
917
sys.excepthook(*sys.exc_info())
918
warning('Exception from within unit test server thread: %r' %
922
class SocketDelay(object):
923
"""A socket decorator to make TCP appear slower.
925
This changes recv, send, and sendall to add a fixed latency to each python
926
call if a new roundtrip is detected. That is, when a recv is called and the
927
flag new_roundtrip is set, latency is charged. Every send and send_all
930
In addition every send, sendall and recv sleeps a bit per character send to
933
Not all methods are implemented, this is deliberate as this class is not a
934
replacement for the builtin sockets layer. fileno is not implemented to
935
prevent the proxy being bypassed.
939
_proxied_arguments = dict.fromkeys([
940
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
941
"setblocking", "setsockopt", "settimeout", "shutdown"])
943
def __init__(self, sock, latency, bandwidth=1.0,
946
:param bandwith: simulated bandwith (MegaBit)
947
:param really_sleep: If set to false, the SocketDelay will just
948
increase a counter, instead of calling time.sleep. This is useful for
949
unittesting the SocketDelay.
952
self.latency = latency
953
self.really_sleep = really_sleep
954
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
955
self.new_roundtrip = False
958
if self.really_sleep:
961
SocketDelay.simulated_time += s
963
def __getattr__(self, attr):
964
if attr in SocketDelay._proxied_arguments:
965
return getattr(self.sock, attr)
966
raise AttributeError("'SocketDelay' object has no attribute %r" %
970
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
973
def recv(self, *args):
974
data = self.sock.recv(*args)
975
if data and self.new_roundtrip:
976
self.new_roundtrip = False
977
self.sleep(self.latency)
978
self.sleep(len(data) * self.time_per_byte)
981
def sendall(self, data, flags=0):
982
if not self.new_roundtrip:
983
self.new_roundtrip = True
984
self.sleep(self.latency)
985
self.sleep(len(data) * self.time_per_byte)
986
return self.sock.sendall(data, flags)
988
def send(self, data, flags=0):
989
if not self.new_roundtrip:
990
self.new_roundtrip = True
991
self.sleep(self.latency)
992
bytes_sent = self.sock.send(data, flags)
993
self.sleep(bytes_sent * self.time_per_byte)
997
class SFTPServer(Server):
998
"""Common code for SFTP server facilities."""
1000
def __init__(self, server_interface=StubServer):
1001
self._original_vendor = None
1002
self._homedir = None
1003
self._server_homedir = None
1004
self._listener = None
1006
self._vendor = ssh.ParamikoVendor()
1007
self._server_interface = server_interface
1010
self.add_latency = 0
1012
def _get_sftp_url(self, path):
1013
"""Calculate an sftp url to this server for path."""
1014
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1016
def log(self, message):
1017
"""StubServer uses this to log when a new server is created."""
1018
self.logs.append(message)
1020
def _run_server_entry(self, sock):
1021
"""Entry point for all implementations of _run_server.
1023
If self.add_latency is > 0.000001 then sock is given a latency adding
1026
if self.add_latency > 0.000001:
1027
sock = SocketDelay(sock, self.add_latency)
1028
return self._run_server(sock)
1030
def _run_server(self, s):
1031
ssh_server = paramiko.Transport(s)
1032
key_file = pathjoin(self._homedir, 'test_rsa.key')
1033
f = open(key_file, 'w')
1034
f.write(STUB_SERVER_KEY)
1036
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1037
ssh_server.add_server_key(host_key)
1038
server = self._server_interface(self)
1039
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1040
StubSFTPServer, root=self._root,
1041
home=self._server_homedir)
1042
event = threading.Event()
1043
ssh_server.start_server(event, server)
1046
def setUp(self, backing_server=None):
1047
# XXX: TODO: make sftpserver back onto backing_server rather than local
1049
if not (backing_server is None or
1050
isinstance(backing_server, local.LocalURLServer)):
1051
raise AssertionError(
1052
"backing_server should not be %r, because this can only serve the "
1053
"local current working directory." % (backing_server,))
1054
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1055
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1056
if sys.platform == 'win32':
1057
# Win32 needs to use the UNICODE api
1058
self._homedir = getcwd()
1060
# But Linux SFTP servers should just deal in bytestreams
1061
self._homedir = os.getcwd()
1062
if self._server_homedir is None:
1063
self._server_homedir = self._homedir
1065
if sys.platform == 'win32':
1067
self._listener = SocketListener(self._run_server_entry)
1068
self._listener.setDaemon(True)
1069
self._listener.start()
1072
"""See bzrlib.transport.Server.tearDown."""
1073
self._listener.stop()
1074
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1076
def get_bogus_url(self):
1077
"""See bzrlib.transport.Server.get_bogus_url."""
1078
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1079
# we bind a random socket, so that we get a guaranteed unused port
1080
# we just never listen on that port
1082
s.bind(('localhost', 0))
1083
return 'sftp://%s:%s/' % s.getsockname()
1086
class SFTPFullAbsoluteServer(SFTPServer):
1087
"""A test server for sftp transports, using absolute urls and ssh."""
1090
"""See bzrlib.transport.Server.get_url."""
1091
homedir = self._homedir
1092
if sys.platform != 'win32':
1093
# Remove the initial '/' on all platforms but win32
1094
homedir = homedir[1:]
1095
return self._get_sftp_url(urlutils.escape(homedir))
1098
class SFTPServerWithoutSSH(SFTPServer):
1099
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1102
super(SFTPServerWithoutSSH, self).__init__()
1103
self._vendor = ssh.LoopbackVendor()
1105
def _run_server(self, sock):
1106
# Re-import these as locals, so that they're still accessible during
1107
# interpreter shutdown (when all module globals get set to None, leading
1108
# to confusing errors like "'NoneType' object has no attribute 'error'".
1109
class FakeChannel(object):
1110
def get_transport(self):
1112
def get_log_channel(self):
1116
def get_hexdump(self):
1121
server = paramiko.SFTPServer(
1122
FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1123
root=self._root, home=self._server_homedir)
1125
server.start_subsystem(
1126
'sftp', None, ssh.SocketAsChannelAdapter(sock))
1127
except socket.error, e:
1128
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1129
# it's okay for the client to disconnect abruptly
1130
# (bug in paramiko 1.6: it should absorb this exception)
1134
except Exception, e:
1135
# This typically seems to happen during interpreter shutdown, so
1136
# most of the useful ways to report this error are won't work.
1137
# Writing the exception type, and then the text of the exception,
1138
# seems to be the best we can do.
1140
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1141
sys.stderr.write('%s\n\n' % (e,))
1142
server.finish_subsystem()
1145
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1146
"""A test server for sftp transports, using absolute urls."""
1149
"""See bzrlib.transport.Server.get_url."""
1150
homedir = self._homedir
1151
if sys.platform != 'win32':
1152
# Remove the initial '/' on all platforms but win32
1153
homedir = homedir[1:]
1154
return self._get_sftp_url(urlutils.escape(homedir))
1157
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1158
"""A test server for sftp transports, using homedir relative urls."""
1161
"""See bzrlib.transport.Server.get_url."""
1162
return self._get_sftp_url("~/")
1165
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1166
"""A test server for sftp transports where only absolute paths will work.
1168
It does this by serving from a deeply-nested directory that doesn't exist.
1171
def setUp(self, backing_server=None):
1172
self._server_homedir = '/dev/noone/runs/tests/here'
1173
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1176
def get_test_permutations():
1177
"""Return the permutations to be used in testing."""
1178
return [(SFTPTransport, SFTPAbsoluteServer),
1179
(SFTPTransport, SFTPHomeDirServer),
1180
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
