32
from bzrlib.lazy_import import lazy_import
33
lazy_import(globals(), """
46
from bzrlib.smart import client, protocol, request, vfs
47
from bzrlib.transport import ssh
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):
30
from bzrlib import errors
31
from bzrlib.smart.protocol import SmartServerRequestProtocolOne
34
from bzrlib.transport import ssh
35
except errors.ParamikoNotPresent:
36
# no paramiko. SmartSSHClientMedium will break.
40
class SmartServerStreamMedium(object):
180
41
"""Handles smart commands coming over a stream.
182
43
The stream may be a pipe connected to sshd, or a tcp socket, or an
250
89
"""Called when an unhandled exception from the protocol occurs."""
251
90
raise NotImplementedError(self.terminate_due_to_error)
253
def _read_bytes(self, desired_count):
254
"""Get some bytes from the medium.
256
:param desired_count: number of bytes we want to read.
258
raise NotImplementedError(self._read_bytes)
261
93
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
263
def __init__(self, sock, backing_transport, root_client_path='/'):
95
def __init__(self, sock, backing_transport):
266
98
:param sock: the socket the server will read from. It will be put
267
99
into blocking mode.
269
SmartServerStreamMedium.__init__(
270
self, backing_transport, root_client_path=root_client_path)
101
SmartServerStreamMedium.__init__(self, backing_transport)
271
103
sock.setblocking(True)
272
104
self.socket = sock
274
106
def _serve_one_request_unguarded(self, protocol):
275
107
while protocol.next_read_size():
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)
109
protocol.accept_bytes(self.push_back)
112
bytes = self.socket.recv(4096)
116
protocol.accept_bytes(bytes)
118
self.push_back = protocol.excess_buffer
291
120
def terminate_due_to_error(self):
121
"""Called when an unhandled exception from the protocol occurs."""
292
122
# TODO: This should log to a server log file, but no such thing
293
123
# exists yet. Andrew Bennetts 2006-09-29.
294
124
self.socket.close()
295
125
self.finished = True
297
127
def _write_out(self, 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))
128
self.socket.sendall(bytes)
307
131
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
462
280
return self._read_bytes(count)
464
282
def _read_bytes(self, count):
465
"""Helper for SmartClientMediumRequest.read_bytes.
283
"""Helper for read_bytes.
467
285
read_bytes checks the state of the request to determing if bytes
468
286
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.
474
return self._medium.read_bytes(count)
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.")
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
498
bzrlib.global_state exits, the total number of calls made on that medium
499
are reported via trace.note.
503
self.counts = weakref.WeakKeyDictionary()
504
client._SmartClient.hooks.install_named_hook(
505
'call', self.increment_call_count, 'hpss call counter')
506
bzrlib.global_state.cleanups.add_cleanup(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):
289
raise NotImplementedError(self._read_bytes)
292
class SmartClientMedium(object):
557
293
"""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
657
295
def disconnect(self):
658
296
"""If this medium maintains a persistent connection, close it.
660
298
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)
675
302
class SmartClientStreamMedium(SmartClientMedium):
676
303
"""Stream based medium common class.
734
362
def _read_bytes(self, count):
735
363
"""See SmartClientStreamMedium._read_bytes."""
736
bytes_to_read = min(count, _MAX_READ_SIZE)
737
bytes = self._readable_pipe.read(bytes_to_read)
738
self._report_activity(len(bytes), 'read')
742
class SSHParams(object):
743
"""A set of parameters for starting a remote bzr via SSH."""
364
return self._readable_pipe.read(count)
367
class SmartSSHClientMedium(SmartClientStreamMedium):
368
"""A client medium using SSH."""
745
370
def __init__(self, host, port=None, username=None, password=None,
746
bzr_remote_path='bzr'):
749
self.username = username
750
self.password = password
751
self.bzr_remote_path = bzr_remote_path
754
class SmartSSHClientMedium(SmartClientStreamMedium):
755
"""A client medium using SSH.
757
It delegates IO to a SmartClientSocketMedium or
758
SmartClientAlreadyConnectedSocketMedium (depending on platform).
761
def __init__(self, base, ssh_params, vendor=None):
762
372
"""Creates a client that will connect on the first use.
764
:param ssh_params: A SSHParams instance.
765
374
:param vendor: An optional override for the ssh vendor to use. See
766
375
bzrlib.transport.ssh for details on ssh vendors.
768
self._real_medium = None
769
self._ssh_params = ssh_params
770
# for the benefit of progress making a short description of this
772
self._scheme = 'bzr+ssh'
773
# SmartClientStreamMedium stores the repr of this object in its
774
# _DebugCounter so we have to store all the values used in our repr
775
# method before calling the super init.
776
SmartClientStreamMedium.__init__(self, base)
377
SmartClientStreamMedium.__init__(self)
378
self._connected = False
380
self._password = password
382
self._username = username
383
self._read_from = None
384
self._ssh_connection = None
777
385
self._vendor = vendor
778
self._ssh_connection = None
781
if self._ssh_params.port is None:
784
maybe_port = ':%s' % self._ssh_params.port
785
return "%s(%s://%s@%s%s/)" % (
786
self.__class__.__name__,
788
self._ssh_params.username,
789
self._ssh_params.host,
386
self._write_to = None
792
388
def _accept_bytes(self, bytes):
793
389
"""See SmartClientStreamMedium.accept_bytes."""
794
390
self._ensure_connection()
795
self._real_medium.accept_bytes(bytes)
391
self._write_to.write(bytes)
797
393
def disconnect(self):
798
394
"""See SmartClientMedium.disconnect()."""
799
if self._real_medium is not None:
800
self._real_medium.disconnect()
801
self._real_medium = None
802
if self._ssh_connection is not None:
803
self._ssh_connection.close()
804
self._ssh_connection = None
395
if not self._connected:
397
self._read_from.close()
398
self._write_to.close()
399
self._ssh_connection.close()
400
self._connected = False
806
402
def _ensure_connection(self):
807
403
"""Connect this medium if not already connected."""
808
if self._real_medium is not None:
406
executable = os.environ.get('BZR_REMOTE_PATH', 'bzr')
810
407
if self._vendor is None:
811
408
vendor = ssh._get_ssh_vendor()
813
410
vendor = self._vendor
814
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
815
self._ssh_params.password, self._ssh_params.host,
816
self._ssh_params.port,
817
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
818
'--directory=/', '--allow-writes'])
819
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
820
if io_kind == 'socket':
821
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
822
self.base, io_object)
823
elif io_kind == 'pipes':
824
read_from, write_to = io_object
825
self._real_medium = SmartSimplePipesClientMedium(
826
read_from, write_to, self.base)
828
raise AssertionError(
829
"Unexpected io_kind %r from %r"
830
% (io_kind, self._ssh_connection))
411
self._ssh_connection = vendor.connect_ssh(self._username,
412
self._password, self._host, self._port,
413
command=[executable, 'serve', '--inet', '--directory=/',
415
self._read_from, self._write_to = \
416
self._ssh_connection.get_filelike_channels()
417
self._connected = True
832
419
def _flush(self):
833
420
"""See SmartClientStreamMedium._flush()."""
834
self._real_medium._flush()
421
self._write_to.flush()
836
423
def _read_bytes(self, count):
837
424
"""See SmartClientStreamMedium.read_bytes."""
838
if self._real_medium is None:
425
if not self._connected:
839
426
raise errors.MediumNotConnected(self)
840
return self._real_medium.read_bytes(count)
843
# Port 4155 is the default port for bzr://, registered with IANA.
844
BZR_DEFAULT_INTERFACE = None
845
BZR_DEFAULT_PORT = 4155
848
class SmartClientSocketMedium(SmartClientStreamMedium):
849
"""A client medium using a socket.
427
return self._read_from.read(count)
430
class SmartTCPClientMedium(SmartClientStreamMedium):
431
"""A client medium using TCP."""
851
This class isn't usable directly. Use one of its subclasses instead.
854
def __init__(self, base):
855
SmartClientStreamMedium.__init__(self, base)
433
def __init__(self, host, port):
434
"""Creates a client that will connect on the first use."""
435
SmartClientStreamMedium.__init__(self)
436
self._connected = False
856
439
self._socket = None
857
self._connected = False
859
441
def _accept_bytes(self, bytes):
860
442
"""See SmartClientMedium.accept_bytes."""
861
443
self._ensure_connection()
862
osutils.send_all(self._socket, bytes, self._report_activity)
444
self._socket.sendall(bytes)
446
def disconnect(self):
447
"""See SmartClientMedium.disconnect()."""
448
if not self._connected:
452
self._connected = False
864
454
def _ensure_connection(self):
865
455
"""Connect this medium if not already connected."""
866
raise NotImplementedError(self._ensure_connection)
458
self._socket = socket.socket()
459
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
460
result = self._socket.connect_ex((self._host, int(self._port)))
462
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
463
(self._host, self._port, os.strerror(result)))
464
self._connected = True
868
466
def _flush(self):
869
467
"""See SmartClientStreamMedium._flush().
871
For sockets we do no flushing. For TCP sockets we may want to turn off
872
TCP_NODELAY and add a means to do a flush, but that can be done in the
469
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
470
add a means to do a flush, but that can be done in the future.
876
473
def _read_bytes(self, count):
877
474
"""See SmartClientMedium.read_bytes."""
878
475
if not self._connected:
879
476
raise errors.MediumNotConnected(self)
880
return osutils.read_bytes_from_socket(
881
self._socket, self._report_activity)
883
def disconnect(self):
884
"""See SmartClientMedium.disconnect()."""
885
if not self._connected:
889
self._connected = False
892
class SmartTCPClientMedium(SmartClientSocketMedium):
893
"""A client medium that creates a TCP connection."""
895
def __init__(self, host, port, base):
896
"""Creates a client that will connect on the first use."""
897
SmartClientSocketMedium.__init__(self, base)
901
def _ensure_connection(self):
902
"""Connect this medium if not already connected."""
905
if self._port is None:
906
port = BZR_DEFAULT_PORT
908
port = int(self._port)
910
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
911
socket.SOCK_STREAM, 0, 0)
912
except socket.gaierror, (err_num, err_msg):
913
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
914
(self._host, port, err_msg))
915
# Initialize err in case there are no addresses returned:
916
err = socket.error("no address found for %s" % self._host)
917
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
919
self._socket = socket.socket(family, socktype, proto)
920
self._socket.setsockopt(socket.IPPROTO_TCP,
921
socket.TCP_NODELAY, 1)
922
self._socket.connect(sockaddr)
923
except socket.error, err:
924
if self._socket is not None:
929
if self._socket is None:
930
# socket errors either have a (string) or (errno, string) as their
932
if type(err.args) is str:
935
err_msg = err.args[1]
936
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
937
(self._host, port, err_msg))
938
self._connected = True
941
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
942
"""A client medium for an already connected socket.
944
Note that this class will assume it "owns" the socket, so it will close it
945
when its disconnect method is called.
948
def __init__(self, base, sock):
949
SmartClientSocketMedium.__init__(self, base)
951
self._connected = True
953
def _ensure_connection(self):
954
# Already connected, by definition! So nothing to do.
477
return self._socket.recv(count)
958
480
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
added
removed
bzrlib/smart/medium.py
