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
"""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).
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
40
from bzrlib.bundle import serializer
44
class SmartServerRequest(object):
45
"""Base class for request handlers.
47
To define a new request, subclass this class and override the `do` method
48
(and if appropriate, `do_body` as well). Request implementors should take
49
care to call `translate_client_path` and `transport_from_client_path` as
50
appropriate when dealing with paths received from the client.
52
# XXX: rename this class to BaseSmartServerRequestHandler ? A request
53
# *handler* is a different concept to the request.
55
def __init__(self, backing_transport, root_client_path='/'):
58
:param backing_transport: the base transport to be used when performing
60
:param root_client_path: the client path that maps to the root of
61
backing_transport. This is used to interpret relpaths received
62
from the client. Clients will not be able to refer to paths above
63
this root. If root_client_path is None, then no translation will
64
be performed on client paths. Default is '/'.
66
self._backing_transport = backing_transport
67
if root_client_path is not None:
68
if not root_client_path.startswith('/'):
69
root_client_path = '/' + root_client_path
70
if not root_client_path.endswith('/'):
71
root_client_path += '/'
72
self._root_client_path = root_client_path
74
def _check_enabled(self):
75
"""Raises DisabledMethod if this method is disabled."""
79
"""Mandatory extension point for SmartServerRequest subclasses.
81
Subclasses must implement this.
83
This should return a SmartServerResponse if this command expects to
86
raise NotImplementedError(self.do)
88
def execute(self, *args):
89
"""Public entry point to execute this request.
91
It will return a SmartServerResponse if the command does not expect a
94
:param *args: the arguments of the request.
99
def do_body(self, body_bytes):
100
"""Called if the client sends a body with the request.
102
The do() method is still called, and must have returned None.
104
Must return a SmartServerResponse.
106
raise NotImplementedError(self.do_body)
108
def do_chunk(self, chunk_bytes):
109
"""Called with each body chunk if the request has a streamed body.
111
The do() method is still called, and must have returned None.
113
raise NotImplementedError(self.do_chunk)
116
"""Called when the end of the request has been received."""
119
def translate_client_path(self, client_path):
120
"""Translate a path received from a network client into a local
123
All paths received from the client *must* be translated.
125
:param client_path: the path from the client.
126
:returns: a relpath that may be used with self._backing_transport
127
(unlike the untranslated client_path, which must not be used with
128
the backing transport).
130
if self._root_client_path is None:
131
# no translation necessary!
133
if not client_path.startswith('/'):
134
client_path = '/' + client_path
135
if client_path.startswith(self._root_client_path):
136
path = client_path[len(self._root_client_path):]
137
relpath = urlutils.joinpath('/', path)
138
if not relpath.startswith('/'):
139
raise ValueError(relpath)
142
raise errors.PathNotChild(client_path, self._root_client_path)
144
def transport_from_client_path(self, client_path):
145
"""Get a backing transport corresponding to the location referred to by
148
:seealso: translate_client_path
149
:returns: a transport cloned from self._backing_transport
151
relpath = self.translate_client_path(client_path)
152
return self._backing_transport.clone(relpath)
155
class SmartServerResponse(object):
156
"""A response to a client request.
158
This base class should not be used. Instead use
159
SuccessfulSmartServerResponse and FailedSmartServerResponse as appropriate.
162
def __init__(self, args, body=None, body_stream=None):
165
:param args: tuple of response arguments.
166
:param body: string of a response body.
167
:param body_stream: iterable of bytestrings to be streamed to the
171
if body is not None and body_stream is not None:
172
raise errors.BzrError(
173
"'body' and 'body_stream' are mutually exclusive.")
175
self.body_stream = body_stream
177
def __eq__(self, other):
180
return (other.args == self.args and
181
other.body == self.body and
182
other.body_stream is self.body_stream)
185
return "<%s args=%r body=%r>" % (self.__class__.__name__,
186
self.args, self.body)
189
class FailedSmartServerResponse(SmartServerResponse):
190
"""A SmartServerResponse for a request which failed."""
192
def is_successful(self):
193
"""FailedSmartServerResponse are not successful."""
197
class SuccessfulSmartServerResponse(SmartServerResponse):
198
"""A SmartServerResponse for a successfully completed request."""
200
def is_successful(self):
201
"""SuccessfulSmartServerResponse are successful."""
205
class SmartServerRequestHandler(object):
206
"""Protocol logic for smart server.
208
This doesn't handle serialization at all, it just processes requests and
212
# IMPORTANT FOR IMPLEMENTORS: It is important that SmartServerRequestHandler
213
# not contain encoding or decoding logic to allow the wire protocol to vary
214
# from the object protocol: we will want to tweak the wire protocol separate
215
# from the object model, and ideally we will be able to do that without
216
# having a SmartServerRequestHandler subclass for each wire protocol, rather
217
# just a Protocol subclass.
219
# TODO: Better way of representing the body for commands that take it,
220
# and allow it to be streamed into the server.
222
def __init__(self, backing_transport, commands, root_client_path):
225
:param backing_transport: a Transport to handle requests for.
226
:param commands: a registry mapping command names to SmartServerRequest
227
subclasses. e.g. bzrlib.transport.smart.vfs.vfs_commands.
229
self._backing_transport = backing_transport
230
self._root_client_path = root_client_path
231
self._commands = commands
232
self._body_bytes = ''
234
self.finished_reading = False
237
def accept_body(self, bytes):
238
"""Accept body data."""
240
# TODO: This should be overriden for each command that desired body data
241
# to handle the right format of that data, i.e. plain bytes, a bundle,
242
# etc. The deserialisation into that format should be done in the
245
# default fallback is to accumulate bytes.
246
self._body_bytes += bytes
248
def end_of_body(self):
249
"""No more body data will be received."""
250
self._run_handler_code(self._command.do_body, (self._body_bytes,), {})
251
# cannot read after this.
252
self.finished_reading = True
254
def dispatch_command(self, cmd, args):
255
"""Deprecated compatibility method.""" # XXX XXX
257
command = self._commands.get(cmd)
259
raise errors.UnknownSmartMethod(cmd)
260
self._command = command(self._backing_transport, self._root_client_path)
261
self._run_handler_code(self._command.execute, args, {})
263
def _run_handler_code(self, callable, args, kwargs):
264
"""Run some handler specific code 'callable'.
266
If a result is returned, it is considered to be the commands response,
267
and finished_reading is set true, and its assigned to self.response.
269
Any exceptions caught are translated and a response object created
272
result = self._call_converting_errors(callable, args, kwargs)
274
if result is not None:
275
self.response = result
276
self.finished_reading = True
278
def _call_converting_errors(self, callable, args, kwargs):
279
"""Call callable converting errors to Response objects."""
280
# XXX: most of this error conversion is VFS-related, and thus ought to
281
# be in SmartServerVFSRequestHandler somewhere.
283
return callable(*args, **kwargs)
284
except errors.NoSuchFile, e:
285
return FailedSmartServerResponse(('NoSuchFile', e.path))
286
except errors.FileExists, e:
287
return FailedSmartServerResponse(('FileExists', e.path))
288
except errors.DirectoryNotEmpty, e:
289
return FailedSmartServerResponse(('DirectoryNotEmpty', e.path))
290
except errors.ShortReadvError, e:
291
return FailedSmartServerResponse(('ShortReadvError',
292
e.path, str(e.offset), str(e.length), str(e.actual)))
293
except errors.UnstackableRepositoryFormat, e:
294
return FailedSmartServerResponse(('UnstackableRepositoryFormat',
295
str(e.format), e.url))
296
except errors.UnstackableBranchFormat, e:
297
return FailedSmartServerResponse(('UnstackableBranchFormat',
298
str(e.format), e.url))
299
except errors.NotStacked, e:
300
return FailedSmartServerResponse(('NotStacked',))
301
except UnicodeError, e:
302
# If it is a DecodeError, than most likely we are starting
303
# with a plain string
304
str_or_unicode = e.object
305
if isinstance(str_or_unicode, unicode):
306
# XXX: UTF-8 might have \x01 (our protocol v1 and v2 seperator
307
# byte) in it, so this encoding could cause broken responses.
308
# Newer clients use protocol v3, so will be fine.
309
val = 'u:' + str_or_unicode.encode('utf-8')
311
val = 's:' + str_or_unicode.encode('base64')
312
# This handles UnicodeEncodeError or UnicodeDecodeError
313
return FailedSmartServerResponse((e.__class__.__name__,
314
e.encoding, val, str(e.start), str(e.end), e.reason))
315
except errors.TransportNotPossible, e:
316
if e.msg == "readonly transport":
317
return FailedSmartServerResponse(('ReadOnlyError', ))
320
except errors.ReadError, e:
321
# cannot read the file
322
return FailedSmartServerResponse(('ReadError', e.path))
323
except errors.PermissionDenied, e:
324
return FailedSmartServerResponse(
325
('PermissionDenied', e.path, e.extra))
327
def headers_received(self, headers):
328
# Just a no-op at the moment.
331
def args_received(self, args):
335
command = self._commands.get(cmd)
337
raise errors.UnknownSmartMethod(cmd)
338
self._command = command(self._backing_transport)
339
self._run_handler_code(self._command.execute, args, {})
341
def prefixed_body_received(self, body_bytes):
342
"""No more body data will be received."""
343
self._run_handler_code(self._command.do_body, (body_bytes,), {})
344
# cannot read after this.
345
self.finished_reading = True
347
def body_chunk_received(self, chunk_bytes):
348
self._run_handler_code(self._command.do_chunk, (chunk_bytes,), {})
350
def end_received(self):
351
self._run_handler_code(self._command.do_end, (), {})
354
class HelloRequest(SmartServerRequest):
355
"""Answer a version request with the highest protocol version this server
360
return SuccessfulSmartServerResponse(('ok', '2'))
363
class GetBundleRequest(SmartServerRequest):
364
"""Get a bundle of from the null revision to the specified revision."""
366
def do(self, path, revision_id):
367
# open transport relative to our base
368
t = self.transport_from_client_path(path)
369
control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
370
repo = control.open_repository()
371
tmpf = tempfile.TemporaryFile()
372
base_revision = revision.NULL_REVISION
373
serializer.write_bundle(repo, revision_id, base_revision, tmpf)
375
return SuccessfulSmartServerResponse((), tmpf.read())
378
class SmartServerIsReadonly(SmartServerRequest):
379
# XXX: this request method belongs somewhere else.
382
if self._backing_transport.is_readonly():
386
return SuccessfulSmartServerResponse((answer,))
389
request_handlers = registry.Registry()
390
request_handlers.register_lazy(
391
'append', 'bzrlib.smart.vfs', 'AppendRequest')
392
request_handlers.register_lazy(
393
'Branch.get_config_file', 'bzrlib.smart.branch', 'SmartServerBranchGetConfigFile')
394
request_handlers.register_lazy(
395
'Branch.get_stacked_on_url', 'bzrlib.smart.branch', 'SmartServerBranchRequestGetStackedOnURL')
396
request_handlers.register_lazy(
397
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
398
request_handlers.register_lazy(
399
'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
400
request_handlers.register_lazy(
401
'Branch.revision_history', 'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
402
request_handlers.register_lazy(
403
'Branch.set_last_revision', 'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
404
request_handlers.register_lazy(
405
'Branch.set_last_revision_info', 'bzrlib.smart.branch',
406
'SmartServerBranchRequestSetLastRevisionInfo')
407
request_handlers.register_lazy(
408
'Branch.set_last_revision_ex', 'bzrlib.smart.branch',
409
'SmartServerBranchRequestSetLastRevisionEx')
410
request_handlers.register_lazy(
411
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
412
request_handlers.register_lazy(
413
'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV1')
414
request_handlers.register_lazy(
415
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV2')
416
request_handlers.register_lazy(
417
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir', 'SmartServerRequestInitializeBzrDir')
418
request_handlers.register_lazy(
419
'BzrDir.open_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBranch')
420
request_handlers.register_lazy(
421
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
422
request_handlers.register_lazy(
423
'get', 'bzrlib.smart.vfs', 'GetRequest')
424
request_handlers.register_lazy(
425
'get_bundle', 'bzrlib.smart.request', 'GetBundleRequest')
426
request_handlers.register_lazy(
427
'has', 'bzrlib.smart.vfs', 'HasRequest')
428
request_handlers.register_lazy(
429
'hello', 'bzrlib.smart.request', 'HelloRequest')
430
request_handlers.register_lazy(
431
'iter_files_recursive', 'bzrlib.smart.vfs', 'IterFilesRecursiveRequest')
432
request_handlers.register_lazy(
433
'list_dir', 'bzrlib.smart.vfs', 'ListDirRequest')
434
request_handlers.register_lazy(
435
'mkdir', 'bzrlib.smart.vfs', 'MkdirRequest')
436
request_handlers.register_lazy(
437
'move', 'bzrlib.smart.vfs', 'MoveRequest')
438
request_handlers.register_lazy(
439
'put', 'bzrlib.smart.vfs', 'PutRequest')
440
request_handlers.register_lazy(
441
'put_non_atomic', 'bzrlib.smart.vfs', 'PutNonAtomicRequest')
442
request_handlers.register_lazy(
443
'readv', 'bzrlib.smart.vfs', 'ReadvRequest')
444
request_handlers.register_lazy(
445
'rename', 'bzrlib.smart.vfs', 'RenameRequest')
446
request_handlers.register_lazy('Repository.gather_stats',
447
'bzrlib.smart.repository',
448
'SmartServerRepositoryGatherStats')
449
request_handlers.register_lazy('Repository.get_parent_map',
450
'bzrlib.smart.repository',
451
'SmartServerRepositoryGetParentMap')
452
request_handlers.register_lazy(
453
'Repository.get_revision_graph', 'bzrlib.smart.repository', 'SmartServerRepositoryGetRevisionGraph')
454
request_handlers.register_lazy(
455
'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
456
request_handlers.register_lazy(
457
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
458
request_handlers.register_lazy(
459
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
460
request_handlers.register_lazy(
461
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
462
request_handlers.register_lazy(
463
'Repository.tarball', 'bzrlib.smart.repository',
464
'SmartServerRepositoryTarball')
465
request_handlers.register_lazy(
466
'rmdir', 'bzrlib.smart.vfs', 'RmdirRequest')
467
request_handlers.register_lazy(
468
'stat', 'bzrlib.smart.vfs', 'StatRequest')
469
request_handlers.register_lazy(
470
'Transport.is_readonly', 'bzrlib.smart.request', 'SmartServerIsReadonly')
471
request_handlers.register_lazy(
472
'BzrDir.open', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir')
added
removed
bzrlib/smart/request.py
