~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/request.py

  • Committer: Daniel Watkins
  • Date: 2007-11-17 17:22:08 UTC
  • mto: This revision was merged to the branch mainline in revision 3013.
  • Revision ID: d.m.watkins@warwick.ac.uk-20071117172208-m47tdnnatvm2ir2u
Modified fix as suggested by John on-list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Basic server-side logic for dealing with requests."""
 
18
 
 
19
 
 
20
import tempfile
 
21
 
 
22
from bzrlib import (
 
23
    bzrdir,
 
24
    errors,
 
25
    registry,
 
26
    revision,
 
27
    )
 
28
from bzrlib.bundle.serializer import write_bundle
 
29
 
 
30
 
 
31
class SmartServerRequest(object):
 
32
    """Base class for request handlers."""
 
33
 
 
34
    def __init__(self, backing_transport):
 
35
        """Constructor.
 
36
 
 
37
        :param backing_transport: the base transport to be used when performing
 
38
            this request.
 
39
        """
 
40
        self._backing_transport = backing_transport
 
41
 
 
42
    def _check_enabled(self):
 
43
        """Raises DisabledMethod if this method is disabled."""
 
44
        pass
 
45
 
 
46
    def do(self, *args):
 
47
        """Mandatory extension point for SmartServerRequest subclasses.
 
48
        
 
49
        Subclasses must implement this.
 
50
        
 
51
        This should return a SmartServerResponse if this command expects to
 
52
        receive no body.
 
53
        """
 
54
        raise NotImplementedError(self.do)
 
55
 
 
56
    def execute(self, *args):
 
57
        """Public entry point to execute this request.
 
58
 
 
59
        It will return a SmartServerResponse if the command does not expect a
 
60
        body.
 
61
 
 
62
        :param *args: the arguments of the request.
 
63
        """
 
64
        self._check_enabled()
 
65
        return self.do(*args)
 
66
 
 
67
    def do_body(self, body_bytes):
 
68
        """Called if the client sends a body with the request.
 
69
        
 
70
        Must return a SmartServerResponse.
 
71
        """
 
72
        # TODO: if a client erroneously sends a request that shouldn't have a
 
73
        # body, what to do?  Probably SmartServerRequestHandler should catch
 
74
        # this NotImplementedError and translate it into a 'bad request' error
 
75
        # to send to the client.
 
76
        raise NotImplementedError(self.do_body)
 
77
 
 
78
 
 
79
class SmartServerResponse(object):
 
80
    """A response to a client request.
 
81
    
 
82
    This base class should not be used. Instead use
 
83
    SuccessfulSmartServerResponse and FailedSmartServerResponse as appropriate.
 
84
    """
 
85
 
 
86
    def __init__(self, args, body=None, body_stream=None):
 
87
        """Constructor.
 
88
 
 
89
        :param args: tuple of response arguments.
 
90
        :param body: string of a response body.
 
91
        :param body_stream: iterable of bytestrings to be streamed to the
 
92
            client.
 
93
        """
 
94
        self.args = args
 
95
        if body is not None and body_stream is not None:
 
96
            raise errors.BzrError(
 
97
                "'body' and 'body_stream' are mutually exclusive.")
 
98
        self.body = body
 
99
        self.body_stream = body_stream
 
100
 
 
101
    def __eq__(self, other):
 
102
        if other is None:
 
103
            return False
 
104
        return (other.args == self.args and
 
105
                other.body == self.body and
 
106
                other.body_stream is self.body_stream)
 
107
 
 
108
    def __repr__(self):
 
109
        return "<SmartServerResponse %r args=%r body=%r>" % (
 
110
            self.is_successful(), self.args, self.body)
 
111
 
 
112
 
 
113
class FailedSmartServerResponse(SmartServerResponse):
 
114
    """A SmartServerResponse for a request which failed."""
 
115
 
 
116
    def is_successful(self):
 
117
        """FailedSmartServerResponse are not successful."""
 
118
        return False
 
119
 
 
120
 
 
121
class SuccessfulSmartServerResponse(SmartServerResponse):
 
122
    """A SmartServerResponse for a successfully completed request."""
 
123
 
 
124
    def is_successful(self):
 
125
        """SuccessfulSmartServerResponse are successful."""
 
126
        return True
 
127
 
 
128
 
 
129
class SmartServerRequestHandler(object):
 
130
    """Protocol logic for smart server.
 
