1
# Copyright (C) 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""RemoteTransport client for the smart-server.
19
This module shouldn't be accessed directly. The classes defined here should be
20
imported from bzrlib.smart.
23
__all__ = ['RemoteTransport', 'RemoteTCPTransport', 'RemoteSSHTransport']
25
from cStringIO import StringIO
34
from bzrlib.smart import client, medium, protocol
36
# must do this otherwise urllib can't parse the urls properly :(
37
for scheme in ['ssh', 'bzr', 'bzr+loopback', 'bzr+ssh', 'bzr+http']:
38
transport.register_urlparse_netloc_protocol(scheme)
42
# Port 4155 is the default port for bzr://, registered with IANA.
43
BZR_DEFAULT_INTERFACE = '0.0.0.0'
44
BZR_DEFAULT_PORT = 4155
47
class _SmartStat(object):
49
def __init__(self, size, mode):
54
class RemoteTransport(transport.Transport):
55
"""Connection to a smart server.
57
The connection holds references to the medium that can be used to send
58
requests to the server.
60
The connection has a notion of the current directory to which it's
61
connected; this is incorporated in filenames passed to the server.
63
This supports some higher-level RPC operations and can also be treated
64
like a Transport to do file-like operations.
66
The connection can be made over a tcp socket, an ssh pipe or a series of
67
http requests. There are concrete subclasses for each type:
68
RemoteTCPTransport, etc.
71
# IMPORTANT FOR IMPLEMENTORS: RemoteTransport MUST NOT be given encoding
72
# responsibilities: Put those on SmartClient or similar. This is vital for
73
# the ability to support multiple versions of the smart protocol over time:
74
# RemoteTransport is an adapter from the Transport object model to the
75
# SmartClient model, not an encoder.
77
def __init__(self, url, clone_from=None, medium=None, _client=None):
80
:param clone_from: Another RemoteTransport instance that this one is
81
being cloned from. Attributes such as credentials and the medium
83
:param medium: The medium to use for this RemoteTransport. This must be
84
supplied if clone_from is None.
85
:param _client: Override the _SmartClient used by this transport. This
86
should only be used for testing purposes; normally this is
87
determined from the medium.
89
### Technically super() here is faulty because Transport's __init__
90
### fails to take 2 parameters, and if super were to choose a silly
91
### initialisation order things would blow up.
92
if not url.endswith('/'):
94
super(RemoteTransport, self).__init__(url)
95
self._scheme, self._username, self._password, self._host, self._port, self._path = \
96
transport.split_url(url)
97
if clone_from is None:
100
# credentials may be stripped from the base in some circumstances
101
# as yet to be clearly defined or documented, so copy them.
102
self._username = clone_from._username
103
# reuse same connection
104
self._medium = clone_from._medium
105
assert self._medium is not None
107
self._client = client._SmartClient(self._medium)
109
self._client = _client
111
def abspath(self, relpath):
112
"""Return the full url to the given relative path.
114
@param relpath: the relative path or path components
115
@type relpath: str or list
117
return self._unparse_url(self._remote_path(relpath))
119
def clone(self, relative_url):
120
"""Make a new RemoteTransport related to me, sharing the same connection.
122
This essentially opens a handle on a different remote directory.
124
if relative_url is None:
125
return RemoteTransport(self.base, self)
127
return RemoteTransport(self.abspath(relative_url), self)
129
def is_readonly(self):
130
"""Smart server transport can do read/write file operations."""
131
resp = self._call2('Transport.is_readonly')
132
if resp == ('yes', ):
134
elif resp == ('no', ):
136
elif (resp == ('error', "Generic bzr smart protocol error: "
137
"bad request 'Transport.is_readonly'") or
138
resp == ('error', "Generic bzr smart protocol error: "
139
"bad request u'Transport.is_readonly'")):
140
# XXX: nasty hack: servers before 0.16 don't have a
141
# 'Transport.is_readonly' verb, so we do what clients before 0.16
145
self._translate_error(resp)
146
assert False, 'weird response %r' % (resp,)
148
def get_smart_client(self):
151
def get_smart_medium(self):
154
def _unparse_url(self, path):
155
"""Return URL for a path.
157
:see: SFTPUrlHandling._unparse_url
159
# TODO: Eventually it should be possible to unify this with
160
# SFTPUrlHandling._unparse_url?
163
path = urllib.quote(path)
164
netloc = urllib.quote(self._host)
165
if self._username is not None:
166
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
167
if self._port is not None:
168
netloc = '%s:%d' % (netloc, self._port)
169
return urlparse.urlunparse((self._scheme, netloc, path, '', '', ''))
171
def _remote_path(self, relpath):
172
"""Returns the Unicode version of the absolute path for relpath."""
173
return self._combine_paths(self._path, relpath)
175
def _call(self, method, *args):
176
resp = self._call2(method, *args)
177
self._translate_error(resp)
179
def _call2(self, method, *args):
180
"""Call a method on the remote server."""
181
return self._client.call(method, *args)
183
def _call_with_body_bytes(self, method, args, body):
184
"""Call a method on the remote server with body bytes."""
185
return self._client.call_with_body_bytes(method, args, body)
187
def has(self, relpath):
188
"""Indicate whether a remote file of the given name exists or not.
190
:see: Transport.has()
192
resp = self._call2('has', self._remote_path(relpath))
193
if resp == ('yes', ):
195
elif resp == ('no', ):
198
self._translate_error(resp)
200
def get(self, relpath):
201
"""Return file-like object reading the contents of a remote file.
203
:see: Transport.get_bytes()/get_file()
205
return StringIO(self.get_bytes(relpath))
207
def get_bytes(self, relpath):
208
remote = self._remote_path(relpath)
209
request = self._medium.get_request()
210
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
211
smart_protocol.call('get', remote)
212
resp = smart_protocol.read_response_tuple(True)
214
smart_protocol.cancel_read_body()
215
self._translate_error(resp, relpath)
216
return smart_protocol.read_body_bytes()
218
def _serialise_optional_mode(self, mode):
224
def mkdir(self, relpath, mode=None):
225
resp = self._call2('mkdir', self._remote_path(relpath),
226
self._serialise_optional_mode(mode))
227
self._translate_error(resp)
229
def put_bytes(self, relpath, upload_contents, mode=None):
230
# FIXME: upload_file is probably not safe for non-ascii characters -
231
# should probably just pass all parameters as length-delimited
233
if type(upload_contents) is unicode:
234
# Although not strictly correct, we raise UnicodeEncodeError to be
235
# compatible with other transports.
236
raise UnicodeEncodeError(
237
'undefined', upload_contents, 0, 1,
238
'put_bytes must be given bytes, not unicode.')
239
resp = self._call_with_body_bytes('put',
240
(self._remote_path(relpath), self._serialise_optional_mode(mode)),
242
self._translate_error(resp)
244
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
245
create_parent_dir=False,
247
"""See Transport.put_bytes_non_atomic."""
248
# FIXME: no encoding in the transport!
249
create_parent_str = 'F'
250
if create_parent_dir:
251
create_parent_str = 'T'
253
resp = self._call_with_body_bytes(
255
(self._remote_path(relpath), self._serialise_optional_mode(mode),
256
create_parent_str, self._serialise_optional_mode(dir_mode)),
258
self._translate_error(resp)
260
def put_file(self, relpath, upload_file, mode=None):
261
# its not ideal to seek back, but currently put_non_atomic_file depends
262
# on transports not reading before failing - which is a faulty
263
# assumption I think - RBC 20060915
264
pos = upload_file.tell()
266
return self.put_bytes(relpath, upload_file.read(), mode)
268
upload_file.seek(pos)
271
def put_file_non_atomic(self, relpath, f, mode=None,
272
create_parent_dir=False,
274
return self.put_bytes_non_atomic(relpath, f.read(), mode=mode,
275
create_parent_dir=create_parent_dir,
278
def append_file(self, relpath, from_file, mode=None):
279
return self.append_bytes(relpath, from_file.read(), mode)
281
def append_bytes(self, relpath, bytes, mode=None):
282
resp = self._call_with_body_bytes(
284
(self._remote_path(relpath), self._serialise_optional_mode(mode)),
286
if resp[0] == 'appended':
288
self._translate_error(resp)
290
def delete(self, relpath):
291
resp = self._call2('delete', self._remote_path(relpath))
292
self._translate_error(resp)
294
def readv(self, relpath, offsets):
298
offsets = list(offsets)
300
sorted_offsets = sorted(offsets)
301
# turn the list of offsets into a stack
302
offset_stack = iter(offsets)
303
cur_offset_and_size = offset_stack.next()
304
coalesced = list(self._coalesce_offsets(sorted_offsets,
305
limit=self._max_readv_combine,
306
fudge_factor=self._bytes_to_read_before_seek))
308
request = self._medium.get_request()
309
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
310
smart_protocol.call_with_body_readv_array(
311
('readv', self._remote_path(relpath)),
312
[(c.start, c.length) for c in coalesced])
313
resp = smart_protocol.read_response_tuple(True)
315
if resp[0] != 'readv':
316
# This should raise an exception
317
smart_protocol.cancel_read_body()
318
self._translate_error(resp)
321
# FIXME: this should know how many bytes are needed, for clarity.
322
data = smart_protocol.read_body_bytes()
323
# Cache the results, but only until they have been fulfilled
325
for c_offset in coalesced:
326
if len(data) < c_offset.length:
327
raise errors.ShortReadvError(relpath, c_offset.start,
328
c_offset.length, actual=len(data))
329
for suboffset, subsize in c_offset.ranges:
330
key = (c_offset.start+suboffset, subsize)
331
data_map[key] = data[suboffset:suboffset+subsize]
332
data = data[c_offset.length:]
334
# Now that we've read some data, see if we can yield anything back
335
while cur_offset_and_size in data_map:
336
this_data = data_map.pop(cur_offset_and_size)
337
yield cur_offset_and_size[0], this_data
338
cur_offset_and_size = offset_stack.next()
340
def rename(self, rel_from, rel_to):
342
self._remote_path(rel_from),
343
self._remote_path(rel_to))
345
def move(self, rel_from, rel_to):
347
self._remote_path(rel_from),
348
self._remote_path(rel_to))
350
def rmdir(self, relpath):
351
resp = self._call('rmdir', self._remote_path(relpath))
353
def _translate_error(self, resp, orig_path=None):
354
"""Raise an exception from a response"""
361
elif what == 'NoSuchFile':
362
if orig_path is not None:
363
error_path = orig_path
366
raise errors.NoSuchFile(error_path)
367
elif what == 'error':
368
raise errors.SmartProtocolError(unicode(resp[1]))
369
elif what == 'FileExists':
370
raise errors.FileExists(resp[1])
371
elif what == 'DirectoryNotEmpty':
372
raise errors.DirectoryNotEmpty(resp[1])
373
elif what == 'ShortReadvError':
374
raise errors.ShortReadvError(resp[1], int(resp[2]),
375
int(resp[3]), int(resp[4]))
376
elif what in ('UnicodeEncodeError', 'UnicodeDecodeError'):
377
encoding = str(resp[1]) # encoding must always be a string
381
reason = str(resp[5]) # reason must always be a string
382
if val.startswith('u:'):
383
val = val[2:].decode('utf-8')
384
elif val.startswith('s:'):
385
val = val[2:].decode('base64')
386
if what == 'UnicodeDecodeError':
387
raise UnicodeDecodeError(encoding, val, start, end, reason)
388
elif what == 'UnicodeEncodeError':
389
raise UnicodeEncodeError(encoding, val, start, end, reason)
390
elif what == "ReadOnlyError":
391
raise errors.TransportNotPossible('readonly transport')
393
raise errors.SmartProtocolError('unexpected smart server error: %r' % (resp,))
395
def disconnect(self):
396
self._medium.disconnect()
398
def delete_tree(self, relpath):
399
raise errors.TransportNotPossible('readonly transport')
401
def stat(self, relpath):
402
resp = self._call2('stat', self._remote_path(relpath))
403
if resp[0] == 'stat':
404
return _SmartStat(int(resp[1]), int(resp[2], 8))
406
self._translate_error(resp)
408
## def lock_read(self, relpath):
409
## """Lock the given file for shared (read) access.
410
## :return: A lock object, which should be passed to Transport.unlock()
412
## # The old RemoteBranch ignore lock for reading, so we will
413
## # continue that tradition and return a bogus lock object.
414
## class BogusLock(object):
415
## def __init__(self, path):
419
## return BogusLock(relpath)
424
def list_dir(self, relpath):
425
resp = self._call2('list_dir', self._remote_path(relpath))
426
if resp[0] == 'names':
427
return [name.encode('ascii') for name in resp[1:]]
429
self._translate_error(resp)
431
def iter_files_recursive(self):
432
resp = self._call2('iter_files_recursive', self._remote_path(''))
433
if resp[0] == 'names':
436
self._translate_error(resp)
439
class RemoteTCPTransport(RemoteTransport):
440
"""Connection to smart server over plain tcp.
442
This is essentially just a factory to get 'RemoteTransport(url,
443
SmartTCPClientMedium).
446
def __init__(self, url):
447
_scheme, _username, _password, _host, _port, _path = \
448
transport.split_url(url)
450
_port = BZR_DEFAULT_PORT
454
except (ValueError, TypeError), e:
455
raise errors.InvalidURL(
456
path=url, extra="invalid port %s" % _port)
457
client_medium = medium.SmartTCPClientMedium(_host, _port)
458
super(RemoteTCPTransport, self).__init__(url, medium=client_medium)
461
class RemoteSSHTransport(RemoteTransport):
462
"""Connection to smart server over SSH.
464
This is essentially just a factory to get 'RemoteTransport(url,
465
SmartSSHClientMedium).
468
def __init__(self, url):
469
_scheme, _username, _password, _host, _port, _path = \
470
transport.split_url(url)
472
if _port is not None:
474
except (ValueError, TypeError), e:
475
raise errors.InvalidURL(path=url, extra="invalid port %s" %
477
client_medium = medium.SmartSSHClientMedium(_host, _port,
478
_username, _password)
479
super(RemoteSSHTransport, self).__init__(url, medium=client_medium)
482
class RemoteHTTPTransport(RemoteTransport):
483
"""Just a way to connect between a bzr+http:// url and http://.
485
This connection operates slightly differently than the RemoteSSHTransport.
486
It uses a plain http:// transport underneath, which defines what remote
487
.bzr/smart URL we are connected to. From there, all paths that are sent are
488
sent as relative paths, this way, the remote side can properly
489
de-reference them, since it is likely doing rewrite rules to translate an
490
HTTP path into a local path.
493
def __init__(self, url, http_transport=None):
494
assert url.startswith('bzr+http://')
496
if http_transport is None:
497
http_url = url[len('bzr+'):]
498
self._http_transport = transport.get_transport(http_url)
500
self._http_transport = http_transport
501
http_medium = self._http_transport.get_smart_medium()
502
super(RemoteHTTPTransport, self).__init__(url, medium=http_medium)
504
def _remote_path(self, relpath):
505
"""After connecting HTTP Transport only deals in relative URLs."""
506
# Adjust the relpath based on which URL this smart transport is
508
base = urlutils.normalize_url(self._http_transport.base)
509
url = urlutils.join(self.base[len('bzr+'):], relpath)
510
url = urlutils.normalize_url(url)
511
return urlutils.relative_url(base, url)
513
def abspath(self, relpath):
514
"""Return the full url to the given relative path.
516
:param relpath: the relative path or path components
517
:type relpath: str or list
519
return self._unparse_url(self._combine_paths(self._path, relpath))
521
def clone(self, relative_url):
522
"""Make a new RemoteHTTPTransport related to me.
524
This is re-implemented rather than using the default
525
RemoteTransport.clone() because we must be careful about the underlying
528
Also, the cloned smart transport will POST to the same .bzr/smart
529
location as this transport (although obviously the relative paths in the
530
smart requests may be different). This is so that the server doesn't
531
have to handle .bzr/smart requests at arbitrary places inside .bzr
532
directories, just at the initial URL the user uses.
534
The exception is parent paths (i.e. relative_url of "..").
537
abs_url = self.abspath(relative_url)
540
# We either use the exact same http_transport (for child locations), or
541
# a clone of the underlying http_transport (for parent locations). This
542
# means we share the connection.
543
norm_base = urlutils.normalize_url(self.base)
544
norm_abs_url = urlutils.normalize_url(abs_url)
545
normalized_rel_url = urlutils.relative_url(norm_base, norm_abs_url)
546
if normalized_rel_url == ".." or normalized_rel_url.startswith("../"):
547
http_transport = self._http_transport.clone(normalized_rel_url)
549
http_transport = self._http_transport
550
return RemoteHTTPTransport(abs_url, http_transport=http_transport)
553
def get_test_permutations():
554
"""Return (transport, server) permutations for testing."""
555
### We may need a little more test framework support to construct an
556
### appropriate RemoteTransport in the future.
557
from bzrlib.smart import server
558
return [(RemoteTCPTransport, server.SmartTCPServer_for_testing)]
added
removed
bzrlib/transport/remote.py
