14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Basic server-side logic for dealing with requests."""
17
"""Basic server-side logic for dealing with requests.
21
The class names are a little confusing: the protocol will instantiate a
22
SmartServerRequestHandler, whose dispatch_command method creates an instance of
23
a SmartServerRequest subclass.
25
The request_handlers registry tracks SmartServerRequest classes (rather than
26
SmartServerRequestHandler).
28
38
from bzrlib.bundle.serializer import write_bundle
31
41
class SmartServerRequest(object):
32
"""Base class for request handlers."""
42
"""Base class for request handlers.
44
To define a new request, subclass this class and override the `do` method
45
(and if appropriate, `do_body` as well). Request implementors should take
46
care to call `translate_client_path` and `transport_from_client_path` as
47
appropriate when dealing with paths received from the client.
49
# XXX: rename this class to BaseSmartServerRequestHandler ? A request
50
# *handler* is a different concept to the request.
34
def __init__(self, backing_transport):
52
def __init__(self, backing_transport, root_client_path='/'):
37
55
:param backing_transport: the base transport to be used when performing
57
:param root_client_path: the client path that maps to the root of
58
backing_transport. This is used to interpret relpaths received
59
from the client. Clients will not be able to refer to paths above
60
this root. If root_client_path is None, then no translation will
61
be performed on client paths. Default is '/'.
40
63
self._backing_transport = backing_transport
64
if root_client_path is not None:
65
if not root_client_path.startswith('/'):
66
root_client_path = '/' + root_client_path
67
if not root_client_path.endswith('/'):
68
root_client_path += '/'
69
self._root_client_path = root_client_path
42
71
def _check_enabled(self):
43
72
"""Raises DisabledMethod if this method is disabled."""
72
101
Must return a SmartServerResponse.
74
# TODO: if a client erroneously sends a request that shouldn't have a
75
# body, what to do? Probably SmartServerRequestHandler should catch
76
# this NotImplementedError and translate it into a 'bad request' error
77
# to send to the client.
78
103
raise NotImplementedError(self.do_body)
105
def do_chunk(self, chunk_bytes):
106
"""Called with each body chunk if the request has a streamed body.
108
The do() method is still called, and must have returned None.
110
raise NotImplementedError(self.do_chunk)
113
"""Called when the end of the request has been received."""
116
def translate_client_path(self, client_path):
117
"""Translate a path received from a network client into a local
120
All paths received from the client *must* be translated.
122
:param client_path: the path from the client.
123
:returns: a relpath that may be used with self._backing_transport
124
(unlike the untranslated client_path, which must not be used with
125
the backing transport).
127
if self._root_client_path is None:
128
# no translation necessary!
130
if not client_path.startswith('/'):
131
client_path = '/' + client_path
132
if client_path.startswith(self._root_client_path):
133
path = client_path[len(self._root_client_path):]
134
relpath = urlutils.joinpath('/', path)
135
if not relpath.startswith('/'):
136
raise ValueError(relpath)
139
raise errors.PathNotChild(client_path, self._root_client_path)
141
def transport_from_client_path(self, client_path):
142
"""Get a backing transport corresponding to the location referred to by
145
:seealso: translate_client_path
146
:returns: a transport cloned from self._backing_transport
148
relpath = self.translate_client_path(client_path)
149
return self._backing_transport.clone(relpath)
81
152
class SmartServerResponse(object):
82
153
"""A response to a client request.
108
179
other.body_stream is self.body_stream)
110
181
def __repr__(self):
111
return ("<SmartServerResponse successful=%s args=%r body=%r>"
112
% (self.is_successful(), self.args, self.body))
182
status = {True: 'OK', False: 'ERR'}[self.is_successful()]
183
return "<SmartServerResponse status=%s args=%r body=%r>" % (status,
184
self.args, self.body)
115
187
class FailedSmartServerResponse(SmartServerResponse):
145
217
# TODO: Better way of representing the body for commands that take it,
146
218
# and allow it to be streamed into the server.
148
def __init__(self, backing_transport, commands):
220
def __init__(self, backing_transport, commands, root_client_path):
151
223
:param backing_transport: a Transport to handle requests for.
182
255
command = self._commands.get(cmd)
183
256
except LookupError:
184
raise errors.SmartProtocolError("bad request %r" % (cmd,))
185
self._command = command(self._backing_transport)
257
raise errors.UnknownSmartMethod(cmd)
258
self._command = command(self._backing_transport, self._root_client_path)
186
259
self._run_handler_code(self._command.execute, args, {})
188
261
def _run_handler_code(self, callable, args, kwargs):
310
def headers_received(self, headers):
311
# Just a no-op at the moment.
314
def args_received(self, args):
318
command = self._commands.get(cmd)
320
raise errors.UnknownSmartMethod(cmd)
321
self._command = command(self._backing_transport)
322
self._run_handler_code(self._command.execute, args, {})
324
def prefixed_body_received(self, body_bytes):
325
"""No more body data will be received."""
326
self._run_handler_code(self._command.do_body, (body_bytes,), {})
327
# cannot read after this.
328
self.finished_reading = True
330
def body_chunk_received(self, chunk_bytes):
331
self._run_handler_code(self._command.do_chunk, (chunk_bytes,), {})
333
def end_received(self):
334
self._run_handler_code(self._command.do_end, (), {})
238
337
class HelloRequest(SmartServerRequest):
239
338
"""Answer a version request with the highest protocol version this server
250
349
def do(self, path, revision_id):
251
350
# open transport relative to our base
252
t = self._backing_transport.clone(path)
351
t = self.transport_from_client_path(path)
253
352
control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
254
353
repo = control.open_repository()
255
354
tmpf = tempfile.TemporaryFile()
284
383
request_handlers.register_lazy(
285
384
'Branch.set_last_revision', 'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
286
385
request_handlers.register_lazy(
386
'Branch.set_last_revision_info', 'bzrlib.smart.branch',
387
'SmartServerBranchRequestSetLastRevisionInfo')
388
request_handlers.register_lazy(
287
389
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
288
390
request_handlers.register_lazy(
289
391
'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV1')
added
removed
bzrlib/smart/request.py
