83
78
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.
81
:param medium: The medium to use for this RemoteTransport. This must be
82
supplied if _from_transport is None.
91
84
:param _client: Override the _SmartClient used by this transport. This
92
85
should only be used for testing purposes; normally this is
93
86
determined from the medium.
95
super(RemoteTransport, self).__init__(
96
url, _from_transport=_from_transport)
88
super(RemoteTransport, self).__init__(url,
89
_from_transport=_from_transport)
98
91
# The medium is the connection, except when we need to share it with
99
92
# other objects (RemoteBzrDir, RemoteRepository etc). In these cases
100
93
# 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:
95
if _from_transport is None:
106
96
# If no _from_transport is specified, we need to intialize the
108
98
credentials = None
139
119
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
121
def is_readonly(self):
150
122
"""Smart server transport can do read/write file operations."""
152
resp = self._call2('Transport.is_readonly')
153
except errors.UnknownSmartMethod:
123
resp = self._call2('Transport.is_readonly')
124
if resp == ('yes', ):
126
elif resp == ('no', ):
128
elif (resp == ('error', "Generic bzr smart protocol error: "
129
"bad request 'Transport.is_readonly'") or
130
resp == ('error', "Generic bzr smart protocol error: "
131
"bad request u'Transport.is_readonly'")):
154
132
# XXX: nasty hack: servers before 0.16 don't have a
155
133
# 'Transport.is_readonly' verb, so we do what clients before 0.16
156
134
# did: assume False.
158
if resp == ('yes', ):
160
elif resp == ('no', ):
163
raise errors.UnexpectedSmartServerResponse(resp)
137
self._translate_error(resp)
138
raise errors.UnexpectedSmartServerResponse(resp)
165
140
def get_smart_client(self):
166
141
return self._get_connection()
168
143
def get_smart_medium(self):
169
144
return self._get_connection()
146
def get_shared_medium(self):
147
return self._get_shared_connection()
171
149
def _remote_path(self, relpath):
172
150
"""Returns the Unicode version of the absolute path for relpath."""
173
151
return self._combine_paths(self._path, relpath)
175
153
def _call(self, method, *args):
176
154
resp = self._call2(method, *args)
177
self._ensure_ok(resp)
155
self._translate_error(resp)
179
157
def _call2(self, method, *args):
180
158
"""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)
159
return self._client.call(method, *args)
191
161
def _call_with_body_bytes(self, method, args, body):
192
162
"""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)
163
return self._client.call_with_body_bytes(method, args, body)
203
165
def has(self, relpath):
204
166
"""Indicate whether a remote file of the given name exists or not.
211
173
elif resp == ('no', ):
214
raise errors.UnexpectedSmartServerResponse(resp)
176
self._translate_error(resp)
216
178
def get(self, relpath):
217
179
"""Return file-like object reading the contents of a remote file.
219
181
:see: Transport.get_bytes()/get_file()
221
183
return StringIO(self.get_bytes(relpath))
223
185
def get_bytes(self, relpath):
224
186
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)
187
request = self.get_smart_medium().get_request()
188
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
189
smart_protocol.call('get', remote)
190
resp = smart_protocol.read_response_tuple(True)
229
191
if resp != ('ok', ):
230
response_handler.cancel_read_body()
231
raise errors.UnexpectedSmartServerResponse(resp)
232
return response_handler.read_body_bytes()
192
smart_protocol.cancel_read_body()
193
self._translate_error(resp, relpath)
194
return smart_protocol.read_body_bytes()
234
196
def _serialise_optional_mode(self, mode):
330
289
offsets = list(offsets)
332
291
sorted_offsets = sorted(offsets)
292
# turn the list of offsets into a stack
293
offset_stack = iter(offsets)
294
cur_offset_and_size = offset_stack.next()
333
295
coalesced = list(self._coalesce_offsets(sorted_offsets,
334
296
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)))
297
fudge_factor=self._bytes_to_read_before_seek))
299
request = self.get_smart_medium().get_request()
300
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
301
smart_protocol.call_with_body_readv_array(
302
('readv', self._remote_path(relpath)),
303
[(c.start, c.length) for c in coalesced])
304
resp = smart_protocol.read_response_tuple(True)
306
if resp[0] != 'readv':
307
# This should raise an exception
308
smart_protocol.cancel_read_body()
309
self._translate_error(resp)
312
# FIXME: this should know how many bytes are needed, for clarity.
313
data = smart_protocol.read_body_bytes()
357
314
# 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
316
for c_offset in coalesced:
390
317
if len(data) < c_offset.length:
391
318
raise errors.ShortReadvError(relpath, c_offset.start,
392
319
c_offset.length, actual=len(data))
393
320
for suboffset, subsize in c_offset.ranges:
394
321
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
322
data_map[key] = data[suboffset:suboffset+subsize]
323
data = data[c_offset.length:]
411
325
# Now that we've read some data, see if we can yield anything back
412
326
while cur_offset_and_size in data_map:
413
327
this_data = data_map.pop(cur_offset_and_size)
414
328
yield cur_offset_and_size[0], this_data
415
cur_offset_and_size = next_offset[0] = offset_stack.next()
329
cur_offset_and_size = offset_stack.next()
417
331
def rename(self, rel_from, rel_to):
418
332
self._call('rename',
427
341
def rmdir(self, relpath):
428
342
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)
344
def _translate_error(self, resp, orig_path=None):
345
"""Raise an exception from a response"""
352
elif what == 'NoSuchFile':
353
if orig_path is not None:
354
error_path = orig_path
357
raise errors.NoSuchFile(error_path)
358
elif what == 'error':
359
raise errors.SmartProtocolError(unicode(resp[1]))
360
elif what == 'FileExists':
361
raise errors.FileExists(resp[1])
362
elif what == 'DirectoryNotEmpty':
363
raise errors.DirectoryNotEmpty(resp[1])
364
elif what == 'ShortReadvError':
365
raise errors.ShortReadvError(resp[1], int(resp[2]),
366
int(resp[3]), int(resp[4]))
367
elif what in ('UnicodeEncodeError', 'UnicodeDecodeError'):
368
encoding = str(resp[1]) # encoding must always be a string
372
reason = str(resp[5]) # reason must always be a string
373
if val.startswith('u:'):
374
val = val[2:].decode('utf-8')
375
elif val.startswith('s:'):
376
val = val[2:].decode('base64')
377
if what == 'UnicodeDecodeError':
378
raise UnicodeDecodeError(encoding, val, start, end, reason)
379
elif what == 'UnicodeEncodeError':
380
raise UnicodeEncodeError(encoding, val, start, end, reason)
381
elif what == "ReadOnlyError":
382
raise errors.TransportNotPossible('readonly transport')
383
elif what == "ReadError":
384
if orig_path is not None:
385
error_path = orig_path
388
raise errors.ReadError(error_path)
390
raise errors.SmartProtocolError('unexpected smart server error: %r' % (resp,))
437
392
def disconnect(self):
438
393
self.get_smart_medium().disconnect()
395
def delete_tree(self, relpath):
396
raise errors.TransportNotPossible('readonly transport')
440
398
def stat(self, relpath):
441
399
resp = self._call2('stat', self._remote_path(relpath))
442
400
if resp[0] == 'stat':
443
401
return _SmartStat(int(resp[1]), int(resp[2], 8))
444
raise errors.UnexpectedSmartServerResponse(resp)
403
self._translate_error(resp)
446
405
## def lock_read(self, relpath):
447
406
## """Lock the given file for shared (read) access.
463
422
resp = self._call2('list_dir', self._remote_path(relpath))
464
423
if resp[0] == 'names':
465
424
return [name.encode('ascii') for name in resp[1:]]
466
raise errors.UnexpectedSmartServerResponse(resp)
426
self._translate_error(resp)
468
428
def iter_files_recursive(self):
469
429
resp = self._call2('iter_files_recursive', self._remote_path(''))
470
430
if resp[0] == 'names':
472
raise errors.UnexpectedSmartServerResponse(resp)
433
self._translate_error(resp)
475
436
class RemoteTCPTransport(RemoteTransport):
476
437
"""Connection to smart server over plain tcp.
478
439
This is essentially just a factory to get 'RemoteTransport(url,
479
440
SmartTCPClientMedium).
482
443
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
444
assert self.base.startswith('bzr://')
445
return medium.SmartTCPClientMedium(self._host, self._port), None
503
448
class RemoteSSHTransport(RemoteTransport):
510
455
def _build_medium(self):
456
assert self.base.startswith('bzr+ssh://')
457
# ssh will prompt the user for a password if needed and if none is
458
# provided but it will not give it back, so no credentials can be
511
460
location_config = config.LocationConfig(self.base)
512
461
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)
462
return medium.SmartSSHClientMedium(self._host, self._port,
463
self._user, self._password, bzr_remote_path=bzr_remote_path), None
523
466
class RemoteHTTPTransport(RemoteTransport):
524
467
"""Just a way to connect between a bzr+http:// url and http://.
526
469
This connection operates slightly differently than the RemoteSSHTransport.
527
470
It uses a plain http:// transport underneath, which defines what remote
528
471
.bzr/smart URL we are connected to. From there, all paths that are sent are
568
513
smart requests may be different). This is so that the server doesn't
569
514
have to handle .bzr/smart requests at arbitrary places inside .bzr
570
515
directories, just at the initial URL the user uses.
517
The exception is parent paths (i.e. relative_url of "..").
573
520
abs_url = self.abspath(relative_url)
575
522
abs_url = self.base
523
# We either use the exact same http_transport (for child locations), or
524
# a clone of the underlying http_transport (for parent locations). This
525
# means we share the connection.
526
norm_base = urlutils.normalize_url(self.base)
527
norm_abs_url = urlutils.normalize_url(abs_url)
528
normalized_rel_url = urlutils.relative_url(norm_base, norm_abs_url)
529
if normalized_rel_url == ".." or normalized_rel_url.startswith("../"):
530
http_transport = self._http_transport.clone(normalized_rel_url)
532
http_transport = self._http_transport
576
533
return RemoteHTTPTransport(abs_url,
577
534
_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)
535
http_transport=http_transport)
600
538
def get_test_permutations():
601
539
"""Return (transport, server) permutations for testing."""
602
540
### We may need a little more test framework support to construct an
603
541
### appropriate RemoteTransport in the future.
604
from bzrlib.tests import test_server
605
return [(RemoteTCPTransport, test_server.SmartTCPServer_for_testing)]
542
from bzrlib.smart import server
543
return [(RemoteTCPTransport, server.SmartTCPServer_for_testing)]
added
removed
bzrlib/transport/remote.py
