← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

  • Committer: Aaron Bentley
  • Date: 2009-06-20 01:17:38 UTC
  • mto: This revision was merged to the branch mainline in revision 4465.
  • Revision ID: aaron@aaronbentley.com-20090620011738-ui5v1f48fluueiix
https://launchpad.net/bugs/363444
ContainerPushParser.accept_bytes handles zero-length records correctly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/server.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Server for smart-server protocol."""
18
18
 
19
19
import errno
20
 
import os.path
21
20
import socket
22
21
import sys
23
22
import threading
31
30
from bzrlib.lazy_import import lazy_import
32
31
lazy_import(globals(), """
33
32
from bzrlib.smart import medium
34
 
from bzrlib.transport import (
35
 
    chroot,
36
 
    get_transport,
37
 
    pathfilter,
38
 
    )
39
 
from bzrlib import (
40
 
    urlutils,
41
 
    )
42
33
""")
43
34
 
44
35
 
120
111
            pass
121
112
        for hook in SmartTCPServer.hooks['server_started']:
122
113
            hook(backing_urls, self.get_url())
123
 
        for hook in SmartTCPServer.hooks['server_started_ex']:
124
 
            hook(backing_urls, self)
125
114
        self._started.set()
126
115
        try:
127
116
            try:
143
132
                # dont log when CTRL-C'd.
144
133
                raise
145
134
            except Exception, e:
146
 
                trace.report_exception(sys.exc_info(), sys.stderr)
 
135
                trace.error("Unhandled smart server error.")
 
136
                trace.log_exception_quietly()
147
137
                raise
148
138
        finally:
149
139
            self._stopped.set()
224
214
            "where backing_url is a list of URLs giving the "
225
215
            "server-specific directory locations, and public_url is the "
226
216
            "public URL for the directory being served.", (0, 16), None))
227
 
        self.create_hook(HookPoint('server_started_ex',
228
 
            "Called by the bzr server when it starts serving a directory. "
229
 
            "server_started is called with (backing_urls, server_obj).",
230
 
            (1, 17), None))
231
217
        self.create_hook(HookPoint('server_stopped',
232
218
            "Called by the bzr server when it stops serving a directory. "
233
219
            "server_stopped is called with the same parameters as the "
236
222
SmartTCPServer.hooks = SmartServerHooks()
237
223
 
238
224
 
239
 
def _local_path_for_transport(transport):
240
 
    """Return a local path for transport, if reasonably possible.
241
 
    
242
 
    This function works even if transport's url has a "readonly+" prefix,
243
 
    unlike local_path_from_url.
244
 
    
245
 
    This essentially recovers the --directory argument the user passed to "bzr
246
 
    serve" from the transport passed to serve_bzr.
247
 
    """
248
 
    try:
249
 
        base_url = transport.external_url()
250
 
    except (errors.InProcessTransport, NotImplementedError):
251
 
        return None
 
225
class SmartTCPServer_for_testing(SmartTCPServer):
 
226
    """Server suitable for use by transport tests.
 
227
 
 
228
    This server is backed by the process's cwd.
 
229
    """
 
230
 
 
231
    def __init__(self, thread_name_suffix=''):
 
232
        SmartTCPServer.__init__(self, None)
 
233
        self.client_path_extra = None
 
234
        self.thread_name_suffix = thread_name_suffix
 
235
 
 
236
    def get_backing_transport(self, backing_transport_server):
 
237
        """Get a backing transport from a server we are decorating."""
 
238
        return transport.get_transport(backing_transport_server.get_url())
 
239
 
 
240
    def setUp(self, backing_transport_server=None,
 
241
              client_path_extra='/extra/'):
 
242
        """Set up server for testing.
 
243
 
 
244
        :param backing_transport_server: backing server to use.  If not
 
245
            specified, a LocalURLServer at the current working directory will
 
246
            be used.
 
247
        :param client_path_extra: a path segment starting with '/' to append to
 
248
            the root URL for this server.  For instance, a value of '/foo/bar/'
 
249
            will mean the root of the backing transport will be published at a
 
250
            URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
 
251
            `bzr://127.0.0.1:nnnn/`.  Default value is `extra`, so that tests
 
252
            by default will fail unless they do the necessary path translation.
 
