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.
45
from bzrlib.errors import (FileExists,
46
NoSuchFile, PathNotChild,
52
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
53
from bzrlib.symbol_versioning import (
56
from bzrlib.trace import mutter, warning
57
from bzrlib.transport import (
66
# Disable one particular warning that comes from paramiko in Python2.5; if
67
# this is emitted at the wrong time it tends to cause spurious test failures
68
# or at least noise in the test case::
70
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
71
# test_permissions.TestSftpPermissions.test_new_files
72
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
73
# self.packet.write(struct.pack('>I', n))
74
warnings.filterwarnings('ignore',
75
'integer argument expected, got float',
76
category=DeprecationWarning,
77
module='paramiko.message')
81
except ImportError, e:
82
raise ParamikoNotPresent(e)
84
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
85
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
87
from paramiko.sftp_attr import SFTPAttributes
88
from paramiko.sftp_file import SFTPFile
91
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
92
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
93
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
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
self.lock_file = None
109
self.lock_path = path + '.write-lock'
110
self.transport = transport
112
# RBC 20060103 FIXME should we be using private methods here ?
113
abspath = transport._remote_path(self.lock_path)
114
self.lock_file = transport._sftp_open_exclusive(abspath)
116
raise LockError('File %r already locked' % (self.path,))
119
"""Should this warn, or actually try to cleanup?"""
121
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
125
if not self.lock_file:
127
self.lock_file.close()
128
self.lock_file = None
130
self.transport.delete(self.lock_path)
131
except (NoSuchFile,):
132
# What specific errors should we catch here?
136
class _SFTPReadvHelper(object):
137
"""A class to help with managing the state of a readv request."""
139
# See _get_requests for an explanation.
140
_max_request_size = 32768
142
def __init__(self, original_offsets, relpath):
143
"""Create a new readv helper.
145
:param original_offsets: The original requests given by the caller of
147
:param relpath: The name of the file (if known)
149
self.original_offsets = list(original_offsets)
150
self.relpath = relpath
152
def _get_requests(self):
153
"""Break up the offsets into individual requests over sftp.
155
The SFTP spec only requires implementers to support 32kB requests. We
156
could try something larger (openssh supports 64kB), but then we have to
157
handle requests that fail.
158
So instead, we just break up our maximum chunks into 32kB chunks, and
159
asyncronously requests them.
160
Newer versions of paramiko would do the chunking for us, but we want to
161
start processing results right away, so we do it ourselves.
163
# TODO: Because we issue async requests, we don't 'fudge' any extra
164
# data. I'm not 100% sure that is the best choice.
166
# The first thing we do, is to collapse the individual requests as much
167
# as possible, so we don't issues requests <32kB
168
sorted_offsets = sorted(self.original_offsets)
169
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
170
limit=0, fudge_factor=0))
172
for c_offset in coalesced:
173
start = c_offset.start
174
size = c_offset.length
176
# Break this up into 32kB requests
178
next_size = min(size, self._max_request_size)
179
requests.append((start, next_size))
182
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
183
self.relpath, len(sorted_offsets), len(coalesced),
187
def request_and_yield_offsets(self, fp):
188
"""Request the data from the remote machine, yielding the results.
190
:param fp: A Paramiko SFTPFile object that supports readv.
191
:return: Yield the data requested by the original readv caller, one by
194
requests = self._get_requests()
195
offset_iter = iter(self.original_offsets)
196
cur_offset, cur_size = offset_iter.next()
197
# paramiko .readv() yields strings that are in the order of the requests
198
# So we track the current request to know where the next data is
199
# being returned from.
205
# This is used to buffer chunks which we couldn't process yet
206
# It is (start, end, data) tuples.
208
# Create an 'unlimited' data stream, so we stop based on requests,
209
# rather than just because the data stream ended. This lets us detect
211
data_stream = itertools.chain(fp.readv(requests),
212
itertools.repeat(None))
213
for (start, length), data in itertools.izip(requests, data_stream):
215
if cur_coalesced is not None:
216
raise errors.ShortReadvError(self.relpath,
217
start, length, len(data))
218
if len(data) != length:
219
raise errors.ShortReadvError(self.relpath,
220
start, length, len(data))
222
# This is the first request, just buffer it
223
buffered_data = [data]
224
buffered_len = length
226
elif start == last_end:
227
# The data we are reading fits neatly on the previous
228
# buffer, so this is all part of a larger coalesced range.
229
buffered_data.append(data)
230
buffered_len += length
232
# We have an 'interrupt' in the data stream. So we know we are
233
# at a request boundary.
235
# We haven't consumed the buffer so far, so put it into
236
# data_chunks, and continue.
237
buffered = ''.join(buffered_data)
238
data_chunks.append((input_start, buffered))
240
buffered_data = [data]
241
buffered_len = length
242
last_end = start + length
243
if input_start == cur_offset and cur_size <= buffered_len:
244
# Simplify the next steps a bit by transforming buffered_data
245
# into a single string. We also have the nice property that
246
# when there is only one string ''.join([x]) == x, so there is
248
buffered = ''.join(buffered_data)
250
# TODO: We *could* also consider the case where cur_offset is in
251
# in the buffered range, even though it doesn't *start*
252
# the buffered range. But for packs we pretty much always
253
# read in order, so you won't get any extra data in the
255
while (input_start == cur_offset
256
and (buffered_offset + cur_size) <= buffered_len):
257
# We've buffered enough data to process this request, spit it
259
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
260
# move the direct pointer into our buffered data
261
buffered_offset += cur_size
262
# Move the start-of-buffer pointer
263
input_start += cur_size
264
# Yield the requested data
265
yield cur_offset, cur_data
266
cur_offset, cur_size = offset_iter.next()
267
# at this point, we've consumed as much of buffered as we can,
268
# so break off the portion that we consumed
269
if buffered_offset == len(buffered_data):
270
# No tail to leave behind
274
buffered = buffered[buffered_offset:]
275
buffered_data = [buffered]
276
buffered_len = len(buffered)
278
buffered = ''.join(buffered_data)
279
data_chunks.append((input_start, buffered))
281
mutter('SFTP readv left with %d out-of-order bytes',
282
sum(map(lambda x: len(x[1]), data_chunks)))
283
# We've processed all the readv data, at this point, anything we
284
# couldn't process is in data_chunks. This doesn't happen often, so
285
# this code path isn't optimized
286
# We use an interesting process for data_chunks
287
# Specifically if we have "bisect_left([(start, len, entries)],
289
# If start == qstart, then we get the specific node. Otherwise we
290
# get the previous node
292
idx = bisect.bisect_left(data_chunks, (cur_offset,))
293
if data_chunks[idx][0] == cur_offset: # The data starts here
294
data = data_chunks[idx][1][:cur_size]
296
# The data is in a portion of a previous page
298
sub_offset = cur_offset - data_chunks[idx][0]
299
data = data_chunks[idx][1]
300
data = data[sub_offset:sub_offset + cur_size]
302
# We are missing the page where the data should be found,
305
if len(data) != cur_size:
306
raise AssertionError('We must have miscalulated.'
307
' We expected %d bytes, but only found %d'
308
% (cur_size, len(data)))
309
yield cur_offset, data
310
cur_offset, cur_size = offset_iter.next()
313
class SFTPTransport(ConnectedTransport):
314
"""Transport implementation for SFTP access."""
316
_do_prefetch = _default_do_prefetch
317
# TODO: jam 20060717 Conceivably these could be configurable, either
318
# by auto-tuning at run-time, or by a configuration (per host??)
319
# but the performance curve is pretty flat, so just going with
320
# reasonable defaults.
321
_max_readv_combine = 200
322
# Having to round trip to the server means waiting for a response,
323
# so it is better to download extra bytes.
324
# 8KiB had good performance for both local and remote network operations
325
_bytes_to_read_before_seek = 8192
327
# The sftp spec says that implementations SHOULD allow reads
328
# to be at least 32K. paramiko.readv() does an async request
329
# for the chunks. So we need to keep it within a single request
330
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
331
# up the request itself, rather than us having to worry about it
332
_max_request_size = 32768
334
def __init__(self, base, _from_transport=None):
335
super(SFTPTransport, self).__init__(base,
336
_from_transport=_from_transport)
338
def _remote_path(self, relpath):
339
"""Return the path to be passed along the sftp protocol for relpath.
341
:param relpath: is a urlencoded string.
343
relative = urlutils.unescape(relpath).encode('utf-8')
344
remote_path = self._combine_paths(self._path, relative)
345
# the initial slash should be removed from the path, and treated as a
346
# homedir relative path (the path begins with a double slash if it is
347
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
348
# RBC 20060118 we are not using this as its too user hostile. instead
349
# we are following lftp and using /~/foo to mean '~/foo'
350
# vila--20070602 and leave absolute paths begin with a single slash.
351
if remote_path.startswith('/~/'):
352
remote_path = remote_path[3:]
353
elif remote_path == '/~':
357
def _create_connection(self, credentials=None):
358
"""Create a new connection with the provided credentials.
360
:param credentials: The credentials needed to establish the connection.
362
:return: The created connection and its associated credentials.
364
The credentials are only the password as it may have been entered
365
interactively by the user and may be different from the one provided
366
in base url at transport creation time.
368
if credentials is None:
369
password = self._password
371
password = credentials
373
vendor = ssh._get_ssh_vendor()
374
connection = vendor.connect_sftp(self._user, password,
375
self._host, self._port)
376
return connection, password
379
"""Ensures that a connection is established"""
380
connection = self._get_connection()
381
if connection is None:
382
# First connection ever
383
connection, credentials = self._create_connection()
384
self._set_connection(connection, credentials)
387
def has(self, relpath):
389
Does the target location exist?
392
self._get_sftp().stat(self._remote_path(relpath))
397
def get(self, relpath):
399
Get the file at the given relative path.
401
:param relpath: The relative path to the file
404
path = self._remote_path(relpath)
405
f = self._get_sftp().file(path, mode='rb')
406
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
409
except (IOError, paramiko.SSHException), e:
410
self._translate_io_exception(e, path, ': error retrieving',
411
failure_exc=errors.ReadError)
413
def _readv(self, relpath, offsets):
414
"""See Transport.readv()"""
415
# We overload the default readv() because we want to use a file
416
# that does not have prefetch enabled.
417
# Also, if we have a new paramiko, it implements an async readv()
422
path = self._remote_path(relpath)
423
fp = self._get_sftp().file(path, mode='rb')
424
readv = getattr(fp, 'readv', None)
426
return self._sftp_readv(fp, offsets, relpath)
427
mutter('seek and read %s offsets', len(offsets))
428
return self._seek_and_read(fp, offsets, relpath)
429
except (IOError, paramiko.SSHException), e:
430
self._translate_io_exception(e, path, ': error retrieving')
432
def recommended_page_size(self):
433
"""See Transport.recommended_page_size().
435
For SFTP we suggest a large page size to reduce the overhead
436
introduced by latency.
440
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
441
"""Use the readv() member of fp to do async readv.
443
And then read them using paramiko.readv(). paramiko.readv()
444
does not support ranges > 64K, so it caps the request size, and
445
just reads until it gets all the stuff it wants
447
helper = _SFTPReadvHelper(offsets, relpath)
448
return helper.request_and_yield_offsets(fp)
450
def put_file(self, relpath, f, mode=None):
452
Copy the file-like object into the location.
454
:param relpath: Location to put the contents, relative to base.
455
:param f: File-like object.
456
:param mode: The final mode for the file
458
final_path = self._remote_path(relpath)
459
return self._put(final_path, f, mode=mode)
461
def _put(self, abspath, f, mode=None):
462
"""Helper function so both put() and copy_abspaths can reuse the code"""
463
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
464
os.getpid(), random.randint(0,0x7FFFFFFF))
465
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
469
fout.set_pipelined(True)
470
length = self._pump(f, fout)
471
except (IOError, paramiko.SSHException), e:
472
self._translate_io_exception(e, tmp_abspath)
473
# XXX: This doesn't truly help like we would like it to.
474
# The problem is that openssh strips sticky bits. So while we
475
# can properly set group write permission, we lose the group
476
# sticky bit. So it is probably best to stop chmodding, and
477
# just tell users that they need to set the umask correctly.
478
# The attr.st_mode = mode, in _sftp_open_exclusive
479
# will handle when the user wants the final mode to be more
480
# restrictive. And then we avoid a round trip. Unless
481
# paramiko decides to expose an async chmod()
483
# This is designed to chmod() right before we close.
484
# Because we set_pipelined() earlier, theoretically we might
485
# avoid the round trip for fout.close()
487
self._get_sftp().chmod(tmp_abspath, mode)
490
self._rename_and_overwrite(tmp_abspath, abspath)
493
# If we fail, try to clean up the temporary file
494
# before we throw the exception
495
# but don't let another exception mess things up
496
# Write out the traceback, because otherwise
497
# the catch and throw destroys it
499
mutter(traceback.format_exc())
503
self._get_sftp().remove(tmp_abspath)
505
# raise the saved except
507
# raise the original with its traceback if we can.
510
def _put_non_atomic_helper(self, relpath, writer, mode=None,
511
create_parent_dir=False,
513
abspath = self._remote_path(relpath)
515
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
516
# set the file mode at create time. If it does, use it.
517
# But for now, we just chmod later anyway.
519
def _open_and_write_file():
520
"""Try to open the target file, raise error on failure"""
524
fout = self._get_sftp().file(abspath, mode='wb')
525
fout.set_pipelined(True)
527
except (paramiko.SSHException, IOError), e:
528
self._translate_io_exception(e, abspath,
531
# This is designed to chmod() right before we close.
532
# Because we set_pipelined() earlier, theoretically we might
533
# avoid the round trip for fout.close()
535
self._get_sftp().chmod(abspath, mode)
540
if not create_parent_dir:
541
_open_and_write_file()
544
# Try error handling to create the parent directory if we need to
546
_open_and_write_file()
548
# Try to create the parent directory, and then go back to
550
parent_dir = os.path.dirname(abspath)
551
self._mkdir(parent_dir, dir_mode)
552
_open_and_write_file()
554
def put_file_non_atomic(self, relpath, f, mode=None,
555
create_parent_dir=False,
557
"""Copy the file-like object into the target location.
559
This function is not strictly safe to use. It is only meant to
560
be used when you already know that the target does not exist.
561
It is not safe, because it will open and truncate the remote
562
file. So there may be a time when the file has invalid contents.
564
:param relpath: The remote location to put the contents.
565
:param f: File-like object.
566
:param mode: Possible access permissions for new file.
567
None means do not set remote permissions.
568
:param create_parent_dir: If we cannot create the target file because
569
the parent directory does not exist, go ahead and
570
create it, and then try again.
574
self._put_non_atomic_helper(relpath, writer, mode=mode,
575
create_parent_dir=create_parent_dir,
578
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
579
create_parent_dir=False,
583
self._put_non_atomic_helper(relpath, writer, mode=mode,
584
create_parent_dir=create_parent_dir,
587
def iter_files_recursive(self):
588
"""Walk the relative paths of all files in this transport."""
589
queue = list(self.list_dir('.'))
591
relpath = queue.pop(0)
592
st = self.stat(relpath)
593
if stat.S_ISDIR(st.st_mode):
594
for i, basename in enumerate(self.list_dir(relpath)):
595
queue.insert(i, relpath+'/'+basename)
599
def _mkdir(self, abspath, mode=None):
605
self._get_sftp().mkdir(abspath, local_mode)
607
# chmod a dir through sftp will erase any sgid bit set
608
# on the server side. So, if the bit mode are already
609
# set, avoid the chmod. If the mode is not fine but
610
# the sgid bit is set, report a warning to the user
611
# with the umask fix.
612
stat = self._get_sftp().lstat(abspath)
613
mode = mode & 0777 # can't set special bits anyway
614
if mode != stat.st_mode & 0777:
615
if stat.st_mode & 06000:
616
warning('About to chmod %s over sftp, which will result'
617
' in its suid or sgid bits being cleared. If'
618
' you want to preserve those bits, change your '
619
' environment on the server to use umask 0%03o.'
620
% (abspath, 0777 - mode))
621
self._get_sftp().chmod(abspath, mode=mode)
622
except (paramiko.SSHException, IOError), e:
623
self._translate_io_exception(e, abspath, ': unable to mkdir',
624
failure_exc=FileExists)
626
def mkdir(self, relpath, mode=None):
627
"""Create a directory at the given path."""
628
self._mkdir(self._remote_path(relpath), mode=mode)
630
def open_write_stream(self, relpath, mode=None):
631
"""See Transport.open_write_stream."""
632
# initialise the file to zero-length
633
# this is three round trips, but we don't use this
634
# api more than once per write_group at the moment so
635
# it is a tolerable overhead. Better would be to truncate
636
# the file after opening. RBC 20070805
637
self.put_bytes_non_atomic(relpath, "", mode)
638
abspath = self._remote_path(relpath)
639
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
640
# set the file mode at create time. If it does, use it.
641
# But for now, we just chmod later anyway.
644
handle = self._get_sftp().file(abspath, mode='wb')
645
handle.set_pipelined(True)
646
except (paramiko.SSHException, IOError), e:
647
self._translate_io_exception(e, abspath,
649
_file_streams[self.abspath(relpath)] = handle
650
return FileFileStream(self, relpath, handle)
652
def _translate_io_exception(self, e, path, more_info='',
653
failure_exc=PathError):
654
"""Translate a paramiko or IOError into a friendlier exception.
656
:param e: The original exception
657
:param path: The path in question when the error is raised
658
:param more_info: Extra information that can be included,
659
such as what was going on
660
:param failure_exc: Paramiko has the super fun ability to raise completely
661
opaque errors that just set "e.args = ('Failure',)" with
663
If this parameter is set, it defines the exception
664
to raise in these cases.
666
# paramiko seems to generate detailless errors.
667
self._translate_error(e, path, raise_generic=False)
668
if getattr(e, 'args', None) is not None:
669
if (e.args == ('No such file or directory',) or
670
e.args == ('No such file',)):
671
raise NoSuchFile(path, str(e) + more_info)
672
if (e.args == ('mkdir failed',) or
673
e.args[0].startswith('syserr: File exists')):
674
raise FileExists(path, str(e) + more_info)
675
# strange but true, for the paramiko server.
676
if (e.args == ('Failure',)):
677
raise failure_exc(path, str(e) + more_info)
678
mutter('Raising exception with args %s', e.args)
679
if getattr(e, 'errno', None) is not None:
680
mutter('Raising exception with errno %s', e.errno)
683
def append_file(self, relpath, f, mode=None):
685
Append the text in the file-like object into the final
689
path = self._remote_path(relpath)
690
fout = self._get_sftp().file(path, 'ab')
692
self._get_sftp().chmod(path, mode)
696
except (IOError, paramiko.SSHException), e:
697
self._translate_io_exception(e, relpath, ': unable to append')
699
def rename(self, rel_from, rel_to):
700
"""Rename without special overwriting"""
702
self._get_sftp().rename(self._remote_path(rel_from),
703
self._remote_path(rel_to))
704
except (IOError, paramiko.SSHException), e:
705
self._translate_io_exception(e, rel_from,
706
': unable to rename to %r' % (rel_to))
708
def _rename_and_overwrite(self, abs_from, abs_to):
709
"""Do a fancy rename on the remote server.
711
Using the implementation provided by osutils.
714
sftp = self._get_sftp()
715
fancy_rename(abs_from, abs_to,
716
rename_func=sftp.rename,
717
unlink_func=sftp.remove)
718
except (IOError, paramiko.SSHException), e:
719
self._translate_io_exception(e, abs_from,
720
': unable to rename to %r' % (abs_to))
722
def move(self, rel_from, rel_to):
723
"""Move the item at rel_from to the location at rel_to"""
724
path_from = self._remote_path(rel_from)
725
path_to = self._remote_path(rel_to)
726
self._rename_and_overwrite(path_from, path_to)
728
def delete(self, relpath):
729
"""Delete the item at relpath"""
730
path = self._remote_path(relpath)
732
self._get_sftp().remove(path)
733
except (IOError, paramiko.SSHException), e:
734
self._translate_io_exception(e, path, ': unable to delete')
736
def external_url(self):
737
"""See bzrlib.transport.Transport.external_url."""
738
# the external path for SFTP is the base
742
"""Return True if this store supports listing."""
745
def list_dir(self, relpath):
747
Return a list of all files at the given location.
749
# does anything actually use this?
751
# This is at least used by copy_tree for remote upgrades.
752
# -- David Allouche 2006-08-11
753
path = self._remote_path(relpath)
755
entries = self._get_sftp().listdir(path)
756
except (IOError, paramiko.SSHException), e:
757
self._translate_io_exception(e, path, ': failed to list_dir')
758
return [urlutils.escape(entry) for entry in entries]
760
def rmdir(self, relpath):
761
"""See Transport.rmdir."""
762
path = self._remote_path(relpath)
764
return self._get_sftp().rmdir(path)
765
except (IOError, paramiko.SSHException), e:
766
self._translate_io_exception(e, path, ': failed to rmdir')
768
def stat(self, relpath):
769
"""Return the stat information for a file."""
770
path = self._remote_path(relpath)
772
return self._get_sftp().stat(path)
773
except (IOError, paramiko.SSHException), e:
774
self._translate_io_exception(e, path, ': unable to stat')
776
def lock_read(self, relpath):
778
Lock the given file for shared (read) access.
779
:return: A lock object, which has an unlock() member function
781
# FIXME: there should be something clever i can do here...
782
class BogusLock(object):
783
def __init__(self, path):
787
return BogusLock(relpath)
789
def lock_write(self, relpath):
791
Lock the given file for exclusive (write) access.
792
WARNING: many transports do not support this, so trying avoid using it
794
:return: A lock object, which has an unlock() member function
796
# This is a little bit bogus, but basically, we create a file
797
# which should not already exist, and if it does, we assume
798
# that there is a lock, and if it doesn't, the we assume
799
# that we have taken the lock.
800
return SFTPLock(relpath, self)
802
def _sftp_open_exclusive(self, abspath, mode=None):
803
"""Open a remote path exclusively.
805
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
806
the file already exists. However it does not expose this
807
at the higher level of SFTPClient.open(), so we have to
810
WARNING: This breaks the SFTPClient abstraction, so it
811
could easily break against an updated version of paramiko.
813
:param abspath: The remote absolute path where the file should be opened
814
:param mode: The mode permissions bits for the new file
816
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
817
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
818
# However, there is no way to set the permission mode at open
819
# time using the sftp_client.file() functionality.
820
path = self._get_sftp()._adjust_cwd(abspath)
821
# mutter('sftp abspath %s => %s', abspath, path)
822
attr = SFTPAttributes()
825
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
826
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
828
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
830
raise TransportError('Expected an SFTP handle')
831
handle = msg.get_string()
832
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
833
except (paramiko.SSHException, IOError), e:
834
self._translate_io_exception(e, abspath, ': unable to open',
835
failure_exc=FileExists)
837
def _can_roundtrip_unix_modebits(self):
838
if sys.platform == 'win32':
844
# ------------- server test implementation --------------
847
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
849
STUB_SERVER_KEY = """
850
-----BEGIN RSA PRIVATE KEY-----
851
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
852
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
853
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
854
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
855
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
856
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
857
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
858
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
859
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
860
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
861
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
862
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
863
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
864
-----END RSA PRIVATE KEY-----
868
class SocketListener(threading.Thread):
870
def __init__(self, callback):
871
threading.Thread.__init__(self)
872
self._callback = callback
873
self._socket = socket.socket()
874
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
875
self._socket.bind(('localhost', 0))
876
self._socket.listen(1)
877
self.port = self._socket.getsockname()[1]
878
self._stop_event = threading.Event()
881
# called from outside this thread
882
self._stop_event.set()
883
# use a timeout here, because if the test fails, the server thread may
884
# never notice the stop_event.
890
readable, writable_unused, exception_unused = \
891
select.select([self._socket], [], [], 0.1)
892
if self._stop_event.isSet():
894
if len(readable) == 0:
897
s, addr_unused = self._socket.accept()
898
# because the loopback socket is inline, and transports are
899
# never explicitly closed, best to launch a new thread.
900
threading.Thread(target=self._callback, args=(s,)).start()
901
except socket.error, x:
902
sys.excepthook(*sys.exc_info())
903
warning('Socket error during accept() within unit test server'
906
# probably a failed test; unit test thread will log the
908
sys.excepthook(*sys.exc_info())
909
warning('Exception from within unit test server thread: %r' %
913
class SocketDelay(object):
914
"""A socket decorator to make TCP appear slower.
916
This changes recv, send, and sendall to add a fixed latency to each python
917
call if a new roundtrip is detected. That is, when a recv is called and the
918
flag new_roundtrip is set, latency is charged. Every send and send_all
921
In addition every send, sendall and recv sleeps a bit per character send to
924
Not all methods are implemented, this is deliberate as this class is not a
925
replacement for the builtin sockets layer. fileno is not implemented to
926
prevent the proxy being bypassed.
930
_proxied_arguments = dict.fromkeys([
931
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
932
"setblocking", "setsockopt", "settimeout", "shutdown"])
934
def __init__(self, sock, latency, bandwidth=1.0,
937
:param bandwith: simulated bandwith (MegaBit)
938
:param really_sleep: If set to false, the SocketDelay will just
939
increase a counter, instead of calling time.sleep. This is useful for
940
unittesting the SocketDelay.
943
self.latency = latency
944
self.really_sleep = really_sleep
945
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
946
self.new_roundtrip = False
949
if self.really_sleep:
952
SocketDelay.simulated_time += s
954
def __getattr__(self, attr):
955
if attr in SocketDelay._proxied_arguments:
956
return getattr(self.sock, attr)
957
raise AttributeError("'SocketDelay' object has no attribute %r" %
961
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
964
def recv(self, *args):
965
data = self.sock.recv(*args)
966
if data and self.new_roundtrip:
967
self.new_roundtrip = False
968
self.sleep(self.latency)
969
self.sleep(len(data) * self.time_per_byte)
972
def sendall(self, data, flags=0):
973
if not self.new_roundtrip:
974
self.new_roundtrip = True
975
self.sleep(self.latency)
976
self.sleep(len(data) * self.time_per_byte)
977
return self.sock.sendall(data, flags)
979
def send(self, data, flags=0):
980
if not self.new_roundtrip:
981
self.new_roundtrip = True
982
self.sleep(self.latency)
983
bytes_sent = self.sock.send(data, flags)
984
self.sleep(bytes_sent * self.time_per_byte)
988
class SFTPServer(Server):
989
"""Common code for SFTP server facilities."""
991
def __init__(self, server_interface=StubServer):
992
self._original_vendor = None
994
self._server_homedir = None
995
self._listener = None
997
self._vendor = ssh.ParamikoVendor()
998
self._server_interface = server_interface
1001
self.add_latency = 0
1003
def _get_sftp_url(self, path):
1004
"""Calculate an sftp url to this server for path."""
1005
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1007
def log(self, message):
1008
"""StubServer uses this to log when a new server is created."""
1009
self.logs.append(message)
1011
def _run_server_entry(self, sock):
1012
"""Entry point for all implementations of _run_server.
1014
If self.add_latency is > 0.000001 then sock is given a latency adding
1017
if self.add_latency > 0.000001:
1018
sock = SocketDelay(sock, self.add_latency)
1019
return self._run_server(sock)
1021
def _run_server(self, s):
1022
ssh_server = paramiko.Transport(s)
1023
key_file = pathjoin(self._homedir, 'test_rsa.key')
1024
f = open(key_file, 'w')
1025
f.write(STUB_SERVER_KEY)
1027
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1028
ssh_server.add_server_key(host_key)
1029
server = self._server_interface(self)
1030
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1031
StubSFTPServer, root=self._root,
1032
home=self._server_homedir)
1033
event = threading.Event()
1034
ssh_server.start_server(event, server)
1037
def setUp(self, backing_server=None):
1038
# XXX: TODO: make sftpserver back onto backing_server rather than local
1040
if not (backing_server is None or
1041
isinstance(backing_server, local.LocalURLServer)):
1042
raise AssertionError(
1043
"backing_server should not be %r, because this can only serve the "
1044
"local current working directory." % (backing_server,))
1045
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1046
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1047
if sys.platform == 'win32':
1048
# Win32 needs to use the UNICODE api
1049
self._homedir = getcwd()
1051
# But Linux SFTP servers should just deal in bytestreams
1052
self._homedir = os.getcwd()
1053
if self._server_homedir is None:
1054
self._server_homedir = self._homedir
1056
if sys.platform == 'win32':
1058
self._listener = SocketListener(self._run_server_entry)
1059
self._listener.setDaemon(True)
1060
self._listener.start()
1063
"""See bzrlib.transport.Server.tearDown."""
1064
self._listener.stop()
1065
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1067
def get_bogus_url(self):
1068
"""See bzrlib.transport.Server.get_bogus_url."""
1069
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1070
# we bind a random socket, so that we get a guaranteed unused port
1071
# we just never listen on that port
1073
s.bind(('localhost', 0))
1074
return 'sftp://%s:%s/' % s.getsockname()
1077
class SFTPFullAbsoluteServer(SFTPServer):
1078
"""A test server for sftp transports, using absolute urls and ssh."""
1081
"""See bzrlib.transport.Server.get_url."""
1082
homedir = self._homedir
1083
if sys.platform != 'win32':
1084
# Remove the initial '/' on all platforms but win32
1085
homedir = homedir[1:]
1086
return self._get_sftp_url(urlutils.escape(homedir))
1089
class SFTPServerWithoutSSH(SFTPServer):
1090
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1093
super(SFTPServerWithoutSSH, self).__init__()
1094
self._vendor = ssh.LoopbackVendor()
1096
def _run_server(self, sock):
1097
# Re-import these as locals, so that they're still accessible during
1098
# interpreter shutdown (when all module globals get set to None, leading
1099
# to confusing errors like "'NoneType' object has no attribute 'error'".
1100
class FakeChannel(object):
1101
def get_transport(self):
1103
def get_log_channel(self):
1107
def get_hexdump(self):
1112
server = paramiko.SFTPServer(
1113
FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1114
root=self._root, home=self._server_homedir)
1116
server.start_subsystem(
1117
'sftp', None, ssh.SocketAsChannelAdapter(sock))
1118
except socket.error, e:
1119
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1120
# it's okay for the client to disconnect abruptly
1121
# (bug in paramiko 1.6: it should absorb this exception)
1125
except Exception, e:
1126
# This typically seems to happen during interpreter shutdown, so
1127
# most of the useful ways to report this error are won't work.
1128
# Writing the exception type, and then the text of the exception,
1129
# seems to be the best we can do.
1131
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1132
sys.stderr.write('%s\n\n' % (e,))
1133
server.finish_subsystem()
1136
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1137
"""A test server for sftp transports, using absolute urls."""
1140
"""See bzrlib.transport.Server.get_url."""
1141
homedir = self._homedir
1142
if sys.platform != 'win32':
1143
# Remove the initial '/' on all platforms but win32
1144
homedir = homedir[1:]
1145
return self._get_sftp_url(urlutils.escape(homedir))
1148
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1149
"""A test server for sftp transports, using homedir relative urls."""
1152
"""See bzrlib.transport.Server.get_url."""
1153
return self._get_sftp_url("~/")
1156
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1157
"""A test server for sftp transports where only absolute paths will work.
1159
It does this by serving from a deeply-nested directory that doesn't exist.
1162
def setUp(self, backing_server=None):
1163
self._server_homedir = '/dev/noone/runs/tests/here'
1164
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1167
def get_test_permutations():
1168
"""Return the permutations to be used in testing."""
1169
return [(SFTPTransport, SFTPAbsoluteServer),
1170
(SFTPTransport, SFTPHomeDirServer),
1171
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
