1
# iopyright (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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Basic server-side logic for dealing with requests."""
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
30
from bzrlib.bundle import serializer
34
class SmartServerRequest(object):
35
"""Base class for request handlers."""
37
def __init__(self, backing_transport):
40
:param backing_transport: the base transport to be used when performing
43
self._backing_transport = backing_transport
45
def _check_enabled(self):
46
"""Raises DisabledMethod if this method is disabled."""
50
"""Mandatory extension point for SmartServerRequest subclasses.
52
Subclasses must implement this.
54
This should return a SmartServerResponse if this command expects to
57
raise NotImplementedError(self.do)
59
def execute(self, *args):
60
"""Public entry point to execute this request.
62
It will return a SmartServerResponse if the command does not expect a
65
:param *args: the arguments of the request.
70
def do_body(self, body_bytes):
71
"""Called if the client sends a body with the request.
73
The do() method is still called, and must have returned None.
75
Must return a SmartServerResponse.
77
# TODO: if a client erroneously sends a request that shouldn't have a
78
# body, what to do? Probably SmartServerRequestHandler should catch
79
# this NotImplementedError and translate it into a 'bad request' error
80
# to send to the client.
81
raise NotImplementedError(self.do_body)
84
class SmartServerResponse(object):
85
"""A response to a client request.
87
This base class should not be used. Instead use
88
SuccessfulSmartServerResponse and FailedSmartServerResponse as appropriate.
91
def __init__(self, args, body=None, body_stream=None):
94
:param args: tuple of response arguments.
95
:param body: string of a response body.
96
:param body_stream: iterable of bytestrings to be streamed to the
100
if body is not None and body_stream is not None:
101
raise errors.BzrError(
102
"'body' and 'body_stream' are mutually exclusive.")
104
self.body_stream = body_stream
106
def __eq__(self, other):
109
return (other.args == self.args and
110
other.body == self.body and
111
other.body_stream is self.body_stream)
114
return ("<SmartServerResponse successful=%s args=%r body=%r>"
115
% (self.is_successful(), self.args, self.body))
118
class FailedSmartServerResponse(SmartServerResponse):
119
"""A SmartServerResponse for a request which failed."""
121
def is_successful(self):
122
"""FailedSmartServerResponse are not successful."""
126
class SuccessfulSmartServerResponse(SmartServerResponse):
127
"""A SmartServerResponse for a successfully completed request."""
129
def is_successful(self):
130
"""SuccessfulSmartServerResponse are successful."""
134
class SmartServerRequestHandler(object):
135
"""Protocol logic for smart server.
137
This doesn't handle serialization at all, it just processes requests and
141
# IMPORTANT FOR IMPLEMENTORS: It is important that SmartServerRequestHandler
142
# not contain encoding or decoding logic to allow the wire protocol to vary
143
# from the object protocol: we will want to tweak the wire protocol separate
144
# from the object model, and ideally we will be able to do that without
145
# having a SmartServerRequestHandler subclass for each wire protocol, rather
146
# just a Protocol subclass.
148
# TODO: Better way of representing the body for commands that take it,
149
# and allow it to be streamed into the server.
151
def __init__(self, backing_transport, commands):
154
:param backing_transport: a Transport to handle requests for.
155
:param commands: a registry mapping command names to SmartServerRequest
156
subclasses. e.g. bzrlib.transport.smart.vfs.vfs_commands.
158
self._backing_transport = backing_transport
159
self._commands = commands
160
self._body_bytes = ''
162
self.finished_reading = False
165
def accept_body(self, bytes):
166
"""Accept body data."""
168
# TODO: This should be overriden for each command that desired body data
169
# to handle the right format of that data, i.e. plain bytes, a bundle,
170
# etc. The deserialisation into that format should be done in the
173
# default fallback is to accumulate bytes.
174
self._body_bytes += bytes
176
def end_of_body(self):
177
"""No more body data will be received."""
178
self._run_handler_code(self._command.do_body, (self._body_bytes,), {})
179
# cannot read after this.
180
self.finished_reading = True
182
def dispatch_command(self, cmd, args):
183
"""Deprecated compatibility method.""" # XXX XXX
185
command = self._commands.get(cmd)
187
raise errors.SmartProtocolError("bad request %r" % (cmd,))
188
self._command = command(self._backing_transport)
189
self._run_handler_code(self._command.execute, args, {})
191
def _run_handler_code(self, callable, args, kwargs):
192
"""Run some handler specific code 'callable'.
194
If a result is returned, it is considered to be the commands response,
195
and finished_reading is set true, and its assigned to self.response.
197
Any exceptions caught are translated and a response object created
200
result = self._call_converting_errors(callable, args, kwargs)
202
if result is not None:
203
self.response = result
204
self.finished_reading = True
206
def _call_converting_errors(self, callable, args, kwargs):
207
"""Call callable converting errors to Response objects."""
208
# XXX: most of this error conversion is VFS-related, and thus ought to
209
# be in SmartServerVFSRequestHandler somewhere.
211
return callable(*args, **kwargs)
212
except errors.NoSuchFile, e:
213
return FailedSmartServerResponse(('NoSuchFile', e.path))
214
except errors.FileExists, e:
215
return FailedSmartServerResponse(('FileExists', e.path))
216
except errors.DirectoryNotEmpty, e:
217
return FailedSmartServerResponse(('DirectoryNotEmpty', e.path))
218
except errors.ShortReadvError, e:
219
return FailedSmartServerResponse(('ShortReadvError',
220
e.path, str(e.offset), str(e.length), str(e.actual)))
221
except UnicodeError, e:
222
# If it is a DecodeError, than most likely we are starting
223
# with a plain string
224
str_or_unicode = e.object
225
if isinstance(str_or_unicode, unicode):
226
# XXX: UTF-8 might have \x01 (our seperator byte) in it. We
227
# should escape it somehow.
228
val = 'u:' + str_or_unicode.encode('utf-8')
230
val = 's:' + str_or_unicode.encode('base64')
231
# This handles UnicodeEncodeError or UnicodeDecodeError
232
return FailedSmartServerResponse((e.__class__.__name__,
233
e.encoding, val, str(e.start), str(e.end), e.reason))
234
except errors.TransportNotPossible, e:
235
if e.msg == "readonly transport":
236
return FailedSmartServerResponse(('ReadOnlyError', ))
241
class HelloRequest(SmartServerRequest):
242
"""Answer a version request with the highest protocol version this server
247
return SuccessfulSmartServerResponse(('ok', '2'))
250
class GetBundleRequest(SmartServerRequest):
251
"""Get a bundle of from the null revision to the specified revision."""
253
def do(self, path, revision_id):
254
# open transport relative to our base
255
t = self._backing_transport.clone(path)
256
control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
257
repo = control.open_repository()
258
tmpf = tempfile.TemporaryFile()
259
base_revision = revision.NULL_REVISION
260
serializer.write_bundle(repo, revision_id, base_revision, tmpf)
262
return SuccessfulSmartServerResponse((), tmpf.read())
265
class SmartServerIsReadonly(SmartServerRequest):
266
# XXX: this request method belongs somewhere else.
269
if self._backing_transport.is_readonly():
273
return SuccessfulSmartServerResponse((answer,))
276
request_handlers = registry.Registry()
277
request_handlers.register_lazy(
278
'append', 'bzrlib.smart.vfs', 'AppendRequest')
279
request_handlers.register_lazy(
280
'Branch.get_config_file', 'bzrlib.smart.branch', 'SmartServerBranchGetConfigFile')
281
request_handlers.register_lazy(
282
'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
283
request_handlers.register_lazy(
284
'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
285
request_handlers.register_lazy(
286
'Branch.revision_history', 'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
287
request_handlers.register_lazy(
288
'Branch.set_last_revision', 'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
289
request_handlers.register_lazy(
290
'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
291
request_handlers.register_lazy(
292
'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV1')
293
request_handlers.register_lazy(
294
'BzrDir.find_repositoryV2', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepositoryV2')
295
request_handlers.register_lazy(
296
'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir', 'SmartServerRequestInitializeBzrDir')
297
request_handlers.register_lazy(
298
'BzrDir.open_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBranch')
299
request_handlers.register_lazy(
300
'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
301
request_handlers.register_lazy(
302
'get', 'bzrlib.smart.vfs', 'GetRequest')
303
request_handlers.register_lazy(
304
'get_bundle', 'bzrlib.smart.request', 'GetBundleRequest')
305
request_handlers.register_lazy(
306
'has', 'bzrlib.smart.vfs', 'HasRequest')
307
request_handlers.register_lazy(
308
'hello', 'bzrlib.smart.request', 'HelloRequest')
309
request_handlers.register_lazy(
310
'iter_files_recursive', 'bzrlib.smart.vfs', 'IterFilesRecursiveRequest')
311
request_handlers.register_lazy(
312
'list_dir', 'bzrlib.smart.vfs', 'ListDirRequest')
313
request_handlers.register_lazy(
314
'mkdir', 'bzrlib.smart.vfs', 'MkdirRequest')
315
request_handlers.register_lazy(
316
'move', 'bzrlib.smart.vfs', 'MoveRequest')
317
request_handlers.register_lazy(
318
'put', 'bzrlib.smart.vfs', 'PutRequest')
319
request_handlers.register_lazy(
320
'put_non_atomic', 'bzrlib.smart.vfs', 'PutNonAtomicRequest')
321
request_handlers.register_lazy(
322
'readv', 'bzrlib.smart.vfs', 'ReadvRequest')
323
request_handlers.register_lazy(
324
'rename', 'bzrlib.smart.vfs', 'RenameRequest')
325
request_handlers.register_lazy('Repository.gather_stats',
326
'bzrlib.smart.repository',
327
'SmartServerRepositoryGatherStats')
328
request_handlers.register_lazy('Repository.get_parent_map',
329
'bzrlib.smart.repository',
330
'SmartServerRepositoryGetParentMap')
331
request_handlers.register_lazy(
332
'Repository.stream_knit_data_for_revisions',
333
'bzrlib.smart.repository',
334
'SmartServerRepositoryStreamKnitDataForRevisions')
335
request_handlers.register_lazy(
336
'Repository.stream_revisions_chunked',
337
'bzrlib.smart.repository',
338
'SmartServerRepositoryStreamRevisionsChunked')
339
request_handlers.register_lazy(
340
'Repository.get_revision_graph', 'bzrlib.smart.repository', 'SmartServerRepositoryGetRevisionGraph')
341
request_handlers.register_lazy(
342
'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
343
request_handlers.register_lazy(
344
'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
345
request_handlers.register_lazy(
346
'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
347
request_handlers.register_lazy(
348
'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
349
request_handlers.register_lazy(
350
'Repository.tarball', 'bzrlib.smart.repository',
351
'SmartServerRepositoryTarball')
352
request_handlers.register_lazy(
353
'rmdir', 'bzrlib.smart.vfs', 'RmdirRequest')
354
request_handlers.register_lazy(
355
'stat', 'bzrlib.smart.vfs', 'StatRequest')
356
request_handlers.register_lazy(
357
'Transport.is_readonly', 'bzrlib.smart.request', 'SmartServerIsReadonly')
358
request_handlers.register_lazy(
359
'BzrDir.open', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir')
added
removed
bzrlib/smart/request.py