253
        """
 
254
        if not client_path_extra.startswith('/'):
 
255
            raise ValueError(client_path_extra)
 
256
        from bzrlib.transport.chroot import ChrootServer
 
257
        if backing_transport_server is None:
 
258
            from bzrlib.transport.local import LocalURLServer
 
259
            backing_transport_server = LocalURLServer()
 
260
        self.chroot_server = ChrootServer(
 
261
            self.get_backing_transport(backing_transport_server))
 
262
        self.chroot_server.setUp()
 
263
        self.backing_transport = transport.get_transport(
 
264
            self.chroot_server.get_url())
 
265
        self.root_client_path = self.client_path_extra = client_path_extra
 
266
        self.start_background_thread(self.thread_name_suffix)
 
267
 
 
268
    def tearDown(self):
 
269
        self.stop_background_thread()
 
270
        self.chroot_server.tearDown()
 
271
 
 
272
    def get_url(self):
 
273
        url = super(SmartTCPServer_for_testing, self).get_url()
 
274
        return url[:-1] + self.client_path_extra
 
275
 
 
276
    def get_bogus_url(self):
 
277
        """Return a URL which will fail to connect"""
 
278
        return 'bzr://127.0.0.1:1/'
 
279
 
 
280
 
 
281
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
 
282
    """Get a readonly server for testing."""
 
283
 
 
284
    def get_backing_transport(self, backing_transport_server):
 
285
        """Get a backing transport from a server we are decorating."""
 
286
        url = 'readonly+' + backing_transport_server.get_url()
 
287
        return transport.get_transport(url)
 
288
 
 
289
 
 
290
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
 
291
    """A variation of SmartTCPServer_for_testing that limits the client to
 
292
    using RPCs in protocol v2 (i.e. bzr <= 1.5).
 
293
    """
 
294
 
 
295
    def get_url(self):
 
296
        url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
 
297
        url = 'bzr-v2://' + url[len('bzr://'):]
 
298
        return url
 
299
 
 
300
 
 
301
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
 
302
    """Get a readonly server for testing."""
 
303
 
 
304
    def get_backing_transport(self, backing_transport_server):
 
305
        """Get a backing transport from a server we are decorating."""
 
306
        url = 'readonly+' + backing_transport_server.get_url()
 
307
        return transport.get_transport(url)
 
308
 
 
309
 
 
310
def serve_bzr(transport, host=None, port=None, inet=False):
 
311
    from bzrlib import lockdir, ui
 
312
    from bzrlib.transport import get_transport
 
313
    from bzrlib.transport.chroot import ChrootServer
 
314
    chroot_server = ChrootServer(transport)
 
315
    chroot_server.setUp()
 
316
    t = get_transport(chroot_server.get_url())
 
317
    if inet:
 
318
        smart_server = medium.SmartServerPipeStreamMedium(
 
319
            sys.stdin, sys.stdout, transport)
252
320
    else:
253
 
        # Strip readonly prefix
254
 
        if base_url.startswith('readonly+'):
255
 
            base_url = base_url[len('readonly+'):]
256
 
        try:
257
 
            return urlutils.local_path_from_url(base_url)
258
 
        except errors.InvalidURL:
259
 
            return None
260
 
 
261
 
 
262
 
class BzrServerFactory(object):
263
 
    """Helper class for serve_bzr."""
264
 
 
265
 
    def __init__(self, userdir_expander=None, get_base_path=None):
266
 
        self.cleanups = []
267
 
        self.base_path = None
268
 
        self.backing_transport = None
269
 
        if userdir_expander is None:
270
 
            userdir_expander = os.path.expanduser
271
 
        self.userdir_expander = userdir_expander
272
 
        if get_base_path is None:
273
 
            get_base_path = _local_path_for_transport
274
 
        self.get_base_path = get_base_path
275
 
 
276
 
    def _expand_userdirs(self, path):
277
 
        """Translate /~/ or /~user/ to e.g. /home/foo, using
278
 
        self.userdir_expander (os.path.expanduser by default).
279
 
 
280
 
        If the translated path would fall outside base_path, or the path does
281
 
        not start with ~, then no translation is applied.
282
 
 
283
 
        If the path is inside, it is adjusted to be relative to the base path.
284
 
 
285
 
        e.g. if base_path is /home, and the expanded path is /home/joe, then
286
 
        the translated path is joe.
