24
24
bzrlib/transport/smart/__init__.py.
27
from __future__ import absolute_import
35
from bzrlib.lazy_import import lazy_import
36
lazy_import(globals(), """
31
from bzrlib import errors
32
from bzrlib.smart.protocol import (
34
SmartServerRequestProtocolOne,
35
SmartServerRequestProtocolTwo,
39
from bzrlib.transport import ssh
40
except errors.ParamikoNotPresent:
41
# no paramiko. SmartSSHClientMedium will break.
45
class SmartServerStreamMedium(object):
50
from bzrlib.i18n import gettext
51
from bzrlib.smart import client, protocol, request, signals, vfs
52
from bzrlib.transport import ssh
54
from bzrlib import osutils
56
# Throughout this module buffer size parameters are either limited to be at
57
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
58
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
59
# from non-sockets as well.
60
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
62
def _get_protocol_factory_for_bytes(bytes):
63
"""Determine the right protocol factory for 'bytes'.
65
This will return an appropriate protocol factory depending on the version
66
of the protocol being used, as determined by inspecting the given bytes.
67
The bytes should have at least one newline byte (i.e. be a whole line),
68
otherwise it's possible that a request will be incorrectly identified as
71
Typical use would be::
73
factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
74
server_protocol = factory(transport, write_func, root_client_path)
75
server_protocol.accept_bytes(unused_bytes)
77
:param bytes: a str of bytes of the start of the request.
78
:returns: 2-tuple of (protocol_factory, unused_bytes). protocol_factory is
79
a callable that takes three args: transport, write_func,
80
root_client_path. unused_bytes are any bytes that were not part of a
81
protocol version marker.
83
if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
84
protocol_factory = protocol.build_server_protocol_three
85
bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
86
elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
87
protocol_factory = protocol.SmartServerRequestProtocolTwo
88
bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
90
protocol_factory = protocol.SmartServerRequestProtocolOne
91
return protocol_factory, bytes
94
def _get_line(read_bytes_func):
95
"""Read bytes using read_bytes_func until a newline byte.
97
This isn't particularly efficient, so should only be used when the
98
expected size of the line is quite short.
100
:returns: a tuple of two strs: (line, excess)
104
while newline_pos == -1:
105
new_bytes = read_bytes_func(1)
108
# Ran out of bytes before receiving a complete line.
110
newline_pos = bytes.find('\n')
111
line = bytes[:newline_pos+1]
112
excess = bytes[newline_pos+1:]
116
class SmartMedium(object):
117
"""Base class for smart protocol media, both client- and server-side."""
120
self._push_back_buffer = None
122
def _push_back(self, bytes):
123
"""Return unused bytes to the medium, because they belong to the next
126
This sets the _push_back_buffer to the given bytes.
128
if self._push_back_buffer is not None:
129
raise AssertionError(
130
"_push_back called when self._push_back_buffer is %r"
131
% (self._push_back_buffer,))
134
self._push_back_buffer = bytes
136
def _get_push_back_buffer(self):
137
if self._push_back_buffer == '':
138
raise AssertionError(
139
'%s._push_back_buffer should never be the empty string, '
140
'which can be confused with EOF' % (self,))
141
bytes = self._push_back_buffer
142
self._push_back_buffer = None
145
def read_bytes(self, desired_count):
146
"""Read some bytes from this medium.
148
:returns: some bytes, possibly more or less than the number requested
149
in 'desired_count' depending on the medium.
151
if self._push_back_buffer is not None:
152
return self._get_push_back_buffer()
153
bytes_to_read = min(desired_count, _MAX_READ_SIZE)
154
return self._read_bytes(bytes_to_read)
156
def _read_bytes(self, count):
157
raise NotImplementedError(self._read_bytes)
160
"""Read bytes from this request's response until a newline byte.
162
This isn't particularly efficient, so should only be used when the
163
expected size of the line is quite short.
165
:returns: a string of bytes ending in a newline (byte 0x0A).
167
line, excess = _get_line(self.read_bytes)
168
self._push_back(excess)
171
def _report_activity(self, bytes, direction):
172
"""Notify that this medium has activity.
174
Implementations should call this from all methods that actually do IO.
175
Be careful that it's not called twice, if one method is implemented on
178
:param bytes: Number of bytes read or written.
179
:param direction: 'read' or 'write' or None.
181
ui.ui_factory.report_transport_activity(self, bytes, direction)
184
_bad_file_descriptor = (errno.EBADF,)
185
if sys.platform == 'win32':
186
# Given on Windows if you pass a closed socket to select.select. Probably
187
# also given if you pass a file handle to select.
189
_bad_file_descriptor += (WSAENOTSOCK,)
192
class SmartServerStreamMedium(SmartMedium):
46
193
"""Handles smart commands coming over a stream.
48
195
The stream may be a pipe connected to sshd, or a tcp socket, or an
87
277
:returns: a SmartServerRequestProtocol.
89
# Identify the protocol version.
279
self._wait_for_bytes_with_timeout(self._client_timeout)
281
# We're stopping, so don't try to do any more work
90
283
bytes = self._get_line()
91
if bytes.startswith(REQUEST_VERSION_TWO):
92
protocol_class = SmartServerRequestProtocolTwo
93
bytes = bytes[len(REQUEST_VERSION_TWO):]
95
protocol_class = SmartServerRequestProtocolOne
96
protocol = protocol_class(self.backing_transport, self._write_out)
97
protocol.accept_bytes(bytes)
284
protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
285
protocol = protocol_factory(
286
self.backing_transport, self._write_out, self.root_client_path)
287
protocol.accept_bytes(unused_bytes)
290
def _wait_on_descriptor(self, fd, timeout_seconds):
291
"""select() on a file descriptor, waiting for nonblocking read()
293
This will raise a ConnectionTimeout exception if we do not get a
294
readable handle before timeout_seconds.
297
t_end = self._timer() + timeout_seconds
298
poll_timeout = min(timeout_seconds, self._client_poll_timeout)
300
while not rs and not xs and self._timer() < t_end:
304
rs, _, xs = select.select([fd], [], [fd], poll_timeout)
305
except (select.error, socket.error) as e:
306
err = getattr(e, 'errno', None)
307
if err is None and getattr(e, 'args', None) is not None:
308
# select.error doesn't have 'errno', it just has args[0]
310
if err in _bad_file_descriptor:
311
return # Not a socket indicates read() will fail
312
elif err == errno.EINTR:
313
# Interrupted, keep looping.
318
raise errors.ConnectionTimeout('disconnecting client after %.1f seconds'
319
% (timeout_seconds,))
100
321
def _serve_one_request(self, protocol):
101
322
"""Read one request from input, process, send back a response.
103
324
:param protocol: a SmartServerRequestProtocol.
106
329
self._serve_one_request_unguarded(protocol)
107
330
except KeyboardInterrupt:
113
336
"""Called when an unhandled exception from the protocol occurs."""
114
337
raise NotImplementedError(self.terminate_due_to_error)
116
def _get_bytes(self, desired_count):
339
def _read_bytes(self, desired_count):
117
340
"""Get some bytes from the medium.
119
342
:param desired_count: number of bytes we want to read.
121
raise NotImplementedError(self._get_bytes)
124
"""Read bytes from this request's response until a newline byte.
126
This isn't particularly efficient, so should only be used when the
127
expected size of the line is quite short.
129
:returns: a string of bytes ending in a newline (byte 0x0A).
131
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
133
while not line or line[-1] != '\n':
134
new_char = self._get_bytes(1)
137
# Ran out of bytes before receiving a complete line.
344
raise NotImplementedError(self._read_bytes)
142
347
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
144
def __init__(self, sock, backing_transport):
349
def __init__(self, sock, backing_transport, root_client_path='/',
147
353
:param sock: the socket the server will read from. It will be put
148
354
into blocking mode.
150
SmartServerStreamMedium.__init__(self, backing_transport)
356
SmartServerStreamMedium.__init__(
357
self, backing_transport, root_client_path=root_client_path,
152
359
sock.setblocking(True)
153
360
self.socket = sock
361
# Get the getpeername now, as we might be closed later when we care.
363
self._client_info = sock.getpeername()
365
self._client_info = '<unknown>'
368
return '%s(client=%s)' % (self.__class__.__name__, self._client_info)
371
return '%s.%s(client=%s)' % (self.__module__, self.__class__.__name__,
155
374
def _serve_one_request_unguarded(self, protocol):
156
375
while protocol.next_read_size():
158
protocol.accept_bytes(self.push_back)
161
bytes = self._get_bytes(4096)
165
protocol.accept_bytes(bytes)
167
self.push_back = protocol.excess_buffer
169
def _get_bytes(self, desired_count):
170
# We ignore the desired_count because on sockets it's more efficient to
172
return self.socket.recv(4096)
376
# We can safely try to read large chunks. If there is less data
377
# than MAX_SOCKET_CHUNK ready, the socket will just return a
378
# short read immediately rather than block.
379
bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
383
protocol.accept_bytes(bytes)
385
self._push_back(protocol.unused_data)
387
def _disconnect_client(self):
388
"""Close the current connection. We stopped due to a timeout/etc."""
391
def _wait_for_bytes_with_timeout(self, timeout_seconds):
392
"""Wait for more bytes to be read, but timeout if none available.
394
This allows us to detect idle connections, and stop trying to read from
395
them, without setting the socket itself to non-blocking. This also
396
allows us to specify when we watch for idle timeouts.
398
:return: None, this will raise ConnectionTimeout if we time out before
401
return self._wait_on_descriptor(self.socket, timeout_seconds)
403
def _read_bytes(self, desired_count):
404
return osutils.read_bytes_from_socket(
405
self.socket, self._report_activity)
174
407
def terminate_due_to_error(self):
175
"""Called when an unhandled exception from the protocol occurs."""
176
408
# TODO: This should log to a server log file, but no such thing
177
409
# exists yet. Andrew Bennetts 2006-09-29.
178
410
self.socket.close()
179
411
self.finished = True
181
413
def _write_out(self, bytes):
182
self.socket.sendall(bytes)
414
tstart = osutils.timer_func()
415
osutils.send_all(self.socket, bytes, self._report_activity)
416
if 'hpss' in debug.debug_flags:
417
thread_id = thread.get_ident()
418
trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
419
% ('wrote', thread_id, len(bytes),
420
osutils.timer_func() - tstart))
185
423
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
187
def __init__(self, in_file, out_file, backing_transport):
425
def __init__(self, in_file, out_file, backing_transport, timeout=None):
188
426
"""Construct new server.
190
428
:param in_file: Python file from which requests can be read.
191
429
:param out_file: Python file to write responses.
192
430
:param backing_transport: Transport for the directory served.
194
SmartServerStreamMedium.__init__(self, backing_transport)
432
SmartServerStreamMedium.__init__(self, backing_transport,
195
434
if sys.platform == 'win32':
196
435
# force binary mode for files
337
611
return self._read_bytes(count)
339
613
def _read_bytes(self, count):
340
"""Helper for read_bytes.
614
"""Helper for SmartClientMediumRequest.read_bytes.
342
616
read_bytes checks the state of the request to determing if bytes
343
617
should be read. After that it hands off to _read_bytes to do the
620
By default this forwards to self._medium.read_bytes because we are
621
operating on the medium's stream.
346
raise NotImplementedError(self._read_bytes)
623
return self._medium.read_bytes(count)
348
625
def read_line(self):
349
"""Read bytes from this request's response until a newline byte.
351
This isn't particularly efficient, so should only be used when the
352
expected size of the line is quite short.
354
:returns: a string of bytes ending in a newline (byte 0x0A).
356
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
358
while not line or line[-1] != '\n':
359
new_char = self.read_bytes(1)
362
raise errors.SmartProtocolError(
363
'unexpected end of file reading from server')
626
line = self._read_line()
627
if not line.endswith('\n'):
628
# end of file encountered reading from server
629
raise errors.ConnectionReset(
630
"Unexpected end of message. Please check connectivity "
631
"and permissions, and report a bug if problems persist.")
367
class SmartClientMedium(object):
634
def _read_line(self):
635
"""Helper for SmartClientMediumRequest.read_line.
637
By default this forwards to self._medium._get_line because we are
638
operating on the medium's stream.
640
return self._medium._get_line()
643
class _VfsRefuser(object):
644
"""An object that refuses all VFS requests.
649
client._SmartClient.hooks.install_named_hook(
650
'call', self.check_vfs, 'vfs refuser')
652
def check_vfs(self, params):
654
request_method = request.request_handlers.get(params.method)
656
# A method we don't know about doesn't count as a VFS method.
658
if issubclass(request_method, vfs.VfsRequest):
659
raise errors.HpssVfsRequestNotAllowed(params.method, params.args)
662
class _DebugCounter(object):
663
"""An object that counts the HPSS calls made to each client medium.
665
When a medium is garbage-collected, or failing that when
666
bzrlib.global_state exits, the total number of calls made on that medium
667
are reported via trace.note.
671
self.counts = weakref.WeakKeyDictionary()
672
client._SmartClient.hooks.install_named_hook(
673
'call', self.increment_call_count, 'hpss call counter')
674
bzrlib.global_state.cleanups.add_cleanup(self.flush_all)
676
def track(self, medium):
677
"""Start tracking calls made to a medium.
679
This only keeps a weakref to the medium, so shouldn't affect the
682
medium_repr = repr(medium)
683
# Add this medium to the WeakKeyDictionary
684
self.counts[medium] = dict(count=0, vfs_count=0,
685
medium_repr=medium_repr)
686
# Weakref callbacks are fired in reverse order of their association
687
# with the referenced object. So we add a weakref *after* adding to
688
# the WeakKeyDict so that we can report the value from it before the
689
# entry is removed by the WeakKeyDict's own callback.
690
ref = weakref.ref(medium, self.done)
692
def increment_call_count(self, params):
693
# Increment the count in the WeakKeyDictionary
694
value = self.counts[params.medium]
697
request_method = request.request_handlers.get(params.method)
699
# A method we don't know about doesn't count as a VFS method.
701
if issubclass(request_method, vfs.VfsRequest):
702
value['vfs_count'] += 1
705
value = self.counts[ref]
706
count, vfs_count, medium_repr = (
707
value['count'], value['vfs_count'], value['medium_repr'])
708
# In case this callback is invoked for the same ref twice (by the
709
# weakref callback and by the atexit function), set the call count back
710
# to 0 so this item won't be reported twice.
712
value['vfs_count'] = 0
714
trace.note(gettext('HPSS calls: {0} ({1} vfs) {2}').format(
715
count, vfs_count, medium_repr))
718
for ref in list(self.counts.keys()):
721
_debug_counter = None
725
class SmartClientMedium(SmartMedium):
368
726
"""Smart client is a medium for sending smart protocol requests over."""
728
def __init__(self, base):
729
super(SmartClientMedium, self).__init__()
731
self._protocol_version_error = None
732
self._protocol_version = None
733
self._done_hello = False
734
# Be optimistic: we assume the remote end can accept new remote
735
# requests until we get an error saying otherwise.
736
# _remote_version_is_before tracks the bzr version the remote side
737
# can be based on what we've seen so far.
738
self._remote_version_is_before = None
739
# Install debug hook function if debug flag is set.
740
if 'hpss' in debug.debug_flags:
741
global _debug_counter
742
if _debug_counter is None:
743
_debug_counter = _DebugCounter()
744
_debug_counter.track(self)
745
if 'hpss_client_no_vfs' in debug.debug_flags:
747
if _vfs_refuser is None:
748
_vfs_refuser = _VfsRefuser()
750
def _is_remote_before(self, version_tuple):
751
"""Is it possible the remote side supports RPCs for a given version?
755
needed_version = (1, 2)
756
if medium._is_remote_before(needed_version):
757
fallback_to_pre_1_2_rpc()
761
except UnknownSmartMethod:
762
medium._remember_remote_is_before(needed_version)
763
fallback_to_pre_1_2_rpc()
765
:seealso: _remember_remote_is_before
767
if self._remote_version_is_before is None:
768
# So far, the remote side seems to support everything
770
return version_tuple >= self._remote_version_is_before
772
def _remember_remote_is_before(self, version_tuple):
773
"""Tell this medium that the remote side is older the given version.
775
:seealso: _is_remote_before
777
if (self._remote_version_is_before is not None and
778
version_tuple > self._remote_version_is_before):
779
# We have been told that the remote side is older than some version
780
# which is newer than a previously supplied older-than version.
781
# This indicates that some smart verb call is not guarded
782
# appropriately (it should simply not have been tried).
784
"_remember_remote_is_before(%r) called, but "
785
"_remember_remote_is_before(%r) was called previously."
786
, version_tuple, self._remote_version_is_before)
787
if 'hpss' in debug.debug_flags:
788
ui.ui_factory.show_warning(
789
"_remember_remote_is_before(%r) called, but "
790
"_remember_remote_is_before(%r) was called previously."
791
% (version_tuple, self._remote_version_is_before))
793
self._remote_version_is_before = version_tuple
795
def protocol_version(self):
796
"""Find out if 'hello' smart request works."""
797
if self._protocol_version_error is not None:
798
raise self._protocol_version_error
799
if not self._done_hello:
801
medium_request = self.get_request()
802
# Send a 'hello' request in protocol version one, for maximum
803
# backwards compatibility.
804
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
805
client_protocol.query_version()
806
self._done_hello = True
807
except errors.SmartProtocolError, e:
808
# Cache the error, just like we would cache a successful
810
self._protocol_version_error = e
814
def should_probe(self):
815
"""Should RemoteBzrDirFormat.probe_transport send a smart request on
818
Some transports are unambiguously smart-only; there's no need to check
819
if the transport is able to carry smart requests, because that's all
820
it is for. In those cases, this method should return False.
822
But some HTTP transports can sometimes fail to carry smart requests,
823
but still be usuable for accessing remote bzrdirs via plain file
824
accesses. So for those transports, their media should return True here
825
so that RemoteBzrDirFormat can determine if it is appropriate for that
370
830
def disconnect(self):
371
831
"""If this medium maintains a persistent connection, close it.
373
833
The default implementation does nothing.
836
def remote_path_from_transport(self, transport):
837
"""Convert transport into a path suitable for using in a request.
839
Note that the resulting remote path doesn't encode the host name or
840
anything but path, so it is only safe to use it in requests sent over
841
the medium from the matching transport.
843
medium_base = urlutils.join(self.base, '/')
844
rel_url = urlutils.relative_url(medium_base, transport.base)
845
return urlutils.unquote(rel_url)
377
848
class SmartClientStreamMedium(SmartClientMedium):
378
849
"""Stream based medium common class.
412
884
return SmartClientStreamMediumRequest(self)
414
def read_bytes(self, count):
415
return self._read_bytes(count)
887
"""We have been disconnected, reset current state.
889
This resets things like _current_request and connected state.
892
self._current_request = None
418
895
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
419
896
"""A client medium using simple pipes.
421
898
This client does not manage the pipes: it assumes they will always be open.
424
def __init__(self, readable_pipe, writeable_pipe):
425
SmartClientStreamMedium.__init__(self)
901
def __init__(self, readable_pipe, writeable_pipe, base):
902
SmartClientStreamMedium.__init__(self, base)
426
903
self._readable_pipe = readable_pipe
427
904
self._writeable_pipe = writeable_pipe
429
906
def _accept_bytes(self, bytes):
430
907
"""See SmartClientStreamMedium.accept_bytes."""
431
self._writeable_pipe.write(bytes)
909
self._writeable_pipe.write(bytes)
911
if e.errno in (errno.EINVAL, errno.EPIPE):
912
raise errors.ConnectionReset(
913
"Error trying to write to subprocess", e)
915
self._report_activity(len(bytes), 'write')
433
917
def _flush(self):
434
918
"""See SmartClientStreamMedium._flush()."""
919
# Note: If flush were to fail, we'd like to raise ConnectionReset, etc.
920
# However, testing shows that even when the child process is
921
# gone, this doesn't error.
435
922
self._writeable_pipe.flush()
437
924
def _read_bytes(self, count):
438
925
"""See SmartClientStreamMedium._read_bytes."""
439
return self._readable_pipe.read(count)
926
bytes_to_read = min(count, _MAX_READ_SIZE)
927
bytes = self._readable_pipe.read(bytes_to_read)
928
self._report_activity(len(bytes), 'read')
932
class SSHParams(object):
933
"""A set of parameters for starting a remote bzr via SSH."""
935
def __init__(self, host, port=None, username=None, password=None,
936
bzr_remote_path='bzr'):
939
self.username = username
940
self.password = password
941
self.bzr_remote_path = bzr_remote_path
442
944
class SmartSSHClientMedium(SmartClientStreamMedium):
443
"""A client medium using SSH."""
445
def __init__(self, host, port=None, username=None, password=None,
945
"""A client medium using SSH.
947
It delegates IO to a SmartSimplePipesClientMedium or
948
SmartClientAlreadyConnectedSocketMedium (depending on platform).
951
def __init__(self, base, ssh_params, vendor=None):
447
952
"""Creates a client that will connect on the first use.
954
:param ssh_params: A SSHParams instance.
449
955
:param vendor: An optional override for the ssh vendor to use. See
450
956
bzrlib.transport.ssh for details on ssh vendors.
452
SmartClientStreamMedium.__init__(self)
453
self._connected = False
455
self._password = password
457
self._username = username
458
self._read_from = None
958
self._real_medium = None
959
self._ssh_params = ssh_params
960
# for the benefit of progress making a short description of this
962
self._scheme = 'bzr+ssh'
963
# SmartClientStreamMedium stores the repr of this object in its
964
# _DebugCounter so we have to store all the values used in our repr
965
# method before calling the super init.
966
SmartClientStreamMedium.__init__(self, base)
967
self._vendor = vendor
459
968
self._ssh_connection = None
460
self._vendor = vendor
461
self._write_to = None
971
if self._ssh_params.port is None:
974
maybe_port = ':%s' % self._ssh_params.port
975
if self._ssh_params.username is None:
978
maybe_user = '%s@' % self._ssh_params.username
979
return "%s(%s://%s%s%s/)" % (
980
self.__class__.__name__,
983
self._ssh_params.host,
463
986
def _accept_bytes(self, bytes):
464
987
"""See SmartClientStreamMedium.accept_bytes."""
465
988
self._ensure_connection()
466
self._write_to.write(bytes)
989
self._real_medium.accept_bytes(bytes)
468
991
def disconnect(self):
469
992
"""See SmartClientMedium.disconnect()."""
470
if not self._connected:
472
self._read_from.close()
473
self._write_to.close()
474
self._ssh_connection.close()
475
self._connected = False
993
if self._real_medium is not None:
994
self._real_medium.disconnect()
995
self._real_medium = None
996
if self._ssh_connection is not None:
997
self._ssh_connection.close()
998
self._ssh_connection = None
477
1000
def _ensure_connection(self):
478
1001
"""Connect this medium if not already connected."""
1002
if self._real_medium is not None:
481
executable = os.environ.get('BZR_REMOTE_PATH', 'bzr')
482
1004
if self._vendor is None:
483
1005
vendor = ssh._get_ssh_vendor()
485
1007
vendor = self._vendor
486
self._ssh_connection = vendor.connect_ssh(self._username,
487
self._password, self._host, self._port,
488
command=[executable, 'serve', '--inet', '--directory=/',
490
self._read_from, self._write_to = \
491
self._ssh_connection.get_filelike_channels()
492
self._connected = True
1008
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
1009
self._ssh_params.password, self._ssh_params.host,
1010
self._ssh_params.port,
1011
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
1012
'--directory=/', '--allow-writes'])
1013
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
1014
if io_kind == 'socket':
1015
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
1016
self.base, io_object)
1017
elif io_kind == 'pipes':
1018
read_from, write_to = io_object
1019
self._real_medium = SmartSimplePipesClientMedium(
1020
read_from, write_to, self.base)
1022
raise AssertionError(
1023
"Unexpected io_kind %r from %r"
1024
% (io_kind, self._ssh_connection))
1025
for hook in transport.Transport.hooks["post_connect"]:
494
1028
def _flush(self):
495
1029
"""See SmartClientStreamMedium._flush()."""
496
self._write_to.flush()
1030
self._real_medium._flush()
498
1032
def _read_bytes(self, count):
499
1033
"""See SmartClientStreamMedium.read_bytes."""
500
if not self._connected:
1034
if self._real_medium is None:
501
1035
raise errors.MediumNotConnected(self)
502
return self._read_from.read(count)
505
class SmartTCPClientMedium(SmartClientStreamMedium):
506
"""A client medium using TCP."""
508
def __init__(self, host, port):
509
"""Creates a client that will connect on the first use."""
510
SmartClientStreamMedium.__init__(self)
1036
return self._real_medium.read_bytes(count)
1039
# Port 4155 is the default port for bzr://, registered with IANA.
1040
BZR_DEFAULT_INTERFACE = None
1041
BZR_DEFAULT_PORT = 4155
1044
class SmartClientSocketMedium(SmartClientStreamMedium):
1045
"""A client medium using a socket.
1047
This class isn't usable directly. Use one of its subclasses instead.
1050
def __init__(self, base):
1051
SmartClientStreamMedium.__init__(self, base)
511
1053
self._connected = False
516
1055
def _accept_bytes(self, bytes):
517
1056
"""See SmartClientMedium.accept_bytes."""
518
1057
self._ensure_connection()
519
self._socket.sendall(bytes)
1058
osutils.send_all(self._socket, bytes, self._report_activity)
1060
def _ensure_connection(self):
1061
"""Connect this medium if not already connected."""
1062
raise NotImplementedError(self._ensure_connection)
1065
"""See SmartClientStreamMedium._flush().
1067
For sockets we do no flushing. For TCP sockets we may want to turn off
1068
TCP_NODELAY and add a means to do a flush, but that can be done in the
1072
def _read_bytes(self, count):
1073
"""See SmartClientMedium.read_bytes."""
1074
if not self._connected:
1075
raise errors.MediumNotConnected(self)
1076
return osutils.read_bytes_from_socket(
1077
self._socket, self._report_activity)
521
1079
def disconnect(self):
522
1080
"""See SmartClientMedium.disconnect()."""
526
1084
self._socket = None
527
1085
self._connected = False
1088
class SmartTCPClientMedium(SmartClientSocketMedium):
1089
"""A client medium that creates a TCP connection."""
1091
def __init__(self, host, port, base):
1092
"""Creates a client that will connect on the first use."""
1093
SmartClientSocketMedium.__init__(self, base)
529
1097
def _ensure_connection(self):
530
1098
"""Connect this medium if not already connected."""
531
1099
if self._connected:
533
self._socket = socket.socket()
534
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
535
result = self._socket.connect_ex((self._host, int(self._port)))
1101
if self._port is None:
1102
port = BZR_DEFAULT_PORT
1104
port = int(self._port)
1106
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
1107
socket.SOCK_STREAM, 0, 0)
1108
except socket.gaierror, (err_num, err_msg):
1109
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
1110
(self._host, port, err_msg))
1111
# Initialize err in case there are no addresses returned:
1112
err = socket.error("no address found for %s" % self._host)
1113
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
1115
self._socket = socket.socket(family, socktype, proto)
1116
self._socket.setsockopt(socket.IPPROTO_TCP,
1117
socket.TCP_NODELAY, 1)
1118
self._socket.connect(sockaddr)
1119
except socket.error, err:
1120
if self._socket is not None:
1121
self._socket.close()
1125
if self._socket is None:
1126
# socket errors either have a (string) or (errno, string) as their
1128
if type(err.args) is str:
1131
err_msg = err.args[1]
537
1132
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
538
(self._host, self._port, os.strerror(result)))
539
self._connected = True
542
"""See SmartClientStreamMedium._flush().
544
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
545
add a means to do a flush, but that can be done in the future.
548
def _read_bytes(self, count):
549
"""See SmartClientMedium.read_bytes."""
550
if not self._connected:
551
raise errors.MediumNotConnected(self)
552
return self._socket.recv(count)
1133
(self._host, port, err_msg))
1134
self._connected = True
1135
for hook in transport.Transport.hooks["post_connect"]:
1139
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
1140
"""A client medium for an already connected socket.
1142
Note that this class will assume it "owns" the socket, so it will close it
1143
when its disconnect method is called.
1146
def __init__(self, base, sock):
1147
SmartClientSocketMedium.__init__(self, base)
1149
self._connected = True
1151
def _ensure_connection(self):
1152
# Already connected, by definition! So nothing to do.
555
1156
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
added
removed
bzrlib/smart/medium.py
