1
# Copyright (C) 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Wire-level encoding and decoding of requests and responses for the smart
22
from cStringIO import StringIO
24
from bzrlib import debug
25
from bzrlib import errors
26
from bzrlib.smart import request
27
from bzrlib.trace import log_exception_quietly, mutter
30
# Protocol version strings. These are sent as prefixes of bzr requests and
31
# responses to identify the protocol version being used. (There are no version
32
# one strings because that version doesn't send any).
33
REQUEST_VERSION_TWO = 'bzr request 2\n'
34
RESPONSE_VERSION_TWO = 'bzr response 2\n'
37
def _recv_tuple(from_file):
38
req_line = from_file.readline()
39
return _decode_tuple(req_line)
42
def _decode_tuple(req_line):
43
if req_line == None or req_line == '':
45
if req_line[-1] != '\n':
46
raise errors.SmartProtocolError("request %r not terminated" % req_line)
47
return tuple(req_line[:-1].split('\x01'))
50
def _encode_tuple(args):
51
"""Encode the tuple args to a bytestream."""
52
return '\x01'.join(args) + '\n'
55
class SmartProtocolBase(object):
56
"""Methods common to client and server"""
58
# TODO: this only actually accomodates a single block; possibly should
59
# support multiple chunks?
60
def _encode_bulk_data(self, body):
61
"""Encode body as a bulk data chunk."""
62
return ''.join(('%d\n' % len(body), body, 'done\n'))
64
def _serialise_offsets(self, offsets):
65
"""Serialise a readv offset list."""
67
for start, length in offsets:
68
txt.append('%d,%d' % (start, length))
72
class SmartServerRequestProtocolOne(SmartProtocolBase):
73
"""Server-side encoding and decoding logic for smart version 1."""
75
def __init__(self, backing_transport, write_func):
76
self._backing_transport = backing_transport
77
self.excess_buffer = ''
78
self._finished = False
80
self.has_dispatched = False
82
self._body_decoder = None
83
self._write_func = write_func
85
def accept_bytes(self, bytes):
86
"""Take bytes, and advance the internal state machine appropriately.
88
:param bytes: must be a byte string
90
assert isinstance(bytes, str)
91
self.in_buffer += bytes
92
if not self.has_dispatched:
93
if '\n' not in self.in_buffer:
96
self.has_dispatched = True
98
first_line, self.in_buffer = self.in_buffer.split('\n', 1)
100
req_args = _decode_tuple(first_line)
101
self.request = request.SmartServerRequestHandler(
102
self._backing_transport, commands=request.request_handlers)
103
self.request.dispatch_command(req_args[0], req_args[1:])
104
if self.request.finished_reading:
106
self.excess_buffer = self.in_buffer
108
self._send_response(self.request.response)
109
except KeyboardInterrupt:
111
except Exception, exception:
112
# everything else: pass to client, flush, and quit
113
log_exception_quietly()
114
self._send_response(request.FailedSmartServerResponse(
115
('error', str(exception))))
118
if self.has_dispatched:
120
# nothing to do.XXX: this routine should be a single state
122
self.excess_buffer += self.in_buffer
125
if self._body_decoder is None:
126
self._body_decoder = LengthPrefixedBodyDecoder()
127
self._body_decoder.accept_bytes(self.in_buffer)
128
self.in_buffer = self._body_decoder.unused_data
129
body_data = self._body_decoder.read_pending_data()
130
self.request.accept_body(body_data)
131
if self._body_decoder.finished_reading:
132
self.request.end_of_body()
133
assert self.request.finished_reading, \
134
"no more body, request not finished"
135
if self.request.response is not None:
136
self._send_response(self.request.response)
137
self.excess_buffer = self.in_buffer
140
assert not self.request.finished_reading, \
141
"no response and we have finished reading."
143
def _send_response(self, response):
144
"""Send a smart server response down the output stream."""
145
assert not self._finished, 'response already sent'
148
self._finished = True
149
self._write_protocol_version()
150
self._write_success_or_failure_prefix(response)
151
self._write_func(_encode_tuple(args))
153
assert isinstance(body, str), 'body must be a str'
154
bytes = self._encode_bulk_data(body)
155
self._write_func(bytes)
157
def _write_protocol_version(self):
158
"""Write any prefixes this protocol requires.
160
Version one doesn't send protocol versions.
163
def _write_success_or_failure_prefix(self, response):
164
"""Write the protocol specific success/failure prefix.
166
For SmartServerRequestProtocolOne this is omitted but we
167
call is_successful to ensure that the response is valid.
169
response.is_successful()
171
def next_read_size(self):
174
if self._body_decoder is None:
177
return self._body_decoder.next_read_size()
180
class SmartServerRequestProtocolTwo(SmartServerRequestProtocolOne):
181
r"""Version two of the server side of the smart protocol.
183
This prefixes responses with the value of RESPONSE_VERSION_TWO.
186
def _write_success_or_failure_prefix(self, response):
187
"""Write the protocol specific success/failure prefix."""
188
if response.is_successful():
189
self._write_func('success\n')
191
self._write_func('failed\n')
193
def _write_protocol_version(self):
194
r"""Write any prefixes this protocol requires.
196
Version two sends the value of RESPONSE_VERSION_TWO.
198
self._write_func(RESPONSE_VERSION_TWO)
201
class LengthPrefixedBodyDecoder(object):
202
"""Decodes the length-prefixed bulk data."""
205
self.bytes_left = None
206
self.finished_reading = False
207
self.unused_data = ''
208
self.state_accept = self._state_accept_expecting_length
209
self.state_read = self._state_read_no_data
211
self._trailer_buffer = ''
213
def accept_bytes(self, bytes):
214
"""Decode as much of bytes as possible.
216
If 'bytes' contains too much data it will be appended to
219
finished_reading will be set when no more data is required. Further
220
data will be appended to self.unused_data.
222
# accept_bytes is allowed to change the state
223
current_state = self.state_accept
224
self.state_accept(bytes)
225
while current_state != self.state_accept:
226
current_state = self.state_accept
227
self.state_accept('')
229
def next_read_size(self):
230
if self.bytes_left is not None:
231
# Ideally we want to read all the remainder of the body and the
233
return self.bytes_left + 5
234
elif self.state_accept == self._state_accept_reading_trailer:
235
# Just the trailer left
236
return 5 - len(self._trailer_buffer)
237
elif self.state_accept == self._state_accept_expecting_length:
238
# There's still at least 6 bytes left ('\n' to end the length, plus
242
# Reading excess data. Either way, 1 byte at a time is fine.
245
def read_pending_data(self):
246
"""Return any pending data that has been decoded."""
247
return self.state_read()
249
def _state_accept_expecting_length(self, bytes):
250
self._in_buffer += bytes
251
pos = self._in_buffer.find('\n')
254
self.bytes_left = int(self._in_buffer[:pos])
255
self._in_buffer = self._in_buffer[pos+1:]
256
self.bytes_left -= len(self._in_buffer)
257
self.state_accept = self._state_accept_reading_body
258
self.state_read = self._state_read_in_buffer
260
def _state_accept_reading_body(self, bytes):
261
self._in_buffer += bytes
262
self.bytes_left -= len(bytes)
263
if self.bytes_left <= 0:
265
if self.bytes_left != 0:
266
self._trailer_buffer = self._in_buffer[self.bytes_left:]
267
self._in_buffer = self._in_buffer[:self.bytes_left]
268
self.bytes_left = None
269
self.state_accept = self._state_accept_reading_trailer
271
def _state_accept_reading_trailer(self, bytes):
272
self._trailer_buffer += bytes
273
# TODO: what if the trailer does not match "done\n"? Should this raise
274
# a ProtocolViolation exception?
275
if self._trailer_buffer.startswith('done\n'):
276
self.unused_data = self._trailer_buffer[len('done\n'):]
277
self.state_accept = self._state_accept_reading_unused
278
self.finished_reading = True
280
def _state_accept_reading_unused(self, bytes):
281
self.unused_data += bytes
283
def _state_read_no_data(self):
286
def _state_read_in_buffer(self):
287
result = self._in_buffer
292
class SmartClientRequestProtocolOne(SmartProtocolBase):
293
"""The client-side protocol for smart version 1."""
295
def __init__(self, request):
296
"""Construct a SmartClientRequestProtocolOne.
298
:param request: A SmartClientMediumRequest to serialise onto and
301
self._request = request
302
self._body_buffer = None
304
def call(self, *args):
305
if 'hpss' in debug.debug_flags:
306
mutter('hpss call: %r', args)
307
self._write_args(args)
308
self._request.finished_writing()
310
def call_with_body_bytes(self, args, body):
311
"""Make a remote call of args with body bytes 'body'.
313
After calling this, call read_response_tuple to find the result out.
315
if 'hpss' in debug.debug_flags:
316
mutter('hpss call w/body: %r (%r...)', args, body[:20])
317
self._write_args(args)
318
bytes = self._encode_bulk_data(body)
319
self._request.accept_bytes(bytes)
320
self._request.finished_writing()
322
def call_with_body_readv_array(self, args, body):
323
"""Make a remote call with a readv array.
325
The body is encoded with one line per readv offset pair. The numbers in
326
each pair are separated by a comma, and no trailing \n is emitted.
328
if 'hpss' in debug.debug_flags:
329
mutter('hpss call w/readv: %r', args)
330
self._write_args(args)
331
readv_bytes = self._serialise_offsets(body)
332
bytes = self._encode_bulk_data(readv_bytes)
333
self._request.accept_bytes(bytes)
334
self._request.finished_writing()
336
def cancel_read_body(self):
337
"""After expecting a body, a response code may indicate one otherwise.
339
This method lets the domain client inform the protocol that no body
340
will be transmitted. This is a terminal method: after calling it the
341
protocol is not able to be used further.
343
self._request.finished_reading()
345
def read_response_tuple(self, expect_body=False):
346
"""Read a response tuple from the wire.
348
This should only be called once.
350
result = self._recv_tuple()
351
if 'hpss' in debug.debug_flags:
352
mutter('hpss result: %r', result)
354
self._request.finished_reading()
357
def read_body_bytes(self, count=-1):
358
"""Read bytes from the body, decoding into a byte stream.
360
We read all bytes at once to ensure we've checked the trailer for
361
errors, and then feed the buffer back as read_body_bytes is called.
363
if self._body_buffer is not None:
364
return self._body_buffer.read(count)
365
_body_decoder = LengthPrefixedBodyDecoder()
367
while not _body_decoder.finished_reading:
368
bytes_wanted = _body_decoder.next_read_size()
369
bytes = self._request.read_bytes(bytes_wanted)
370
_body_decoder.accept_bytes(bytes)
371
self._request.finished_reading()
372
self._body_buffer = StringIO(_body_decoder.read_pending_data())
373
# XXX: TODO check the trailer result.
374
return self._body_buffer.read(count)
376
def _recv_tuple(self):
377
"""Receive a tuple from the medium request."""
378
return _decode_tuple(self._recv_line())
380
def _recv_line(self):
381
"""Read an entire line from the medium request."""
383
while not line or line[-1] != '\n':
384
# TODO: this is inefficient - but tuples are short.
385
new_char = self._request.read_bytes(1)
387
assert new_char != '', "end of file reading from server."
390
def query_version(self):
391
"""Return protocol version number of the server."""
393
resp = self.read_response_tuple()
394
if resp == ('ok', '1'):
396
elif resp == ('ok', '2'):
399
raise errors.SmartProtocolError("bad response %r" % (resp,))
401
def _write_args(self, args):
402
self._write_protocol_version()
403
bytes = _encode_tuple(args)
404
self._request.accept_bytes(bytes)
406
def _write_protocol_version(self):
407
"""Write any prefixes this protocol requires.
409
Version one doesn't send protocol versions.
413
class SmartClientRequestProtocolTwo(SmartClientRequestProtocolOne):
414
"""Version two of the client side of the smart protocol.
416
This prefixes the request with the value of REQUEST_VERSION_TWO.
419
def read_response_tuple(self, expect_body=False):
420
"""Read a response tuple from the wire.
422
This should only be called once.
424
version = self._request.read_line()
425
if version != RESPONSE_VERSION_TWO:
426
raise errors.SmartProtocolError('bad protocol marker %r' % version)
427
response_status = self._recv_line()
428
if response_status not in ('success\n', 'failed\n'):
429
raise errors.SmartProtocolError(
430
'bad protocol status %r' % response_status)
431
self.response_status = response_status == 'success\n'
432
return SmartClientRequestProtocolOne.read_response_tuple(self, expect_body)
434
def _write_protocol_version(self):
435
r"""Write any prefixes this protocol requires.
437
Version two sends the value of REQUEST_VERSION_TWO.
439
self._request.accept_bytes(REQUEST_VERSION_TWO)
added
removed
bzrlib/smart/protocol.py
