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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Infrastructure for server-side request handlers.
19
Interesting module attributes:
20
* The request_handlers registry maps verb names to SmartServerRequest
22
* The jail_info threading.local() object is used to prevent accidental
23
opening of BzrDirs outside of the backing transport, or any other
24
transports placed in jail_info.transports. The jail_info is reset on
25
every call into a request handler (which can happen an arbitrary number
26
of times during a request).
29
# XXX: The class names are a little confusing: the protocol will instantiate a
30
# SmartServerRequestHandler, whose dispatch_command method creates an instance
31
# of a SmartServerRequest subclass.
45
from bzrlib.lazy_import import lazy_import
46
lazy_import(globals(), """
47
from bzrlib.bundle import serializer
51
jail_info = threading.local()
52
jail_info.transports = None
56
bzrdir.BzrDir.hooks.install_named_hook(
57
'pre_open', _pre_open_hook, 'checking server jail')
60
def _pre_open_hook(transport):
61
allowed_transports = getattr(jail_info, 'transports', None)
62
if allowed_transports is None:
64
abspath = transport.base
65
for allowed_transport in allowed_transports:
67
allowed_transport.relpath(abspath)
68
except errors.PathNotChild:
72
raise errors.JailBreak(abspath)
78
class SmartServerRequest(object):
79
"""Base class for request handlers.
81
To define a new request, subclass this class and override the `do` method
82
(and if appropriate, `do_body` as well). Request implementors should take
83
care to call `translate_client_path` and `transport_from_client_path` as
84
appropriate when dealing with paths received from the client.
86
# XXX: rename this class to BaseSmartServerRequestHandler ? A request
87
# *handler* is a different concept to the request.
89
def __init__(self, backing_transport, root_client_path='/'):
92
:param backing_transport: the base transport to be used when performing
94
:param root_client_path: the client path that maps to the root of
95
backing_transport. This is used to interpret relpaths received
96
from the client. Clients will not be able to refer to paths above
97
this root. If root_client_path is None, then no translation will
98
be performed on client paths. Default is '/'.
100
self._backing_transport = backing_transport
101
if root_client_path is not None:
102
if not root_client_path.startswith('/'):
103
root_client_path = '/' + root_client_path
104
if not root_client_path.endswith('/'):
105
root_client_path += '/'
106
self._root_client_path = root_client_path
107
self._body_chunks = []
109
def _check_enabled(self):
110
"""Raises DisabledMethod if this method is disabled."""
114
"""Mandatory extension point for SmartServerRequest subclasses.
116
Subclasses must implement this.
118
This should return a SmartServerResponse if this command expects to
121
raise NotImplementedError(self.do)
123
def execute(self, *args):
124
"""Public entry point to execute this request.
126
It will return a SmartServerResponse if the command does not expect a
129
:param *args: the arguments of the request.
131
self._check_enabled()
132
return self.do(*args)
134
def do_body(self, body_bytes):
135
"""Called if the client sends a body with the request.
137
The do() method is still called, and must have returned None.
139
Must return a SmartServerResponse.
142
raise errors.SmartProtocolError('Request does not expect a body')
144
def do_chunk(self, chunk_bytes):
145
"""Called with each body chunk if the request has a streamed body.
147
The do() method is still called, and must have returned None.
149
self._body_chunks.append(chunk_bytes)
152
"""Called when the end of the request has been received."""
153
body_bytes = ''.join(self._body_chunks)
154
self._body_chunks = None
155
return self.do_body(body_bytes)
157
def setup_jail(self):
158
jail_info.transports = [self._backing_transport]
160
def teardown_jail(self):
161
jail_info.transports = None
163
def translate_client_path(self, client_path):
164
"""Translate a path received from a network client into a local
167
All paths received from the client *must* be translated.
169
:param client_path: the path from the client.
170
:returns: a relpath that may be used with self._backing_transport
171
(unlike the untranslated client_path, which must not be used with
172
the backing transport).
174
if self._root_client_path is None:
175
# no translation necessary!
177
if not client_path.startswith('/'):
178
client_path = '/' + client_path
179
if client_path + '/' == self._root_client_path:
181
if client_path.startswith(self._root_client_path):
182
path = client_path[len(self._root_client_path):]
183
relpath = urlutils.joinpath('/', path)
184
if not relpath.startswith('/'):
185
raise ValueError(relpath)
188
raise errors.PathNotChild(client_path, self._root_client_path)
190
def transport_from_client_path(self, client_path):
191
"""Get a backing transport corresponding to the location referred to by
194
:seealso: translate_client_path
195
:returns: a transport cloned from self._backing_transport
197
relpath = self.translate_client_path(client_path)
198
return self._backing_transport.clone(relpath)
201
class SmartServerResponse(object):
202
"""A response to a client request.
204
This base class should not be used. Instead use
205
SuccessfulSmartServerResponse and FailedSmartServerResponse as appropriate.
208
def __init__(self, args, body=None, body_stream=None):
211
:param args: tuple of response arguments.
212
:param body: string of a response body.
213
:param body_stream: iterable of bytestrings to be streamed to the
217
if body is not None and body_stream is not None:
218
raise errors.BzrError(
219
"'body' and 'body_stream' are mutually exclusive.")
221
self.body_stream = body_stream
223
def __eq__(self, other):
226
return (other.args == self.args and
227
other.body == self.body and
228
other.body_stream is self.body_stream)
231
return "<%s args=%r body=%r>" % (self.__class__.__name__,
232
self.args, self.body)
235
class FailedSmartServerResponse(SmartServerResponse):
236
"""A SmartServerResponse for a request which failed."""
238
def is_successful(self):
239
"""FailedSmartServerResponse are not successful."""
243
class SuccessfulSmartServerResponse(SmartServerResponse):
244
"""A SmartServerResponse for a successfully completed request."""
246
def is_successful(self):
247
"""SuccessfulSmartServerResponse are successful."""
251
class SmartServerRequestHandler(object):
252
"""Protocol logic for smart server.
254
This doesn't handle serialization at all, it just processes requests and
258
# IMPORTANT FOR IMPLEMENTORS: It is important that SmartServerRequestHandler
259
# not contain encoding or decoding logic to allow the wire protocol to vary
260
# from the object protocol: we will want to tweak the wire protocol separate
261
# from the object model, and ideally we will be able to do that without
262
# having a SmartServerRequestHandler subclass for each wire protocol, rather
263
# just a Protocol subclass.
265
# TODO: Better way of representing the body for commands that take it,
266
# and allow it to be streamed into the server.
268
def __init__(self, backing_transport, commands, root_client_path):
271
:param backing_transport: a Transport to handle requests for.
272
:param commands: a registry mapping command names to SmartServerRequest
273
subclasses. e.g. bzrlib.transport.smart.vfs.vfs_commands.
275
self._backing_transport = backing_transport
276
self._root_client_path = root_client_path
277
self._commands = commands
279
self.finished_reading = False
282
def accept_body(self, bytes):
283
"""Accept body data."""
284
if self._command is None:
285
# no active command object, so ignore the event.
287
self._run_handler_code(self._command.do_chunk, (bytes,), {})
289
def end_of_body(self):
290
"""No more body data will be received."""
291
self._run_handler_code(self._command.do_end, (), {})
292
# cannot read after this.
293
self.finished_reading = True
295
def dispatch_command(self, cmd, args):
296
"""Deprecated compatibility method.""" # XXX XXX
298
command = self._commands.get(cmd)
300
raise errors.UnknownSmartMethod(cmd)
301
self._command = command(self._backing_transport, self._root_client_path)
302
self._run_handler_code(self._command.execute, args, {})
304
def _run_handler_code(self, callable, args, kwargs):
305
"""Run some handler specific code 'callable'.
307
If a result is returned, it is considered to be the commands response,
308
and finished_reading is set true, and its assigned to self.response.
310
Any exceptions caught are translated and a response object created
313
result = self._call_converting_errors(callable, args, kwargs)
315
if result is not None:
316
self.response = result
317
self.finished_reading = True
319
def _call_converting_errors(self, callable, args, kwargs):
320
"""Call callable converting errors to Response objects."""
321
# XXX: most of this error conversion is VFS-related, and thus ought to
322
# be in SmartServerVFSRequestHandler somewhere.
324
self._command.setup_jail()
326
return callable(*args, **kwargs)
328
self._command.teardown_jail()
329
except (KeyboardInterrupt, SystemExit):
331
except Exception, err:
332
err_struct = _translate_error(err)
333
return FailedSmartServerResponse(err_struct)
335
def headers_received(self, headers):
336
# Just a no-op at the moment.
339
def args_received(self, args):
343
command = self._commands.get(cmd)
345
raise errors.UnknownSmartMethod(cmd)
346
self._command = command(self._backing_transport)
347
self._run_handler_code(self._command.execute, args, {})
349
def end_received(self):
350
if self._command is None:
351
# no active command object, so ignore the event.
353
self._run_handler_code(self._command.do_end, (), {})
355
def post_body_error_received(self, error_args):
356
# Just a no-op at the moment.
360
def _translate_error(err):
361
if isinstance(err, errors.NoSuchFile):
362
return ('NoSuchFile', err.path)
363
elif isinstance(err, errors.FileExists):
364
return ('FileExists', err.path)
365
elif isinstance(err, errors.DirectoryNotEmpty):
366
return ('DirectoryNotEmpty', err.path)
367
elif isinstance(err, errors.ShortReadvError):
368
return ('ShortReadvError', err.path, str(err.offset), str(err.length),
370
elif isinstance(err, errors.UnstackableRepositoryFormat):
371
return (('UnstackableRepositoryFormat', str(err.format), err.url))
372
elif isinstance(err, errors.UnstackableBranchFormat):
373
return ('UnstackableBranchFormat', str(err.format), err.url)
374
elif isinstance(err, errors.NotStacked):
375
return ('NotStacked',)
376
elif isinstance(err, UnicodeError):
377
# If it is a DecodeError, than most likely we are starting
378
# with a plain string
379
str_or_unicode = err.object
380
if isinstance(str_or_unicode, unicode):
381
# XXX: UTF-8 might have \x01 (our protocol v1 and v2 seperator
382
# byte) in it, so this encoding could cause broken responses.
383
# Newer clients use protocol v3, so will be fine.
384
val = 'u:' + str_or_unicode.encode('utf-8')
386
val = 's:' + str_or_unicode.encode('base64')
387
# This handles UnicodeEncodeError or UnicodeDecodeError
388
return (err.__class__.__name__, err.encoding, val, str(err.start),
389
str(err.end), err.reason)
390
elif isinstance(err, errors.TransportNotPossible):
391
if err.msg == "readonly transport":
392
return ('ReadOnlyError', )
393
elif isinstance(err, errors.ReadError):
394
# cannot read the file
395
return ('ReadError', err.path)
396
elif isinstance(err, errors.PermissionDenied):
397
return ('PermissionDenied', err.path, err.extra)
398
elif isinstance(err, errors.TokenMismatch):
399
return ('TokenMismatch', err.given_token, err.lock_token)
400
elif isinstance(err, errors.LockContention):
401
return ('LockContention', err.lock, err.msg)
402
# Unserialisable error. Log it, and return a generic error
403
trace.log_exception_quietly()
404
return ('error', str(err))
407
class HelloRequest(SmartServerRequest):
408
"""Answer a version request with the highest protocol version this server
413
return SuccessfulSmartServerResponse(('ok', '2'))
416
class GetBundleRequest(SmartServerRequest):
417
"""Get a bundle of from the null revision to the specified revision."""
419
def do(self, path, revision_id):
420
# open transport relative to our base
421
t = self.transport_from_client_path(path)
422
control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
423
repo = control.open_repository()
424
tmpf = tempfile.TemporaryFile()
425
base_revision = revision.NULL_REVISION
426
serializer.write_bundle(repo, revision_id, base_revision, tmpf)
428
return SuccessfulSmartServerResponse((), tmpf.read())
431
class SmartServerIsReadonly(SmartServerRequest):
432
# XXX: this request method belongs somewhere else.
435
if self._backing_transport.is_readonly():
439
return SuccessfulSmartServerResponse((answer,))
442
request_handlers = registry.Registry()
443
request_handlers.register_lazy(
444
'append', 'bzrlib.smart.vfs', 'AppendRequest')
445
request_handlers.register_lazy(
446
'Branch.get_config_file', 'bzrlib.smart.branch',
447
'SmartServerBranchGetConfigFile')
448
request_handlers.register_lazy(
449
'Branch.get_parent', 'bzrlib.smart.branch', 'SmartServerBranchGetParent')
450
request_handlers.register_lazy(
451
'Branch.get_tags_bytes', 'bzrlib.smart.branch',
452
'SmartServerBranchGetTagsBytes')
453
request_handlers.register_lazy(
454
'Branch.get_stacked_on_url', 'bzrlib.smart.branch', 'SmartServerBranchRequestGetStackedOnURL')
455
request_handlers.register_lazy(
456
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
457
request_handlers.register_lazy(
458
'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
459
request_handlers.register_lazy( 'Branch.revision_history',
460
'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
461
request_handlers.register_lazy( 'Branch.set_config_option',
462
'bzrlib.smart.branch', 'SmartServerBranchRequestSetConfigOption')
463
request_handlers.register_lazy( 'Branch.set_last_revision',
464
'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
465
request_handlers.register_lazy(
466
'Branch.set_last_revision_info', 'bzrlib.smart.branch',
467
'SmartServerBranchRequestSetLastRevisionInfo')
468
request_handlers.register_lazy(
469
'Branch.set_last_revision_ex', 'bzrlib.smart.branch',
470
'SmartServerBranchRequestSetLastRevisionEx')
471
request_handlers.register_lazy(
472
'Branch.set_parent_location', 'bzrlib.smart.branch',
473
'SmartServerBranchRequestSetParentLocation')
474
request_handlers.register_lazy(
475
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
476
request_handlers.register_lazy(
477
'BzrDir.cloning_metadir', 'bzrlib.smart.bzrdir',
478
'SmartServerBzrDirRequestCloningMetaDir')
479
request_handlers.register_lazy(
480
'BzrDir.create_branch', 'bzrlib.smart.bzrdir',
481
'SmartServerRequestCreateBranch')
482
request_handlers.register_lazy(
483
'BzrDir.create_repository', 'bzrlib.smart.bzrdir',
484
'SmartServerRequestCreateRepository')
485
request_handlers.register_lazy(
486
'BzrDir.find_repository', 'bzrlib.smart.bzrdir',
487
'SmartServerRequestFindRepositoryV1')
488
request_handlers.register_lazy(
489
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir',
490
'SmartServerRequestFindRepositoryV2')
491
request_handlers.register_lazy(
492
'BzrDir.find_repositoryV3', 'bzrlib.smart.bzrdir',
493
'SmartServerRequestFindRepositoryV3')
494
request_handlers.register_lazy(
495
'BzrDir.get_config_file', 'bzrlib.smart.bzrdir',
496
'SmartServerBzrDirRequestConfigFile')
497
request_handlers.register_lazy(
498
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir',
499
'SmartServerRequestInitializeBzrDir')
500
request_handlers.register_lazy(
501
'BzrDirFormat.initialize_ex_1.16', 'bzrlib.smart.bzrdir',
502
'SmartServerRequestBzrDirInitializeEx')
503
request_handlers.register_lazy(
504
'BzrDir.open', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir')
505
request_handlers.register_lazy(
506
'BzrDir.open_branch', 'bzrlib.smart.bzrdir',
507
'SmartServerRequestOpenBranch')
508
request_handlers.register_lazy(
509
'BzrDir.open_branchV2', 'bzrlib.smart.bzrdir',
510
'SmartServerRequestOpenBranchV2')
511
request_handlers.register_lazy(
512
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
513
request_handlers.register_lazy(
514
'get', 'bzrlib.smart.vfs', 'GetRequest')
515
request_handlers.register_lazy(
516
'get_bundle', 'bzrlib.smart.request', 'GetBundleRequest')
517
request_handlers.register_lazy(
518
'has', 'bzrlib.smart.vfs', 'HasRequest')
519
request_handlers.register_lazy(
520
'hello', 'bzrlib.smart.request', 'HelloRequest')
521
request_handlers.register_lazy(
522
'iter_files_recursive', 'bzrlib.smart.vfs', 'IterFilesRecursiveRequest')
523
request_handlers.register_lazy(
524
'list_dir', 'bzrlib.smart.vfs', 'ListDirRequest')
525
request_handlers.register_lazy(
526
'mkdir', 'bzrlib.smart.vfs', 'MkdirRequest')
527
request_handlers.register_lazy(
528
'move', 'bzrlib.smart.vfs', 'MoveRequest')
529
request_handlers.register_lazy(
530
'put', 'bzrlib.smart.vfs', 'PutRequest')
531
request_handlers.register_lazy(
532
'put_non_atomic', 'bzrlib.smart.vfs', 'PutNonAtomicRequest')
533
request_handlers.register_lazy(
534
'readv', 'bzrlib.smart.vfs', 'ReadvRequest')
535
request_handlers.register_lazy(
536
'rename', 'bzrlib.smart.vfs', 'RenameRequest')
537
request_handlers.register_lazy(
538
'PackRepository.autopack', 'bzrlib.smart.packrepository',
539
'SmartServerPackRepositoryAutopack')
540
request_handlers.register_lazy('Repository.gather_stats',
541
'bzrlib.smart.repository',
542
'SmartServerRepositoryGatherStats')
543
request_handlers.register_lazy('Repository.get_parent_map',
544
'bzrlib.smart.repository',
545
'SmartServerRepositoryGetParentMap')
546
request_handlers.register_lazy(
547
'Repository.get_revision_graph', 'bzrlib.smart.repository', 'SmartServerRepositoryGetRevisionGraph')
548
request_handlers.register_lazy(
549
'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
550
request_handlers.register_lazy(
551
'Repository.insert_stream', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStream')
552
request_handlers.register_lazy(
553
'Repository.insert_stream_locked', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStreamLocked')
554
request_handlers.register_lazy(
555
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
556
request_handlers.register_lazy(
557
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
558
request_handlers.register_lazy(
559
'Repository.set_make_working_trees', 'bzrlib.smart.repository',
560
'SmartServerRepositorySetMakeWorkingTrees')
561
request_handlers.register_lazy(
562
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
563
request_handlers.register_lazy(
564
'Repository.get_rev_id_for_revno', 'bzrlib.smart.repository',
565
'SmartServerRepositoryGetRevIdForRevno')
566
request_handlers.register_lazy(
567
'Repository.get_stream', 'bzrlib.smart.repository',
568
'SmartServerRepositoryGetStream')
569
request_handlers.register_lazy(
570
'Repository.tarball', 'bzrlib.smart.repository',
571
'SmartServerRepositoryTarball')
572
request_handlers.register_lazy(
573
'rmdir', 'bzrlib.smart.vfs', 'RmdirRequest')
574
request_handlers.register_lazy(
575
'stat', 'bzrlib.smart.vfs', 'StatRequest')
576
request_handlers.register_lazy(
577
'Transport.is_readonly', 'bzrlib.smart.request', 'SmartServerIsReadonly')
added
removed
bzrlib/smart/request.py
