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.
42
from bzrlib.errors import (FileExists,
43
NoSuchFile, PathNotChild,
49
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
50
from bzrlib.symbol_versioning import (
54
from bzrlib.trace import mutter, warning
55
from bzrlib.transport import (
57
register_urlparse_netloc_protocol,
65
except ImportError, e:
66
raise ParamikoNotPresent(e)
68
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
69
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
71
from paramiko.sftp_attr import SFTPAttributes
72
from paramiko.sftp_file import SFTPFile
75
register_urlparse_netloc_protocol('sftp')
78
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
79
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
80
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
83
@deprecated_function(zero_ninety)
84
def clear_connection_cache():
85
"""Remove all hosts from the SFTP connection cache.
87
Primarily useful for test cases wanting to force garbage collection.
88
We don't have a global connection cache anymore.
91
class SFTPLock(object):
92
"""This fakes a lock in a remote location.
94
A present lock is indicated just by the existence of a file. This
95
doesn't work well on all transports and they are only used in
96
deprecated storage formats.
99
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
101
def __init__(self, path, transport):
102
assert isinstance(transport, SFTPTransport)
104
self.lock_file = None
106
self.lock_path = path + '.write-lock'
107
self.transport = transport
109
# RBC 20060103 FIXME should we be using private methods here ?
110
abspath = transport._remote_path(self.lock_path)
111
self.lock_file = transport._sftp_open_exclusive(abspath)
113
raise LockError('File %r already locked' % (self.path,))
116
"""Should this warn, or actually try to cleanup?"""
118
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
122
if not self.lock_file:
124
self.lock_file.close()
125
self.lock_file = None
127
self.transport.delete(self.lock_path)
128
except (NoSuchFile,):
129
# What specific errors should we catch here?
133
class SFTPTransport(ConnectedTransport):
134
"""Transport implementation for SFTP access."""
136
_do_prefetch = _default_do_prefetch
137
# TODO: jam 20060717 Conceivably these could be configurable, either
138
# by auto-tuning at run-time, or by a configuration (per host??)
139
# but the performance curve is pretty flat, so just going with
140
# reasonable defaults.
141
_max_readv_combine = 200
142
# Having to round trip to the server means waiting for a response,
143
# so it is better to download extra bytes.
144
# 8KiB had good performance for both local and remote network operations
145
_bytes_to_read_before_seek = 8192
147
# The sftp spec says that implementations SHOULD allow reads
148
# to be at least 32K. paramiko.readv() does an async request
149
# for the chunks. So we need to keep it within a single request
150
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
151
# up the request itself, rather than us having to worry about it
152
_max_request_size = 32768
154
def __init__(self, base, _from_transport=None):
155
assert base.startswith('sftp://')
156
super(SFTPTransport, self).__init__(base,
157
_from_transport=_from_transport)
159
def _remote_path(self, relpath):
160
"""Return the path to be passed along the sftp protocol for relpath.
162
:param relpath: is a urlencoded string.
164
relative = urlutils.unescape(relpath).encode('utf-8')
165
remote_path = self._combine_paths(self._path, relative)
166
# the initial slash should be removed from the path, and treated as a
167
# homedir relative path (the path begins with a double slash if it is
168
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
169
# RBC 20060118 we are not using this as its too user hostile. instead
170
# we are following lftp and using /~/foo to mean '~/foo'
171
# vila--20070602 and leave absolute paths begin with a single slash.
172
if remote_path.startswith('/~/'):
173
remote_path = remote_path[3:]
174
elif remote_path == '/~':
178
def _create_connection(self, credentials=None):
179
"""Create a new connection with the provided credentials.
181
:param credentials: The credentials needed to establish the connection.
183
:return: The created connection and its associated credentials.
185
The credentials are only the password as it may have been entered
186
interactively by the user and may be different from the one provided
187
in base url at transport creation time.
189
if credentials is None:
190
password = self._password
192
password = credentials
194
vendor = ssh._get_ssh_vendor()
195
connection = vendor.connect_sftp(self._user, password,
196
self._host, self._port)
197
return connection, password
200
"""Ensures that a connection is established"""
201
connection = self._get_connection()
202
if connection is None:
203
# First connection ever
204
connection, credentials = self._create_connection()
205
self._set_connection(connection, credentials)
209
def should_cache(self):
211
Return True if the data pulled across should be cached locally.
215
def has(self, relpath):
217
Does the target location exist?
220
self._get_sftp().stat(self._remote_path(relpath))
225
def get(self, relpath):
227
Get the file at the given relative path.
229
:param relpath: The relative path to the file
232
path = self._remote_path(relpath)
233
f = self._get_sftp().file(path, mode='rb')
234
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
237
except (IOError, paramiko.SSHException), e:
238
self._translate_io_exception(e, path, ': error retrieving',
239
failure_exc=errors.ReadError)
241
def readv(self, relpath, offsets):
242
"""See Transport.readv()"""
243
# We overload the default readv() because we want to use a file
244
# that does not have prefetch enabled.
245
# Also, if we have a new paramiko, it implements an async readv()
250
path = self._remote_path(relpath)
251
fp = self._get_sftp().file(path, mode='rb')
252
readv = getattr(fp, 'readv', None)
254
return self._sftp_readv(fp, offsets, relpath)
255
mutter('seek and read %s offsets', len(offsets))
256
return self._seek_and_read(fp, offsets, relpath)
257
except (IOError, paramiko.SSHException), e:
258
self._translate_io_exception(e, path, ': error retrieving')
260
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
261
"""Use the readv() member of fp to do async readv.
263
And then read them using paramiko.readv(). paramiko.readv()
264
does not support ranges > 64K, so it caps the request size, and
265
just reads until it gets all the stuff it wants
267
offsets = list(offsets)
268
sorted_offsets = sorted(offsets)
270
# The algorithm works as follows:
271
# 1) Coalesce nearby reads into a single chunk
272
# This generates a list of combined regions, the total size
273
# and the size of the sub regions. This coalescing step is limited
274
# in the number of nearby chunks to combine, and is allowed to
275
# skip small breaks in the requests. Limiting it makes sure that
276
# we can start yielding some data earlier, and skipping means we
277
# make fewer requests. (Beneficial even when using async)
278
# 2) Break up this combined regions into chunks that are smaller
279
# than 64KiB. Technically the limit is 65536, but we are a
280
# little bit conservative. This is because sftp has a maximum
281
# return chunk size of 64KiB (max size of an unsigned short)
282
# 3) Issue a readv() to paramiko to create an async request for
284
# 4) Read in the data as it comes back, until we've read one
285
# continuous section as determined in step 1
286
# 5) Break up the full sections into hunks for the original requested
287
# offsets. And put them in a cache
288
# 6) Check if the next request is in the cache, and if it is, remove
289
# it from the cache, and yield its data. Continue until no more
290
# entries are in the cache.
291
# 7) loop back to step 4 until all data has been read
293
# TODO: jam 20060725 This could be optimized one step further, by
294
# attempting to yield whatever data we have read, even before
295
# the first coallesced section has been fully processed.
297
# When coalescing for use with readv(), we don't really need to
298
# use any fudge factor, because the requests are made asynchronously
299
coalesced = list(self._coalesce_offsets(sorted_offsets,
300
limit=self._max_readv_combine,
304
for c_offset in coalesced:
305
start = c_offset.start
306
size = c_offset.length
308
# We need to break this up into multiple requests
310
next_size = min(size, self._max_request_size)
311
requests.append((start, next_size))
315
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
316
len(offsets), len(coalesced), len(requests))
318
# Queue the current read until we have read the full coalesced section
321
cur_coalesced_stack = iter(coalesced)
322
cur_coalesced = cur_coalesced_stack.next()
324
# Cache the results, but only until they have been fulfilled
326
# turn the list of offsets into a stack
327
offset_stack = iter(offsets)
328
cur_offset_and_size = offset_stack.next()
330
for data in fp.readv(requests):
332
cur_data_len += len(data)
334
if cur_data_len < cur_coalesced.length:
336
assert cur_data_len == cur_coalesced.length, \
337
"Somehow we read too much: %s != %s" % (cur_data_len,
338
cur_coalesced.length)
339
all_data = ''.join(cur_data)
343
for suboffset, subsize in cur_coalesced.ranges:
344
key = (cur_coalesced.start+suboffset, subsize)
345
data_map[key] = all_data[suboffset:suboffset+subsize]
347
# Now that we've read some data, see if we can yield anything back
348
while cur_offset_and_size in data_map:
349
this_data = data_map.pop(cur_offset_and_size)
350
yield cur_offset_and_size[0], this_data
351
cur_offset_and_size = offset_stack.next()
353
# We read a coalesced entry, so mark it as done
355
# Now that we've read all of the data for this coalesced section
357
cur_coalesced = cur_coalesced_stack.next()
359
if cur_coalesced is not None:
360
raise errors.ShortReadvError(relpath, cur_coalesced.start,
361
cur_coalesced.length, len(data))
363
def put_file(self, relpath, f, mode=None):
365
Copy the file-like object into the location.
367
:param relpath: Location to put the contents, relative to base.
368
:param f: File-like object.
369
:param mode: The final mode for the file
371
final_path = self._remote_path(relpath)
372
self._put(final_path, f, mode=mode)
374
def _put(self, abspath, f, mode=None):
375
"""Helper function so both put() and copy_abspaths can reuse the code"""
376
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
377
os.getpid(), random.randint(0,0x7FFFFFFF))
378
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
382
fout.set_pipelined(True)
384
except (IOError, paramiko.SSHException), e:
385
self._translate_io_exception(e, tmp_abspath)
386
# XXX: This doesn't truly help like we would like it to.
387
# The problem is that openssh strips sticky bits. So while we
388
# can properly set group write permission, we lose the group
389
# sticky bit. So it is probably best to stop chmodding, and
390
# just tell users that they need to set the umask correctly.
391
# The attr.st_mode = mode, in _sftp_open_exclusive
392
# will handle when the user wants the final mode to be more
393
# restrictive. And then we avoid a round trip. Unless
394
# paramiko decides to expose an async chmod()
396
# This is designed to chmod() right before we close.
397
# Because we set_pipelined() earlier, theoretically we might
398
# avoid the round trip for fout.close()
400
self._get_sftp().chmod(tmp_abspath, mode)
403
self._rename_and_overwrite(tmp_abspath, abspath)
405
# If we fail, try to clean up the temporary file
406
# before we throw the exception
407
# but don't let another exception mess things up
408
# Write out the traceback, because otherwise
409
# the catch and throw destroys it
411
mutter(traceback.format_exc())
415
self._get_sftp().remove(tmp_abspath)
417
# raise the saved except
419
# raise the original with its traceback if we can.
422
def _put_non_atomic_helper(self, relpath, writer, mode=None,
423
create_parent_dir=False,
425
abspath = self._remote_path(relpath)
427
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
428
# set the file mode at create time. If it does, use it.
429
# But for now, we just chmod later anyway.
431
def _open_and_write_file():
432
"""Try to open the target file, raise error on failure"""
436
fout = self._get_sftp().file(abspath, mode='wb')
437
fout.set_pipelined(True)
439
except (paramiko.SSHException, IOError), e:
440
self._translate_io_exception(e, abspath,
443
# This is designed to chmod() right before we close.
444
# Because we set_pipelined() earlier, theoretically we might
445
# avoid the round trip for fout.close()
447
self._get_sftp().chmod(abspath, mode)
452
if not create_parent_dir:
453
_open_and_write_file()
456
# Try error handling to create the parent directory if we need to
458
_open_and_write_file()
460
# Try to create the parent directory, and then go back to
462
parent_dir = os.path.dirname(abspath)
463
self._mkdir(parent_dir, dir_mode)
464
_open_and_write_file()
466
def put_file_non_atomic(self, relpath, f, mode=None,
467
create_parent_dir=False,
469
"""Copy the file-like object into the target location.
471
This function is not strictly safe to use. It is only meant to
472
be used when you already know that the target does not exist.
473
It is not safe, because it will open and truncate the remote
474
file. So there may be a time when the file has invalid contents.
476
:param relpath: The remote location to put the contents.
477
:param f: File-like object.
478
:param mode: Possible access permissions for new file.
479
None means do not set remote permissions.
480
:param create_parent_dir: If we cannot create the target file because
481
the parent directory does not exist, go ahead and
482
create it, and then try again.
486
self._put_non_atomic_helper(relpath, writer, mode=mode,
487
create_parent_dir=create_parent_dir,
490
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
491
create_parent_dir=False,
495
self._put_non_atomic_helper(relpath, writer, mode=mode,
496
create_parent_dir=create_parent_dir,
499
def iter_files_recursive(self):
500
"""Walk the relative paths of all files in this transport."""
501
queue = list(self.list_dir('.'))
503
relpath = queue.pop(0)
504
st = self.stat(relpath)
505
if stat.S_ISDIR(st.st_mode):
506
for i, basename in enumerate(self.list_dir(relpath)):
507
queue.insert(i, relpath+'/'+basename)
511
def _mkdir(self, abspath, mode=None):
517
self._get_sftp().mkdir(abspath, local_mode)
519
self._get_sftp().chmod(abspath, mode=mode)
520
except (paramiko.SSHException, IOError), e:
521
self._translate_io_exception(e, abspath, ': unable to mkdir',
522
failure_exc=FileExists)
524
def mkdir(self, relpath, mode=None):
525
"""Create a directory at the given path."""
526
self._mkdir(self._remote_path(relpath), mode=mode)
528
def _translate_io_exception(self, e, path, more_info='',
529
failure_exc=PathError):
530
"""Translate a paramiko or IOError into a friendlier exception.
532
:param e: The original exception
533
:param path: The path in question when the error is raised
534
:param more_info: Extra information that can be included,
535
such as what was going on
536
:param failure_exc: Paramiko has the super fun ability to raise completely
537
opaque errors that just set "e.args = ('Failure',)" with
539
If this parameter is set, it defines the exception
540
to raise in these cases.
542
# paramiko seems to generate detailless errors.
543
self._translate_error(e, path, raise_generic=False)
544
if getattr(e, 'args', None) is not None:
545
if (e.args == ('No such file or directory',) or
546
e.args == ('No such file',)):
547
raise NoSuchFile(path, str(e) + more_info)
548
if (e.args == ('mkdir failed',)):
549
raise FileExists(path, str(e) + more_info)
550
# strange but true, for the paramiko server.
551
if (e.args == ('Failure',)):
552
raise failure_exc(path, str(e) + more_info)
553
mutter('Raising exception with args %s', e.args)
554
if getattr(e, 'errno', None) is not None:
555
mutter('Raising exception with errno %s', e.errno)
558
def append_file(self, relpath, f, mode=None):
560
Append the text in the file-like object into the final
564
path = self._remote_path(relpath)
565
fout = self._get_sftp().file(path, 'ab')
567
self._get_sftp().chmod(path, mode)
571
except (IOError, paramiko.SSHException), e:
572
self._translate_io_exception(e, relpath, ': unable to append')
574
def rename(self, rel_from, rel_to):
575
"""Rename without special overwriting"""
577
self._get_sftp().rename(self._remote_path(rel_from),
578
self._remote_path(rel_to))
579
except (IOError, paramiko.SSHException), e:
580
self._translate_io_exception(e, rel_from,
581
': unable to rename to %r' % (rel_to))
583
def _rename_and_overwrite(self, abs_from, abs_to):
584
"""Do a fancy rename on the remote server.
586
Using the implementation provided by osutils.
589
sftp = self._get_sftp()
590
fancy_rename(abs_from, abs_to,
591
rename_func=sftp.rename,
592
unlink_func=sftp.remove)
593
except (IOError, paramiko.SSHException), e:
594
self._translate_io_exception(e, abs_from,
595
': unable to rename to %r' % (abs_to))
597
def move(self, rel_from, rel_to):
598
"""Move the item at rel_from to the location at rel_to"""
599
path_from = self._remote_path(rel_from)
600
path_to = self._remote_path(rel_to)
601
self._rename_and_overwrite(path_from, path_to)
603
def delete(self, relpath):
604
"""Delete the item at relpath"""
605
path = self._remote_path(relpath)
607
self._get_sftp().remove(path)
608
except (IOError, paramiko.SSHException), e:
609
self._translate_io_exception(e, path, ': unable to delete')
611
def external_url(self):
612
"""See bzrlib.transport.Transport.external_url."""
613
# the external path for SFTP is the base
617
"""Return True if this store supports listing."""
620
def list_dir(self, relpath):
622
Return a list of all files at the given location.
624
# does anything actually use this?
626
# This is at least used by copy_tree for remote upgrades.
627
# -- David Allouche 2006-08-11
628
path = self._remote_path(relpath)
630
entries = self._get_sftp().listdir(path)
631
except (IOError, paramiko.SSHException), e:
632
self._translate_io_exception(e, path, ': failed to list_dir')
633
return [urlutils.escape(entry) for entry in entries]
635
def rmdir(self, relpath):
636
"""See Transport.rmdir."""
637
path = self._remote_path(relpath)
639
return self._get_sftp().rmdir(path)
640
except (IOError, paramiko.SSHException), e:
641
self._translate_io_exception(e, path, ': failed to rmdir')
643
def stat(self, relpath):
644
"""Return the stat information for a file."""
645
path = self._remote_path(relpath)
647
return self._get_sftp().stat(path)
648
except (IOError, paramiko.SSHException), e:
649
self._translate_io_exception(e, path, ': unable to stat')
651
def lock_read(self, relpath):
653
Lock the given file for shared (read) access.
654
:return: A lock object, which has an unlock() member function
656
# FIXME: there should be something clever i can do here...
657
class BogusLock(object):
658
def __init__(self, path):
662
return BogusLock(relpath)
664
def lock_write(self, relpath):
666
Lock the given file for exclusive (write) access.
667
WARNING: many transports do not support this, so trying avoid using it
669
:return: A lock object, which has an unlock() member function
671
# This is a little bit bogus, but basically, we create a file
672
# which should not already exist, and if it does, we assume
673
# that there is a lock, and if it doesn't, the we assume
674
# that we have taken the lock.
675
return SFTPLock(relpath, self)
677
def _sftp_open_exclusive(self, abspath, mode=None):
678
"""Open a remote path exclusively.
680
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
681
the file already exists. However it does not expose this
682
at the higher level of SFTPClient.open(), so we have to
685
WARNING: This breaks the SFTPClient abstraction, so it
686
could easily break against an updated version of paramiko.
688
:param abspath: The remote absolute path where the file should be opened
689
:param mode: The mode permissions bits for the new file
691
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
692
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
693
# However, there is no way to set the permission mode at open
694
# time using the sftp_client.file() functionality.
695
path = self._get_sftp()._adjust_cwd(abspath)
696
# mutter('sftp abspath %s => %s', abspath, path)
697
attr = SFTPAttributes()
700
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
701
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
703
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
705
raise TransportError('Expected an SFTP handle')
706
handle = msg.get_string()
707
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
708
except (paramiko.SSHException, IOError), e:
709
self._translate_io_exception(e, abspath, ': unable to open',
710
failure_exc=FileExists)
712
def _can_roundtrip_unix_modebits(self):
713
if sys.platform == 'win32':
719
# ------------- server test implementation --------------
722
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
724
STUB_SERVER_KEY = """
725
-----BEGIN RSA PRIVATE KEY-----
726
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
727
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
728
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
729
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
730
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
731
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
732
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
733
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
734
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
735
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
736
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
737
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
738
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
739
-----END RSA PRIVATE KEY-----
743
class SocketListener(threading.Thread):
745
def __init__(self, callback):
746
threading.Thread.__init__(self)
747
self._callback = callback
748
self._socket = socket.socket()
749
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
750
self._socket.bind(('localhost', 0))
751
self._socket.listen(1)
752
self.port = self._socket.getsockname()[1]
753
self._stop_event = threading.Event()
756
# called from outside this thread
757
self._stop_event.set()
758
# use a timeout here, because if the test fails, the server thread may
759
# never notice the stop_event.
765
readable, writable_unused, exception_unused = \
766
select.select([self._socket], [], [], 0.1)
767
if self._stop_event.isSet():
769
if len(readable) == 0:
772
s, addr_unused = self._socket.accept()
773
# because the loopback socket is inline, and transports are
774
# never explicitly closed, best to launch a new thread.
775
threading.Thread(target=self._callback, args=(s,)).start()
776
except socket.error, x:
777
sys.excepthook(*sys.exc_info())
778
warning('Socket error during accept() within unit test server'
781
# probably a failed test; unit test thread will log the
783
sys.excepthook(*sys.exc_info())
784
warning('Exception from within unit test server thread: %r' %
788
class SocketDelay(object):
789
"""A socket decorator to make TCP appear slower.
791
This changes recv, send, and sendall to add a fixed latency to each python
792
call if a new roundtrip is detected. That is, when a recv is called and the
793
flag new_roundtrip is set, latency is charged. Every send and send_all
796
In addition every send, sendall and recv sleeps a bit per character send to
799
Not all methods are implemented, this is deliberate as this class is not a
800
replacement for the builtin sockets layer. fileno is not implemented to
801
prevent the proxy being bypassed.
805
_proxied_arguments = dict.fromkeys([
806
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
807
"setblocking", "setsockopt", "settimeout", "shutdown"])
809
def __init__(self, sock, latency, bandwidth=1.0,
812
:param bandwith: simulated bandwith (MegaBit)
813
:param really_sleep: If set to false, the SocketDelay will just
814
increase a counter, instead of calling time.sleep. This is useful for
815
unittesting the SocketDelay.
818
self.latency = latency
819
self.really_sleep = really_sleep
820
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
821
self.new_roundtrip = False
824
if self.really_sleep:
827
SocketDelay.simulated_time += s
829
def __getattr__(self, attr):
830
if attr in SocketDelay._proxied_arguments:
831
return getattr(self.sock, attr)
832
raise AttributeError("'SocketDelay' object has no attribute %r" %
836
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
839
def recv(self, *args):
840
data = self.sock.recv(*args)
841
if data and self.new_roundtrip:
842
self.new_roundtrip = False
843
self.sleep(self.latency)
844
self.sleep(len(data) * self.time_per_byte)
847
def sendall(self, data, flags=0):
848
if not self.new_roundtrip:
849
self.new_roundtrip = True
850
self.sleep(self.latency)
851
self.sleep(len(data) * self.time_per_byte)
852
return self.sock.sendall(data, flags)
854
def send(self, data, flags=0):
855
if not self.new_roundtrip:
856
self.new_roundtrip = True
857
self.sleep(self.latency)
858
bytes_sent = self.sock.send(data, flags)
859
self.sleep(bytes_sent * self.time_per_byte)
863
class SFTPServer(Server):
864
"""Common code for SFTP server facilities."""
866
def __init__(self, server_interface=StubServer):
867
self._original_vendor = None
869
self._server_homedir = None
870
self._listener = None
872
self._vendor = ssh.ParamikoVendor()
873
self._server_interface = server_interface
878
def _get_sftp_url(self, path):
879
"""Calculate an sftp url to this server for path."""
880
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
882
def log(self, message):
883
"""StubServer uses this to log when a new server is created."""
884
self.logs.append(message)
886
def _run_server_entry(self, sock):
887
"""Entry point for all implementations of _run_server.
889
If self.add_latency is > 0.000001 then sock is given a latency adding
892
if self.add_latency > 0.000001:
893
sock = SocketDelay(sock, self.add_latency)
894
return self._run_server(sock)
896
def _run_server(self, s):
897
ssh_server = paramiko.Transport(s)
898
key_file = pathjoin(self._homedir, 'test_rsa.key')
899
f = open(key_file, 'w')
900
f.write(STUB_SERVER_KEY)
902
host_key = paramiko.RSAKey.from_private_key_file(key_file)
903
ssh_server.add_server_key(host_key)
904
server = self._server_interface(self)
905
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
906
StubSFTPServer, root=self._root,
907
home=self._server_homedir)
908
event = threading.Event()
909
ssh_server.start_server(event, server)
912
def setUp(self, backing_server=None):
913
# XXX: TODO: make sftpserver back onto backing_server rather than local
915
assert (backing_server is None or
916
isinstance(backing_server, local.LocalURLServer)), (
917
"backing_server should not be %r, because this can only serve the "
918
"local current working directory." % (backing_server,))
919
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
920
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
921
if sys.platform == 'win32':
922
# Win32 needs to use the UNICODE api
923
self._homedir = getcwd()
925
# But Linux SFTP servers should just deal in bytestreams
926
self._homedir = os.getcwd()
927
if self._server_homedir is None:
928
self._server_homedir = self._homedir
930
if sys.platform == 'win32':
932
self._listener = SocketListener(self._run_server_entry)
933
self._listener.setDaemon(True)
934
self._listener.start()
937
"""See bzrlib.transport.Server.tearDown."""
938
self._listener.stop()
939
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
941
def get_bogus_url(self):
942
"""See bzrlib.transport.Server.get_bogus_url."""
943
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
944
# we bind a random socket, so that we get a guaranteed unused port
945
# we just never listen on that port
947
s.bind(('localhost', 0))
948
return 'sftp://%s:%s/' % s.getsockname()
951
class SFTPFullAbsoluteServer(SFTPServer):
952
"""A test server for sftp transports, using absolute urls and ssh."""
955
"""See bzrlib.transport.Server.get_url."""
956
homedir = self._homedir
957
if sys.platform != 'win32':
958
# Remove the initial '/' on all platforms but win32
959
homedir = homedir[1:]
960
return self._get_sftp_url(urlutils.escape(homedir))
963
class SFTPServerWithoutSSH(SFTPServer):
964
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
967
super(SFTPServerWithoutSSH, self).__init__()
968
self._vendor = ssh.LoopbackVendor()
970
def _run_server(self, sock):
971
# Re-import these as locals, so that they're still accessible during
972
# interpreter shutdown (when all module globals get set to None, leading
973
# to confusing errors like "'NoneType' object has no attribute 'error'".
974
class FakeChannel(object):
975
def get_transport(self):
977
def get_log_channel(self):
981
def get_hexdump(self):
986
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
987
root=self._root, home=self._server_homedir)
989
server.start_subsystem('sftp', None, sock)
990
except socket.error, e:
991
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
992
# it's okay for the client to disconnect abruptly
993
# (bug in paramiko 1.6: it should absorb this exception)
998
# This typically seems to happen during interpreter shutdown, so
999
# most of the useful ways to report this error are won't work.
1000
# Writing the exception type, and then the text of the exception,
1001
# seems to be the best we can do.
1003
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1004
sys.stderr.write('%s\n\n' % (e,))
1005
server.finish_subsystem()
1008
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1009
"""A test server for sftp transports, using absolute urls."""
1012
"""See bzrlib.transport.Server.get_url."""
1013
homedir = self._homedir
1014
if sys.platform != 'win32':
1015
# Remove the initial '/' on all platforms but win32
1016
homedir = homedir[1:]
1017
return self._get_sftp_url(urlutils.escape(homedir))
1020
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1021
"""A test server for sftp transports, using homedir relative urls."""
1024
"""See bzrlib.transport.Server.get_url."""
1025
return self._get_sftp_url("~/")
1028
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1029
"""A test server for sftp transports where only absolute paths will work.
1031
It does this by serving from a deeply-nested directory that doesn't exist.
1034
def setUp(self, backing_server=None):
1035
self._server_homedir = '/dev/noone/runs/tests/here'
1036
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1039
def get_test_permutations():
1040
"""Return the permutations to be used in testing."""
1041
return [(SFTPTransport, SFTPAbsoluteServer),
1042
(SFTPTransport, SFTPHomeDirServer),
1043
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
