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.
47
from bzrlib.lazy_import import lazy_import
48
lazy_import(globals(), """
49
from bzrlib.bundle import serializer
53
jail_info = threading.local()
54
jail_info.transports = None
58
bzrdir.BzrDir.hooks.install_named_hook(
59
'pre_open', _pre_open_hook, 'checking server jail')
62
def _pre_open_hook(transport):
63
allowed_transports = getattr(jail_info, 'transports', None)
64
if allowed_transports is None:
66
abspath = transport.base
67
for allowed_transport in allowed_transports:
69
allowed_transport.relpath(abspath)
70
except errors.PathNotChild:
74
raise errors.JailBreak(abspath)
80
class SmartServerRequest(object):
81
"""Base class for request handlers.
83
To define a new request, subclass this class and override the `do` method
84
(and if appropriate, `do_body` as well). Request implementors should take
85
care to call `translate_client_path` and `transport_from_client_path` as
86
appropriate when dealing with paths received from the client.
88
# XXX: rename this class to BaseSmartServerRequestHandler ? A request
89
# *handler* is a different concept to the request.
91
def __init__(self, backing_transport, root_client_path='/', jail_root=None):
94
:param backing_transport: the base transport to be used when performing
96
:param root_client_path: the client path that maps to the root of
97
backing_transport. This is used to interpret relpaths received
98
from the client. Clients will not be able to refer to paths above
99
this root. If root_client_path is None, then no translation will
100
be performed on client paths. Default is '/'.
101
:param jail_root: if specified, the root of the BzrDir.open jail to use
102
instead of backing_transport.
104
self._backing_transport = backing_transport
105
if jail_root is None:
106
jail_root = backing_transport
107
self._jail_root = jail_root
108
if root_client_path is not None:
109
if not root_client_path.startswith('/'):
110
root_client_path = '/' + root_client_path
111
if not root_client_path.endswith('/'):
112
root_client_path += '/'
113
self._root_client_path = root_client_path
114
self._body_chunks = []
116
def _check_enabled(self):
117
"""Raises DisabledMethod if this method is disabled."""
121
"""Mandatory extension point for SmartServerRequest subclasses.
123
Subclasses must implement this.
125
This should return a SmartServerResponse if this command expects to
128
raise NotImplementedError(self.do)
130
def execute(self, *args):
131
"""Public entry point to execute this request.
133
It will return a SmartServerResponse if the command does not expect a
136
:param *args: the arguments of the request.
138
self._check_enabled()
139
return self.do(*args)
141
def do_body(self, body_bytes):
142
"""Called if the client sends a body with the request.
144
The do() method is still called, and must have returned None.
146
Must return a SmartServerResponse.
149
raise errors.SmartProtocolError('Request does not expect a body')
151
def do_chunk(self, chunk_bytes):
152
"""Called with each body chunk if the request has a streamed body.
154
The do() method is still called, and must have returned None.
156
self._body_chunks.append(chunk_bytes)
159
"""Called when the end of the request has been received."""
160
body_bytes = ''.join(self._body_chunks)
161
self._body_chunks = None
162
return self.do_body(body_bytes)
164
def setup_jail(self):
165
jail_info.transports = [self._jail_root]
167
def teardown_jail(self):
168
jail_info.transports = None
170
def translate_client_path(self, client_path):
171
"""Translate a path received from a network client into a local
174
All paths received from the client *must* be translated.
176
:param client_path: the path from the client.
177
:returns: a relpath that may be used with self._backing_transport
178
(unlike the untranslated client_path, which must not be used with
179
the backing transport).
181
if self._root_client_path is None:
182
# no translation necessary!
184
if not client_path.startswith('/'):
185
client_path = '/' + client_path
186
if client_path + '/' == self._root_client_path:
188
if client_path.startswith(self._root_client_path):
189
path = client_path[len(self._root_client_path):]
190
relpath = urlutils.joinpath('/', path)
191
if not relpath.startswith('/'):
192
raise ValueError(relpath)
193
return urlutils.escape('.' + relpath)
195
raise errors.PathNotChild(client_path, self._root_client_path)
197
def transport_from_client_path(self, client_path):
198
"""Get a backing transport corresponding to the location referred to by
201
:seealso: translate_client_path
202
:returns: a transport cloned from self._backing_transport
204
relpath = self.translate_client_path(client_path)
205
return self._backing_transport.clone(relpath)
208
class SmartServerResponse(object):
209
"""A response to a client request.
211
This base class should not be used. Instead use
212
SuccessfulSmartServerResponse and FailedSmartServerResponse as appropriate.
215
def __init__(self, args, body=None, body_stream=None):
218
:param args: tuple of response arguments.
219
:param body: string of a response body.
220
:param body_stream: iterable of bytestrings to be streamed to the
224
if body is not None and body_stream is not None:
225
raise errors.BzrError(
226
"'body' and 'body_stream' are mutually exclusive.")
228
self.body_stream = body_stream
230
def __eq__(self, other):
233
return (other.args == self.args and
234
other.body == self.body and
235
other.body_stream is self.body_stream)
238
return "<%s args=%r body=%r>" % (self.__class__.__name__,
239
self.args, self.body)
242
class FailedSmartServerResponse(SmartServerResponse):
243
"""A SmartServerResponse for a request which failed."""
245
def is_successful(self):
246
"""FailedSmartServerResponse are not successful."""
250
class SuccessfulSmartServerResponse(SmartServerResponse):
251
"""A SmartServerResponse for a successfully completed request."""
253
def is_successful(self):
254
"""SuccessfulSmartServerResponse are successful."""
258
class SmartServerRequestHandler(object):
259
"""Protocol logic for smart server.
261
This doesn't handle serialization at all, it just processes requests and
265
# IMPORTANT FOR IMPLEMENTORS: It is important that SmartServerRequestHandler
266
# not contain encoding or decoding logic to allow the wire protocol to vary
267
# from the object protocol: we will want to tweak the wire protocol separate
268
# from the object model, and ideally we will be able to do that without
269
# having a SmartServerRequestHandler subclass for each wire protocol, rather
270
# just a Protocol subclass.
272
# TODO: Better way of representing the body for commands that take it,
273
# and allow it to be streamed into the server.
275
def __init__(self, backing_transport, commands, root_client_path,
279
:param backing_transport: a Transport to handle requests for.
280
:param commands: a registry mapping command names to SmartServerRequest
281
subclasses. e.g. bzrlib.transport.smart.vfs.vfs_commands.
283
self._backing_transport = backing_transport
284
self._root_client_path = root_client_path
285
self._commands = commands
286
if jail_root is None:
287
jail_root = backing_transport
288
self._jail_root = jail_root
290
self.finished_reading = False
292
if 'hpss' in debug.debug_flags:
293
self._request_start_time = osutils.timer_func()
294
self._thread_id = threading.currentThread().get_ident()
296
def _trace(self, action, message, extra_bytes=None, include_time=False):
297
# It is a bit of a shame that this functionality overlaps with that of
298
# ProtocolThreeRequester._trace. However, there is enough difference
299
# that just putting it in a helper doesn't help a lot. And some state
300
# is taken from the instance.
302
t = '%5.3fs ' % (osutils.timer_func() - self._request_start_time)
305
if extra_bytes is None:
308
extra = ' ' + repr(extra_bytes[:40])
310
extra = extra[:29] + extra[-1] + '...'
311
trace.mutter('%12s: [%s] %s%s%s'
312
% (action, self._thread_id, t, message, extra))
314
def accept_body(self, bytes):
315
"""Accept body data."""
316
if self._command is None:
317
# no active command object, so ignore the event.
319
self._run_handler_code(self._command.do_chunk, (bytes,), {})
320
if 'hpss' in debug.debug_flags:
321
self._trace('accept body',
322
'%d bytes' % (len(bytes),), bytes)
324
def end_of_body(self):
325
"""No more body data will be received."""
326
self._run_handler_code(self._command.do_end, (), {})
327
# cannot read after this.
328
self.finished_reading = True
329
if 'hpss' in debug.debug_flags:
330
self._trace('end of body', '', include_time=True)
332
def _run_handler_code(self, callable, args, kwargs):
333
"""Run some handler specific code 'callable'.
335
If a result is returned, it is considered to be the commands response,
336
and finished_reading is set true, and its assigned to self.response.
338
Any exceptions caught are translated and a response object created
341
result = self._call_converting_errors(callable, args, kwargs)
343
if result is not None:
344
self.response = result
345
self.finished_reading = True
347
def _call_converting_errors(self, callable, args, kwargs):
348
"""Call callable converting errors to Response objects."""
349
# XXX: most of this error conversion is VFS-related, and thus ought to
350
# be in SmartServerVFSRequestHandler somewhere.
352
self._command.setup_jail()
354
return callable(*args, **kwargs)
356
self._command.teardown_jail()
357
except (KeyboardInterrupt, SystemExit):
359
except Exception, err:
360
err_struct = _translate_error(err)
361
return FailedSmartServerResponse(err_struct)
363
def headers_received(self, headers):
364
# Just a no-op at the moment.
365
if 'hpss' in debug.debug_flags:
366
self._trace('headers', repr(headers))
368
def args_received(self, args):
372
command = self._commands.get(cmd)
374
if 'hpss' in debug.debug_flags:
375
self._trace('hpss unknown request',
376
cmd, repr(args)[1:-1])
377
raise errors.UnknownSmartMethod(cmd)
378
if 'hpss' in debug.debug_flags:
379
from bzrlib.smart import vfs
380
if issubclass(command, vfs.VfsRequest):
381
action = 'hpss vfs req'
383
action = 'hpss request'
385
'%s %s' % (cmd, repr(args)[1:-1]))
386
self._command = command(
387
self._backing_transport, self._root_client_path, self._jail_root)
388
self._run_handler_code(self._command.execute, args, {})
390
def end_received(self):
391
if self._command is None:
392
# no active command object, so ignore the event.
394
self._run_handler_code(self._command.do_end, (), {})
395
if 'hpss' in debug.debug_flags:
396
self._trace('end', '', include_time=True)
398
def post_body_error_received(self, error_args):
399
# Just a no-op at the moment.
403
def _translate_error(err):
404
if isinstance(err, errors.NoSuchFile):
405
return ('NoSuchFile', err.path)
406
elif isinstance(err, errors.FileExists):
407
return ('FileExists', err.path)
408
elif isinstance(err, errors.DirectoryNotEmpty):
409
return ('DirectoryNotEmpty', err.path)
410
elif isinstance(err, errors.IncompatibleRepositories):
411
return ('IncompatibleRepositories', str(err.source), str(err.target),
413
elif isinstance(err, errors.ShortReadvError):
414
return ('ShortReadvError', err.path, str(err.offset), str(err.length),
416
elif isinstance(err, errors.UnstackableRepositoryFormat):
417
return (('UnstackableRepositoryFormat', str(err.format), err.url))
418
elif isinstance(err, errors.UnstackableBranchFormat):
419
return ('UnstackableBranchFormat', str(err.format), err.url)
420
elif isinstance(err, errors.NotStacked):
421
return ('NotStacked',)
422
elif isinstance(err, UnicodeError):
423
# If it is a DecodeError, than most likely we are starting
424
# with a plain string
425
str_or_unicode = err.object
426
if isinstance(str_or_unicode, unicode):
427
# XXX: UTF-8 might have \x01 (our protocol v1 and v2 seperator
428
# byte) in it, so this encoding could cause broken responses.
429
# Newer clients use protocol v3, so will be fine.
430
val = 'u:' + str_or_unicode.encode('utf-8')
432
val = 's:' + str_or_unicode.encode('base64')
433
# This handles UnicodeEncodeError or UnicodeDecodeError
434
return (err.__class__.__name__, err.encoding, val, str(err.start),
435
str(err.end), err.reason)
436
elif isinstance(err, errors.TransportNotPossible):
437
if err.msg == "readonly transport":
438
return ('ReadOnlyError', )
439
elif isinstance(err, errors.ReadError):
440
# cannot read the file
441
return ('ReadError', err.path)
442
elif isinstance(err, errors.PermissionDenied):
443
return ('PermissionDenied', err.path, err.extra)
444
elif isinstance(err, errors.TokenMismatch):
445
return ('TokenMismatch', err.given_token, err.lock_token)
446
elif isinstance(err, errors.LockContention):
447
return ('LockContention',)
448
# Unserialisable error. Log it, and return a generic error
449
trace.log_exception_quietly()
450
return ('error', str(err))
453
class HelloRequest(SmartServerRequest):
454
"""Answer a version request with the highest protocol version this server
459
return SuccessfulSmartServerResponse(('ok', '2'))
462
class GetBundleRequest(SmartServerRequest):
463
"""Get a bundle of from the null revision to the specified revision."""
465
def do(self, path, revision_id):
466
# open transport relative to our base
467
t = self.transport_from_client_path(path)
468
control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
469
repo = control.open_repository()
470
tmpf = tempfile.TemporaryFile()
471
base_revision = revision.NULL_REVISION
472
serializer.write_bundle(repo, revision_id, base_revision, tmpf)
474
return SuccessfulSmartServerResponse((), tmpf.read())
477
class SmartServerIsReadonly(SmartServerRequest):
478
# XXX: this request method belongs somewhere else.
481
if self._backing_transport.is_readonly():
485
return SuccessfulSmartServerResponse((answer,))
488
request_handlers = registry.Registry()
489
request_handlers.register_lazy(
490
'append', 'bzrlib.smart.vfs', 'AppendRequest')
491
request_handlers.register_lazy(
492
'Branch.get_config_file', 'bzrlib.smart.branch',
493
'SmartServerBranchGetConfigFile')
494
request_handlers.register_lazy(
495
'Branch.get_parent', 'bzrlib.smart.branch', 'SmartServerBranchGetParent')
496
request_handlers.register_lazy(
497
'Branch.get_tags_bytes', 'bzrlib.smart.branch',
498
'SmartServerBranchGetTagsBytes')
499
request_handlers.register_lazy(
500
'Branch.set_tags_bytes', 'bzrlib.smart.branch',
501
'SmartServerBranchSetTagsBytes')
502
request_handlers.register_lazy(
503
'Branch.get_stacked_on_url', 'bzrlib.smart.branch', 'SmartServerBranchRequestGetStackedOnURL')
504
request_handlers.register_lazy(
505
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
506
request_handlers.register_lazy(
507
'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
508
request_handlers.register_lazy( 'Branch.revision_history',
509
'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
510
request_handlers.register_lazy( 'Branch.set_config_option',
511
'bzrlib.smart.branch', 'SmartServerBranchRequestSetConfigOption')
512
request_handlers.register_lazy( 'Branch.set_last_revision',
513
'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
514
request_handlers.register_lazy(
515
'Branch.set_last_revision_info', 'bzrlib.smart.branch',
516
'SmartServerBranchRequestSetLastRevisionInfo')
517
request_handlers.register_lazy(
518
'Branch.set_last_revision_ex', 'bzrlib.smart.branch',
519
'SmartServerBranchRequestSetLastRevisionEx')
520
request_handlers.register_lazy(
521
'Branch.set_parent_location', 'bzrlib.smart.branch',
522
'SmartServerBranchRequestSetParentLocation')
523
request_handlers.register_lazy(
524
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
525
request_handlers.register_lazy(
526
'BzrDir.cloning_metadir', 'bzrlib.smart.bzrdir',
527
'SmartServerBzrDirRequestCloningMetaDir')
528
request_handlers.register_lazy(
529
'BzrDir.create_branch', 'bzrlib.smart.bzrdir',
530
'SmartServerRequestCreateBranch')
531
request_handlers.register_lazy(
532
'BzrDir.create_repository', 'bzrlib.smart.bzrdir',
533
'SmartServerRequestCreateRepository')
534
request_handlers.register_lazy(
535
'BzrDir.find_repository', 'bzrlib.smart.bzrdir',
536
'SmartServerRequestFindRepositoryV1')
537
request_handlers.register_lazy(
538
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir',
539
'SmartServerRequestFindRepositoryV2')
540
request_handlers.register_lazy(
541
'BzrDir.find_repositoryV3', 'bzrlib.smart.bzrdir',
542
'SmartServerRequestFindRepositoryV3')
543
request_handlers.register_lazy(
544
'BzrDir.get_config_file', 'bzrlib.smart.bzrdir',
545
'SmartServerBzrDirRequestConfigFile')
546
request_handlers.register_lazy(
547
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir',
548
'SmartServerRequestInitializeBzrDir')
549
request_handlers.register_lazy(
550
'BzrDirFormat.initialize_ex_1.16', 'bzrlib.smart.bzrdir',
551
'SmartServerRequestBzrDirInitializeEx')
552
request_handlers.register_lazy(
553
'BzrDir.open', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir')
554
request_handlers.register_lazy(
555
'BzrDir.open_2.1', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir_2_1')
556
request_handlers.register_lazy(
557
'BzrDir.open_branch', 'bzrlib.smart.bzrdir',
558
'SmartServerRequestOpenBranch')
559
request_handlers.register_lazy(
560
'BzrDir.open_branchV2', 'bzrlib.smart.bzrdir',
561
'SmartServerRequestOpenBranchV2')
562
request_handlers.register_lazy(
563
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
564
request_handlers.register_lazy(
565
'get', 'bzrlib.smart.vfs', 'GetRequest')
566
request_handlers.register_lazy(
567
'get_bundle', 'bzrlib.smart.request', 'GetBundleRequest')
568
request_handlers.register_lazy(
569
'has', 'bzrlib.smart.vfs', 'HasRequest')
570
request_handlers.register_lazy(
571
'hello', 'bzrlib.smart.request', 'HelloRequest')
572
request_handlers.register_lazy(
573
'iter_files_recursive', 'bzrlib.smart.vfs', 'IterFilesRecursiveRequest')
574
request_handlers.register_lazy(
575
'list_dir', 'bzrlib.smart.vfs', 'ListDirRequest')
576
request_handlers.register_lazy(
577
'mkdir', 'bzrlib.smart.vfs', 'MkdirRequest')
578
request_handlers.register_lazy(
579
'move', 'bzrlib.smart.vfs', 'MoveRequest')
580
request_handlers.register_lazy(
581
'put', 'bzrlib.smart.vfs', 'PutRequest')
582
request_handlers.register_lazy(
583
'put_non_atomic', 'bzrlib.smart.vfs', 'PutNonAtomicRequest')
584
request_handlers.register_lazy(
585
'readv', 'bzrlib.smart.vfs', 'ReadvRequest')
586
request_handlers.register_lazy(
587
'rename', 'bzrlib.smart.vfs', 'RenameRequest')
588
request_handlers.register_lazy(
589
'PackRepository.autopack', 'bzrlib.smart.packrepository',
590
'SmartServerPackRepositoryAutopack')
591
request_handlers.register_lazy('Repository.gather_stats',
592
'bzrlib.smart.repository',
593
'SmartServerRepositoryGatherStats')
594
request_handlers.register_lazy('Repository.get_parent_map',
595
'bzrlib.smart.repository',
596
'SmartServerRepositoryGetParentMap')
597
request_handlers.register_lazy(
598
'Repository.get_revision_graph', 'bzrlib.smart.repository', 'SmartServerRepositoryGetRevisionGraph')
599
request_handlers.register_lazy(
600
'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
601
request_handlers.register_lazy(
602
'Repository.insert_stream', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStream')
603
request_handlers.register_lazy(
604
'Repository.insert_stream_1.19', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStream_1_19')
605
request_handlers.register_lazy(
606
'Repository.insert_stream_locked', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStreamLocked')
607
request_handlers.register_lazy(
608
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
609
request_handlers.register_lazy(
610
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
611
request_handlers.register_lazy(
612
'Repository.set_make_working_trees', 'bzrlib.smart.repository',
613
'SmartServerRepositorySetMakeWorkingTrees')
614
request_handlers.register_lazy(
615
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
616
request_handlers.register_lazy(
617
'Repository.get_rev_id_for_revno', 'bzrlib.smart.repository',
618
'SmartServerRepositoryGetRevIdForRevno')
619
request_handlers.register_lazy(
620
'Repository.get_stream', 'bzrlib.smart.repository',
621
'SmartServerRepositoryGetStream')
622
request_handlers.register_lazy(
623
'Repository.get_stream_1.19', 'bzrlib.smart.repository',
624
'SmartServerRepositoryGetStream_1_19')
625
request_handlers.register_lazy(
626
'Repository.tarball', 'bzrlib.smart.repository',
627
'SmartServerRepositoryTarball')
628
request_handlers.register_lazy(
629
'rmdir', 'bzrlib.smart.vfs', 'RmdirRequest')
630
request_handlers.register_lazy(
631
'stat', 'bzrlib.smart.vfs', 'StatRequest')
632
request_handlers.register_lazy(
633
'Transport.is_readonly', 'bzrlib.smart.request', 'SmartServerIsReadonly')
added
removed
bzrlib/smart/request.py
