/usr/lib/python2.7/dist-packages/bzrlib/transport/sftp.py is in python-bzrlib 2.7.0-2ubuntu3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 | # Copyright (C) 2005-2011, 2016 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Implementation of Transport over SFTP, using paramiko."""
from __future__ import absolute_import
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
# then raise TransportNotPossible, which will break remote access to any
# formats which rely on OS-level locks. That should be fine as those formats
# are pretty old, but these combinations may have to be removed from the test
# suite. Those formats all date back to 0.7; so we should be able to remove
# these methods when we officially drop support for those formats.
import bisect
import errno
import itertools
import os
import random
import stat
import sys
import time
import warnings
from bzrlib import (
config,
debug,
errors,
urlutils,
)
from bzrlib.errors import (FileExists,
NoSuchFile,
TransportError,
LockError,
PathError,
ParamikoNotPresent,
)
from bzrlib.osutils import fancy_rename
from bzrlib.trace import mutter, warning
from bzrlib.transport import (
FileFileStream,
_file_streams,
ssh,
ConnectedTransport,
)
# Disable one particular warning that comes from paramiko in Python2.5; if
# this is emitted at the wrong time it tends to cause spurious test failures
# or at least noise in the test case::
#
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
# test_permissions.TestSftpPermissions.test_new_files
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
# self.packet.write(struct.pack('>I', n))
warnings.filterwarnings('ignore',
'integer argument expected, got float',
category=DeprecationWarning,
module='paramiko.message')
try:
import paramiko
except ImportError, e:
raise ParamikoNotPresent(e)
else:
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
SFTP_OK, CMD_HANDLE, CMD_OPEN)
from paramiko.sftp_attr import SFTPAttributes
from paramiko.sftp_file import SFTPFile
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
class SFTPLock(object):
"""This fakes a lock in a remote location.
A present lock is indicated just by the existence of a file. This
doesn't work well on all transports and they are only used in
deprecated storage formats.
"""
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
def __init__(self, path, transport):
self.lock_file = None
self.path = path
self.lock_path = path + '.write-lock'
self.transport = transport
try:
# RBC 20060103 FIXME should we be using private methods here ?
abspath = transport._remote_path(self.lock_path)
self.lock_file = transport._sftp_open_exclusive(abspath)
except FileExists:
raise LockError('File %r already locked' % (self.path,))
def unlock(self):
if not self.lock_file:
return
self.lock_file.close()
self.lock_file = None
try:
self.transport.delete(self.lock_path)
except (NoSuchFile,):
# What specific errors should we catch here?
pass
class _SFTPReadvHelper(object):
"""A class to help with managing the state of a readv request."""
# See _get_requests for an explanation.
_max_request_size = 32768
def __init__(self, original_offsets, relpath, _report_activity):
"""Create a new readv helper.
:param original_offsets: The original requests given by the caller of
readv()
:param relpath: The name of the file (if known)
:param _report_activity: A Transport._report_activity bound method,
to be called as data arrives.
"""
self.original_offsets = list(original_offsets)
self.relpath = relpath
self._report_activity = _report_activity
def _get_requests(self):
"""Break up the offsets into individual requests over sftp.
The SFTP spec only requires implementers to support 32kB requests. We
could try something larger (openssh supports 64kB), but then we have to
handle requests that fail.
So instead, we just break up our maximum chunks into 32kB chunks, and
asyncronously requests them.
Newer versions of paramiko would do the chunking for us, but we want to
start processing results right away, so we do it ourselves.
"""
# TODO: Because we issue async requests, we don't 'fudge' any extra
# data. I'm not 100% sure that is the best choice.
# The first thing we do, is to collapse the individual requests as much
# as possible, so we don't issues requests <32kB
sorted_offsets = sorted(self.original_offsets)
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
limit=0, fudge_factor=0))
requests = []
for c_offset in coalesced:
start = c_offset.start
size = c_offset.length
# Break this up into 32kB requests
while size > 0:
next_size = min(size, self._max_request_size)
requests.append((start, next_size))
size -= next_size
start += next_size
if 'sftp' in debug.debug_flags:
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
self.relpath, len(sorted_offsets), len(coalesced),
len(requests))
return requests
def request_and_yield_offsets(self, fp):
"""Request the data from the remote machine, yielding the results.
:param fp: A Paramiko SFTPFile object that supports readv.
:return: Yield the data requested by the original readv caller, one by
one.
"""
requests = self._get_requests()
offset_iter = iter(self.original_offsets)
cur_offset, cur_size = offset_iter.next()
# paramiko .readv() yields strings that are in the order of the requests
# So we track the current request to know where the next data is
# being returned from.
input_start = None
last_end = None
buffered_data = []
buffered_len = 0
# This is used to buffer chunks which we couldn't process yet
# It is (start, end, data) tuples.
data_chunks = []
# Create an 'unlimited' data stream, so we stop based on requests,
# rather than just because the data stream ended. This lets us detect
# short readv.
data_stream = itertools.chain(fp.readv(requests),
itertools.repeat(None))
for (start, length), data in itertools.izip(requests, data_stream):
if data is None:
if cur_coalesced is not None:
raise errors.ShortReadvError(self.relpath,
start, length, len(data))
if len(data) != length:
raise errors.ShortReadvError(self.relpath,
start, length, len(data))
self._report_activity(length, 'read')
if last_end is None:
# This is the first request, just buffer it
buffered_data = [data]
buffered_len = length
input_start = start
elif start == last_end:
# The data we are reading fits neatly on the previous
# buffer, so this is all part of a larger coalesced range.
buffered_data.append(data)
buffered_len += length
else:
# We have an 'interrupt' in the data stream. So we know we are
# at a request boundary.
if buffered_len > 0:
# We haven't consumed the buffer so far, so put it into
# data_chunks, and continue.
buffered = ''.join(buffered_data)
data_chunks.append((input_start, buffered))
input_start = start
buffered_data = [data]
buffered_len = length
last_end = start + length
if input_start == cur_offset and cur_size <= buffered_len:
# Simplify the next steps a bit by transforming buffered_data
# into a single string. We also have the nice property that
# when there is only one string ''.join([x]) == x, so there is
# no data copying.
buffered = ''.join(buffered_data)
# Clean out buffered data so that we keep memory
# consumption low
del buffered_data[:]
buffered_offset = 0
# TODO: We *could* also consider the case where cur_offset is in
# in the buffered range, even though it doesn't *start*
# the buffered range. But for packs we pretty much always
# read in order, so you won't get any extra data in the
# middle.
while (input_start == cur_offset
and (buffered_offset + cur_size) <= buffered_len):
# We've buffered enough data to process this request, spit it
# out
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
# move the direct pointer into our buffered data
buffered_offset += cur_size
# Move the start-of-buffer pointer
input_start += cur_size
# Yield the requested data
yield cur_offset, cur_data
cur_offset, cur_size = offset_iter.next()
# at this point, we've consumed as much of buffered as we can,
# so break off the portion that we consumed
if buffered_offset == len(buffered_data):
# No tail to leave behind
buffered_data = []
buffered_len = 0
else:
buffered = buffered[buffered_offset:]
buffered_data = [buffered]
buffered_len = len(buffered)
# now that the data stream is done, close the handle
fp.close()
if buffered_len:
buffered = ''.join(buffered_data)
del buffered_data[:]
data_chunks.append((input_start, buffered))
if data_chunks:
if 'sftp' in debug.debug_flags:
mutter('SFTP readv left with %d out-of-order bytes',
sum(map(lambda x: len(x[1]), data_chunks)))
# We've processed all the readv data, at this point, anything we
# couldn't process is in data_chunks. This doesn't happen often, so
# this code path isn't optimized
# We use an interesting process for data_chunks
# Specifically if we have "bisect_left([(start, len, entries)],
# (qstart,)])
# If start == qstart, then we get the specific node. Otherwise we
# get the previous node
while True:
idx = bisect.bisect_left(data_chunks, (cur_offset,))
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
# The data starts here
data = data_chunks[idx][1][:cur_size]
elif idx > 0:
# The data is in a portion of a previous page
idx -= 1
sub_offset = cur_offset - data_chunks[idx][0]
data = data_chunks[idx][1]
data = data[sub_offset:sub_offset + cur_size]
else:
# We are missing the page where the data should be found,
# something is wrong
data = ''
if len(data) != cur_size:
raise AssertionError('We must have miscalulated.'
' We expected %d bytes, but only found %d'
% (cur_size, len(data)))
yield cur_offset, data
cur_offset, cur_size = offset_iter.next()
class SFTPTransport(ConnectedTransport):
"""Transport implementation for SFTP access."""
_do_prefetch = _default_do_prefetch
# TODO: jam 20060717 Conceivably these could be configurable, either
# by auto-tuning at run-time, or by a configuration (per host??)
# but the performance curve is pretty flat, so just going with
# reasonable defaults.
_max_readv_combine = 200
# Having to round trip to the server means waiting for a response,
# so it is better to download extra bytes.
# 8KiB had good performance for both local and remote network operations
_bytes_to_read_before_seek = 8192
# The sftp spec says that implementations SHOULD allow reads
# to be at least 32K. paramiko.readv() does an async request
# for the chunks. So we need to keep it within a single request
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
# up the request itself, rather than us having to worry about it
_max_request_size = 32768
def _remote_path(self, relpath):
"""Return the path to be passed along the sftp protocol for relpath.
:param relpath: is a urlencoded string.
"""
remote_path = self._parsed_url.clone(relpath).path
# the initial slash should be removed from the path, and treated as a
# homedir relative path (the path begins with a double slash if it is
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
# RBC 20060118 we are not using this as its too user hostile. instead
# we are following lftp and using /~/foo to mean '~/foo'
# vila--20070602 and leave absolute paths begin with a single slash.
if remote_path.startswith('/~/'):
remote_path = remote_path[3:]
elif remote_path == '/~':
remote_path = ''
return remote_path
def _create_connection(self, credentials=None):
"""Create a new connection with the provided credentials.
:param credentials: The credentials needed to establish the connection.
:return: The created connection and its associated credentials.
The credentials are only the password as it may have been entered
interactively by the user and may be different from the one provided
in base url at transport creation time.
"""
if credentials is None:
password = self._parsed_url.password
else:
password = credentials
vendor = ssh._get_ssh_vendor()
user = self._parsed_url.user
if user is None:
auth = config.AuthenticationConfig()
user = auth.get_user('ssh', self._parsed_url.host,
self._parsed_url.port)
connection = vendor.connect_sftp(self._parsed_url.user, password,
self._parsed_url.host, self._parsed_url.port)
return connection, (user, password)
def disconnect(self):
connection = self._get_connection()
if connection is not None:
connection.close()
def _get_sftp(self):
"""Ensures that a connection is established"""
connection = self._get_connection()
if connection is None:
# First connection ever
connection, credentials = self._create_connection()
self._set_connection(connection, credentials)
return connection
def has(self, relpath):
"""
Does the target location exist?
"""
try:
self._get_sftp().stat(self._remote_path(relpath))
# stat result is about 20 bytes, let's say
self._report_activity(20, 'read')
return True
except IOError:
return False
def get(self, relpath):
"""Get the file at the given relative path.
:param relpath: The relative path to the file
"""
try:
path = self._remote_path(relpath)
f = self._get_sftp().file(path, mode='rb')
size = f.stat().st_size
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
f.prefetch(size)
return f
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': error retrieving',
failure_exc=errors.ReadError)
def get_bytes(self, relpath):
# reimplement this here so that we can report how many bytes came back
f = self.get(relpath)
try:
bytes = f.read()
self._report_activity(len(bytes), 'read')
return bytes
finally:
f.close()
def _readv(self, relpath, offsets):
"""See Transport.readv()"""
# We overload the default readv() because we want to use a file
# that does not have prefetch enabled.
# Also, if we have a new paramiko, it implements an async readv()
if not offsets:
return
try:
path = self._remote_path(relpath)
fp = self._get_sftp().file(path, mode='rb')
readv = getattr(fp, 'readv', None)
if readv:
return self._sftp_readv(fp, offsets, relpath)
if 'sftp' in debug.debug_flags:
mutter('seek and read %s offsets', len(offsets))
return self._seek_and_read(fp, offsets, relpath)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': error retrieving')
def recommended_page_size(self):
"""See Transport.recommended_page_size().
For SFTP we suggest a large page size to reduce the overhead
introduced by latency.
"""
return 64 * 1024
def _sftp_readv(self, fp, offsets, relpath):
"""Use the readv() member of fp to do async readv.
Then read them using paramiko.readv(). paramiko.readv()
does not support ranges > 64K, so it caps the request size, and
just reads until it gets all the stuff it wants.
"""
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
return helper.request_and_yield_offsets(fp)
def put_file(self, relpath, f, mode=None):
"""
Copy the file-like object into the location.
:param relpath: Location to put the contents, relative to base.
:param f: File-like object.
:param mode: The final mode for the file
"""
final_path = self._remote_path(relpath)
return self._put(final_path, f, mode=mode)
def _put(self, abspath, f, mode=None):
"""Helper function so both put() and copy_abspaths can reuse the code"""
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
os.getpid(), random.randint(0,0x7FFFFFFF))
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
closed = False
try:
try:
fout.set_pipelined(True)
length = self._pump(f, fout)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, tmp_abspath)
# XXX: This doesn't truly help like we would like it to.
# The problem is that openssh strips sticky bits. So while we
# can properly set group write permission, we lose the group
# sticky bit. So it is probably best to stop chmodding, and
# just tell users that they need to set the umask correctly.
# The attr.st_mode = mode, in _sftp_open_exclusive
# will handle when the user wants the final mode to be more
# restrictive. And then we avoid a round trip. Unless
# paramiko decides to expose an async chmod()
# This is designed to chmod() right before we close.
# Because we set_pipelined() earlier, theoretically we might
# avoid the round trip for fout.close()
if mode is not None:
self._get_sftp().chmod(tmp_abspath, mode)
fout.close()
closed = True
self._rename_and_overwrite(tmp_abspath, abspath)
return length
except Exception, e:
# If we fail, try to clean up the temporary file
# before we throw the exception
# but don't let another exception mess things up
# Write out the traceback, because otherwise
# the catch and throw destroys it
import traceback
mutter(traceback.format_exc())
try:
if not closed:
fout.close()
self._get_sftp().remove(tmp_abspath)
except:
# raise the saved except
raise e
# raise the original with its traceback if we can.
raise
def _put_non_atomic_helper(self, relpath, writer, mode=None,
create_parent_dir=False,
dir_mode=None):
abspath = self._remote_path(relpath)
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
# set the file mode at create time. If it does, use it.
# But for now, we just chmod later anyway.
def _open_and_write_file():
"""Try to open the target file, raise error on failure"""
fout = None
try:
try:
fout = self._get_sftp().file(abspath, mode='wb')
fout.set_pipelined(True)
writer(fout)
except (paramiko.SSHException, IOError), e:
self._translate_io_exception(e, abspath,
': unable to open')
# This is designed to chmod() right before we close.
# Because we set_pipelined() earlier, theoretically we might
# avoid the round trip for fout.close()
if mode is not None:
self._get_sftp().chmod(abspath, mode)
finally:
if fout is not None:
fout.close()
if not create_parent_dir:
_open_and_write_file()
return
# Try error handling to create the parent directory if we need to
try:
_open_and_write_file()
except NoSuchFile:
# Try to create the parent directory, and then go back to
# writing the file
parent_dir = os.path.dirname(abspath)
self._mkdir(parent_dir, dir_mode)
_open_and_write_file()
def put_file_non_atomic(self, relpath, f, mode=None,
create_parent_dir=False,
dir_mode=None):
"""Copy the file-like object into the target location.
This function is not strictly safe to use. It is only meant to
be used when you already know that the target does not exist.
It is not safe, because it will open and truncate the remote
file. So there may be a time when the file has invalid contents.
:param relpath: The remote location to put the contents.
:param f: File-like object.
:param mode: Possible access permissions for new file.
None means do not set remote permissions.
:param create_parent_dir: If we cannot create the target file because
the parent directory does not exist, go ahead and
create it, and then try again.
"""
def writer(fout):
self._pump(f, fout)
self._put_non_atomic_helper(relpath, writer, mode=mode,
create_parent_dir=create_parent_dir,
dir_mode=dir_mode)
def put_bytes_non_atomic(self, relpath, raw_bytes, mode=None,
create_parent_dir=False,
dir_mode=None):
if not isinstance(raw_bytes, str):
raise TypeError(
'raw_bytes must be a plain string, not %s' % type(raw_bytes))
def writer(fout):
fout.write(raw_bytes)
self._put_non_atomic_helper(relpath, writer, mode=mode,
create_parent_dir=create_parent_dir,
dir_mode=dir_mode)
def iter_files_recursive(self):
"""Walk the relative paths of all files in this transport."""
# progress is handled by list_dir
queue = list(self.list_dir('.'))
while queue:
relpath = queue.pop(0)
st = self.stat(relpath)
if stat.S_ISDIR(st.st_mode):
for i, basename in enumerate(self.list_dir(relpath)):
queue.insert(i, relpath+'/'+basename)
else:
yield relpath
def _mkdir(self, abspath, mode=None):
if mode is None:
local_mode = 0777
else:
local_mode = mode
try:
self._report_activity(len(abspath), 'write')
self._get_sftp().mkdir(abspath, local_mode)
self._report_activity(1, 'read')
if mode is not None:
# chmod a dir through sftp will erase any sgid bit set
# on the server side. So, if the bit mode are already
# set, avoid the chmod. If the mode is not fine but
# the sgid bit is set, report a warning to the user
# with the umask fix.
stat = self._get_sftp().lstat(abspath)
mode = mode & 0777 # can't set special bits anyway
if mode != stat.st_mode & 0777:
if stat.st_mode & 06000:
warning('About to chmod %s over sftp, which will result'
' in its suid or sgid bits being cleared. If'
' you want to preserve those bits, change your '
' environment on the server to use umask 0%03o.'
% (abspath, 0777 - mode))
self._get_sftp().chmod(abspath, mode=mode)
except (paramiko.SSHException, IOError), e:
self._translate_io_exception(e, abspath, ': unable to mkdir',
failure_exc=FileExists)
def mkdir(self, relpath, mode=None):
"""Create a directory at the given path."""
self._mkdir(self._remote_path(relpath), mode=mode)
def open_write_stream(self, relpath, mode=None):
"""See Transport.open_write_stream."""
# initialise the file to zero-length
# this is three round trips, but we don't use this
# api more than once per write_group at the moment so
# it is a tolerable overhead. Better would be to truncate
# the file after opening. RBC 20070805
self.put_bytes_non_atomic(relpath, "", mode)
abspath = self._remote_path(relpath)
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
# set the file mode at create time. If it does, use it.
# But for now, we just chmod later anyway.
handle = None
try:
handle = self._get_sftp().file(abspath, mode='wb')
handle.set_pipelined(True)
except (paramiko.SSHException, IOError), e:
self._translate_io_exception(e, abspath,
': unable to open')
_file_streams[self.abspath(relpath)] = handle
return FileFileStream(self, relpath, handle)
def _translate_io_exception(self, e, path, more_info='',
failure_exc=PathError):
"""Translate a paramiko or IOError into a friendlier exception.
:param e: The original exception
:param path: The path in question when the error is raised
:param more_info: Extra information that can be included,
such as what was going on
:param failure_exc: Paramiko has the super fun ability to raise completely
opaque errors that just set "e.args = ('Failure',)" with
no more information.
If this parameter is set, it defines the exception
to raise in these cases.
"""
# paramiko seems to generate detailless errors.
self._translate_error(e, path, raise_generic=False)
if getattr(e, 'args', None) is not None:
if (e.args == ('No such file or directory',) or
e.args == ('No such file',)):
raise NoSuchFile(path, str(e) + more_info)
if (e.args == ('mkdir failed',) or
e.args[0].startswith('syserr: File exists')):
raise FileExists(path, str(e) + more_info)
# strange but true, for the paramiko server.
if (e.args == ('Failure',)):
raise failure_exc(path, str(e) + more_info)
# Can be something like args = ('Directory not empty:
# '/srv/bazaar.launchpad.net/blah...: '
# [Errno 39] Directory not empty',)
if (e.args[0].startswith('Directory not empty: ')
or getattr(e, 'errno', None) == errno.ENOTEMPTY):
raise errors.DirectoryNotEmpty(path, str(e))
if e.args == ('Operation unsupported',):
raise errors.TransportNotPossible()
mutter('Raising exception with args %s', e.args)
if getattr(e, 'errno', None) is not None:
mutter('Raising exception with errno %s', e.errno)
raise e
def append_file(self, relpath, f, mode=None):
"""
Append the text in the file-like object into the final
location.
"""
try:
path = self._remote_path(relpath)
fout = self._get_sftp().file(path, 'ab')
if mode is not None:
self._get_sftp().chmod(path, mode)
result = fout.tell()
self._pump(f, fout)
return result
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, relpath, ': unable to append')
def rename(self, rel_from, rel_to):
"""Rename without special overwriting"""
try:
self._get_sftp().rename(self._remote_path(rel_from),
self._remote_path(rel_to))
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, rel_from,
': unable to rename to %r' % (rel_to))
def _rename_and_overwrite(self, abs_from, abs_to):
"""Do a fancy rename on the remote server.
Using the implementation provided by osutils.
"""
try:
sftp = self._get_sftp()
fancy_rename(abs_from, abs_to,
rename_func=sftp.rename,
unlink_func=sftp.remove)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, abs_from,
': unable to rename to %r' % (abs_to))
def move(self, rel_from, rel_to):
"""Move the item at rel_from to the location at rel_to"""
path_from = self._remote_path(rel_from)
path_to = self._remote_path(rel_to)
self._rename_and_overwrite(path_from, path_to)
def delete(self, relpath):
"""Delete the item at relpath"""
path = self._remote_path(relpath)
try:
self._get_sftp().remove(path)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': unable to delete')
def external_url(self):
"""See bzrlib.transport.Transport.external_url."""
# the external path for SFTP is the base
return self.base
def listable(self):
"""Return True if this store supports listing."""
return True
def list_dir(self, relpath):
"""
Return a list of all files at the given location.
"""
# does anything actually use this?
# -- Unknown
# This is at least used by copy_tree for remote upgrades.
# -- David Allouche 2006-08-11
path = self._remote_path(relpath)
try:
entries = self._get_sftp().listdir(path)
self._report_activity(sum(map(len, entries)), 'read')
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': failed to list_dir')
return [urlutils.escape(entry) for entry in entries]
def rmdir(self, relpath):
"""See Transport.rmdir."""
path = self._remote_path(relpath)
try:
return self._get_sftp().rmdir(path)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': failed to rmdir')
def stat(self, relpath):
"""Return the stat information for a file."""
path = self._remote_path(relpath)
try:
return self._get_sftp().lstat(path)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': unable to stat')
def readlink(self, relpath):
"""See Transport.readlink."""
path = self._remote_path(relpath)
try:
return self._get_sftp().readlink(path)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, path, ': unable to readlink')
def symlink(self, source, link_name):
"""See Transport.symlink."""
try:
conn = self._get_sftp()
sftp_retval = conn.symlink(source, link_name)
if SFTP_OK != sftp_retval:
raise TransportError(
'%r: unable to create symlink to %r' % (link_name, source),
sftp_retval
)
except (IOError, paramiko.SSHException), e:
self._translate_io_exception(e, link_name,
': unable to create symlink to %r' % (source))
def lock_read(self, relpath):
"""
Lock the given file for shared (read) access.
:return: A lock object, which has an unlock() member function
"""
# FIXME: there should be something clever i can do here...
class BogusLock(object):
def __init__(self, path):
self.path = path
def unlock(self):
pass
return BogusLock(relpath)
def lock_write(self, relpath):
"""
Lock the given file for exclusive (write) access.
WARNING: many transports do not support this, so trying avoid using it
:return: A lock object, which has an unlock() member function
"""
# This is a little bit bogus, but basically, we create a file
# which should not already exist, and if it does, we assume
# that there is a lock, and if it doesn't, the we assume
# that we have taken the lock.
return SFTPLock(relpath, self)
def _sftp_open_exclusive(self, abspath, mode=None):
"""Open a remote path exclusively.
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
the file already exists. However it does not expose this
at the higher level of SFTPClient.open(), so we have to
sneak away with it.
WARNING: This breaks the SFTPClient abstraction, so it
could easily break against an updated version of paramiko.
:param abspath: The remote absolute path where the file should be opened
:param mode: The mode permissions bits for the new file
"""
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
# However, there is no way to set the permission mode at open
# time using the sftp_client.file() functionality.
path = self._get_sftp()._adjust_cwd(abspath)
# mutter('sftp abspath %s => %s', abspath, path)
attr = SFTPAttributes()
if mode is not None:
attr.st_mode = mode
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
try:
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
if t != CMD_HANDLE:
raise TransportError('Expected an SFTP handle')
handle = msg.get_string()
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
except (paramiko.SSHException, IOError), e:
self._translate_io_exception(e, abspath, ': unable to open',
failure_exc=FileExists)
def _can_roundtrip_unix_modebits(self):
if sys.platform == 'win32':
# anyone else?
return False
else:
return True
def get_test_permutations():
"""Return the permutations to be used in testing."""
from bzrlib.tests import stub_sftp
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
]
|