131
    
 
132
    This doesn't handle serialization at all, it just processes requests and
 
133
    creates responses.
 
134
    """
 
135
 
 
136
    # IMPORTANT FOR IMPLEMENTORS: It is important that SmartServerRequestHandler
 
137
    # not contain encoding or decoding logic to allow the wire protocol to vary
 
138
    # from the object protocol: we will want to tweak the wire protocol separate
 
139
    # from the object model, and ideally we will be able to do that without
 
140
    # having a SmartServerRequestHandler subclass for each wire protocol, rather
 
141
    # just a Protocol subclass.
 
142
 
 
143
    # TODO: Better way of representing the body for commands that take it,
 
144
    # and allow it to be streamed into the server.
 
145
 
 
146
    def __init__(self, backing_transport, commands):
 
147
        """Constructor.
 
148
 
 
149
        :param backing_transport: a Transport to handle requests for.
 
150
        :param commands: a registry mapping command names to SmartServerRequest
 
151
            subclasses. e.g. bzrlib.transport.smart.vfs.vfs_commands.
 
152
        """
 
153
        self._backing_transport = backing_transport
 
154
        self._commands = commands
 
155
        self._body_bytes = ''
 
156
        self.response = None
 
157
        self.finished_reading = False
 
158
        self._command = None
 
159
 
 
160
    def accept_body(self, bytes):
 
161
        """Accept body data."""
 
162
 
 
163
        # TODO: This should be overriden for each command that desired body data
 
164
        # to handle the right format of that data, i.e. plain bytes, a bundle,
 
165
        # etc.  The deserialisation into that format should be done in the
 
166
        # Protocol object.
 
167
 
 
168
        # default fallback is to accumulate bytes.
 
169
        self._body_bytes += bytes
 
170
        
 
171
    def end_of_body(self):
 
172
        """No more body data will be received."""
 
173
        self._run_handler_code(self._command.do_body, (self._body_bytes,), {})
 
174
        # cannot read after this.
 
175
        self.finished_reading = True
 
176
 
 
177
    def dispatch_command(self, cmd, args):
 
178
        """Deprecated compatibility method.""" # XXX XXX
 
179
        try:
 
180
            command = self._commands.get(cmd)
 
181
        except LookupError:
 
182
            raise errors.SmartProtocolError("bad request %r" % (cmd,))
 
183
        self._command = command(self._backing_transport)
 
184
        self._run_handler_code(self._command.execute, args, {})
 
185
 
 
186
    def _run_handler_code(self, callable, args, kwargs):
 
187
        """Run some handler specific code 'callable'.
 
188
 
 
189
        If a result is returned, it is considered to be the commands response,
 
190
        and finished_reading is set true, and its assigned to self.response.
 
191
 
 
192
        Any exceptions caught are translated and a response object created
 
193
        from them.
 
