31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
31
38
from bzrlib import (
36
from bzrlib.smart.protocol import (
38
SmartServerRequestProtocolOne,
39
SmartServerRequestProtocolTwo,
46
from bzrlib.smart import client, protocol, request, vfs
41
47
from bzrlib.transport import ssh
44
class SmartServerStreamMedium(object):
49
from bzrlib import osutils
51
# Throughout this module buffer size parameters are either limited to be at
52
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
53
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
54
# from non-sockets as well.
55
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
57
def _get_protocol_factory_for_bytes(bytes):
58
"""Determine the right protocol factory for 'bytes'.
60
This will return an appropriate protocol factory depending on the version
61
of the protocol being used, as determined by inspecting the given bytes.
62
The bytes should have at least one newline byte (i.e. be a whole line),
63
otherwise it's possible that a request will be incorrectly identified as
66
Typical use would be::
68
factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
69
server_protocol = factory(transport, write_func, root_client_path)
70
server_protocol.accept_bytes(unused_bytes)
72
:param bytes: a str of bytes of the start of the request.
73
:returns: 2-tuple of (protocol_factory, unused_bytes). protocol_factory is
74
a callable that takes three args: transport, write_func,
75
root_client_path. unused_bytes are any bytes that were not part of a
76
protocol version marker.
78
if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
79
protocol_factory = protocol.build_server_protocol_three
80
bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
81
elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
82
protocol_factory = protocol.SmartServerRequestProtocolTwo
83
bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
85
protocol_factory = protocol.SmartServerRequestProtocolOne
86
return protocol_factory, bytes
89
def _get_line(read_bytes_func):
90
"""Read bytes using read_bytes_func until a newline byte.
92
This isn't particularly efficient, so should only be used when the
93
expected size of the line is quite short.
95
:returns: a tuple of two strs: (line, excess)
99
while newline_pos == -1:
100
new_bytes = read_bytes_func(1)
103
# Ran out of bytes before receiving a complete line.
105
newline_pos = bytes.find('\n')
106
line = bytes[:newline_pos+1]
107
excess = bytes[newline_pos+1:]
111
class SmartMedium(object):
112
"""Base class for smart protocol media, both client- and server-side."""
115
self._push_back_buffer = None
117
def _push_back(self, bytes):
118
"""Return unused bytes to the medium, because they belong to the next
121
This sets the _push_back_buffer to the given bytes.
123
if self._push_back_buffer is not None:
124
raise AssertionError(
125
"_push_back called when self._push_back_buffer is %r"
126
% (self._push_back_buffer,))
129
self._push_back_buffer = bytes
131
def _get_push_back_buffer(self):
132
if self._push_back_buffer == '':
133
raise AssertionError(
134
'%s._push_back_buffer should never be the empty string, '
135
'which can be confused with EOF' % (self,))
136
bytes = self._push_back_buffer
137
self._push_back_buffer = None
140
def read_bytes(self, desired_count):
141
"""Read some bytes from this medium.
143
:returns: some bytes, possibly more or less than the number requested
144
in 'desired_count' depending on the medium.
146
if self._push_back_buffer is not None:
147
return self._get_push_back_buffer()
148
bytes_to_read = min(desired_count, _MAX_READ_SIZE)
149
return self._read_bytes(bytes_to_read)
151
def _read_bytes(self, count):
152
raise NotImplementedError(self._read_bytes)
155
"""Read bytes from this request's response until a newline byte.
157
This isn't particularly efficient, so should only be used when the
158
expected size of the line is quite short.
160
:returns: a string of bytes ending in a newline (byte 0x0A).
162
line, excess = _get_line(self.read_bytes)
163
self._push_back(excess)
166
def _report_activity(self, bytes, direction):
167
"""Notify that this medium has activity.
169
Implementations should call this from all methods that actually do IO.
170
Be careful that it's not called twice, if one method is implemented on
173
:param bytes: Number of bytes read or written.
174
:param direction: 'read' or 'write' or None.
176
ui.ui_factory.report_transport_activity(self, bytes, direction)
179
class SmartServerStreamMedium(SmartMedium):
45
180
"""Handles smart commands coming over a stream.
47
182
The stream may be a pipe connected to sshd, or a tcp socket, or an
112
250
"""Called when an unhandled exception from the protocol occurs."""
113
251
raise NotImplementedError(self.terminate_due_to_error)
115
def _get_bytes(self, desired_count):
253
def _read_bytes(self, desired_count):
116
254
"""Get some bytes from the medium.
118
256
:param desired_count: number of bytes we want to read.
120
raise NotImplementedError(self._get_bytes)
123
"""Read bytes from this request's response until a newline byte.
125
This isn't particularly efficient, so should only be used when the
126
expected size of the line is quite short.
128
:returns: a string of bytes ending in a newline (byte 0x0A).
130
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
132
while not line or line[-1] != '\n':
133
new_char = self._get_bytes(1)
136
# Ran out of bytes before receiving a complete line.
258
raise NotImplementedError(self._read_bytes)
141
261
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
143
def __init__(self, sock, backing_transport):
263
def __init__(self, sock, backing_transport, root_client_path='/'):
146
266
:param sock: the socket the server will read from. It will be put
147
267
into blocking mode.
149
SmartServerStreamMedium.__init__(self, backing_transport)
269
SmartServerStreamMedium.__init__(
270
self, backing_transport, root_client_path=root_client_path)
151
271
sock.setblocking(True)
152
272
self.socket = sock
154
274
def _serve_one_request_unguarded(self, protocol):
155
275
while protocol.next_read_size():
157
protocol.accept_bytes(self.push_back)
160
bytes = self._get_bytes(4096)
164
protocol.accept_bytes(bytes)
166
self.push_back = protocol.excess_buffer
168
def _get_bytes(self, desired_count):
169
# We ignore the desired_count because on sockets it's more efficient to
171
return self.socket.recv(4096)
276
# We can safely try to read large chunks. If there is less data
277
# than MAX_SOCKET_CHUNK ready, the socket will just return a
278
# short read immediately rather than block.
279
bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
283
protocol.accept_bytes(bytes)
285
self._push_back(protocol.unused_data)
287
def _read_bytes(self, desired_count):
288
return osutils.read_bytes_from_socket(
289
self.socket, self._report_activity)
173
291
def terminate_due_to_error(self):
174
"""Called when an unhandled exception from the protocol occurs."""
175
292
# TODO: This should log to a server log file, but no such thing
176
293
# exists yet. Andrew Bennetts 2006-09-29.
177
294
self.socket.close()
178
295
self.finished = True
180
297
def _write_out(self, bytes):
181
osutils.send_all(self.socket, bytes)
298
tstart = osutils.timer_func()
299
osutils.send_all(self.socket, bytes, self._report_activity)
300
if 'hpss' in debug.debug_flags:
301
thread_id = thread.get_ident()
302
trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
303
% ('wrote', thread_id, len(bytes),
304
osutils.timer_func() - tstart))
184
307
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
336
462
return self._read_bytes(count)
338
464
def _read_bytes(self, count):
339
"""Helper for read_bytes.
465
"""Helper for SmartClientMediumRequest.read_bytes.
341
467
read_bytes checks the state of the request to determing if bytes
342
468
should be read. After that it hands off to _read_bytes to do the
471
By default this forwards to self._medium.read_bytes because we are
472
operating on the medium's stream.
345
raise NotImplementedError(self._read_bytes)
474
return self._medium.read_bytes(count)
347
476
def read_line(self):
348
"""Read bytes from this request's response until a newline byte.
350
This isn't particularly efficient, so should only be used when the
351
expected size of the line is quite short.
353
:returns: a string of bytes ending in a newline (byte 0x0A).
355
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
357
while not line or line[-1] != '\n':
358
new_char = self.read_bytes(1)
361
# end of file encountered reading from server
362
raise errors.ConnectionReset(
363
"please check connectivity and permissions",
364
"(and try -Dhpss if further diagnosis is required)")
477
line = self._read_line()
478
if not line.endswith('\n'):
479
# end of file encountered reading from server
480
raise errors.ConnectionReset(
481
"Unexpected end of message. Please check connectivity "
482
"and permissions, and report a bug if problems persist.")
368
class SmartClientMedium(object):
485
def _read_line(self):
486
"""Helper for SmartClientMediumRequest.read_line.
488
By default this forwards to self._medium._get_line because we are
489
operating on the medium's stream.
491
return self._medium._get_line()
494
class _DebugCounter(object):
495
"""An object that counts the HPSS calls made to each client medium.
497
When a medium is garbage-collected, or failing that when atexit functions
498
are run, the total number of calls made on that medium are reported via
503
self.counts = weakref.WeakKeyDictionary()
504
client._SmartClient.hooks.install_named_hook(
505
'call', self.increment_call_count, 'hpss call counter')
506
atexit.register(self.flush_all)
508
def track(self, medium):
509
"""Start tracking calls made to a medium.
511
This only keeps a weakref to the medium, so shouldn't affect the
514
medium_repr = repr(medium)
515
# Add this medium to the WeakKeyDictionary
516
self.counts[medium] = dict(count=0, vfs_count=0,
517
medium_repr=medium_repr)
518
# Weakref callbacks are fired in reverse order of their association
519
# with the referenced object. So we add a weakref *after* adding to
520
# the WeakKeyDict so that we can report the value from it before the
521
# entry is removed by the WeakKeyDict's own callback.
522
ref = weakref.ref(medium, self.done)
524
def increment_call_count(self, params):
525
# Increment the count in the WeakKeyDictionary
526
value = self.counts[params.medium]
529
request_method = request.request_handlers.get(params.method)
531
# A method we don't know about doesn't count as a VFS method.
533
if issubclass(request_method, vfs.VfsRequest):
534
value['vfs_count'] += 1
537
value = self.counts[ref]
538
count, vfs_count, medium_repr = (
539
value['count'], value['vfs_count'], value['medium_repr'])
540
# In case this callback is invoked for the same ref twice (by the
541
# weakref callback and by the atexit function), set the call count back
542
# to 0 so this item won't be reported twice.
544
value['vfs_count'] = 0
546
trace.note('HPSS calls: %d (%d vfs) %s',
547
count, vfs_count, medium_repr)
550
for ref in list(self.counts.keys()):
553
_debug_counter = None
556
class SmartClientMedium(SmartMedium):
369
557
"""Smart client is a medium for sending smart protocol requests over."""
559
def __init__(self, base):
560
super(SmartClientMedium, self).__init__()
562
self._protocol_version_error = None
563
self._protocol_version = None
564
self._done_hello = False
565
# Be optimistic: we assume the remote end can accept new remote
566
# requests until we get an error saying otherwise.
567
# _remote_version_is_before tracks the bzr version the remote side
568
# can be based on what we've seen so far.
569
self._remote_version_is_before = None
570
# Install debug hook function if debug flag is set.
571
if 'hpss' in debug.debug_flags:
572
global _debug_counter
573
if _debug_counter is None:
574
_debug_counter = _DebugCounter()
575
_debug_counter.track(self)
577
def _is_remote_before(self, version_tuple):
578
"""Is it possible the remote side supports RPCs for a given version?
582
needed_version = (1, 2)
583
if medium._is_remote_before(needed_version):
584
fallback_to_pre_1_2_rpc()
588
except UnknownSmartMethod:
589
medium._remember_remote_is_before(needed_version)
590
fallback_to_pre_1_2_rpc()
592
:seealso: _remember_remote_is_before
594
if self._remote_version_is_before is None:
595
# So far, the remote side seems to support everything
597
return version_tuple >= self._remote_version_is_before
599
def _remember_remote_is_before(self, version_tuple):
600
"""Tell this medium that the remote side is older the given version.
602
:seealso: _is_remote_before
604
if (self._remote_version_is_before is not None and
605
version_tuple > self._remote_version_is_before):
606
# We have been told that the remote side is older than some version
607
# which is newer than a previously supplied older-than version.
608
# This indicates that some smart verb call is not guarded
609
# appropriately (it should simply not have been tried).
611
"_remember_remote_is_before(%r) called, but "
612
"_remember_remote_is_before(%r) was called previously."
613
, version_tuple, self._remote_version_is_before)
614
if 'hpss' in debug.debug_flags:
615
ui.ui_factory.show_warning(
616
"_remember_remote_is_before(%r) called, but "
617
"_remember_remote_is_before(%r) was called previously."
618
% (version_tuple, self._remote_version_is_before))
620
self._remote_version_is_before = version_tuple
622
def protocol_version(self):
623
"""Find out if 'hello' smart request works."""
624
if self._protocol_version_error is not None:
625
raise self._protocol_version_error
626
if not self._done_hello:
628
medium_request = self.get_request()
629
# Send a 'hello' request in protocol version one, for maximum
630
# backwards compatibility.
631
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
632
client_protocol.query_version()
633
self._done_hello = True
634
except errors.SmartProtocolError, e:
635
# Cache the error, just like we would cache a successful
637
self._protocol_version_error = e
641
def should_probe(self):
642
"""Should RemoteBzrDirFormat.probe_transport send a smart request on
645
Some transports are unambiguously smart-only; there's no need to check
646
if the transport is able to carry smart requests, because that's all
647
it is for. In those cases, this method should return False.
649
But some HTTP transports can sometimes fail to carry smart requests,
650
but still be usuable for accessing remote bzrdirs via plain file
651
accesses. So for those transports, their media should return True here
652
so that RemoteBzrDirFormat can determine if it is appropriate for that
371
657
def disconnect(self):
372
658
"""If this medium maintains a persistent connection, close it.
374
660
The default implementation does nothing.
663
def remote_path_from_transport(self, transport):
664
"""Convert transport into a path suitable for using in a request.
666
Note that the resulting remote path doesn't encode the host name or
667
anything but path, so it is only safe to use it in requests sent over
668
the medium from the matching transport.
670
medium_base = urlutils.join(self.base, '/')
671
rel_url = urlutils.relative_url(medium_base, transport.base)
672
return urllib.unquote(rel_url)
378
675
class SmartClientStreamMedium(SmartClientMedium):
379
676
"""Stream based medium common class.
442
738
def _read_bytes(self, count):
443
739
"""See SmartClientStreamMedium._read_bytes."""
444
return self._readable_pipe.read(count)
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
447
745
class SmartSSHClientMedium(SmartClientStreamMedium):
448
746
"""A client medium using SSH."""
450
748
def __init__(self, host, port=None, username=None, password=None,
451
vendor=None, bzr_remote_path=None):
749
base=None, vendor=None, bzr_remote_path=None):
452
750
"""Creates a client that will connect on the first use.
454
752
:param vendor: An optional override for the ssh vendor to use. See
455
753
bzrlib.transport.ssh for details on ssh vendors.
457
SmartClientStreamMedium.__init__(self)
458
755
self._connected = False
459
756
self._host = host
460
757
self._password = password
461
758
self._port = port
462
759
self._username = username
760
# for the benefit of progress making a short description of this
762
self._scheme = 'bzr+ssh'
763
# SmartClientStreamMedium stores the repr of this object in its
764
# _DebugCounter so we have to store all the values used in our repr
765
# method before calling the super init.
766
SmartClientStreamMedium.__init__(self, base)
463
767
self._read_from = None
464
768
self._ssh_connection = None
465
769
self._vendor = vendor
466
770
self._write_to = None
467
771
self._bzr_remote_path = bzr_remote_path
468
if self._bzr_remote_path is None:
469
symbol_versioning.warn(
470
'bzr_remote_path is required as of bzr 0.92',
471
DeprecationWarning, stacklevel=2)
472
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
774
if self._port is None:
777
maybe_port = ':%s' % self._port
778
return "%s(%s://%s@%s%s/)" % (
779
self.__class__.__name__,
474
785
def _accept_bytes(self, bytes):
475
786
"""See SmartClientStreamMedium.accept_bytes."""
476
787
self._ensure_connection()
477
788
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
479
791
def disconnect(self):
480
792
"""See SmartClientMedium.disconnect()."""
545
860
"""Connect this medium if not already connected."""
546
861
if self._connected:
548
self._socket = socket.socket()
549
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
550
863
if self._port is None:
551
864
port = BZR_DEFAULT_PORT
553
866
port = int(self._port)
555
self._socket.connect((self._host, port))
556
except socket.error, err:
868
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
869
socket.SOCK_STREAM, 0, 0)
870
except socket.gaierror, (err_num, err_msg):
871
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
872
(self._host, port, err_msg))
873
# Initialize err in case there are no addresses returned:
874
err = socket.error("no address found for %s" % self._host)
875
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
877
self._socket = socket.socket(family, socktype, proto)
878
self._socket.setsockopt(socket.IPPROTO_TCP,
879
socket.TCP_NODELAY, 1)
880
self._socket.connect(sockaddr)
881
except socket.error, err:
882
if self._socket is not None:
887
if self._socket is None:
557
888
# socket errors either have a (string) or (errno, string) as their
559
890
if type(err.args) is str:
added
removed
bzrlib/smart/medium.py
