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)
208
def has(self, relpath):
210
Does the target location exist?
213
self._get_sftp().stat(self._remote_path(relpath))
218
def get(self, relpath):
220
Get the file at the given relative path.
222
:param relpath: The relative path to the file
225
path = self._remote_path(relpath)
226
f = self._get_sftp().file(path, mode='rb')
227
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
230
except (IOError, paramiko.SSHException), e:
231
self._translate_io_exception(e, path, ': error retrieving',
232
failure_exc=errors.ReadError)
234
def readv(self, relpath, offsets):
235
"""See Transport.readv()"""
236
# We overload the default readv() because we want to use a file
237
# that does not have prefetch enabled.
238
# Also, if we have a new paramiko, it implements an async readv()
243
path = self._remote_path(relpath)
244
fp = self._get_sftp().file(path, mode='rb')
245
readv = getattr(fp, 'readv', None)
247
return self._sftp_readv(fp, offsets, relpath)
248
mutter('seek and read %s offsets', len(offsets))
249
return self._seek_and_read(fp, offsets, relpath)
250
except (IOError, paramiko.SSHException), e:
251
self._translate_io_exception(e, path, ': error retrieving')
253
def _sftp_readv(self, fp, offsets, relpath='<unknown>'):
254
"""Use the readv() member of fp to do async readv.
256
And then read them using paramiko.readv(). paramiko.readv()
257
does not support ranges > 64K, so it caps the request size, and
258
just reads until it gets all the stuff it wants
260
offsets = list(offsets)
261
sorted_offsets = sorted(offsets)
263
# The algorithm works as follows:
264
# 1) Coalesce nearby reads into a single chunk
265
# This generates a list of combined regions, the total size
266
# and the size of the sub regions. This coalescing step is limited
267
# in the number of nearby chunks to combine, and is allowed to
268
# skip small breaks in the requests. Limiting it makes sure that
269
# we can start yielding some data earlier, and skipping means we
270
# make fewer requests. (Beneficial even when using async)
271
# 2) Break up this combined regions into chunks that are smaller
272
# than 64KiB. Technically the limit is 65536, but we are a
273
# little bit conservative. This is because sftp has a maximum
274
# return chunk size of 64KiB (max size of an unsigned short)
275
# 3) Issue a readv() to paramiko to create an async request for
277
# 4) Read in the data as it comes back, until we've read one
278
# continuous section as determined in step 1
279
# 5) Break up the full sections into hunks for the original requested
280
# offsets. And put them in a cache
281
# 6) Check if the next request is in the cache, and if it is, remove
282
# it from the cache, and yield its data. Continue until no more
283
# entries are in the cache.
284
# 7) loop back to step 4 until all data has been read
286
# TODO: jam 20060725 This could be optimized one step further, by
287
# attempting to yield whatever data we have read, even before
288
# the first coallesced section has been fully processed.
290
# When coalescing for use with readv(), we don't really need to
291
# use any fudge factor, because the requests are made asynchronously
292
coalesced = list(self._coalesce_offsets(sorted_offsets,
293
limit=self._max_readv_combine,
297
for c_offset in coalesced:
298
start = c_offset.start
299
size = c_offset.length
301
# We need to break this up into multiple requests
303
next_size = min(size, self._max_request_size)
304
requests.append((start, next_size))
308
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
309
len(offsets), len(coalesced), len(requests))
311
# Queue the current read until we have read the full coalesced section
314
cur_coalesced_stack = iter(coalesced)
315
cur_coalesced = cur_coalesced_stack.next()
317
# Cache the results, but only until they have been fulfilled
319
# turn the list of offsets into a stack
320
offset_stack = iter(offsets)
321
cur_offset_and_size = offset_stack.next()
323
for data in fp.readv(requests):
325
cur_data_len += len(data)
327
if cur_data_len < cur_coalesced.length:
329
assert cur_data_len == cur_coalesced.length, \
330
"Somehow we read too much: %s != %s" % (cur_data_len,
331
cur_coalesced.length)
332
all_data = ''.join(cur_data)
336
for suboffset, subsize in cur_coalesced.ranges:
337
key = (cur_coalesced.start+suboffset, subsize)
338
data_map[key] = all_data[suboffset:suboffset+subsize]
340
# Now that we've read some data, see if we can yield anything back
341
while cur_offset_and_size in data_map:
342
this_data = data_map.pop(cur_offset_and_size)
343
yield cur_offset_and_size[0], this_data
344
cur_offset_and_size = offset_stack.next()
346
# We read a coalesced entry, so mark it as done
348
# Now that we've read all of the data for this coalesced section
350
cur_coalesced = cur_coalesced_stack.next()
352
if cur_coalesced is not None:
353
raise errors.ShortReadvError(relpath, cur_coalesced.start,
354
cur_coalesced.length, len(data))
356
def put_file(self, relpath, f, mode=None):
358
Copy the file-like object into the location.
360
:param relpath: Location to put the contents, relative to base.
361
:param f: File-like object.
362
:param mode: The final mode for the file
364
final_path = self._remote_path(relpath)
365
self._put(final_path, f, mode=mode)
367
def _put(self, abspath, f, mode=None):
368
"""Helper function so both put() and copy_abspaths can reuse the code"""
369
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
370
os.getpid(), random.randint(0,0x7FFFFFFF))
371
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
375
fout.set_pipelined(True)
377
except (IOError, paramiko.SSHException), e:
378
self._translate_io_exception(e, tmp_abspath)
379
# XXX: This doesn't truly help like we would like it to.
380
# The problem is that openssh strips sticky bits. So while we
381
# can properly set group write permission, we lose the group
382
# sticky bit. So it is probably best to stop chmodding, and
383
# just tell users that they need to set the umask correctly.
384
# The attr.st_mode = mode, in _sftp_open_exclusive
385
# will handle when the user wants the final mode to be more
386
# restrictive. And then we avoid a round trip. Unless
387
# paramiko decides to expose an async chmod()
389
# This is designed to chmod() right before we close.
390
# Because we set_pipelined() earlier, theoretically we might
391
# avoid the round trip for fout.close()
393
self._get_sftp().chmod(tmp_abspath, mode)
396
self._rename_and_overwrite(tmp_abspath, abspath)
398
# If we fail, try to clean up the temporary file
399
# before we throw the exception
400
# but don't let another exception mess things up
401
# Write out the traceback, because otherwise
402
# the catch and throw destroys it
404
mutter(traceback.format_exc())
408
self._get_sftp().remove(tmp_abspath)
410
# raise the saved except
412
# raise the original with its traceback if we can.
415
def _put_non_atomic_helper(self, relpath, writer, mode=None,
416
create_parent_dir=False,
418
abspath = self._remote_path(relpath)
420
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
421
# set the file mode at create time. If it does, use it.
422
# But for now, we just chmod later anyway.
424
def _open_and_write_file():
425
"""Try to open the target file, raise error on failure"""
429
fout = self._get_sftp().file(abspath, mode='wb')
430
fout.set_pipelined(True)
432
except (paramiko.SSHException, IOError), e:
433
self._translate_io_exception(e, abspath,
436
# This is designed to chmod() right before we close.
437
# Because we set_pipelined() earlier, theoretically we might
438
# avoid the round trip for fout.close()
440
self._get_sftp().chmod(abspath, mode)
445
if not create_parent_dir:
446
_open_and_write_file()
449
# Try error handling to create the parent directory if we need to
451
_open_and_write_file()
453
# Try to create the parent directory, and then go back to
455
parent_dir = os.path.dirname(abspath)
456
self._mkdir(parent_dir, dir_mode)
457
_open_and_write_file()
459
def put_file_non_atomic(self, relpath, f, mode=None,
460
create_parent_dir=False,
462
"""Copy the file-like object into the target location.
464
This function is not strictly safe to use. It is only meant to
465
be used when you already know that the target does not exist.
466
It is not safe, because it will open and truncate the remote
467
file. So there may be a time when the file has invalid contents.
469
:param relpath: The remote location to put the contents.
470
:param f: File-like object.
471
:param mode: Possible access permissions for new file.
472
None means do not set remote permissions.
473
:param create_parent_dir: If we cannot create the target file because
474
the parent directory does not exist, go ahead and
475
create it, and then try again.
479
self._put_non_atomic_helper(relpath, writer, mode=mode,
480
create_parent_dir=create_parent_dir,
483
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
484
create_parent_dir=False,
488
self._put_non_atomic_helper(relpath, writer, mode=mode,
489
create_parent_dir=create_parent_dir,
492
def iter_files_recursive(self):
493
"""Walk the relative paths of all files in this transport."""
494
queue = list(self.list_dir('.'))
496
relpath = queue.pop(0)
497
st = self.stat(relpath)
498
if stat.S_ISDIR(st.st_mode):
499
for i, basename in enumerate(self.list_dir(relpath)):
500
queue.insert(i, relpath+'/'+basename)
504
def _mkdir(self, abspath, mode=None):
510
self._get_sftp().mkdir(abspath, local_mode)
512
self._get_sftp().chmod(abspath, mode=mode)
513
except (paramiko.SSHException, IOError), e:
514
self._translate_io_exception(e, abspath, ': unable to mkdir',
515
failure_exc=FileExists)
517
def mkdir(self, relpath, mode=None):
518
"""Create a directory at the given path."""
519
self._mkdir(self._remote_path(relpath), mode=mode)
521
def _translate_io_exception(self, e, path, more_info='',
522
failure_exc=PathError):
523
"""Translate a paramiko or IOError into a friendlier exception.
525
:param e: The original exception
526
:param path: The path in question when the error is raised
527
:param more_info: Extra information that can be included,
528
such as what was going on
529
:param failure_exc: Paramiko has the super fun ability to raise completely
530
opaque errors that just set "e.args = ('Failure',)" with
532
If this parameter is set, it defines the exception
533
to raise in these cases.
535
# paramiko seems to generate detailless errors.
536
self._translate_error(e, path, raise_generic=False)
537
if getattr(e, 'args', None) is not None:
538
if (e.args == ('No such file or directory',) or
539
e.args == ('No such file',)):
540
raise NoSuchFile(path, str(e) + more_info)
541
if (e.args == ('mkdir failed',)):
542
raise FileExists(path, str(e) + more_info)
543
# strange but true, for the paramiko server.
544
if (e.args == ('Failure',)):
545
raise failure_exc(path, str(e) + more_info)
546
mutter('Raising exception with args %s', e.args)
547
if getattr(e, 'errno', None) is not None:
548
mutter('Raising exception with errno %s', e.errno)
551
def append_file(self, relpath, f, mode=None):
553
Append the text in the file-like object into the final
557
path = self._remote_path(relpath)
558
fout = self._get_sftp().file(path, 'ab')
560
self._get_sftp().chmod(path, mode)
564
except (IOError, paramiko.SSHException), e:
565
self._translate_io_exception(e, relpath, ': unable to append')
567
def rename(self, rel_from, rel_to):
568
"""Rename without special overwriting"""
570
self._get_sftp().rename(self._remote_path(rel_from),
571
self._remote_path(rel_to))
572
except (IOError, paramiko.SSHException), e:
573
self._translate_io_exception(e, rel_from,
574
': unable to rename to %r' % (rel_to))
576
def _rename_and_overwrite(self, abs_from, abs_to):
577
"""Do a fancy rename on the remote server.
579
Using the implementation provided by osutils.
582
sftp = self._get_sftp()
583
fancy_rename(abs_from, abs_to,
584
rename_func=sftp.rename,
585
unlink_func=sftp.remove)
586
except (IOError, paramiko.SSHException), e:
587
self._translate_io_exception(e, abs_from,
588
': unable to rename to %r' % (abs_to))
590
def move(self, rel_from, rel_to):
591
"""Move the item at rel_from to the location at rel_to"""
592
path_from = self._remote_path(rel_from)
593
path_to = self._remote_path(rel_to)
594
self._rename_and_overwrite(path_from, path_to)
596
def delete(self, relpath):
597
"""Delete the item at relpath"""
598
path = self._remote_path(relpath)
600
self._get_sftp().remove(path)
601
except (IOError, paramiko.SSHException), e:
602
self._translate_io_exception(e, path, ': unable to delete')
604
def external_url(self):
605
"""See bzrlib.transport.Transport.external_url."""
606
# the external path for SFTP is the base
610
"""Return True if this store supports listing."""
613
def list_dir(self, relpath):
615
Return a list of all files at the given location.
617
# does anything actually use this?
619
# This is at least used by copy_tree for remote upgrades.
620
# -- David Allouche 2006-08-11
621
path = self._remote_path(relpath)
623
entries = self._get_sftp().listdir(path)
624
except (IOError, paramiko.SSHException), e:
625
self._translate_io_exception(e, path, ': failed to list_dir')
626
return [urlutils.escape(entry) for entry in entries]
628
def rmdir(self, relpath):
629
"""See Transport.rmdir."""
630
path = self._remote_path(relpath)
632
return self._get_sftp().rmdir(path)
633
except (IOError, paramiko.SSHException), e:
634
self._translate_io_exception(e, path, ': failed to rmdir')
636
def stat(self, relpath):
637
"""Return the stat information for a file."""
638
path = self._remote_path(relpath)
640
return self._get_sftp().stat(path)
641
except (IOError, paramiko.SSHException), e:
642
self._translate_io_exception(e, path, ': unable to stat')
644
def lock_read(self, relpath):
646
Lock the given file for shared (read) access.
647
:return: A lock object, which has an unlock() member function
649
# FIXME: there should be something clever i can do here...
650
class BogusLock(object):
651
def __init__(self, path):
655
return BogusLock(relpath)
657
def lock_write(self, relpath):
659
Lock the given file for exclusive (write) access.
660
WARNING: many transports do not support this, so trying avoid using it
662
:return: A lock object, which has an unlock() member function
664
# This is a little bit bogus, but basically, we create a file
665
# which should not already exist, and if it does, we assume
666
# that there is a lock, and if it doesn't, the we assume
667
# that we have taken the lock.
668
return SFTPLock(relpath, self)
670
def _sftp_open_exclusive(self, abspath, mode=None):
671
"""Open a remote path exclusively.
673
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
674
the file already exists. However it does not expose this
675
at the higher level of SFTPClient.open(), so we have to
678
WARNING: This breaks the SFTPClient abstraction, so it
679
could easily break against an updated version of paramiko.
681
:param abspath: The remote absolute path where the file should be opened
682
:param mode: The mode permissions bits for the new file
684
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
685
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
686
# However, there is no way to set the permission mode at open
687
# time using the sftp_client.file() functionality.
688
path = self._get_sftp()._adjust_cwd(abspath)
689
# mutter('sftp abspath %s => %s', abspath, path)
690
attr = SFTPAttributes()
693
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
694
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
696
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
698
raise TransportError('Expected an SFTP handle')
699
handle = msg.get_string()
700
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
701
except (paramiko.SSHException, IOError), e:
702
self._translate_io_exception(e, abspath, ': unable to open',
703
failure_exc=FileExists)
705
def _can_roundtrip_unix_modebits(self):
706
if sys.platform == 'win32':
712
# ------------- server test implementation --------------
715
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
717
STUB_SERVER_KEY = """
718
-----BEGIN RSA PRIVATE KEY-----
719
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
720
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
721
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
722
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
723
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
724
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
725
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
726
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
727
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
728
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
729
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
730
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
731
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
732
-----END RSA PRIVATE KEY-----
736
class SocketListener(threading.Thread):
738
def __init__(self, callback):
739
threading.Thread.__init__(self)
740
self._callback = callback
741
self._socket = socket.socket()
742
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
743
self._socket.bind(('localhost', 0))
744
self._socket.listen(1)
745
self.port = self._socket.getsockname()[1]
746
self._stop_event = threading.Event()
749
# called from outside this thread
750
self._stop_event.set()
751
# use a timeout here, because if the test fails, the server thread may
752
# never notice the stop_event.
758
readable, writable_unused, exception_unused = \
759
select.select([self._socket], [], [], 0.1)
760
if self._stop_event.isSet():
762
if len(readable) == 0:
765
s, addr_unused = self._socket.accept()
766
# because the loopback socket is inline, and transports are
767
# never explicitly closed, best to launch a new thread.
768
threading.Thread(target=self._callback, args=(s,)).start()
769
except socket.error, x:
770
sys.excepthook(*sys.exc_info())
771
warning('Socket error during accept() within unit test server'
774
# probably a failed test; unit test thread will log the
776
sys.excepthook(*sys.exc_info())
777
warning('Exception from within unit test server thread: %r' %
781
class SocketDelay(object):
782
"""A socket decorator to make TCP appear slower.
784
This changes recv, send, and sendall to add a fixed latency to each python
785
call if a new roundtrip is detected. That is, when a recv is called and the
786
flag new_roundtrip is set, latency is charged. Every send and send_all
789
In addition every send, sendall and recv sleeps a bit per character send to
792
Not all methods are implemented, this is deliberate as this class is not a
793
replacement for the builtin sockets layer. fileno is not implemented to
794
prevent the proxy being bypassed.
798
_proxied_arguments = dict.fromkeys([
799
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
800
"setblocking", "setsockopt", "settimeout", "shutdown"])
802
def __init__(self, sock, latency, bandwidth=1.0,
805
:param bandwith: simulated bandwith (MegaBit)
806
:param really_sleep: If set to false, the SocketDelay will just
807
increase a counter, instead of calling time.sleep. This is useful for
808
unittesting the SocketDelay.
811
self.latency = latency
812
self.really_sleep = really_sleep
813
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
814
self.new_roundtrip = False
817
if self.really_sleep:
820
SocketDelay.simulated_time += s
822
def __getattr__(self, attr):
823
if attr in SocketDelay._proxied_arguments:
824
return getattr(self.sock, attr)
825
raise AttributeError("'SocketDelay' object has no attribute %r" %
829
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
832
def recv(self, *args):
833
data = self.sock.recv(*args)
834
if data and self.new_roundtrip:
835
self.new_roundtrip = False
836
self.sleep(self.latency)
837
self.sleep(len(data) * self.time_per_byte)
840
def sendall(self, data, flags=0):
841
if not self.new_roundtrip:
842
self.new_roundtrip = True
843
self.sleep(self.latency)
844
self.sleep(len(data) * self.time_per_byte)
845
return self.sock.sendall(data, flags)
847
def send(self, data, flags=0):
848
if not self.new_roundtrip:
849
self.new_roundtrip = True
850
self.sleep(self.latency)
851
bytes_sent = self.sock.send(data, flags)
852
self.sleep(bytes_sent * self.time_per_byte)
856
class SFTPServer(Server):
857
"""Common code for SFTP server facilities."""
859
def __init__(self, server_interface=StubServer):
860
self._original_vendor = None
862
self._server_homedir = None
863
self._listener = None
865
self._vendor = ssh.ParamikoVendor()
866
self._server_interface = server_interface
871
def _get_sftp_url(self, path):
872
"""Calculate an sftp url to this server for path."""
873
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
875
def log(self, message):
876
"""StubServer uses this to log when a new server is created."""
877
self.logs.append(message)
879
def _run_server_entry(self, sock):
880
"""Entry point for all implementations of _run_server.
882
If self.add_latency is > 0.000001 then sock is given a latency adding
885
if self.add_latency > 0.000001:
886
sock = SocketDelay(sock, self.add_latency)
887
return self._run_server(sock)
889
def _run_server(self, s):
890
ssh_server = paramiko.Transport(s)
891
key_file = pathjoin(self._homedir, 'test_rsa.key')
892
f = open(key_file, 'w')
893
f.write(STUB_SERVER_KEY)
895
host_key = paramiko.RSAKey.from_private_key_file(key_file)
896
ssh_server.add_server_key(host_key)
897
server = self._server_interface(self)
898
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
899
StubSFTPServer, root=self._root,
900
home=self._server_homedir)
901
event = threading.Event()
902
ssh_server.start_server(event, server)
905
def setUp(self, backing_server=None):
906
# XXX: TODO: make sftpserver back onto backing_server rather than local
908
assert (backing_server is None or
909
isinstance(backing_server, local.LocalURLServer)), (
910
"backing_server should not be %r, because this can only serve the "
911
"local current working directory." % (backing_server,))
912
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
913
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
914
if sys.platform == 'win32':
915
# Win32 needs to use the UNICODE api
916
self._homedir = getcwd()
918
# But Linux SFTP servers should just deal in bytestreams
919
self._homedir = os.getcwd()
920
if self._server_homedir is None:
921
self._server_homedir = self._homedir
923
if sys.platform == 'win32':
925
self._listener = SocketListener(self._run_server_entry)
926
self._listener.setDaemon(True)
927
self._listener.start()
930
"""See bzrlib.transport.Server.tearDown."""
931
self._listener.stop()
932
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
934
def get_bogus_url(self):
935
"""See bzrlib.transport.Server.get_bogus_url."""
936
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
937
# we bind a random socket, so that we get a guaranteed unused port
938
# we just never listen on that port
940
s.bind(('localhost', 0))
941
return 'sftp://%s:%s/' % s.getsockname()
944
class SFTPFullAbsoluteServer(SFTPServer):
945
"""A test server for sftp transports, using absolute urls and ssh."""
948
"""See bzrlib.transport.Server.get_url."""
949
homedir = self._homedir
950
if sys.platform != 'win32':
951
# Remove the initial '/' on all platforms but win32
952
homedir = homedir[1:]
953
return self._get_sftp_url(urlutils.escape(homedir))
956
class SFTPServerWithoutSSH(SFTPServer):
957
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
960
super(SFTPServerWithoutSSH, self).__init__()
961
self._vendor = ssh.LoopbackVendor()
963
def _run_server(self, sock):
964
# Re-import these as locals, so that they're still accessible during
965
# interpreter shutdown (when all module globals get set to None, leading
966
# to confusing errors like "'NoneType' object has no attribute 'error'".
967
class FakeChannel(object):
968
def get_transport(self):
970
def get_log_channel(self):
974
def get_hexdump(self):
979
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
980
root=self._root, home=self._server_homedir)
982
server.start_subsystem('sftp', None, sock)
983
except socket.error, e:
984
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
985
# it's okay for the client to disconnect abruptly
986
# (bug in paramiko 1.6: it should absorb this exception)
991
# This typically seems to happen during interpreter shutdown, so
992
# most of the useful ways to report this error are won't work.
993
# Writing the exception type, and then the text of the exception,
994
# seems to be the best we can do.
996
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
997
sys.stderr.write('%s\n\n' % (e,))
998
server.finish_subsystem()
1001
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1002
"""A test server for sftp transports, using absolute urls."""
1005
"""See bzrlib.transport.Server.get_url."""
1006
homedir = self._homedir
1007
if sys.platform != 'win32':
1008
# Remove the initial '/' on all platforms but win32
1009
homedir = homedir[1:]
1010
return self._get_sftp_url(urlutils.escape(homedir))
1013
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1014
"""A test server for sftp transports, using homedir relative urls."""
1017
"""See bzrlib.transport.Server.get_url."""
1018
return self._get_sftp_url("~/")
1021
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1022
"""A test server for sftp transports where only absolute paths will work.
1024
It does this by serving from a deeply-nested directory that doesn't exist.
1027
def setUp(self, backing_server=None):
1028
self._server_homedir = '/dev/noone/runs/tests/here'
1029
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1032
def get_test_permutations():
1033
"""Return the permutations to be used in testing."""
1034
return [(SFTPTransport, SFTPAbsoluteServer),
1035
(SFTPTransport, SFTPHomeDirServer),
1036
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