194
        """
 
195
        result = self._call_converting_errors(callable, args, kwargs)
 
196
 
 
197
        if result is not None:
 
198
            self.response = result
 
199
            self.finished_reading = True
 
200
 
 
201
    def _call_converting_errors(self, callable, args, kwargs):
 
202
        """Call callable converting errors to Response objects."""
 
203
        # XXX: most of this error conversion is VFS-related, and thus ought to
 
204
        # be in SmartServerVFSRequestHandler somewhere.
 
205
        try:
 
206
            return callable(*args, **kwargs)
 
207
        except errors.NoSuchFile, e:
 
208
            return FailedSmartServerResponse(('NoSuchFile', e.path))
 
209
        except errors.FileExists, e:
 
210
            return FailedSmartServerResponse(('FileExists', e.path))
 
211
        except errors.DirectoryNotEmpty, e:
 
212
            return FailedSmartServerResponse(('DirectoryNotEmpty', e.path))
 
213
        except errors.ShortReadvError, e:
 
214
            return FailedSmartServerResponse(('ShortReadvError',
 
215
                e.path, str(e.offset), str(e.length), str(e.actual)))
 
216
        except UnicodeError, e:
 
217
            # If it is a DecodeError, than most likely we are starting
 
218
            # with a plain string
 
219
            str_or_unicode = e.object
 
220
            if isinstance(str_or_unicode, unicode):
 
221
                # XXX: UTF-8 might have \x01 (our seperator byte) in it.  We
 
222
                # should escape it somehow.
 
223
                val = 'u:' + str_or_unicode.encode('utf-8')
 
224
            else:
 
225
                val = 's:' + str_or_unicode.encode('base64')
 
226
            # This handles UnicodeEncodeError or UnicodeDecodeError
 
227
            return FailedSmartServerResponse((e.__class__.__name__,
 
228
                    e.encoding, val, str(e.start), str(e.end), e.reason))
 
229
        except errors.TransportNotPossible, e:
 
230
            if e.msg == "readonly transport":
 
231
                return FailedSmartServerResponse(('ReadOnlyError', ))
 
232
            else:
 
233
                raise
 
234
 
 
235
 
 
236
class HelloRequest(SmartServerRequest):
 
237
    """Answer a version request with the highest protocol version this server
 
238
    supports.
 
