1
# Copyright (C) 2006-2010 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(), """
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):
180
"""Handles smart commands coming over a stream.
182
The stream may be a pipe connected to sshd, or a tcp socket, or an
183
in-process fifo for testing.
185
One instance is created for each connected client; it can serve multiple
186
requests in the lifetime of the connection.
188
The server passes requests through to an underlying backing transport,
189
which will typically be a LocalTransport looking at the server's filesystem.
191
:ivar _push_back_buffer: a str of bytes that have been read from the stream
192
but not used yet, or None if there are no buffered bytes. Subclasses
193
should make sure to exhaust this buffer before reading more bytes from
194
the stream. See also the _push_back method.
197
def __init__(self, backing_transport, root_client_path='/'):
198
"""Construct new server.
200
:param backing_transport: Transport for the directory served.
202
# backing_transport could be passed to serve instead of __init__
203
self.backing_transport = backing_transport
204
self.root_client_path = root_client_path
205
self.finished = False
206
SmartMedium.__init__(self)
209
"""Serve requests until the client disconnects."""
210
# Keep a reference to stderr because the sys module's globals get set to
211
# None during interpreter shutdown.
212
from sys import stderr
214
while not self.finished:
215
server_protocol = self._build_protocol()
216
self._serve_one_request(server_protocol)
218
stderr.write("%s terminating on exception %s\n" % (self, e))
221
def _build_protocol(self):
222
"""Identifies the version of the incoming request, and returns an
223
a protocol object that can interpret it.
225
If more bytes than the version prefix of the request are read, they will
226
be fed into the protocol before it is returned.
228
:returns: a SmartServerRequestProtocol.
230
bytes = self._get_line()
231
protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
232
protocol = protocol_factory(
233
self.backing_transport, self._write_out, self.root_client_path)
234
protocol.accept_bytes(unused_bytes)
237
def _serve_one_request(self, protocol):
238
"""Read one request from input, process, send back a response.
240
:param protocol: a SmartServerRequestProtocol.
243
self._serve_one_request_unguarded(protocol)
244
except KeyboardInterrupt:
247
self.terminate_due_to_error()
249
def terminate_due_to_error(self):
250
"""Called when an unhandled exception from the protocol occurs."""
251
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
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
263
def __init__(self, sock, backing_transport, root_client_path='/'):
266
:param sock: the socket the server will read from. It will be put
269
SmartServerStreamMedium.__init__(
270
self, backing_transport, root_client_path=root_client_path)
271
sock.setblocking(True)
274
def _serve_one_request_unguarded(self, protocol):
275
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)
291
def terminate_due_to_error(self):
292
# TODO: This should log to a server log file, but no such thing
293
# exists yet. Andrew Bennetts 2006-09-29.
297
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))
307
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
309
def __init__(self, in_file, out_file, backing_transport):
310
"""Construct new server.
312
:param in_file: Python file from which requests can be read.
313
:param out_file: Python file to write responses.
314
:param backing_transport: Transport for the directory served.
316
SmartServerStreamMedium.__init__(self, backing_transport)
317
if sys.platform == 'win32':
318
# force binary mode for files
320
for f in (in_file, out_file):
321
fileno = getattr(f, 'fileno', None)
323
msvcrt.setmode(fileno(), os.O_BINARY)
327
def _serve_one_request_unguarded(self, protocol):
329
# We need to be careful not to read past the end of the current
330
# request, or else the read from the pipe will block, so we use
331
# protocol.next_read_size().
332
bytes_to_read = protocol.next_read_size()
333
if bytes_to_read == 0:
334
# Finished serving this request.
337
bytes = self.read_bytes(bytes_to_read)
339
# Connection has been closed.
343
protocol.accept_bytes(bytes)
345
def _read_bytes(self, desired_count):
346
return self._in.read(desired_count)
348
def terminate_due_to_error(self):
349
# TODO: This should log to a server log file, but no such thing
350
# exists yet. Andrew Bennetts 2006-09-29.
354
def _write_out(self, bytes):
355
self._out.write(bytes)
358
class SmartClientMediumRequest(object):
359
"""A request on a SmartClientMedium.
361
Each request allows bytes to be provided to it via accept_bytes, and then
362
the response bytes to be read via read_bytes.
365
request.accept_bytes('123')
366
request.finished_writing()
367
result = request.read_bytes(3)
368
request.finished_reading()
370
It is up to the individual SmartClientMedium whether multiple concurrent
371
requests can exist. See SmartClientMedium.get_request to obtain instances
372
of SmartClientMediumRequest, and the concrete Medium you are using for
373
details on concurrency and pipelining.
376
def __init__(self, medium):
377
"""Construct a SmartClientMediumRequest for the medium medium."""
378
self._medium = medium
379
# we track state by constants - we may want to use the same
380
# pattern as BodyReader if it gets more complex.
381
# valid states are: "writing", "reading", "done"
382
self._state = "writing"
384
def accept_bytes(self, bytes):
385
"""Accept bytes for inclusion in this request.
387
This method may not be called after finished_writing() has been
388
called. It depends upon the Medium whether or not the bytes will be
389
immediately transmitted. Message based Mediums will tend to buffer the
390
bytes until finished_writing() is called.
392
:param bytes: A bytestring.
394
if self._state != "writing":
395
raise errors.WritingCompleted(self)
396
self._accept_bytes(bytes)
398
def _accept_bytes(self, bytes):
399
"""Helper for accept_bytes.
401
Accept_bytes checks the state of the request to determing if bytes
402
should be accepted. After that it hands off to _accept_bytes to do the
405
raise NotImplementedError(self._accept_bytes)
407
def finished_reading(self):
408
"""Inform the request that all desired data has been read.
410
This will remove the request from the pipeline for its medium (if the
411
medium supports pipelining) and any further calls to methods on the
412
request will raise ReadingCompleted.
414
if self._state == "writing":
415
raise errors.WritingNotComplete(self)
416
if self._state != "reading":
417
raise errors.ReadingCompleted(self)
419
self._finished_reading()
421
def _finished_reading(self):
422
"""Helper for finished_reading.
424
finished_reading checks the state of the request to determine if
425
finished_reading is allowed, and if it is hands off to _finished_reading
426
to perform the action.
428
raise NotImplementedError(self._finished_reading)
430
def finished_writing(self):
431
"""Finish the writing phase of this request.
433
This will flush all pending data for this request along the medium.
434
After calling finished_writing, you may not call accept_bytes anymore.
436
if self._state != "writing":
437
raise errors.WritingCompleted(self)
438
self._state = "reading"
439
self._finished_writing()
441
def _finished_writing(self):
442
"""Helper for finished_writing.
444
finished_writing checks the state of the request to determine if
445
finished_writing is allowed, and if it is hands off to _finished_writing
446
to perform the action.
448
raise NotImplementedError(self._finished_writing)
450
def read_bytes(self, count):
451
"""Read bytes from this requests response.
453
This method will block and wait for count bytes to be read. It may not
454
be invoked until finished_writing() has been called - this is to ensure
455
a message-based approach to requests, for compatibility with message
456
based mediums like HTTP.
458
if self._state == "writing":
459
raise errors.WritingNotComplete(self)
460
if self._state != "reading":
461
raise errors.ReadingCompleted(self)
462
return self._read_bytes(count)
464
def _read_bytes(self, count):
465
"""Helper for SmartClientMediumRequest.read_bytes.
467
read_bytes checks the state of the request to determing if bytes
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.
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):
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
657
def disconnect(self):
658
"""If this medium maintains a persistent connection, close it.
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)
675
class SmartClientStreamMedium(SmartClientMedium):
676
"""Stream based medium common class.
678
SmartClientStreamMediums operate on a stream. All subclasses use a common
679
SmartClientStreamMediumRequest for their requests, and should implement
680
_accept_bytes and _read_bytes to allow the request objects to send and
684
def __init__(self, base):
685
SmartClientMedium.__init__(self, base)
686
self._current_request = None
688
def accept_bytes(self, bytes):
689
self._accept_bytes(bytes)
692
"""The SmartClientStreamMedium knows how to close the stream when it is
698
"""Flush the output stream.
700
This method is used by the SmartClientStreamMediumRequest to ensure that
701
all data for a request is sent, to avoid long timeouts or deadlocks.
703
raise NotImplementedError(self._flush)
705
def get_request(self):
706
"""See SmartClientMedium.get_request().
708
SmartClientStreamMedium always returns a SmartClientStreamMediumRequest
711
return SmartClientStreamMediumRequest(self)
714
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
715
"""A client medium using simple pipes.
717
This client does not manage the pipes: it assumes they will always be open.
720
def __init__(self, readable_pipe, writeable_pipe, base):
721
SmartClientStreamMedium.__init__(self, base)
722
self._readable_pipe = readable_pipe
723
self._writeable_pipe = writeable_pipe
725
def _accept_bytes(self, bytes):
726
"""See SmartClientStreamMedium.accept_bytes."""
727
self._writeable_pipe.write(bytes)
728
self._report_activity(len(bytes), 'write')
731
"""See SmartClientStreamMedium._flush()."""
732
self._writeable_pipe.flush()
734
def _read_bytes(self, count):
735
"""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."""
745
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
"""Creates a client that will connect on the first use.
764
:param ssh_params: A SSHParams instance.
765
:param vendor: An optional override for the ssh vendor to use. See
766
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)
777
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,
792
def _accept_bytes(self, bytes):
793
"""See SmartClientStreamMedium.accept_bytes."""
794
self._ensure_connection()
795
self._real_medium.accept_bytes(bytes)
797
def disconnect(self):
798
"""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
806
def _ensure_connection(self):
807
"""Connect this medium if not already connected."""
808
if self._real_medium is not None:
810
if self._vendor is None:
811
vendor = ssh._get_ssh_vendor()
813
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))
833
"""See SmartClientStreamMedium._flush()."""
834
self._real_medium._flush()
836
def _read_bytes(self, count):
837
"""See SmartClientStreamMedium.read_bytes."""
838
if self._real_medium is None:
839
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.
851
This class isn't usable directly. Use one of its subclasses instead.
854
def __init__(self, base):
855
SmartClientStreamMedium.__init__(self, base)
857
self._connected = False
859
def _accept_bytes(self, bytes):
860
"""See SmartClientMedium.accept_bytes."""
861
self._ensure_connection()
862
osutils.send_all(self._socket, bytes, self._report_activity)
864
def _ensure_connection(self):
865
"""Connect this medium if not already connected."""
866
raise NotImplementedError(self._ensure_connection)
869
"""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
876
def _read_bytes(self, count):
877
"""See SmartClientMedium.read_bytes."""
878
if not self._connected:
879
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.
958
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
959
"""A SmartClientMediumRequest that works with an SmartClientStreamMedium."""
961
def __init__(self, medium):
962
SmartClientMediumRequest.__init__(self, medium)
963
# check that we are safe concurrency wise. If some streams start
964
# allowing concurrent requests - i.e. via multiplexing - then this
965
# assert should be moved to SmartClientStreamMedium.get_request,
966
# and the setting/unsetting of _current_request likewise moved into
967
# that class : but its unneeded overhead for now. RBC 20060922
968
if self._medium._current_request is not None:
969
raise errors.TooManyConcurrentRequests(self._medium)
970
self._medium._current_request = self
972
def _accept_bytes(self, bytes):
973
"""See SmartClientMediumRequest._accept_bytes.
975
This forwards to self._medium._accept_bytes because we are operating
976
on the mediums stream.
978
self._medium._accept_bytes(bytes)
980
def _finished_reading(self):
981
"""See SmartClientMediumRequest._finished_reading.
983
This clears the _current_request on self._medium to allow a new
984
request to be created.
986
if self._medium._current_request is not self:
987
raise AssertionError()
988
self._medium._current_request = None
990
def _finished_writing(self):
991
"""See SmartClientMediumRequest._finished_writing.
993
This invokes self._medium._flush to ensure all bytes are transmitted.
995
self._medium._flush()
added
removed
bzrlib/smart/medium.py
