1
# Copyright (C) 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Basic server-side logic for dealing with requests."""
22
from bzrlib import bzrdir, errors, registry, revision
23
from bzrlib.bundle.serializer import write_bundle
26
class SmartServerRequest(object):
27
"""Base class for request handlers.
30
def __init__(self, backing_transport):
31
self._backing_transport = backing_transport
33
def _check_enabled(self):
34
"""Raises DisabledMethod if this method is disabled."""
38
"""Mandatory extension point for SmartServerRequest subclasses.
40
Subclasses must implement this.
42
This should return a SmartServerResponse if this command expects to
45
raise NotImplementedError(self.do)
47
def execute(self, *args):
48
"""Public entry point to execute this request.
50
It will return a SmartServerResponse if the command does not expect a
53
:param *args: the arguments of the request.
58
def do_body(self, body_bytes):
59
"""Called if the client sends a body with the request.
61
Must return a SmartServerResponse.
63
# TODO: if a client erroneously sends a request that shouldn't have a
64
# body, what to do? Probably SmartServerRequestHandler should catch
65
# this NotImplementedError and translate it into a 'bad request' error
66
# to send to the client.
67
raise NotImplementedError(self.do_body)
70
class SmartServerResponse(object):
71
"""Response generated by SmartServerRequestHandler."""
73
def __init__(self, args, body=None):
77
def __eq__(self, other):
80
return other.args == self.args and other.body == self.body
83
return "<SmartServerResponse args=%r body=%r>" % (self.args, self.body)
86
class SmartServerRequestHandler(object):
87
"""Protocol logic for smart server.
89
This doesn't handle serialization at all, it just processes requests and
93
# IMPORTANT FOR IMPLEMENTORS: It is important that SmartServerRequestHandler
94
# not contain encoding or decoding logic to allow the wire protocol to vary
95
# from the object protocol: we will want to tweak the wire protocol separate
96
# from the object model, and ideally we will be able to do that without
97
# having a SmartServerRequestHandler subclass for each wire protocol, rather
98
# just a Protocol subclass.
100
# TODO: Better way of representing the body for commands that take it,
101
# and allow it to be streamed into the server.
103
def __init__(self, backing_transport, commands):
106
:param backing_transport: a Transport to handle requests for.
107
:param commands: a registry mapping command names to SmartServerRequest
108
subclasses. e.g. bzrlib.transport.smart.vfs.vfs_commands.
110
self._backing_transport = backing_transport
111
self._commands = commands
112
self._body_bytes = ''
114
self.finished_reading = False
117
def accept_body(self, bytes):
118
"""Accept body data."""
120
# TODO: This should be overriden for each command that desired body data
121
# to handle the right format of that data, i.e. plain bytes, a bundle,
122
# etc. The deserialisation into that format should be done in the
125
# default fallback is to accumulate bytes.
126
self._body_bytes += bytes
128
def end_of_body(self):
129
"""No more body data will be received."""
130
self._run_handler_code(self._command.do_body, (self._body_bytes,), {})
131
# cannot read after this.
132
self.finished_reading = True
134
def dispatch_command(self, cmd, args):
135
"""Deprecated compatibility method.""" # XXX XXX
137
command = self._commands.get(cmd)
139
raise errors.SmartProtocolError("bad request %r" % (cmd,))
140
self._command = command(self._backing_transport)
141
self._run_handler_code(self._command.execute, args, {})
143
def _run_handler_code(self, callable, args, kwargs):
144
"""Run some handler specific code 'callable'.
146
If a result is returned, it is considered to be the commands response,
147
and finished_reading is set true, and its assigned to self.response.
149
Any exceptions caught are translated and a response object created
152
result = self._call_converting_errors(callable, args, kwargs)
154
if result is not None:
155
self.response = result
156
self.finished_reading = True
158
def _call_converting_errors(self, callable, args, kwargs):
159
"""Call callable converting errors to Response objects."""
160
# XXX: most of this error conversion is VFS-related, and thus ought to
161
# be in SmartServerVFSRequestHandler somewhere.
163
return callable(*args, **kwargs)
164
except errors.NoSuchFile, e:
165
return SmartServerResponse(('NoSuchFile', e.path))
166
except errors.FileExists, e:
167
return SmartServerResponse(('FileExists', e.path))
168
except errors.DirectoryNotEmpty, e:
169
return SmartServerResponse(('DirectoryNotEmpty', e.path))
170
except errors.ShortReadvError, e:
171
return SmartServerResponse(('ShortReadvError',
172
e.path, str(e.offset), str(e.length), str(e.actual)))
173
except UnicodeError, e:
174
# If it is a DecodeError, than most likely we are starting
175
# with a plain string
176
str_or_unicode = e.object
177
if isinstance(str_or_unicode, unicode):
178
# XXX: UTF-8 might have \x01 (our seperator byte) in it. We
179
# should escape it somehow.
180
val = 'u:' + str_or_unicode.encode('utf-8')
182
val = 's:' + str_or_unicode.encode('base64')
183
# This handles UnicodeEncodeError or UnicodeDecodeError
184
return SmartServerResponse((e.__class__.__name__,
185
e.encoding, val, str(e.start), str(e.end), e.reason))
186
except errors.TransportNotPossible, e:
187
if e.msg == "readonly transport":
188
return SmartServerResponse(('ReadOnlyError', ))
193
class HelloRequest(SmartServerRequest):
194
"""Answer a version request with my version."""
197
return SmartServerResponse(('ok', '1'))
200
class GetBundleRequest(SmartServerRequest):
202
def do(self, path, revision_id):
203
# open transport relative to our base
204
t = self._backing_transport.clone(path)
205
control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
206
repo = control.open_repository()
207
tmpf = tempfile.TemporaryFile()
208
base_revision = revision.NULL_REVISION
209
write_bundle(repo, revision_id, base_revision, tmpf)
211
return SmartServerResponse((), tmpf.read())
214
# This exists solely to help RemoteObjectHacking. It should be removed
215
# eventually. It should not be considered part of the real smart server
217
class ProbeDontUseRequest(SmartServerRequest):
220
from bzrlib.bzrdir import BzrDirFormat
221
t = self._backing_transport.clone(path)
222
default_format = BzrDirFormat.get_default_format()
223
real_bzrdir = default_format.open(t, _found=True)
225
real_bzrdir._format.probe_transport(t)
226
except (errors.NotBranchError, errors.UnknownFormatError):
230
return SmartServerResponse((answer,))
233
class SmartServerIsReadonly(SmartServerRequest):
234
# XXX: this request method belongs somewhere else.
237
if self._backing_transport.is_readonly():
241
return SmartServerResponse((answer,))
244
request_handlers = registry.Registry()
245
request_handlers.register_lazy(
246
'append', 'bzrlib.smart.vfs', 'AppendRequest')
247
request_handlers.register_lazy(
248
'Branch.get_config_file', 'bzrlib.smart.branch', 'SmartServerBranchGetConfigFile')
249
request_handlers.register_lazy(
250
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
251
request_handlers.register_lazy(
252
'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
253
request_handlers.register_lazy(
254
'Branch.revision_history', 'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
255
request_handlers.register_lazy(
256
'Branch.set_last_revision', 'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
257
request_handlers.register_lazy(
258
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
259
request_handlers.register_lazy(
260
'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepository')
261
request_handlers.register_lazy(
262
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir', 'SmartServerRequestInitializeBzrDir')
263
request_handlers.register_lazy(
264
'BzrDir.open_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBranch')
265
request_handlers.register_lazy(
266
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
267
request_handlers.register_lazy(
268
'get', 'bzrlib.smart.vfs', 'GetRequest')
269
request_handlers.register_lazy(
270
'get_bundle', 'bzrlib.smart.request', 'GetBundleRequest')
271
request_handlers.register_lazy(
272
'has', 'bzrlib.smart.vfs', 'HasRequest')
273
request_handlers.register_lazy(
274
'hello', 'bzrlib.smart.request', 'HelloRequest')
275
request_handlers.register_lazy(
276
'iter_files_recursive', 'bzrlib.smart.vfs', 'IterFilesRecursiveRequest')
277
request_handlers.register_lazy(
278
'list_dir', 'bzrlib.smart.vfs', 'ListDirRequest')
279
request_handlers.register_lazy(
280
'mkdir', 'bzrlib.smart.vfs', 'MkdirRequest')
281
request_handlers.register_lazy(
282
'move', 'bzrlib.smart.vfs', 'MoveRequest')
283
request_handlers.register_lazy(
284
'put', 'bzrlib.smart.vfs', 'PutRequest')
285
request_handlers.register_lazy(
286
'put_non_atomic', 'bzrlib.smart.vfs', 'PutNonAtomicRequest')
287
request_handlers.register_lazy(
288
'readv', 'bzrlib.smart.vfs', 'ReadvRequest')
289
request_handlers.register_lazy(
290
'rename', 'bzrlib.smart.vfs', 'RenameRequest')
291
request_handlers.register_lazy('Repository.gather_stats',
292
'bzrlib.smart.repository',
293
'SmartServerRepositoryGatherStats')
294
request_handlers.register_lazy(
295
'Repository.get_revision_graph', 'bzrlib.smart.repository', 'SmartServerRepositoryGetRevisionGraph')
296
request_handlers.register_lazy(
297
'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
298
request_handlers.register_lazy(
299
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
300
request_handlers.register_lazy(
301
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
302
request_handlers.register_lazy(
303
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
304
request_handlers.register_lazy(
305
'rmdir', 'bzrlib.smart.vfs', 'RmdirRequest')
306
request_handlers.register_lazy(
307
'stat', 'bzrlib.smart.vfs', 'StatRequest')
308
request_handlers.register_lazy(
309
'Transport.is_readonly', 'bzrlib.smart.request', 'SmartServerIsReadonly')
310
request_handlers.register_lazy(
311
'probe_dont_use', 'bzrlib.smart.request', 'ProbeDontUseRequest')
added
removed
bzrlib/smart/request.py
