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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
36
from bzrlib.smart import client, medium
37
from bzrlib.symbol_versioning import (
42
class _SmartStat(object):
44
def __init__(self, size, mode):
49
class RemoteTransport(transport.ConnectedTransport):
50
"""Connection to a smart server.
52
The connection holds references to the medium that can be used to send
53
requests to the server.
55
The connection has a notion of the current directory to which it's
56
connected; this is incorporated in filenames passed to the server.
58
This supports some higher-level RPC operations and can also be treated
59
like a Transport to do file-like operations.
61
The connection can be made over a tcp socket, an ssh pipe or a series of
62
http requests. There are concrete subclasses for each type:
63
RemoteTCPTransport, etc.
66
# When making a readv request, cap it at requesting 5MB of data
67
_max_readv_bytes = 5*1024*1024
69
# IMPORTANT FOR IMPLEMENTORS: RemoteTransport MUST NOT be given encoding
70
# responsibilities: Put those on SmartClient or similar. This is vital for
71
# the ability to support multiple versions of the smart protocol over time:
72
# RemoteTransport is an adapter from the Transport object model to the
73
# SmartClient model, not an encoder.
75
# FIXME: the medium parameter should be private, only the tests requires
76
# it. It may be even clearer to define a TestRemoteTransport that handles
77
# the specific cases of providing a _client and/or a _medium, and leave
78
# RemoteTransport as an abstract class.
79
def __init__(self, url, _from_transport=None, medium=None, _client=None):
82
:param _from_transport: Another RemoteTransport instance that this
83
one is being cloned from. Attributes such as the medium will
86
:param medium: The medium to use for this RemoteTransport. If None,
87
the medium from the _from_transport is shared. If both this
88
and _from_transport are None, a new medium will be built.
89
_from_transport and medium cannot both be specified.
91
:param _client: Override the _SmartClient used by this transport. This
92
should only be used for testing purposes; normally this is
93
determined from the medium.
95
super(RemoteTransport, self).__init__(
96
url, _from_transport=_from_transport)
98
# The medium is the connection, except when we need to share it with
99
# other objects (RemoteBzrDir, RemoteRepository etc). In these cases
100
# what we want to share is really the shared connection.
102
if (_from_transport is not None
103
and isinstance(_from_transport, RemoteTransport)):
104
_client = _from_transport._client
105
elif _from_transport is None:
106
# If no _from_transport is specified, we need to intialize the
110
medium, credentials = self._build_medium()
111
if 'hpss' in debug.debug_flags:
112
trace.mutter('hpss: Built a new medium: %s',
113
medium.__class__.__name__)
114
self._shared_connection = transport._SharedConnection(medium,
118
# No medium was specified, so share the medium from the
120
medium = self._shared_connection.connection
122
raise AssertionError(
123
"Both _from_transport (%r) and medium (%r) passed to "
124
"RemoteTransport.__init__, but these parameters are mutally "
125
"exclusive." % (_from_transport, medium))
128
self._client = client._SmartClient(medium)
130
self._client = _client
132
def _build_medium(self):
133
"""Create the medium if _from_transport does not provide one.
135
The medium is analogous to the connection for ConnectedTransport: it
136
allows connection sharing.
141
def _report_activity(self, bytes, direction):
142
"""See Transport._report_activity.
144
Does nothing; the smart medium will report activity triggered by a
149
def is_readonly(self):
150
"""Smart server transport can do read/write file operations."""
152
resp = self._call2('Transport.is_readonly')
153
except errors.UnknownSmartMethod:
154
# XXX: nasty hack: servers before 0.16 don't have a
155
# 'Transport.is_readonly' verb, so we do what clients before 0.16
158
if resp == ('yes', ):
160
elif resp == ('no', ):
163
raise errors.UnexpectedSmartServerResponse(resp)
165
def get_smart_client(self):
166
return self._get_connection()
168
def get_smart_medium(self):
169
return self._get_connection()
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._ensure_ok(resp)
179
def _call2(self, method, *args):
180
"""Call a method on the remote server."""
182
return self._client.call(method, *args)
183
except errors.ErrorFromSmartServer, err:
184
# The first argument, if present, is always a path.
186
context = {'relpath': args[0]}
189
self._translate_error(err, **context)
191
def _call_with_body_bytes(self, method, args, body):
192
"""Call a method on the remote server with body bytes."""
194
return self._client.call_with_body_bytes(method, args, body)
195
except errors.ErrorFromSmartServer, err:
196
# The first argument, if present, is always a path.
198
context = {'relpath': args[0]}
201
self._translate_error(err, **context)
203
def has(self, relpath):
204
"""Indicate whether a remote file of the given name exists or not.
206
:see: Transport.has()
208
resp = self._call2('has', self._remote_path(relpath))
209
if resp == ('yes', ):
211
elif resp == ('no', ):
214
raise errors.UnexpectedSmartServerResponse(resp)
216
def get(self, relpath):
217
"""Return file-like object reading the contents of a remote file.
219
:see: Transport.get_bytes()/get_file()
221
return StringIO(self.get_bytes(relpath))
223
def get_bytes(self, relpath):
224
remote = self._remote_path(relpath)
226
resp, response_handler = self._client.call_expecting_body('get', remote)
227
except errors.ErrorFromSmartServer, err:
228
self._translate_error(err, relpath)
230
response_handler.cancel_read_body()
231
raise errors.UnexpectedSmartServerResponse(resp)
232
return response_handler.read_body_bytes()
234
def _serialise_optional_mode(self, mode):
240
def mkdir(self, relpath, mode=None):
241
resp = self._call2('mkdir', self._remote_path(relpath),
242
self._serialise_optional_mode(mode))
244
def open_write_stream(self, relpath, mode=None):
245
"""See Transport.open_write_stream."""
246
self.put_bytes(relpath, "", mode)
247
result = transport.AppendBasedFileStream(self, relpath)
248
transport._file_streams[self.abspath(relpath)] = result
251
def put_bytes(self, relpath, upload_contents, mode=None):
252
# FIXME: upload_file is probably not safe for non-ascii characters -
253
# should probably just pass all parameters as length-delimited
255
if type(upload_contents) is unicode:
256
# Although not strictly correct, we raise UnicodeEncodeError to be
257
# compatible with other transports.
258
raise UnicodeEncodeError(
259
'undefined', upload_contents, 0, 1,
260
'put_bytes must be given bytes, not unicode.')
261
resp = self._call_with_body_bytes('put',
262
(self._remote_path(relpath), self._serialise_optional_mode(mode)),
264
self._ensure_ok(resp)
265
return len(upload_contents)
267
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
268
create_parent_dir=False,
270
"""See Transport.put_bytes_non_atomic."""
271
# FIXME: no encoding in the transport!
272
create_parent_str = 'F'
273
if create_parent_dir:
274
create_parent_str = 'T'
276
resp = self._call_with_body_bytes(
278
(self._remote_path(relpath), self._serialise_optional_mode(mode),
279
create_parent_str, self._serialise_optional_mode(dir_mode)),
281
self._ensure_ok(resp)
283
def put_file(self, relpath, upload_file, mode=None):
284
# its not ideal to seek back, but currently put_non_atomic_file depends
285
# on transports not reading before failing - which is a faulty
286
# assumption I think - RBC 20060915
287
pos = upload_file.tell()
289
return self.put_bytes(relpath, upload_file.read(), mode)
291
upload_file.seek(pos)
294
def put_file_non_atomic(self, relpath, f, mode=None,
295
create_parent_dir=False,
297
return self.put_bytes_non_atomic(relpath, f.read(), mode=mode,
298
create_parent_dir=create_parent_dir,
301
def append_file(self, relpath, from_file, mode=None):
302
return self.append_bytes(relpath, from_file.read(), mode)
304
def append_bytes(self, relpath, bytes, mode=None):
305
resp = self._call_with_body_bytes(
307
(self._remote_path(relpath), self._serialise_optional_mode(mode)),
309
if resp[0] == 'appended':
311
raise errors.UnexpectedSmartServerResponse(resp)
313
def delete(self, relpath):
314
resp = self._call2('delete', self._remote_path(relpath))
315
self._ensure_ok(resp)
317
def external_url(self):
318
"""See bzrlib.transport.Transport.external_url."""
319
# the external path for RemoteTransports is the base
322
def recommended_page_size(self):
323
"""Return the recommended page size for this transport."""
326
def _readv(self, relpath, offsets):
330
offsets = list(offsets)
332
sorted_offsets = sorted(offsets)
333
coalesced = list(self._coalesce_offsets(sorted_offsets,
334
limit=self._max_readv_combine,
335
fudge_factor=self._bytes_to_read_before_seek,
336
max_size=self._max_readv_bytes))
338
# now that we've coallesced things, avoid making enormous requests
343
if c.length + cur_len > self._max_readv_bytes:
344
requests.append(cur_request)
348
cur_request.append(c)
351
requests.append(cur_request)
352
if 'hpss' in debug.debug_flags:
353
trace.mutter('%s.readv %s offsets => %s coalesced'
354
' => %s requests (%s)',
355
self.__class__.__name__, len(offsets), len(coalesced),
356
len(requests), sum(map(len, requests)))
357
# Cache the results, but only until they have been fulfilled
359
# turn the list of offsets into a single stack to iterate
360
offset_stack = iter(offsets)
361
# using a list so it can be modified when passing down and coming back
362
next_offset = [offset_stack.next()]
363
for cur_request in requests:
365
result = self._client.call_with_body_readv_array(
366
('readv', self._remote_path(relpath),),
367
[(c.start, c.length) for c in cur_request])
368
resp, response_handler = result
369
except errors.ErrorFromSmartServer, err:
370
self._translate_error(err, relpath)
372
if resp[0] != 'readv':
373
# This should raise an exception
374
response_handler.cancel_read_body()
375
raise errors.UnexpectedSmartServerResponse(resp)
377
for res in self._handle_response(offset_stack, cur_request,
383
def _handle_response(self, offset_stack, coalesced, response_handler,
384
data_map, next_offset):
385
cur_offset_and_size = next_offset[0]
386
# FIXME: this should know how many bytes are needed, for clarity.
387
data = response_handler.read_body_bytes()
389
for c_offset in coalesced:
390
if len(data) < c_offset.length:
391
raise errors.ShortReadvError(relpath, c_offset.start,
392
c_offset.length, actual=len(data))
393
for suboffset, subsize in c_offset.ranges:
394
key = (c_offset.start+suboffset, subsize)
395
this_data = data[data_offset+suboffset:
396
data_offset+suboffset+subsize]
397
# Special case when the data is in-order, rather than packing
398
# into a map and then back out again. Benchmarking shows that
399
# this has 100% hit rate, but leave in the data_map work just
401
# TODO: Could we get away with using buffer() to avoid the
402
# memory copy? Callers would need to realize they may
403
# not have a real string.
404
if key == cur_offset_and_size:
405
yield cur_offset_and_size[0], this_data
406
cur_offset_and_size = next_offset[0] = offset_stack.next()
408
data_map[key] = this_data
409
data_offset += c_offset.length
411
# Now that we've read some data, see if we can yield anything back
412
while cur_offset_and_size in data_map:
413
this_data = data_map.pop(cur_offset_and_size)
414
yield cur_offset_and_size[0], this_data
415
cur_offset_and_size = next_offset[0] = offset_stack.next()
417
def rename(self, rel_from, rel_to):
419
self._remote_path(rel_from),
420
self._remote_path(rel_to))
422
def move(self, rel_from, rel_to):
424
self._remote_path(rel_from),
425
self._remote_path(rel_to))
427
def rmdir(self, relpath):
428
resp = self._call('rmdir', self._remote_path(relpath))
430
def _ensure_ok(self, resp):
432
raise errors.UnexpectedSmartServerResponse(resp)
434
def _translate_error(self, err, relpath=None):
435
remote._translate_error(err, path=relpath)
437
def disconnect(self):
438
self.get_smart_medium().disconnect()
440
def stat(self, relpath):
441
resp = self._call2('stat', self._remote_path(relpath))
442
if resp[0] == 'stat':
443
return _SmartStat(int(resp[1]), int(resp[2], 8))
444
raise errors.UnexpectedSmartServerResponse(resp)
446
## def lock_read(self, relpath):
447
## """Lock the given file for shared (read) access.
448
## :return: A lock object, which should be passed to Transport.unlock()
450
## # The old RemoteBranch ignore lock for reading, so we will
451
## # continue that tradition and return a bogus lock object.
452
## class BogusLock(object):
453
## def __init__(self, path):
457
## return BogusLock(relpath)
462
def list_dir(self, relpath):
463
resp = self._call2('list_dir', self._remote_path(relpath))
464
if resp[0] == 'names':
465
return [name.encode('ascii') for name in resp[1:]]
466
raise errors.UnexpectedSmartServerResponse(resp)
468
def iter_files_recursive(self):
469
resp = self._call2('iter_files_recursive', self._remote_path(''))
470
if resp[0] == 'names':
472
raise errors.UnexpectedSmartServerResponse(resp)
475
class RemoteTCPTransport(RemoteTransport):
476
"""Connection to smart server over plain tcp.
478
This is essentially just a factory to get 'RemoteTransport(url,
479
SmartTCPClientMedium).
482
def _build_medium(self):
483
client_medium = medium.SmartTCPClientMedium(
484
self._host, self._port, self.base)
485
return client_medium, None
488
class RemoteTCPTransportV2Only(RemoteTransport):
489
"""Connection to smart server over plain tcp with the client hard-coded to
490
assume protocol v2 and remote server version <= 1.6.
492
This should only be used for testing.
495
def _build_medium(self):
496
client_medium = medium.SmartTCPClientMedium(
497
self._host, self._port, self.base)
498
client_medium._protocol_version = 2
499
client_medium._remember_remote_is_before((1, 6))
500
return client_medium, None
503
class RemoteSSHTransport(RemoteTransport):
504
"""Connection to smart server over SSH.
506
This is essentially just a factory to get 'RemoteTransport(url,
507
SmartSSHClientMedium).
510
def _build_medium(self):
511
location_config = config.LocationConfig(self.base)
512
bzr_remote_path = location_config.get_bzr_remote_path()
515
auth = config.AuthenticationConfig()
516
user = auth.get_user('ssh', self._host, self._port)
517
client_medium = medium.SmartSSHClientMedium(self._host, self._port,
518
user, self._password, self.base,
519
bzr_remote_path=bzr_remote_path)
520
return client_medium, (user, self._password)
523
class RemoteHTTPTransport(RemoteTransport):
524
"""Just a way to connect between a bzr+http:// url and http://.
526
This connection operates slightly differently than the RemoteSSHTransport.
527
It uses a plain http:// transport underneath, which defines what remote
528
.bzr/smart URL we are connected to. From there, all paths that are sent are
529
sent as relative paths, this way, the remote side can properly
530
de-reference them, since it is likely doing rewrite rules to translate an
531
HTTP path into a local path.
534
def __init__(self, base, _from_transport=None, http_transport=None):
535
if http_transport is None:
536
# FIXME: the password may be lost here because it appears in the
537
# url only for an intial construction (when the url came from the
539
http_url = base[len('bzr+'):]
540
self._http_transport = transport.get_transport(http_url)
542
self._http_transport = http_transport
543
super(RemoteHTTPTransport, self).__init__(
544
base, _from_transport=_from_transport)
546
def _build_medium(self):
547
# We let http_transport take care of the credentials
548
return self._http_transport.get_smart_medium(), None
550
def _remote_path(self, relpath):
551
"""After connecting, HTTP Transport only deals in relative URLs."""
552
# Adjust the relpath based on which URL this smart transport is
554
http_base = urlutils.normalize_url(self.get_smart_medium().base)
555
url = urlutils.join(self.base[len('bzr+'):], relpath)
556
url = urlutils.normalize_url(url)
557
return urlutils.relative_url(http_base, url)
559
def clone(self, relative_url):
560
"""Make a new RemoteHTTPTransport related to me.
562
This is re-implemented rather than using the default
563
RemoteTransport.clone() because we must be careful about the underlying
566
Also, the cloned smart transport will POST to the same .bzr/smart
567
location as this transport (although obviously the relative paths in the
568
smart requests may be different). This is so that the server doesn't
569
have to handle .bzr/smart requests at arbitrary places inside .bzr
570
directories, just at the initial URL the user uses.
573
abs_url = self.abspath(relative_url)
576
return RemoteHTTPTransport(abs_url,
577
_from_transport=self,
578
http_transport=self._http_transport)
580
def _redirected_to(self, source, target):
581
"""See transport._redirected_to"""
582
redirected = self._http_transport._redirected_to(source, target)
583
if (redirected is not None
584
and isinstance(redirected, type(self._http_transport))):
585
return RemoteHTTPTransport('bzr+' + redirected.external_url(),
586
http_transport=redirected)
588
# Either None or a transport for a different protocol
592
class HintingSSHTransport(transport.Transport):
593
"""Simple transport that handles ssh:// and points out bzr+ssh://."""
595
def __init__(self, url):
596
raise errors.UnsupportedProtocol(url,
597
'bzr supports bzr+ssh to operate over ssh, use "bzr+%s".' % url)
600
def get_test_permutations():
601
"""Return (transport, server) permutations for testing."""
602
### We may need a little more test framework support to construct an
603
### appropriate RemoteTransport in the future.
604
from bzrlib.smart import server
605
return [(RemoteTCPTransport, server.SmartTCPServer_for_testing)]
added
removed
bzrlib/transport/remote.py
