13
13
# You should have received a copy of the GNU General Public License
14
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).
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).
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.
38
31
from bzrlib import (
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
45
class SmartServerRequest(object):
82
46
"""Base class for request handlers.
284
234
self._backing_transport = backing_transport
285
235
self._root_client_path = root_client_path
286
236
self._commands = commands
287
if jail_root is None:
288
jail_root = backing_transport
289
self._jail_root = jail_root
290
237
self.response = None
291
238
self.finished_reading = False
292
239
self._command = None
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
241
def accept_body(self, bytes):
316
242
"""Accept body data."""
317
if self._command is None:
318
# no active command object, so ignore the event.
320
243
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
245
def end_of_body(self):
326
246
"""No more body data will be received."""
327
247
self._run_handler_code(self._command.do_end, (), {})
328
248
# cannot read after this.
329
249
self.finished_reading = True
330
if 'hpss' in debug.debug_flags:
331
self._trace('end of body', '', include_time=True)
251
def dispatch_command(self, cmd, args):
252
"""Deprecated compatibility method.""" # XXX XXX
254
command = self._commands.get(cmd)
256
raise errors.UnknownSmartMethod(cmd)
257
self._command = command(self._backing_transport, self._root_client_path)
258
self._run_handler_code(self._command.execute, args, {})
333
260
def _run_handler_code(self, callable, args, kwargs):
334
261
"""Run some handler specific code 'callable'.
373
295
command = self._commands.get(cmd)
374
296
except LookupError:
375
if 'hpss' in debug.debug_flags:
376
self._trace('hpss unknown request',
377
cmd, repr(args)[1:-1])
378
297
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)
298
self._command = command(self._backing_transport)
389
299
self._run_handler_code(self._command.execute, args, {})
391
301
def end_received(self):
392
if self._command is None:
393
# no active command object, so ignore the event.
395
302
self._run_handler_code(self._command.do_end, (), {})
396
if 'hpss' in debug.debug_flags:
397
self._trace('end', '', include_time=True)
399
304
def post_body_error_received(self, error_args):
400
305
# Just a no-op at the moment.
442
344
return ('ReadError', err.path)
443
345
elif isinstance(err, errors.PermissionDenied):
444
346
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
347
# Unserialisable error. Log it, and return a generic error
450
348
trace.log_exception_quietly()
451
349
return ('error', str(err))
490
388
request_handlers.register_lazy(
491
389
'append', 'bzrlib.smart.vfs', 'AppendRequest')
492
390
request_handlers.register_lazy(
493
'Branch.get_config_file', 'bzrlib.smart.branch',
494
'SmartServerBranchGetConfigFile')
391
'Branch.get_config_file', 'bzrlib.smart.branch', 'SmartServerBranchGetConfigFile')
495
392
request_handlers.register_lazy(
496
393
'Branch.get_parent', 'bzrlib.smart.branch', 'SmartServerBranchGetParent')
497
394
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
395
'Branch.get_stacked_on_url', 'bzrlib.smart.branch', 'SmartServerBranchRequestGetStackedOnURL')
505
396
request_handlers.register_lazy(
506
397
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
507
398
request_handlers.register_lazy(
508
399
'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')
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')
515
404
request_handlers.register_lazy(
516
405
'Branch.set_last_revision_info', 'bzrlib.smart.branch',
517
406
'SmartServerBranchRequestSetLastRevisionInfo')
519
408
'Branch.set_last_revision_ex', 'bzrlib.smart.branch',
520
409
'SmartServerBranchRequestSetLastRevisionEx')
521
410
request_handlers.register_lazy(
522
'Branch.set_parent_location', 'bzrlib.smart.branch',
523
'SmartServerBranchRequestSetParentLocation')
524
request_handlers.register_lazy(
525
411
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
526
412
request_handlers.register_lazy(
527
413
'BzrDir.cloning_metadir', 'bzrlib.smart.bzrdir',
528
414
'SmartServerBzrDirRequestCloningMetaDir')
529
415
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')
416
'BzrDir.create_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestCreateBranch')
417
request_handlers.register_lazy(
418
'BzrDir.create_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestCreateRepository')
419
request_handlers.register_lazy(
420
'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV1')
421
request_handlers.register_lazy(
422
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV2')
423
request_handlers.register_lazy(
424
'BzrDir.find_repositoryV3', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV3')
425
request_handlers.register_lazy(
426
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir', 'SmartServerRequestInitializeBzrDir')
427
request_handlers.register_lazy(
428
'BzrDir.open_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBranch')
566
429
request_handlers.register_lazy(
567
430
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
568
431
request_handlers.register_lazy(
605
468
request_handlers.register_lazy(
606
469
'Repository.insert_stream', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStream')
607
470
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
471
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
613
472
request_handlers.register_lazy(
614
473
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
618
477
request_handlers.register_lazy(
619
478
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
620
479
request_handlers.register_lazy(
621
'Repository.get_rev_id_for_revno', 'bzrlib.smart.repository',
622
'SmartServerRepositoryGetRevIdForRevno')
623
request_handlers.register_lazy(
624
480
'Repository.get_stream', 'bzrlib.smart.repository',
625
481
'SmartServerRepositoryGetStream')
626
482
request_handlers.register_lazy(
627
'Repository.get_stream_1.19', 'bzrlib.smart.repository',
628
'SmartServerRepositoryGetStream_1_19')
629
request_handlers.register_lazy(
630
483
'Repository.tarball', 'bzrlib.smart.repository',
631
484
'SmartServerRepositoryTarball')
632
485
request_handlers.register_lazy(