1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""The 'medium' layer for the smart servers and clients.
19
"Medium" here is the noun meaning "a means of transmission", not the adjective
20
for "the quality between big and small."
22
Media carry the bytes of the requests somehow (e.g. via TCP, wrapped in HTTP, or
23
over SSH), and pass them to and from the protocol logic. See the overview in
24
bzrlib/transport/smart/__init__.py.
32
from bzrlib.lazy_import import lazy_import
33
lazy_import(globals(), """
45
from bzrlib.smart import client, protocol, request, vfs
46
from bzrlib.transport import ssh
48
from bzrlib import osutils
50
# Throughout this module buffer size parameters are either limited to be at
51
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
52
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
53
# from non-sockets as well.
54
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
56
def _get_protocol_factory_for_bytes(bytes):
57
"""Determine the right protocol factory for 'bytes'.
59
This will return an appropriate protocol factory depending on the version
60
of the protocol being used, as determined by inspecting the given bytes.
61
The bytes should have at least one newline byte (i.e. be a whole line),
62
otherwise it's possible that a request will be incorrectly identified as
65
Typical use would be::
67
factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
68
server_protocol = factory(transport, write_func, root_client_path)
69
server_protocol.accept_bytes(unused_bytes)
71
:param bytes: a str of bytes of the start of the request.
72
:returns: 2-tuple of (protocol_factory, unused_bytes). protocol_factory is
73
a callable that takes three args: transport, write_func,
74
root_client_path. unused_bytes are any bytes that were not part of a
75
protocol version marker.
77
if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
78
protocol_factory = protocol.build_server_protocol_three
79
bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
80
elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
81
protocol_factory = protocol.SmartServerRequestProtocolTwo
82
bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
84
protocol_factory = protocol.SmartServerRequestProtocolOne
85
return protocol_factory, bytes
88
def _get_line(read_bytes_func):
89
"""Read bytes using read_bytes_func until a newline byte.
91
This isn't particularly efficient, so should only be used when the
92
expected size of the line is quite short.
94
:returns: a tuple of two strs: (line, excess)
98
while newline_pos == -1:
99
new_bytes = read_bytes_func(1)
102
# Ran out of bytes before receiving a complete line.
104
newline_pos = bytes.find('\n')
105
line = bytes[:newline_pos+1]
106
excess = bytes[newline_pos+1:]
110
class SmartMedium(object):
111
"""Base class for smart protocol media, both client- and server-side."""
114
self._push_back_buffer = None
116
def _push_back(self, bytes):
117
"""Return unused bytes to the medium, because they belong to the next
120
This sets the _push_back_buffer to the given bytes.
122
if self._push_back_buffer is not None:
123
raise AssertionError(
124
"_push_back called when self._push_back_buffer is %r"
125
% (self._push_back_buffer,))
128
self._push_back_buffer = bytes
130
def _get_push_back_buffer(self):
131
if self._push_back_buffer == '':
132
raise AssertionError(
133
'%s._push_back_buffer should never be the empty string, '
134
'which can be confused with EOF' % (self,))
135
bytes = self._push_back_buffer
136
self._push_back_buffer = None
139
def read_bytes(self, desired_count):
140
"""Read some bytes from this medium.
142
:returns: some bytes, possibly more or less than the number requested
143
in 'desired_count' depending on the medium.
145
if self._push_back_buffer is not None:
146
return self._get_push_back_buffer()
147
bytes_to_read = min(desired_count, _MAX_READ_SIZE)
148
return self._read_bytes(bytes_to_read)
150
def _read_bytes(self, count):
151
raise NotImplementedError(self._read_bytes)
154
"""Read bytes from this request's response until a newline byte.
156
This isn't particularly efficient, so should only be used when the
157
expected size of the line is quite short.
159
:returns: a string of bytes ending in a newline (byte 0x0A).
161
line, excess = _get_line(self.read_bytes)
162
self._push_back(excess)
165
def _report_activity(self, bytes, direction):
166
"""Notify that this medium has activity.
168
Implementations should call this from all methods that actually do IO.
169
Be careful that it's not called twice, if one method is implemented on
172
:param bytes: Number of bytes read or written.
173
:param direction: 'read' or 'write' or None.
175
ui.ui_factory.report_transport_activity(self, bytes, direction)
178
class SmartServerStreamMedium(SmartMedium):
179
"""Handles smart commands coming over a stream.
181
The stream may be a pipe connected to sshd, or a tcp socket, or an
182
in-process fifo for testing.
184
One instance is created for each connected client; it can serve multiple
185
requests in the lifetime of the connection.
187
The server passes requests through to an underlying backing transport,
188
which will typically be a LocalTransport looking at the server's filesystem.
190
:ivar _push_back_buffer: a str of bytes that have been read from the stream
191
but not used yet, or None if there are no buffered bytes. Subclasses
192
should make sure to exhaust this buffer before reading more bytes from
193
the stream. See also the _push_back method.
196
def __init__(self, backing_transport, root_client_path='/'):
197
"""Construct new server.
199
:param backing_transport: Transport for the directory served.
201
# backing_transport could be passed to serve instead of __init__
202
self.backing_transport = backing_transport
203
self.root_client_path = root_client_path
204
self.finished = False
205
SmartMedium.__init__(self)
208
"""Serve requests until the client disconnects."""
209
# Keep a reference to stderr because the sys module's globals get set to
210
# None during interpreter shutdown.
211
from sys import stderr
213
while not self.finished:
214
server_protocol = self._build_protocol()
215
self._serve_one_request(server_protocol)
217
stderr.write("%s terminating on exception %s\n" % (self, e))
220
def _build_protocol(self):
221
"""Identifies the version of the incoming request, and returns an
222
a protocol object that can interpret it.
224
If more bytes than the version prefix of the request are read, they will
225
be fed into the protocol before it is returned.
227
:returns: a SmartServerRequestProtocol.
229
bytes = self._get_line()
230
protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
231
protocol = protocol_factory(
232
self.backing_transport, self._write_out, self.root_client_path)
233
protocol.accept_bytes(unused_bytes)
236
def _serve_one_request(self, protocol):
237
"""Read one request from input, process, send back a response.
239
:param protocol: a SmartServerRequestProtocol.
242
self._serve_one_request_unguarded(protocol)
243
except KeyboardInterrupt:
246
self.terminate_due_to_error()
248
def terminate_due_to_error(self):
249
"""Called when an unhandled exception from the protocol occurs."""
250
raise NotImplementedError(self.terminate_due_to_error)
252
def _read_bytes(self, desired_count):
253
"""Get some bytes from the medium.
255
:param desired_count: number of bytes we want to read.
257
raise NotImplementedError(self._read_bytes)
260
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
262
def __init__(self, sock, backing_transport, root_client_path='/'):
265
:param sock: the socket the server will read from. It will be put
268
SmartServerStreamMedium.__init__(
269
self, backing_transport, root_client_path=root_client_path)
270
sock.setblocking(True)
273
def _serve_one_request_unguarded(self, protocol):
274
while protocol.next_read_size():
275
# We can safely try to read large chunks. If there is less data
276
# than MAX_SOCKET_CHUNK ready, the socket will just return a
277
# short read immediately rather than block.
278
bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
282
protocol.accept_bytes(bytes)
284
self._push_back(protocol.unused_data)
286
def _read_bytes(self, desired_count):
287
return osutils.read_bytes_from_socket(
288
self.socket, self._report_activity)
290
def terminate_due_to_error(self):
291
# TODO: This should log to a server log file, but no such thing
292
# exists yet. Andrew Bennetts 2006-09-29.
296
def _write_out(self, bytes):
297
tstart = osutils.timer_func()
298
osutils.send_all(self.socket, bytes, self._report_activity)
299
if 'hpss' in debug.debug_flags:
300
thread_id = thread.get_ident()
301
trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
302
% ('wrote', thread_id, len(bytes),
303
osutils.timer_func() - tstart))
306
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
308
def __init__(self, in_file, out_file, backing_transport):
309
"""Construct new server.
311
:param in_file: Python file from which requests can be read.
312
:param out_file: Python file to write responses.
313
:param backing_transport: Transport for the directory served.
315
SmartServerStreamMedium.__init__(self, backing_transport)
316
if sys.platform == 'win32':
317
# force binary mode for files
319
for f in (in_file, out_file):
320
fileno = getattr(f, 'fileno', None)
322
msvcrt.setmode(fileno(), os.O_BINARY)
326
def _serve_one_request_unguarded(self, protocol):
328
# We need to be careful not to read past the end of the current
329
# request, or else the read from the pipe will block, so we use
330
# protocol.next_read_size().
331
bytes_to_read = protocol.next_read_size()
332
if bytes_to_read == 0:
333
# Finished serving this request.
336
bytes = self.read_bytes(bytes_to_read)
338
# Connection has been closed.
342
protocol.accept_bytes(bytes)
344
def _read_bytes(self, desired_count):
345
return self._in.read(desired_count)
347
def terminate_due_to_error(self):
348
# TODO: This should log to a server log file, but no such thing
349
# exists yet. Andrew Bennetts 2006-09-29.
353
def _write_out(self, bytes):
354
self._out.write(bytes)
357
class SmartClientMediumRequest(object):
358
"""A request on a SmartClientMedium.
360
Each request allows bytes to be provided to it via accept_bytes, and then
361
the response bytes to be read via read_bytes.
364
request.accept_bytes('123')
365
request.finished_writing()
366
result = request.read_bytes(3)
367
request.finished_reading()
369
It is up to the individual SmartClientMedium whether multiple concurrent
370
requests can exist. See SmartClientMedium.get_request to obtain instances
371
of SmartClientMediumRequest, and the concrete Medium you are using for
372
details on concurrency and pipelining.
375
def __init__(self, medium):
376
"""Construct a SmartClientMediumRequest for the medium medium."""
377
self._medium = medium
378
# we track state by constants - we may want to use the same
379
# pattern as BodyReader if it gets more complex.
380
# valid states are: "writing", "reading", "done"
381
self._state = "writing"
383
def accept_bytes(self, bytes):
384
"""Accept bytes for inclusion in this request.
386
This method may not be called after finished_writing() has been
387
called. It depends upon the Medium whether or not the bytes will be
388
immediately transmitted. Message based Mediums will tend to buffer the
389
bytes until finished_writing() is called.
391
:param bytes: A bytestring.
393
if self._state != "writing":
394
raise errors.WritingCompleted(self)
395
self._accept_bytes(bytes)
397
def _accept_bytes(self, bytes):
398
"""Helper for accept_bytes.
400
Accept_bytes checks the state of the request to determing if bytes
401
should be accepted. After that it hands off to _accept_bytes to do the
404
raise NotImplementedError(self._accept_bytes)
406
def finished_reading(self):
407
"""Inform the request that all desired data has been read.
409
This will remove the request from the pipeline for its medium (if the
410
medium supports pipelining) and any further calls to methods on the
411
request will raise ReadingCompleted.
413
if self._state == "writing":
414
raise errors.WritingNotComplete(self)
415
if self._state != "reading":
416
raise errors.ReadingCompleted(self)
418
self._finished_reading()
420
def _finished_reading(self):
421
"""Helper for finished_reading.
423
finished_reading checks the state of the request to determine if
424
finished_reading is allowed, and if it is hands off to _finished_reading
425
to perform the action.
427
raise NotImplementedError(self._finished_reading)
429
def finished_writing(self):
430
"""Finish the writing phase of this request.
432
This will flush all pending data for this request along the medium.
433
After calling finished_writing, you may not call accept_bytes anymore.
435
if self._state != "writing":
436
raise errors.WritingCompleted(self)
437
self._state = "reading"
438
self._finished_writing()
440
def _finished_writing(self):
441
"""Helper for finished_writing.
443
finished_writing checks the state of the request to determine if
444
finished_writing is allowed, and if it is hands off to _finished_writing
445
to perform the action.
447
raise NotImplementedError(self._finished_writing)
449
def read_bytes(self, count):
450
"""Read bytes from this requests response.
452
This method will block and wait for count bytes to be read. It may not
453
be invoked until finished_writing() has been called - this is to ensure
454
a message-based approach to requests, for compatibility with message
455
based mediums like HTTP.
457
if self._state == "writing":
458
raise errors.WritingNotComplete(self)
459
if self._state != "reading":
460
raise errors.ReadingCompleted(self)
461
return self._read_bytes(count)
463
def _read_bytes(self, count):
464
"""Helper for SmartClientMediumRequest.read_bytes.
466
read_bytes checks the state of the request to determing if bytes
467
should be read. After that it hands off to _read_bytes to do the
470
By default this forwards to self._medium.read_bytes because we are
471
operating on the medium's stream.
473
return self._medium.read_bytes(count)
476
line = self._read_line()
477
if not line.endswith('\n'):
478
# end of file encountered reading from server
479
raise errors.ConnectionReset(
480
"Unexpected end of message. Please check connectivity "
481
"and permissions, and report a bug if problems persist.")
484
def _read_line(self):
485
"""Helper for SmartClientMediumRequest.read_line.
487
By default this forwards to self._medium._get_line because we are
488
operating on the medium's stream.
490
return self._medium._get_line()
493
class _DebugCounter(object):
494
"""An object that counts the HPSS calls made to each client medium.
496
When a medium is garbage-collected, or failing that when
497
bzrlib.global_state exits, the total number of calls made on that medium
498
are reported via trace.note.
502
self.counts = weakref.WeakKeyDictionary()
503
client._SmartClient.hooks.install_named_hook(
504
'call', self.increment_call_count, 'hpss call counter')
505
bzrlib.global_state.cleanups.add_cleanup(self.flush_all)
507
def track(self, medium):
508
"""Start tracking calls made to a medium.
510
This only keeps a weakref to the medium, so shouldn't affect the
513
medium_repr = repr(medium)
514
# Add this medium to the WeakKeyDictionary
515
self.counts[medium] = dict(count=0, vfs_count=0,
516
medium_repr=medium_repr)
517
# Weakref callbacks are fired in reverse order of their association
518
# with the referenced object. So we add a weakref *after* adding to
519
# the WeakKeyDict so that we can report the value from it before the
520
# entry is removed by the WeakKeyDict's own callback.
521
ref = weakref.ref(medium, self.done)
523
def increment_call_count(self, params):
524
# Increment the count in the WeakKeyDictionary
525
value = self.counts[params.medium]
528
request_method = request.request_handlers.get(params.method)
530
# A method we don't know about doesn't count as a VFS method.
532
if issubclass(request_method, vfs.VfsRequest):
533
value['vfs_count'] += 1
536
value = self.counts[ref]
537
count, vfs_count, medium_repr = (
538
value['count'], value['vfs_count'], value['medium_repr'])
539
# In case this callback is invoked for the same ref twice (by the
540
# weakref callback and by the atexit function), set the call count back
541
# to 0 so this item won't be reported twice.
543
value['vfs_count'] = 0
545
trace.note('HPSS calls: %d (%d vfs) %s',
546
count, vfs_count, medium_repr)
549
for ref in list(self.counts.keys()):
552
_debug_counter = None
555
class SmartClientMedium(SmartMedium):
556
"""Smart client is a medium for sending smart protocol requests over."""
558
def __init__(self, base):
559
super(SmartClientMedium, self).__init__()
561
self._protocol_version_error = None
562
self._protocol_version = None
563
self._done_hello = False
564
# Be optimistic: we assume the remote end can accept new remote
565
# requests until we get an error saying otherwise.
566
# _remote_version_is_before tracks the bzr version the remote side
567
# can be based on what we've seen so far.
568
self._remote_version_is_before = None
569
# Install debug hook function if debug flag is set.
570
if 'hpss' in debug.debug_flags:
571
global _debug_counter
572
if _debug_counter is None:
573
_debug_counter = _DebugCounter()
574
_debug_counter.track(self)
576
def _is_remote_before(self, version_tuple):
577
"""Is it possible the remote side supports RPCs for a given version?
581
needed_version = (1, 2)
582
if medium._is_remote_before(needed_version):
583
fallback_to_pre_1_2_rpc()
587
except UnknownSmartMethod:
588
medium._remember_remote_is_before(needed_version)
589
fallback_to_pre_1_2_rpc()
591
:seealso: _remember_remote_is_before
593
if self._remote_version_is_before is None:
594
# So far, the remote side seems to support everything
596
return version_tuple >= self._remote_version_is_before
598
def _remember_remote_is_before(self, version_tuple):
599
"""Tell this medium that the remote side is older the given version.
601
:seealso: _is_remote_before
603
if (self._remote_version_is_before is not None and
604
version_tuple > self._remote_version_is_before):
605
# We have been told that the remote side is older than some version
606
# which is newer than a previously supplied older-than version.
607
# This indicates that some smart verb call is not guarded
608
# appropriately (it should simply not have been tried).
610
"_remember_remote_is_before(%r) called, but "
611
"_remember_remote_is_before(%r) was called previously."
612
, version_tuple, self._remote_version_is_before)
613
if 'hpss' in debug.debug_flags:
614
ui.ui_factory.show_warning(
615
"_remember_remote_is_before(%r) called, but "
616
"_remember_remote_is_before(%r) was called previously."
617
% (version_tuple, self._remote_version_is_before))
619
self._remote_version_is_before = version_tuple
621
def protocol_version(self):
622
"""Find out if 'hello' smart request works."""
623
if self._protocol_version_error is not None:
624
raise self._protocol_version_error
625
if not self._done_hello:
627
medium_request = self.get_request()
628
# Send a 'hello' request in protocol version one, for maximum
629
# backwards compatibility.
630
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
631
client_protocol.query_version()
632
self._done_hello = True
633
except errors.SmartProtocolError, e:
634
# Cache the error, just like we would cache a successful
636
self._protocol_version_error = e
640
def should_probe(self):
641
"""Should RemoteBzrDirFormat.probe_transport send a smart request on
644
Some transports are unambiguously smart-only; there's no need to check
645
if the transport is able to carry smart requests, because that's all
646
it is for. In those cases, this method should return False.
648
But some HTTP transports can sometimes fail to carry smart requests,
649
but still be usuable for accessing remote bzrdirs via plain file
650
accesses. So for those transports, their media should return True here
651
so that RemoteBzrDirFormat can determine if it is appropriate for that
656
def disconnect(self):
657
"""If this medium maintains a persistent connection, close it.
659
The default implementation does nothing.
662
def remote_path_from_transport(self, transport):
663
"""Convert transport into a path suitable for using in a request.
665
Note that the resulting remote path doesn't encode the host name or
666
anything but path, so it is only safe to use it in requests sent over
667
the medium from the matching transport.
669
medium_base = urlutils.join(self.base, '/')
670
rel_url = urlutils.relative_url(medium_base, transport.base)
671
return urllib.unquote(rel_url)
674
class SmartClientStreamMedium(SmartClientMedium):
675
"""Stream based medium common class.
677
SmartClientStreamMediums operate on a stream. All subclasses use a common
678
SmartClientStreamMediumRequest for their requests, and should implement
679
_accept_bytes and _read_bytes to allow the request objects to send and
683
def __init__(self, base):
684
SmartClientMedium.__init__(self, base)
685
self._current_request = None
687
def accept_bytes(self, bytes):
688
self._accept_bytes(bytes)
691
"""The SmartClientStreamMedium knows how to close the stream when it is
697
"""Flush the output stream.
699
This method is used by the SmartClientStreamMediumRequest to ensure that
700
all data for a request is sent, to avoid long timeouts or deadlocks.
702
raise NotImplementedError(self._flush)
704
def get_request(self):
705
"""See SmartClientMedium.get_request().
707
SmartClientStreamMedium always returns a SmartClientStreamMediumRequest
710
return SmartClientStreamMediumRequest(self)
713
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
714
"""A client medium using simple pipes.
716
This client does not manage the pipes: it assumes they will always be open.
719
def __init__(self, readable_pipe, writeable_pipe, base):
720
SmartClientStreamMedium.__init__(self, base)
721
self._readable_pipe = readable_pipe
722
self._writeable_pipe = writeable_pipe
724
def _accept_bytes(self, bytes):
725
"""See SmartClientStreamMedium.accept_bytes."""
726
self._writeable_pipe.write(bytes)
727
self._report_activity(len(bytes), 'write')
730
"""See SmartClientStreamMedium._flush()."""
731
self._writeable_pipe.flush()
733
def _read_bytes(self, count):
734
"""See SmartClientStreamMedium._read_bytes."""
735
bytes_to_read = min(count, _MAX_READ_SIZE)
736
bytes = self._readable_pipe.read(bytes_to_read)
737
self._report_activity(len(bytes), 'read')
741
class SSHParams(object):
742
"""A set of parameters for starting a remote bzr via SSH."""
744
def __init__(self, host, port=None, username=None, password=None,
745
bzr_remote_path='bzr'):
748
self.username = username
749
self.password = password
750
self.bzr_remote_path = bzr_remote_path
753
class SmartSSHClientMedium(SmartClientStreamMedium):
754
"""A client medium using SSH.
756
It delegates IO to a SmartClientSocketMedium or
757
SmartClientAlreadyConnectedSocketMedium (depending on platform).
760
def __init__(self, base, ssh_params, vendor=None):
761
"""Creates a client that will connect on the first use.
763
:param ssh_params: A SSHParams instance.
764
:param vendor: An optional override for the ssh vendor to use. See
765
bzrlib.transport.ssh for details on ssh vendors.
767
self._real_medium = None
768
self._ssh_params = ssh_params
769
# for the benefit of progress making a short description of this
771
self._scheme = 'bzr+ssh'
772
# SmartClientStreamMedium stores the repr of this object in its
773
# _DebugCounter so we have to store all the values used in our repr
774
# method before calling the super init.
775
SmartClientStreamMedium.__init__(self, base)
776
self._vendor = vendor
777
self._ssh_connection = None
780
if self._ssh_params.port is None:
783
maybe_port = ':%s' % self._ssh_params.port
784
return "%s(%s://%s@%s%s/)" % (
785
self.__class__.__name__,
787
self._ssh_params.username,
788
self._ssh_params.host,
791
def _accept_bytes(self, bytes):
792
"""See SmartClientStreamMedium.accept_bytes."""
793
self._ensure_connection()
794
self._real_medium.accept_bytes(bytes)
796
def disconnect(self):
797
"""See SmartClientMedium.disconnect()."""
798
if self._real_medium is not None:
799
self._real_medium.disconnect()
800
self._real_medium = None
801
if self._ssh_connection is not None:
802
self._ssh_connection.close()
803
self._ssh_connection = None
805
def _ensure_connection(self):
806
"""Connect this medium if not already connected."""
807
if self._real_medium is not None:
809
if self._vendor is None:
810
vendor = ssh._get_ssh_vendor()
812
vendor = self._vendor
813
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
814
self._ssh_params.password, self._ssh_params.host,
815
self._ssh_params.port,
816
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
817
'--directory=/', '--allow-writes'])
818
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
819
if io_kind == 'socket':
820
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
821
self.base, io_object)
822
elif io_kind == 'pipes':
823
read_from, write_to = io_object
824
self._real_medium = SmartSimplePipesClientMedium(
825
read_from, write_to, self.base)
827
raise AssertionError(
828
"Unexpected io_kind %r from %r"
829
% (io_kind, self._ssh_connection))
832
"""See SmartClientStreamMedium._flush()."""
833
self._real_medium._flush()
835
def _read_bytes(self, count):
836
"""See SmartClientStreamMedium.read_bytes."""
837
if self._real_medium is None:
838
raise errors.MediumNotConnected(self)
839
return self._real_medium.read_bytes(count)
842
# Port 4155 is the default port for bzr://, registered with IANA.
843
BZR_DEFAULT_INTERFACE = None
844
BZR_DEFAULT_PORT = 4155
847
class SmartClientSocketMedium(SmartClientStreamMedium):
848
"""A client medium using a socket.
850
This class isn't usable directly. Use one of its subclasses instead.
853
def __init__(self, base):
854
SmartClientStreamMedium.__init__(self, base)
856
self._connected = False
858
def _accept_bytes(self, bytes):
859
"""See SmartClientMedium.accept_bytes."""
860
self._ensure_connection()
861
osutils.send_all(self._socket, bytes, self._report_activity)
863
def _ensure_connection(self):
864
"""Connect this medium if not already connected."""
865
raise NotImplementedError(self._ensure_connection)
868
"""See SmartClientStreamMedium._flush().
870
For sockets we do no flushing. For TCP sockets we may want to turn off
871
TCP_NODELAY and add a means to do a flush, but that can be done in the
875
def _read_bytes(self, count):
876
"""See SmartClientMedium.read_bytes."""
877
if not self._connected:
878
raise errors.MediumNotConnected(self)
879
return osutils.read_bytes_from_socket(
880
self._socket, self._report_activity)
882
def disconnect(self):
883
"""See SmartClientMedium.disconnect()."""
884
if not self._connected:
888
self._connected = False
891
class SmartTCPClientMedium(SmartClientSocketMedium):
892
"""A client medium that creates a TCP connection."""
894
def __init__(self, host, port, base):
895
"""Creates a client that will connect on the first use."""
896
SmartClientSocketMedium.__init__(self, base)
900
def _ensure_connection(self):
901
"""Connect this medium if not already connected."""
904
if self._port is None:
905
port = BZR_DEFAULT_PORT
907
port = int(self._port)
909
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
910
socket.SOCK_STREAM, 0, 0)
911
except socket.gaierror, (err_num, err_msg):
912
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
913
(self._host, port, err_msg))
914
# Initialize err in case there are no addresses returned:
915
err = socket.error("no address found for %s" % self._host)
916
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
918
self._socket = socket.socket(family, socktype, proto)
919
self._socket.setsockopt(socket.IPPROTO_TCP,
920
socket.TCP_NODELAY, 1)
921
self._socket.connect(sockaddr)
922
except socket.error, err:
923
if self._socket is not None:
928
if self._socket is None:
929
# socket errors either have a (string) or (errno, string) as their
931
if type(err.args) is str:
934
err_msg = err.args[1]
935
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
936
(self._host, port, err_msg))
937
self._connected = True
940
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
941
"""A client medium for an already connected socket.
943
Note that this class will assume it "owns" the socket, so it will close it
944
when its disconnect method is called.
947
def __init__(self, base, sock):
948
SmartClientSocketMedium.__init__(self, base)
950
self._connected = True
952
def _ensure_connection(self):
953
# Already connected, by definition! So nothing to do.
957
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
958
"""A SmartClientMediumRequest that works with an SmartClientStreamMedium."""
960
def __init__(self, medium):
961
SmartClientMediumRequest.__init__(self, medium)
962
# check that we are safe concurrency wise. If some streams start
963
# allowing concurrent requests - i.e. via multiplexing - then this
964
# assert should be moved to SmartClientStreamMedium.get_request,
965
# and the setting/unsetting of _current_request likewise moved into
966
# that class : but its unneeded overhead for now. RBC 20060922
967
if self._medium._current_request is not None:
968
raise errors.TooManyConcurrentRequests(self._medium)
969
self._medium._current_request = self
971
def _accept_bytes(self, bytes):
972
"""See SmartClientMediumRequest._accept_bytes.
974
This forwards to self._medium._accept_bytes because we are operating
975
on the mediums stream.
977
self._medium._accept_bytes(bytes)
979
def _finished_reading(self):
980
"""See SmartClientMediumRequest._finished_reading.
982
This clears the _current_request on self._medium to allow a new
983
request to be created.
985
if self._medium._current_request is not self:
986
raise AssertionError()
987
self._medium._current_request = None
989
def _finished_writing(self):
990
"""See SmartClientMediumRequest._finished_writing.
992
This invokes self._medium._flush to ensure all bytes are transmitted.
994
self._medium._flush()
added
removed
bzrlib/smart/medium.py
