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
35
from bzrlib.smart import client, medium
36
from bzrlib.symbol_versioning import (deprecated_method, one_four)
39
class _SmartStat(object):
41
def __init__(self, size, mode):
46
class RemoteTransport(transport.ConnectedTransport):
47
"""Connection to a smart server.
49
The connection holds references to the medium that can be used to send
50
requests to the server.
52
The connection has a notion of the current directory to which it's
53
connected; this is incorporated in filenames passed to the server.
55
This supports some higher-level RPC operations and can also be treated
56
like a Transport to do file-like operations.
58
The connection can be made over a tcp socket, an ssh pipe or a series of
59
http requests. There are concrete subclasses for each type:
60
RemoteTCPTransport, etc.
63
# IMPORTANT FOR IMPLEMENTORS: RemoteTransport MUST NOT be given encoding
64
# responsibilities: Put those on SmartClient or similar. This is vital for
65
# the ability to support multiple versions of the smart protocol over time:
66
# RemoteTransport is an adapter from the Transport object model to the
67
# SmartClient model, not an encoder.
69
# FIXME: the medium parameter should be private, only the tests requires
70
# it. It may be even clearer to define a TestRemoteTransport that handles
71
# the specific cases of providing a _client and/or a _medium, and leave
72
# RemoteTransport as an abstract class.
73
def __init__(self, url, _from_transport=None, medium=None, _client=None):
76
:param _from_transport: Another RemoteTransport instance that this
77
one is being cloned from. Attributes such as the medium will
80
:param medium: The medium to use for this RemoteTransport. If None,
81
the medium from the _from_transport is shared. If both this
82
and _from_transport are None, a new medium will be built.
83
_from_transport and medium cannot both be specified.
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
super(RemoteTransport, self).__init__(url,
90
_from_transport=_from_transport)
92
# The medium is the connection, except when we need to share it with
93
# other objects (RemoteBzrDir, RemoteRepository etc). In these cases
94
# what we want to share is really the shared connection.
96
if _from_transport is None:
97
# If no _from_transport is specified, we need to intialize the
101
medium, credentials = self._build_medium()
102
if 'hpss' in debug.debug_flags:
103
trace.mutter('hpss: Built a new medium: %s',
104
medium.__class__.__name__)
105
self._shared_connection = transport._SharedConnection(medium,
109
# No medium was specified, so share the medium from the
111
medium = self._shared_connection.connection
113
raise AssertionError(
114
"Both _from_transport (%r) and medium (%r) passed to "
115
"RemoteTransport.__init__, but these parameters are mutally "
116
"exclusive." % (_from_transport, medium))
119
self._client = client._SmartClient(medium)
121
self._client = _client
123
def _build_medium(self):
124
"""Create the medium if _from_transport does not provide one.
126
The medium is analogous to the connection for ConnectedTransport: it
127
allows connection sharing.
132
def is_readonly(self):
133
"""Smart server transport can do read/write file operations."""
135
resp = self._call2('Transport.is_readonly')
136
except errors.UnknownSmartMethod:
137
# XXX: nasty hack: servers before 0.16 don't have a
138
# 'Transport.is_readonly' verb, so we do what clients before 0.16
141
if resp == ('yes', ):
143
elif resp == ('no', ):
146
self._translate_error(resp)
147
raise errors.UnexpectedSmartServerResponse(resp)
149
def get_smart_client(self):
150
return self._get_connection()
152
def get_smart_medium(self):
153
return self._get_connection()
155
@deprecated_method(one_four)
156
def get_shared_medium(self):
157
return self._get_shared_connection()
159
def _remote_path(self, relpath):
160
"""Returns the Unicode version of the absolute path for relpath."""
161
return self._combine_paths(self._path, relpath)
163
def _call(self, method, *args):
165
resp = self._call2(method, *args)
166
except errors.ErrorFromSmartServer, err:
167
self._translate_error(err.error_tuple)
168
self._translate_error(resp)
170
def _call2(self, method, *args):
171
"""Call a method on the remote server."""
173
return self._client.call(method, *args)
174
except errors.ErrorFromSmartServer, err:
175
self._translate_error(err.error_tuple)
177
def _call_with_body_bytes(self, method, args, body):
178
"""Call a method on the remote server with body bytes."""
180
return self._client.call_with_body_bytes(method, args, body)
181
except errors.ErrorFromSmartServer, err:
182
self._translate_error(err.error_tuple)
184
def has(self, relpath):
185
"""Indicate whether a remote file of the given name exists or not.
187
:see: Transport.has()
189
resp = self._call2('has', self._remote_path(relpath))
190
if resp == ('yes', ):
192
elif resp == ('no', ):
195
self._translate_error(resp)
197
def get(self, relpath):
198
"""Return file-like object reading the contents of a remote file.
200
:see: Transport.get_bytes()/get_file()
202
return StringIO(self.get_bytes(relpath))
204
def get_bytes(self, relpath):
205
remote = self._remote_path(relpath)
207
resp, response_handler = self._client.call_expecting_body('get', remote)
208
except errors.ErrorFromSmartServer, err:
209
self._translate_error(err.error_tuple, relpath)
211
response_handler.cancel_read_body()
212
raise errors.UnexpectedSmartServerResponse(resp)
213
return response_handler.read_body_bytes()
215
def _serialise_optional_mode(self, mode):
221
def mkdir(self, relpath, mode=None):
222
resp = self._call2('mkdir', self._remote_path(relpath),
223
self._serialise_optional_mode(mode))
224
self._translate_error(resp)
226
def open_write_stream(self, relpath, mode=None):
227
"""See Transport.open_write_stream."""
228
self.put_bytes(relpath, "", mode)
229
result = transport.AppendBasedFileStream(self, relpath)
230
transport._file_streams[self.abspath(relpath)] = result
233
def put_bytes(self, relpath, upload_contents, mode=None):
234
# FIXME: upload_file is probably not safe for non-ascii characters -
235
# should probably just pass all parameters as length-delimited
237
if type(upload_contents) is unicode:
238
# Although not strictly correct, we raise UnicodeEncodeError to be
239
# compatible with other transports.
240
raise UnicodeEncodeError(
241
'undefined', upload_contents, 0, 1,
242
'put_bytes must be given bytes, not unicode.')
243
resp = self._call_with_body_bytes('put',
244
(self._remote_path(relpath), self._serialise_optional_mode(mode)),
246
self._translate_error(resp)
247
return len(upload_contents)
249
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
250
create_parent_dir=False,
252
"""See Transport.put_bytes_non_atomic."""
253
# FIXME: no encoding in the transport!
254
create_parent_str = 'F'
255
if create_parent_dir:
256
create_parent_str = 'T'
258
resp = self._call_with_body_bytes(
260
(self._remote_path(relpath), self._serialise_optional_mode(mode),
261
create_parent_str, self._serialise_optional_mode(dir_mode)),
263
self._translate_error(resp)
265
def put_file(self, relpath, upload_file, mode=None):
266
# its not ideal to seek back, but currently put_non_atomic_file depends
267
# on transports not reading before failing - which is a faulty
268
# assumption I think - RBC 20060915
269
pos = upload_file.tell()
271
return self.put_bytes(relpath, upload_file.read(), mode)
273
upload_file.seek(pos)
276
def put_file_non_atomic(self, relpath, f, mode=None,
277
create_parent_dir=False,
279
return self.put_bytes_non_atomic(relpath, f.read(), mode=mode,
280
create_parent_dir=create_parent_dir,
283
def append_file(self, relpath, from_file, mode=None):
284
return self.append_bytes(relpath, from_file.read(), mode)
286
def append_bytes(self, relpath, bytes, mode=None):
287
resp = self._call_with_body_bytes(
289
(self._remote_path(relpath), self._serialise_optional_mode(mode)),
291
if resp[0] == 'appended':
293
self._translate_error(resp)
295
def delete(self, relpath):
296
resp = self._call2('delete', self._remote_path(relpath))
297
self._translate_error(resp)
299
def external_url(self):
300
"""See bzrlib.transport.Transport.external_url."""
301
# the external path for RemoteTransports is the base
304
def recommended_page_size(self):
305
"""Return the recommended page size for this transport."""
308
def _readv(self, relpath, offsets):
312
offsets = list(offsets)
314
sorted_offsets = sorted(offsets)
315
# turn the list of offsets into a stack
316
offset_stack = iter(offsets)
317
cur_offset_and_size = offset_stack.next()
318
coalesced = list(self._coalesce_offsets(sorted_offsets,
319
limit=self._max_readv_combine,
320
fudge_factor=self._bytes_to_read_before_seek))
323
result = self._client.call_with_body_readv_array(
324
('readv', self._remote_path(relpath),),
325
[(c.start, c.length) for c in coalesced])
326
resp, response_handler = result
327
except errors.ErrorFromSmartServer, err:
328
self._translate_error(err.error_tuple)
330
if resp[0] != 'readv':
331
# This should raise an exception
332
response_handler.cancel_read_body()
333
raise errors.UnexpectedSmartServerResponse(resp)
335
# FIXME: this should know how many bytes are needed, for clarity.
336
data = response_handler.read_body_bytes()
337
# Cache the results, but only until they have been fulfilled
339
for c_offset in coalesced:
340
if len(data) < c_offset.length:
341
raise errors.ShortReadvError(relpath, c_offset.start,
342
c_offset.length, actual=len(data))
343
for suboffset, subsize in c_offset.ranges:
344
key = (c_offset.start+suboffset, subsize)
345
data_map[key] = data[suboffset:suboffset+subsize]
346
data = data[c_offset.length:]
348
# Now that we've read some data, see if we can yield anything back
349
while cur_offset_and_size in data_map:
350
this_data = data_map.pop(cur_offset_and_size)
351
yield cur_offset_and_size[0], this_data
352
cur_offset_and_size = offset_stack.next()
354
def rename(self, rel_from, rel_to):
356
self._remote_path(rel_from),
357
self._remote_path(rel_to))
359
def move(self, rel_from, rel_to):
361
self._remote_path(rel_from),
362
self._remote_path(rel_to))
364
def rmdir(self, relpath):
365
resp = self._call('rmdir', self._remote_path(relpath))
367
def _translate_error(self, resp, orig_path=None):
368
"""Raise an exception from a response"""
375
elif what == 'NoSuchFile':
376
if orig_path is not None:
377
error_path = orig_path
380
raise errors.NoSuchFile(error_path)
381
elif what == 'error':
382
raise errors.SmartProtocolError(unicode(resp[1]))
383
elif what == 'FileExists':
384
raise errors.FileExists(resp[1])
385
elif what == 'DirectoryNotEmpty':
386
raise errors.DirectoryNotEmpty(resp[1])
387
elif what == 'ShortReadvError':
388
raise errors.ShortReadvError(resp[1], int(resp[2]),
389
int(resp[3]), int(resp[4]))
390
elif what in ('UnicodeEncodeError', 'UnicodeDecodeError'):
391
encoding = str(resp[1]) # encoding must always be a string
395
reason = str(resp[5]) # reason must always be a string
396
if val.startswith('u:'):
397
val = val[2:].decode('utf-8')
398
elif val.startswith('s:'):
399
val = val[2:].decode('base64')
400
if what == 'UnicodeDecodeError':
401
raise UnicodeDecodeError(encoding, val, start, end, reason)
402
elif what == 'UnicodeEncodeError':
403
raise UnicodeEncodeError(encoding, val, start, end, reason)
404
elif what == "ReadOnlyError":
405
raise errors.TransportNotPossible('readonly transport')
406
elif what == "ReadError":
407
if orig_path is not None:
408
error_path = orig_path
411
raise errors.ReadError(error_path)
412
elif what == "PermissionDenied":
413
if orig_path is not None:
414
error_path = orig_path
417
raise errors.PermissionDenied(error_path)
419
raise errors.SmartProtocolError('unexpected smart server error: %r' % (resp,))
421
def disconnect(self):
422
self.get_smart_medium().disconnect()
424
def stat(self, relpath):
425
resp = self._call2('stat', self._remote_path(relpath))
426
if resp[0] == 'stat':
427
return _SmartStat(int(resp[1]), int(resp[2], 8))
429
self._translate_error(resp)
431
## def lock_read(self, relpath):
432
## """Lock the given file for shared (read) access.
433
## :return: A lock object, which should be passed to Transport.unlock()
435
## # The old RemoteBranch ignore lock for reading, so we will
436
## # continue that tradition and return a bogus lock object.
437
## class BogusLock(object):
438
## def __init__(self, path):
442
## return BogusLock(relpath)
447
def list_dir(self, relpath):
448
resp = self._call2('list_dir', self._remote_path(relpath))
449
if resp[0] == 'names':
450
return [name.encode('ascii') for name in resp[1:]]
452
self._translate_error(resp)
454
def iter_files_recursive(self):
455
resp = self._call2('iter_files_recursive', self._remote_path(''))
456
if resp[0] == 'names':
459
self._translate_error(resp)
462
class RemoteTCPTransport(RemoteTransport):
463
"""Connection to smart server over plain tcp.
465
This is essentially just a factory to get 'RemoteTransport(url,
466
SmartTCPClientMedium).
469
def _build_medium(self):
470
client_medium = medium.SmartTCPClientMedium(
471
self._host, self._port, self.base)
472
return client_medium, None
475
class RemoteTCPTransportV2Only(RemoteTransport):
476
"""Connection to smart server over plain tcp with the client hard-coded to
477
assume protocol v2 and remote server version <= 1.6.
479
This should only be used for testing.
482
def _build_medium(self):
483
client_medium = medium.SmartTCPClientMedium(
484
self._host, self._port, self.base)
485
client_medium._protocol_version = 2
486
client_medium._remember_remote_is_before((1, 6))
487
return client_medium, None
490
class RemoteSSHTransport(RemoteTransport):
491
"""Connection to smart server over SSH.
493
This is essentially just a factory to get 'RemoteTransport(url,
494
SmartSSHClientMedium).
497
def _build_medium(self):
498
# ssh will prompt the user for a password if needed and if none is
499
# provided but it will not give it back, so no credentials can be
501
location_config = config.LocationConfig(self.base)
502
bzr_remote_path = location_config.get_bzr_remote_path()
503
client_medium = medium.SmartSSHClientMedium(self._host, self._port,
504
self._user, self._password, self.base,
505
bzr_remote_path=bzr_remote_path)
506
return client_medium, None
509
class RemoteHTTPTransport(RemoteTransport):
510
"""Just a way to connect between a bzr+http:// url and http://.
512
This connection operates slightly differently than the RemoteSSHTransport.
513
It uses a plain http:// transport underneath, which defines what remote
514
.bzr/smart URL we are connected to. From there, all paths that are sent are
515
sent as relative paths, this way, the remote side can properly
516
de-reference them, since it is likely doing rewrite rules to translate an
517
HTTP path into a local path.
520
def __init__(self, base, _from_transport=None, http_transport=None):
521
if http_transport is None:
522
# FIXME: the password may be lost here because it appears in the
523
# url only for an intial construction (when the url came from the
525
http_url = base[len('bzr+'):]
526
self._http_transport = transport.get_transport(http_url)
528
self._http_transport = http_transport
529
super(RemoteHTTPTransport, self).__init__(
530
base, _from_transport=_from_transport)
532
def _build_medium(self):
533
# We let http_transport take care of the credentials
534
return self._http_transport.get_smart_medium(), None
536
def _remote_path(self, relpath):
537
"""After connecting, HTTP Transport only deals in relative URLs."""
538
# Adjust the relpath based on which URL this smart transport is
540
http_base = urlutils.normalize_url(self.get_smart_medium().base)
541
url = urlutils.join(self.base[len('bzr+'):], relpath)
542
url = urlutils.normalize_url(url)
543
return urlutils.relative_url(http_base, url)
545
def clone(self, relative_url):
546
"""Make a new RemoteHTTPTransport related to me.
548
This is re-implemented rather than using the default
549
RemoteTransport.clone() because we must be careful about the underlying
552
Also, the cloned smart transport will POST to the same .bzr/smart
553
location as this transport (although obviously the relative paths in the
554
smart requests may be different). This is so that the server doesn't
555
have to handle .bzr/smart requests at arbitrary places inside .bzr
556
directories, just at the initial URL the user uses.
559
abs_url = self.abspath(relative_url)
562
return RemoteHTTPTransport(abs_url,
563
_from_transport=self,
564
http_transport=self._http_transport)
567
def get_test_permutations():
568
"""Return (transport, server) permutations for testing."""
569
### We may need a little more test framework support to construct an
570
### appropriate RemoteTransport in the future.
571
from bzrlib.smart import server
572
return [(RemoteTCPTransport, server.SmartTCPServer_for_testing)]
added
removed
bzrlib/transport/remote.py
