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.
36
31
from bzrlib import (
46
38
from bzrlib.lazy_import import lazy_import
47
39
lazy_import(globals(), """
48
40
from bzrlib.bundle import serializer
55
jail_info = threading.local()
56
jail_info.transports = None
60
bzrdir.BzrDir.hooks.install_named_hook(
61
'pre_open', _pre_open_hook, 'checking server jail')
64
def _pre_open_hook(transport):
65
allowed_transports = getattr(jail_info, 'transports', None)
66
if allowed_transports is None:
68
abspath = transport.base
69
for allowed_transport in allowed_transports:
71
allowed_transport.relpath(abspath)
72
except errors.PathNotChild:
76
raise errors.JailBreak(abspath)
82
44
class SmartServerRequest(object):
83
45
"""Base class for request handlers.
85
47
To define a new request, subclass this class and override the `do` method
86
48
(and if appropriate, `do_body` as well). Request implementors should take
87
49
care to call `translate_client_path` and `transport_from_client_path` as
144
100
"""Called if the client sends a body with the request.
146
102
The do() method is still called, and must have returned None.
148
104
Must return a SmartServerResponse.
151
raise errors.SmartProtocolError('Request does not expect a body')
106
raise NotImplementedError(self.do_body)
153
108
def do_chunk(self, chunk_bytes):
154
109
"""Called with each body chunk if the request has a streamed body.
156
111
The do() method is still called, and must have returned None.
158
self._body_chunks.append(chunk_bytes)
113
raise NotImplementedError(self.do_chunk)
160
115
def do_end(self):
161
116
"""Called when the end of the request has been received."""
162
body_bytes = ''.join(self._body_chunks)
163
self._body_chunks = None
164
return self.do_body(body_bytes)
166
def setup_jail(self):
167
jail_info.transports = [self._jail_root]
169
def teardown_jail(self):
170
jail_info.transports = None
172
119
def translate_client_path(self, client_path):
173
120
"""Translate a path received from a network client into a local
285
229
self._backing_transport = backing_transport
286
230
self._root_client_path = root_client_path
287
231
self._commands = commands
288
if jail_root is None:
289
jail_root = backing_transport
290
self._jail_root = jail_root
232
self._body_bytes = ''
291
233
self.response = None
292
234
self.finished_reading = False
293
235
self._command = None
294
if 'hpss' in debug.debug_flags:
295
self._request_start_time = osutils.timer_func()
296
self._thread_id = thread.get_ident()
298
def _trace(self, action, message, extra_bytes=None, include_time=False):
299
# It is a bit of a shame that this functionality overlaps with that of
300
# ProtocolThreeRequester._trace. However, there is enough difference
301
# that just putting it in a helper doesn't help a lot. And some state
302
# is taken from the instance.
304
t = '%5.3fs ' % (osutils.timer_func() - self._request_start_time)
307
if extra_bytes is None:
310
extra = ' ' + repr(extra_bytes[:40])
312
extra = extra[:29] + extra[-1] + '...'
313
trace.mutter('%12s: [%s] %s%s%s'
314
% (action, self._thread_id, t, message, extra))
316
237
def accept_body(self, bytes):
317
238
"""Accept body data."""
318
if self._command is None:
319
# no active command object, so ignore the event.
321
self._run_handler_code(self._command.do_chunk, (bytes,), {})
322
if 'hpss' in debug.debug_flags:
323
self._trace('accept body',
324
'%d bytes' % (len(bytes),), bytes)
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
326
248
def end_of_body(self):
327
249
"""No more body data will be received."""
328
self._run_handler_code(self._command.do_end, (), {})
250
self._run_handler_code(self._command.do_body, (self._body_bytes,), {})
329
251
# cannot read after this.
330
252
self.finished_reading = True
331
if 'hpss' in debug.debug_flags:
332
self._trace('end of body', '', include_time=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, {})
334
263
def _run_handler_code(self, callable, args, kwargs):
335
264
"""Run some handler specific code 'callable'.
351
280
# XXX: most of this error conversion is VFS-related, and thus ought to
352
281
# be in SmartServerVFSRequestHandler somewhere.
354
self._command.setup_jail()
356
return callable(*args, **kwargs)
358
self._command.teardown_jail()
359
except (KeyboardInterrupt, SystemExit):
361
except Exception, err:
362
err_struct = _translate_error(err)
363
return FailedSmartServerResponse(err_struct)
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 seperator byte) in it. We
307
# should escape it somehow.
308
val = 'u:' + str_or_unicode.encode('utf-8')
310
val = 's:' + str_or_unicode.encode('base64')
311
# This handles UnicodeEncodeError or UnicodeDecodeError
312
return FailedSmartServerResponse((e.__class__.__name__,
313
e.encoding, val, str(e.start), str(e.end), e.reason))
314
except errors.TransportNotPossible, e:
315
if e.msg == "readonly transport":
316
return FailedSmartServerResponse(('ReadOnlyError', ))
365
320
def headers_received(self, headers):
366
321
# Just a no-op at the moment.
367
if 'hpss' in debug.debug_flags:
368
self._trace('headers', repr(headers))
370
324
def args_received(self, args):
374
328
command = self._commands.get(cmd)
375
329
except LookupError:
376
if 'hpss' in debug.debug_flags:
377
self._trace('hpss unknown request',
378
cmd, repr(args)[1:-1])
379
330
raise errors.UnknownSmartMethod(cmd)
380
if 'hpss' in debug.debug_flags:
381
from bzrlib.smart import vfs
382
if issubclass(command, vfs.VfsRequest):
383
action = 'hpss vfs req'
385
action = 'hpss request'
387
'%s %s' % (cmd, repr(args)[1:-1]))
388
self._command = command(
389
self._backing_transport, self._root_client_path, self._jail_root)
331
self._command = command(self._backing_transport)
390
332
self._run_handler_code(self._command.execute, args, {})
334
def prefixed_body_received(self, body_bytes):
335
"""No more body data will be received."""
336
self._run_handler_code(self._command.do_body, (body_bytes,), {})
337
# cannot read after this.
338
self.finished_reading = True
340
def body_chunk_received(self, chunk_bytes):
341
self._run_handler_code(self._command.do_chunk, (chunk_bytes,), {})
392
343
def end_received(self):
393
if self._command is None:
394
# no active command object, so ignore the event.
396
344
self._run_handler_code(self._command.do_end, (), {})
397
if 'hpss' in debug.debug_flags:
398
self._trace('end', '', include_time=True)
400
def post_body_error_received(self, error_args):
401
# Just a no-op at the moment.
405
def _translate_error(err):
406
if isinstance(err, errors.NoSuchFile):
407
return ('NoSuchFile', err.path)
408
elif isinstance(err, errors.FileExists):
409
return ('FileExists', err.path)
410
elif isinstance(err, errors.DirectoryNotEmpty):
411
return ('DirectoryNotEmpty', err.path)
412
elif isinstance(err, errors.IncompatibleRepositories):
413
return ('IncompatibleRepositories', str(err.source), str(err.target),
415
elif isinstance(err, errors.ShortReadvError):
416
return ('ShortReadvError', err.path, str(err.offset), str(err.length),
418
elif isinstance(err, errors.UnstackableRepositoryFormat):
419
return (('UnstackableRepositoryFormat', str(err.format), err.url))
420
elif isinstance(err, errors.UnstackableBranchFormat):
421
return ('UnstackableBranchFormat', str(err.format), err.url)
422
elif isinstance(err, errors.NotStacked):
423
return ('NotStacked',)
424
elif isinstance(err, UnicodeError):
425
# If it is a DecodeError, than most likely we are starting
426
# with a plain string
427
str_or_unicode = err.object
428
if isinstance(str_or_unicode, unicode):
429
# XXX: UTF-8 might have \x01 (our protocol v1 and v2 seperator
430
# byte) in it, so this encoding could cause broken responses.
431
# Newer clients use protocol v3, so will be fine.
432
val = 'u:' + str_or_unicode.encode('utf-8')
434
val = 's:' + str_or_unicode.encode('base64')
435
# This handles UnicodeEncodeError or UnicodeDecodeError
436
return (err.__class__.__name__, err.encoding, val, str(err.start),
437
str(err.end), err.reason)
438
elif isinstance(err, errors.TransportNotPossible):
439
if err.msg == "readonly transport":
440
return ('ReadOnlyError', )
441
elif isinstance(err, errors.ReadError):
442
# cannot read the file
443
return ('ReadError', err.path)
444
elif isinstance(err, errors.PermissionDenied):
445
return ('PermissionDenied', err.path, err.extra)
446
elif isinstance(err, errors.TokenMismatch):
447
return ('TokenMismatch', err.given_token, err.lock_token)
448
elif isinstance(err, errors.LockContention):
449
return ('LockContention',)
450
elif isinstance(err, MemoryError):
451
# GZ 2011-02-24: Copy bzrlib.trace -Dmem_dump functionality here?
452
return ('MemoryError',)
453
# Unserialisable error. Log it, and return a generic error
454
trace.log_exception_quietly()
455
return ('error', trace._qualified_exception_name(err.__class__, True),
459
347
class HelloRequest(SmartServerRequest):
495
383
request_handlers.register_lazy(
496
384
'append', 'bzrlib.smart.vfs', 'AppendRequest')
497
385
request_handlers.register_lazy(
498
'Branch.get_config_file', 'bzrlib.smart.branch',
499
'SmartServerBranchGetConfigFile')
500
request_handlers.register_lazy(
501
'Branch.get_parent', 'bzrlib.smart.branch', 'SmartServerBranchGetParent')
502
request_handlers.register_lazy(
503
'Branch.get_tags_bytes', 'bzrlib.smart.branch',
504
'SmartServerBranchGetTagsBytes')
505
request_handlers.register_lazy(
506
'Branch.set_tags_bytes', 'bzrlib.smart.branch',
507
'SmartServerBranchSetTagsBytes')
508
request_handlers.register_lazy(
509
'Branch.heads_to_fetch', 'bzrlib.smart.branch',
510
'SmartServerBranchHeadsToFetch')
386
'Branch.get_config_file', 'bzrlib.smart.branch', 'SmartServerBranchGetConfigFile')
511
387
request_handlers.register_lazy(
512
388
'Branch.get_stacked_on_url', 'bzrlib.smart.branch', 'SmartServerBranchRequestGetStackedOnURL')
513
389
request_handlers.register_lazy(
514
390
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
515
391
request_handlers.register_lazy(
516
392
'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
517
request_handlers.register_lazy( 'Branch.revision_history',
518
'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
519
request_handlers.register_lazy( 'Branch.set_config_option',
520
'bzrlib.smart.branch', 'SmartServerBranchRequestSetConfigOption')
521
request_handlers.register_lazy( 'Branch.set_config_option_dict',
522
'bzrlib.smart.branch', 'SmartServerBranchRequestSetConfigOptionDict')
523
request_handlers.register_lazy( 'Branch.set_last_revision',
524
'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
393
request_handlers.register_lazy(
394
'Branch.revision_history', 'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
395
request_handlers.register_lazy(
396
'Branch.set_last_revision', 'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
525
397
request_handlers.register_lazy(
526
398
'Branch.set_last_revision_info', 'bzrlib.smart.branch',
527
399
'SmartServerBranchRequestSetLastRevisionInfo')
529
401
'Branch.set_last_revision_ex', 'bzrlib.smart.branch',
530
402
'SmartServerBranchRequestSetLastRevisionEx')
531
403
request_handlers.register_lazy(
532
'Branch.set_parent_location', 'bzrlib.smart.branch',
533
'SmartServerBranchRequestSetParentLocation')
534
request_handlers.register_lazy(
535
404
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
536
405
request_handlers.register_lazy(
537
'BzrDir.cloning_metadir', 'bzrlib.smart.bzrdir',
538
'SmartServerBzrDirRequestCloningMetaDir')
539
request_handlers.register_lazy(
540
'BzrDir.create_branch', 'bzrlib.smart.bzrdir',
541
'SmartServerRequestCreateBranch')
542
request_handlers.register_lazy(
543
'BzrDir.create_repository', 'bzrlib.smart.bzrdir',
544
'SmartServerRequestCreateRepository')
545
request_handlers.register_lazy(
546
'BzrDir.find_repository', 'bzrlib.smart.bzrdir',
547
'SmartServerRequestFindRepositoryV1')
548
request_handlers.register_lazy(
549
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir',
550
'SmartServerRequestFindRepositoryV2')
551
request_handlers.register_lazy(
552
'BzrDir.find_repositoryV3', 'bzrlib.smart.bzrdir',
553
'SmartServerRequestFindRepositoryV3')
554
request_handlers.register_lazy(
555
'BzrDir.get_config_file', 'bzrlib.smart.bzrdir',
556
'SmartServerBzrDirRequestConfigFile')
557
request_handlers.register_lazy(
558
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir',
559
'SmartServerRequestInitializeBzrDir')
560
request_handlers.register_lazy(
561
'BzrDirFormat.initialize_ex_1.16', 'bzrlib.smart.bzrdir',
562
'SmartServerRequestBzrDirInitializeEx')
563
request_handlers.register_lazy(
564
'BzrDir.open', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir')
565
request_handlers.register_lazy(
566
'BzrDir.open_2.1', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir_2_1')
567
request_handlers.register_lazy(
568
'BzrDir.open_branch', 'bzrlib.smart.bzrdir',
569
'SmartServerRequestOpenBranch')
570
request_handlers.register_lazy(
571
'BzrDir.open_branchV2', 'bzrlib.smart.bzrdir',
572
'SmartServerRequestOpenBranchV2')
573
request_handlers.register_lazy(
574
'BzrDir.open_branchV3', 'bzrlib.smart.bzrdir',
575
'SmartServerRequestOpenBranchV3')
406
'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV1')
407
request_handlers.register_lazy(
408
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV2')
409
request_handlers.register_lazy(
410
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir', 'SmartServerRequestInitializeBzrDir')
411
request_handlers.register_lazy(
412
'BzrDir.open_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBranch')
576
413
request_handlers.register_lazy(
577
414
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
578
415
request_handlers.register_lazy(
613
447
request_handlers.register_lazy(
614
448
'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
615
449
request_handlers.register_lazy(
616
'Repository.insert_stream', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStream')
617
request_handlers.register_lazy(
618
'Repository.insert_stream_1.19', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStream_1_19')
619
request_handlers.register_lazy(
620
'Repository.insert_stream_locked', 'bzrlib.smart.repository', 'SmartServerRepositoryInsertStreamLocked')
621
request_handlers.register_lazy(
622
450
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
623
451
request_handlers.register_lazy(
624
452
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
625
453
request_handlers.register_lazy(
626
'Repository.set_make_working_trees', 'bzrlib.smart.repository',
627
'SmartServerRepositorySetMakeWorkingTrees')
628
request_handlers.register_lazy(
629
454
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
630
455
request_handlers.register_lazy(
631
'Repository.get_rev_id_for_revno', 'bzrlib.smart.repository',
632
'SmartServerRepositoryGetRevIdForRevno')
633
request_handlers.register_lazy(
634
'Repository.get_stream', 'bzrlib.smart.repository',
635
'SmartServerRepositoryGetStream')
636
request_handlers.register_lazy(
637
'Repository.get_stream_1.19', 'bzrlib.smart.repository',
638
'SmartServerRepositoryGetStream_1_19')
639
request_handlers.register_lazy(
640
456
'Repository.tarball', 'bzrlib.smart.repository',
641
457
'SmartServerRepositoryTarball')
642
458
request_handlers.register_lazy(