239
    """
 
240
 
 
241
    def do(self):
 
242
        return SuccessfulSmartServerResponse(('ok', '2'))
 
243
 
 
244
 
 
245
class GetBundleRequest(SmartServerRequest):
 
246
    """Get a bundle of from the null revision to the specified revision."""
 
247
 
 
248
    def do(self, path, revision_id):
 
249
        # open transport relative to our base
 
250
        t = self._backing_transport.clone(path)
 
251
        control, extra_path = bzrdir.BzrDir.open_containing_from_transport(t)
 
252
        repo = control.open_repository()
 
253
        tmpf = tempfile.TemporaryFile()
 
254
        base_revision = revision.NULL_REVISION
 
255
        write_bundle(repo, revision_id, base_revision, tmpf)
 
256
        tmpf.seek(0)
 
257
        return SuccessfulSmartServerResponse((), tmpf.read())
 
258
 
 
259
 
 
260
class SmartServerIsReadonly(SmartServerRequest):
 
261
    # XXX: this request method belongs somewhere else.
 
262
 
 
263
    def do(self):
 
264
        if self._backing_transport.is_readonly():
 
265
            answer = 'yes'
 
266
        else:
 
267
            answer = 'no'
 
268
        return SuccessfulSmartServerResponse((answer,))
 
269
 
 
270
 
 
271
request_handlers = registry.Registry()
 
272
request_handlers.register_lazy(
 
273
    'append', 'bzrlib.smart.vfs', 'AppendRequest')
 
274
request_handlers.register_lazy(
 
275
    'Branch.get_config_file', 'bzrlib.smart.branch', 'SmartServerBranchGetConfigFile')
 
276
request_handlers.register_lazy(
 
277
    'Branch.last_revision_info', 'bzrlib.smart.branch', 'SmartServerBranchRequestLastRevisionInfo')
 
278
request_handlers.register_lazy(
 
279
    'Branch.lock_write', 'bzrlib.smart.branch', 'SmartServerBranchRequestLockWrite')
 
280
request_handlers.register_lazy(
 
281
    'Branch.revision_history', 'bzrlib.smart.branch', 'SmartServerRequestRevisionHistory')
 
282
request_handlers.register_lazy(
 
283
    'Branch.set_last_revision', 'bzrlib.smart.branch', 'SmartServerBranchRequestSetLastRevision')
 
284
request_handlers.register_lazy(
 
285
    'Branch.unlock', 'bzrlib.smart.branch', 'SmartServerBranchRequestUnlock')
 
286
request_handlers.register_lazy(
 
287
    'BzrDir.find_repository', 'bzrlib.smart.bzrdir', 'SmartServerRequestFindRepository')
 
288
request_handlers.register_lazy(
 
289
    'BzrDirFormat.initialize', 'bzrlib.smart.bzrdir', 'SmartServerRequestInitializeBzrDir')
 
290
request_handlers.register_lazy(
 
291
    'BzrDir.open_branch', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBranch')
 
292
request_handlers.register_lazy(
 
293
    'delete', 'bzrlib.smart.vfs', 'DeleteRequest')
 
294
request_handlers.register_lazy(
 
295
    'get', 'bzrlib.smart.vfs', 'GetRequest')
 
296
request_handlers.register_lazy(
 
297
    'get_bundle', 'bzrlib.smart.request', 'GetBundleRequest')
 
298
request_handlers.register_lazy(
 
299
    'has', 'bzrlib.smart.vfs', 'HasRequest')
 
300
request_handlers.register_lazy(
 
301
    'hello', 'bzrlib.smart.request', 'HelloRequest')
 
302
request_handlers.register_lazy(
 
303
    'iter_files_recursive', 'bzrlib.smart.vfs', 'IterFilesRecursiveRequest')
 
304
request_handlers.register_lazy(
 
305
    'list_dir', 'bzrlib.smart.vfs', 'ListDirRequest')
 
306
request_handlers.register_lazy(
 
307
    'mkdir', 'bzrlib.smart.vfs', 'MkdirRequest')
 
308
request_handlers.register_lazy(
 
309
    'move', 'bzrlib.smart.vfs', 'MoveRequest')
 
310
request_handlers.register_lazy(
 
311
    'put', 'bzrlib.smart.vfs', 'PutRequest')
 
312
request_handlers.register_lazy(
 
313
    'put_non_atomic', 'bzrlib.smart.vfs', 'PutNonAtomicRequest')
 
314
request_handlers.register_lazy(
 
315
    'readv', 'bzrlib.smart.vfs', 'ReadvRequest')
 
316
request_handlers.register_lazy(
 
317
    'rename', 'bzrlib.smart.vfs', 'RenameRequest')
 
318
request_handlers.register_lazy('Repository.gather_stats',
 
319
                               'bzrlib.smart.repository',
 
320
                               'SmartServerRepositoryGatherStats')
 
321
request_handlers.register_lazy(
 
322
    'Repository.stream_knit_data_for_revisions', 'bzrlib.smart.repository',
 
323
    'SmartServerRepositoryStreamKnitDataForRevisions')
 
324
request_handlers.register_lazy(
 
325
    'Repository.get_revision_graph', 'bzrlib.smart.repository', 'SmartServerRepositoryGetRevisionGraph')
 
326
request_handlers.register_lazy(
 
327
    'Repository.has_revision', 'bzrlib.smart.repository', 'SmartServerRequestHasRevision')
 
328
request_handlers.register_lazy(
 
329
    'Repository.is_shared', 'bzrlib.smart.repository', 'SmartServerRepositoryIsShared')
 
330
request_handlers.register_lazy(
 
331
    'Repository.lock_write', 'bzrlib.smart.repository', 'SmartServerRepositoryLockWrite')
 
332
request_handlers.register_lazy(
 
333
    'Repository.unlock', 'bzrlib.smart.repository', 'SmartServerRepositoryUnlock')
 
334
request_handlers.register_lazy(
 
335
    'Repository.tarball', 'bzrlib.smart.repository',
 
336
    'SmartServerRepositoryTarball')
 
337
request_handlers.register_lazy(
 
338
    'rmdir', 'bzrlib.smart.vfs', 'RmdirRequest')
 
339
request_handlers.register_lazy(
 
340
    'stat', 'bzrlib.smart.vfs', 'StatRequest')
 
341
request_handlers.register_lazy(
 
342
    'Transport.is_readonly', 'bzrlib.smart.request', 'SmartServerIsReadonly')
 
343
request_handlers.register_lazy(
 
344
    'BzrDir.open', 'bzrlib.smart.bzrdir', 'SmartServerRequestOpenBzrDir')