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