83
79
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.
82
:param medium: The medium to use for this RemoteTransport. This must be
83
supplied if _from_transport is None.
91
85
:param _client: Override the _SmartClient used by this transport. This
92
86
should only be used for testing purposes; normally this is
93
87
determined from the medium.
95
super(RemoteTransport, self).__init__(
96
url, _from_transport=_from_transport)
89
super(RemoteTransport, self).__init__(url,
90
_from_transport=_from_transport)
98
92
# The medium is the connection, except when we need to share it with
99
93
# other objects (RemoteBzrDir, RemoteRepository etc). In these cases
100
94
# 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:
96
if _from_transport is None:
106
97
# If no _from_transport is specified, we need to intialize the
108
99
credentials = None
139
126
return None, None
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
128
def is_readonly(self):
150
129
"""Smart server transport can do read/write file operations."""
152
resp = self._call2('Transport.is_readonly')
153
except errors.UnknownSmartMethod:
130
resp = self._call2('Transport.is_readonly')
131
if resp == ('yes', ):
133
elif resp == ('no', ):
135
elif (resp == ('error', "Generic bzr smart protocol error: "
136
"bad request 'Transport.is_readonly'") or
137
resp == ('error', "Generic bzr smart protocol error: "
138
"bad request u'Transport.is_readonly'")):
154
139
# XXX: nasty hack: servers before 0.16 don't have a
155
140
# 'Transport.is_readonly' verb, so we do what clients before 0.16
156
141
# did: assume False.
158
if resp == ('yes', ):
160
elif resp == ('no', ):
163
raise errors.UnexpectedSmartServerResponse(resp)
144
self._translate_error(resp)
145
raise errors.UnexpectedSmartServerResponse(resp)
165
147
def get_smart_client(self):
166
148
return self._get_connection()
168
150
def get_smart_medium(self):
169
151
return self._get_connection()
153
@deprecated_method(one_four)
154
def get_shared_medium(self):
155
return self._get_shared_connection()
171
157
def _remote_path(self, relpath):
172
158
"""Returns the Unicode version of the absolute path for relpath."""
173
159
return self._combine_paths(self._path, relpath)
175
161
def _call(self, method, *args):
176
162
resp = self._call2(method, *args)
177
self._ensure_ok(resp)
163
self._translate_error(resp)
179
165
def _call2(self, method, *args):
180
166
"""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)
167
return self._client.call(method, *args)
191
169
def _call_with_body_bytes(self, method, args, body):
192
170
"""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)
171
return self._client.call_with_body_bytes(method, args, body)
203
173
def has(self, relpath):
204
174
"""Indicate whether a remote file of the given name exists or not.
211
181
elif resp == ('no', ):
214
raise errors.UnexpectedSmartServerResponse(resp)
184
self._translate_error(resp)
216
186
def get(self, relpath):
217
187
"""Return file-like object reading the contents of a remote file.
219
189
:see: Transport.get_bytes()/get_file()
221
191
return StringIO(self.get_bytes(relpath))
223
193
def get_bytes(self, relpath):
224
194
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)
195
request = self.get_smart_medium().get_request()
196
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
197
smart_protocol.call('get', remote)
198
resp = smart_protocol.read_response_tuple(True)
229
199
if resp != ('ok', ):
230
response_handler.cancel_read_body()
231
raise errors.UnexpectedSmartServerResponse(resp)
232
return response_handler.read_body_bytes()
200
smart_protocol.cancel_read_body()
201
self._translate_error(resp, relpath)
202
return smart_protocol.read_body_bytes()
234
204
def _serialise_optional_mode(self, mode):
330
301
offsets = list(offsets)
332
303
sorted_offsets = sorted(offsets)
304
# turn the list of offsets into a stack
305
offset_stack = iter(offsets)
306
cur_offset_and_size = offset_stack.next()
333
307
coalesced = list(self._coalesce_offsets(sorted_offsets,
334
308
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)))
309
fudge_factor=self._bytes_to_read_before_seek))
311
request = self.get_smart_medium().get_request()
312
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
313
smart_protocol.call_with_body_readv_array(
314
('readv', self._remote_path(relpath)),
315
[(c.start, c.length) for c in coalesced])
316
resp = smart_protocol.read_response_tuple(True)
318
if resp[0] != 'readv':
319
# This should raise an exception
320
smart_protocol.cancel_read_body()
321
self._translate_error(resp)
324
# FIXME: this should know how many bytes are needed, for clarity.
325
data = smart_protocol.read_body_bytes()
357
326
# 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
328
for c_offset in coalesced:
390
329
if len(data) < c_offset.length:
391
330
raise errors.ShortReadvError(relpath, c_offset.start,
392
331
c_offset.length, actual=len(data))
393
332
for suboffset, subsize in c_offset.ranges:
394
333
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
334
data_map[key] = data[suboffset:suboffset+subsize]
335
data = data[c_offset.length:]
411
337
# Now that we've read some data, see if we can yield anything back
412
338
while cur_offset_and_size in data_map:
413
339
this_data = data_map.pop(cur_offset_and_size)
414
340
yield cur_offset_and_size[0], this_data
415
cur_offset_and_size = next_offset[0] = offset_stack.next()
341
cur_offset_and_size = offset_stack.next()
417
343
def rename(self, rel_from, rel_to):
418
344
self._call('rename',
427
353
def rmdir(self, relpath):
428
354
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)
356
def _translate_error(self, resp, orig_path=None):
357
"""Raise an exception from a response"""
364
elif what == 'NoSuchFile':
365
if orig_path is not None:
366
error_path = orig_path
369
raise errors.NoSuchFile(error_path)
370
elif what == 'error':
371
raise errors.SmartProtocolError(unicode(resp[1]))
372
elif what == 'FileExists':
373
raise errors.FileExists(resp[1])
374
elif what == 'DirectoryNotEmpty':
375
raise errors.DirectoryNotEmpty(resp[1])
376
elif what == 'ShortReadvError':
377
raise errors.ShortReadvError(resp[1], int(resp[2]),
378
int(resp[3]), int(resp[4]))
379
elif what in ('UnicodeEncodeError', 'UnicodeDecodeError'):
380
encoding = str(resp[1]) # encoding must always be a string
384
reason = str(resp[5]) # reason must always be a string
385
if val.startswith('u:'):
386
val = val[2:].decode('utf-8')
387
elif val.startswith('s:'):
388
val = val[2:].decode('base64')
389
if what == 'UnicodeDecodeError':
390
raise UnicodeDecodeError(encoding, val, start, end, reason)
391
elif what == 'UnicodeEncodeError':
392
raise UnicodeEncodeError(encoding, val, start, end, reason)
393
elif what == "ReadOnlyError":
394
raise errors.TransportNotPossible('readonly transport')
395
elif what == "ReadError":
396
if orig_path is not None:
397
error_path = orig_path
400
raise errors.ReadError(error_path)
401
elif what == "PermissionDenied":
402
if orig_path is not None:
403
error_path = orig_path
406
raise errors.PermissionDenied(error_path)
408
raise errors.SmartProtocolError('unexpected smart server error: %r' % (resp,))
437
410
def disconnect(self):
438
411
self.get_smart_medium().disconnect()
413
def delete_tree(self, relpath):
414
raise errors.TransportNotPossible('readonly transport')
440
416
def stat(self, relpath):
441
417
resp = self._call2('stat', self._remote_path(relpath))
442
418
if resp[0] == 'stat':
443
419
return _SmartStat(int(resp[1]), int(resp[2], 8))
444
raise errors.UnexpectedSmartServerResponse(resp)
421
self._translate_error(resp)
446
423
## def lock_read(self, relpath):
447
424
## """Lock the given file for shared (read) access.
463
440
resp = self._call2('list_dir', self._remote_path(relpath))
464
441
if resp[0] == 'names':
465
442
return [name.encode('ascii') for name in resp[1:]]
466
raise errors.UnexpectedSmartServerResponse(resp)
444
self._translate_error(resp)
468
446
def iter_files_recursive(self):
469
447
resp = self._call2('iter_files_recursive', self._remote_path(''))
470
448
if resp[0] == 'names':
472
raise errors.UnexpectedSmartServerResponse(resp)
451
self._translate_error(resp)
475
454
class RemoteTCPTransport(RemoteTransport):
476
455
"""Connection to smart server over plain tcp.
478
457
This is essentially just a factory to get 'RemoteTransport(url,
479
458
SmartTCPClientMedium).
482
461
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
462
assert self.base.startswith('bzr://')
463
return medium.SmartTCPClientMedium(self._host, self._port), None
503
466
class RemoteSSHTransport(RemoteTransport):
510
473
def _build_medium(self):
474
assert self.base.startswith('bzr+ssh://')
475
# ssh will prompt the user for a password if needed and if none is
476
# provided but it will not give it back, so no credentials can be
511
478
location_config = config.LocationConfig(self.base)
512
479
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)
480
return medium.SmartSSHClientMedium(self._host, self._port,
481
self._user, self._password, bzr_remote_path=bzr_remote_path), None
523
484
class RemoteHTTPTransport(RemoteTransport):
524
485
"""Just a way to connect between a bzr+http:// url and http://.
526
487
This connection operates slightly differently than the RemoteSSHTransport.
527
488
It uses a plain http:// transport underneath, which defines what remote
528
489
.bzr/smart URL we are connected to. From there, all paths that are sent are
577
540
_from_transport=self,
578
541
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
544
def get_test_permutations():
601
545
"""Return (transport, server) permutations for testing."""
602
546
### We may need a little more test framework support to construct an
603
547
### appropriate RemoteTransport in the future.
604
from bzrlib.tests import test_server
605
return [(RemoteTCPTransport, test_server.SmartTCPServer_for_testing)]
548
from bzrlib.smart import server
549
return [(RemoteTCPTransport, server.SmartTCPServer_for_testing)]
added
removed
bzrlib/transport/remote.py