287
 
        """
288
 
        result = path
289
 
        if path.startswith('~'):
290
 
            expanded = self.userdir_expander(path)
291
 
            if not expanded.endswith('/'):
292
 
                expanded += '/'
293
 
            if expanded.startswith(self.base_path):
294
 
                result = expanded[len(self.base_path):]
295
 
        return result
296
 
 
297
 
    def _make_expand_userdirs_filter(self, transport):
298
 
        return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
299
 
 
300
 
    def _make_backing_transport(self, transport):
301
 
        """Chroot transport, and decorate with userdir expander."""
302
 
        self.base_path = self.get_base_path(transport)
303
 
        chroot_server = chroot.ChrootServer(transport)
304
 
        chroot_server.start_server()
305
 
        self.cleanups.append(chroot_server.stop_server)
306
 
        transport = get_transport(chroot_server.get_url())
307
 
        if self.base_path is not None:
308
 
            # Decorate the server's backing transport with a filter that can
309
 
            # expand homedirs.
310
 
            expand_userdirs = self._make_expand_userdirs_filter(transport)
311
 
            expand_userdirs.start_server()
312
 
            self.cleanups.append(expand_userdirs.stop_server)
313
 
            transport = get_transport(expand_userdirs.get_url())
314
 
        self.transport = transport
315
 
 
316
 
    def _make_smart_server(self, host, port, inet):
317
 
        if inet:
318
 
            smart_server = medium.SmartServerPipeStreamMedium(
319
 
                sys.stdin, sys.stdout, self.transport)
320
 
        else:
321
 
            if host is None:
322
 
                host = medium.BZR_DEFAULT_INTERFACE
323
 
            if port is None:
324
 
                port = medium.BZR_DEFAULT_PORT
325
 
            smart_server = SmartTCPServer(self.transport, host=host, port=port)
326
 
            trace.note('listening on port: %s' % smart_server.port)
327
 
        self.smart_server = smart_server
328
 
 
329
 
    def _change_globals(self):
330
 
        from bzrlib import lockdir, ui
331
 
        # For the duration of this server, no UI output is permitted. note
332
 
        # that this may cause problems with blackbox tests. This should be
333
 
        # changed with care though, as we dont want to use bandwidth sending
334
 
        # progress over stderr to smart server clients!
335
 
        old_factory = ui.ui_factory
336
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
337
 
        def restore_default_ui_factory_and_lockdir_timeout():
338
 
            ui.ui_factory = old_factory
339
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
340
 
        self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
 
321
        if host is None:
 
322
            host = medium.BZR_DEFAULT_INTERFACE
 
323
        if port is None:
 
324
            port = medium.BZR_DEFAULT_PORT
 
325
        smart_server = SmartTCPServer(
 
326
            transport, host=host, port=port)
 
327
        trace.note('listening on port: %s' % smart_server.port)
 
328
    # For the duration of this server, no UI output is permitted. note
 
329
    # that this may cause problems with blackbox tests. This should be
 
330
    # changed with care though, as we dont want to use bandwidth sending
 
331
    # progress over stderr to smart server clients!
 
332
    old_factory = ui.ui_factory
 
333
    old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
334
    try:
341
335
        ui.ui_factory = ui.SilentUIFactory()
342
336
        lockdir._DEFAULT_TIMEOUT_SECONDS = 0
343
 
 
344
 
    def set_up(self, transport, host, port, inet):
345
 
        self._make_backing_transport(transport)
346
 
        self._make_smart_server(host, port, inet)
347
 
        self._change_globals()
348
 
 
349
 
    def tear_down(self):
350
 
        for cleanup in reversed(self.cleanups):
351
 
            cleanup()
352
 
 
353
 
 
354
 
def serve_bzr(transport, host=None, port=None, inet=False):
355
 
    """This is the default implementation of 'bzr serve'.
356
 
    
357
 
    It creates a TCP or pipe smart server on 'transport, and runs it.  The
358
 
    transport will be decorated with a chroot and pathfilter (using
359
 
    os.path.expanduser).
360
 
    """
361
 
    bzr_server = BzrServerFactory()
362
 
    try:
363
 
        bzr_server.set_up(transport, host, port, inet)
364
 
        bzr_server.smart_server.serve()
 
337
        smart_server.serve()
365
338
    finally:
366
 
        bzr_server.tear_down()
 
339
        ui.ui_factory = old_factory
 
340
        lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
367
341