← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

  • Committer: Andrew Bennetts
  • Date: 2009-09-17 03:21:14 UTC
  • mto: This revision was merged to the branch mainline in revision 4702.
  • Revision ID: andrew.bennetts@canonical.com-20090917032114-0iayfgmojst22w1c
Update network-protocol.txt too.

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
138
138
                        if e.args[0] != errno.EBADF:
139
139
                            trace.warning("listening socket error: %s", e)
140
140
                    else:
141
 
                        if self._should_terminate:
142
 
                            break
143
141
                        self.serve_conn(conn, thread_name_suffix)
144
142
            except KeyboardInterrupt:
145
143
                # dont log when CTRL-C'd.
146
144
                raise
147
145
            except Exception, e:
148
 
                trace.report_exception(sys.exc_info(), sys.stderr)
 
146
                trace.error("Unhandled smart server error.")
 
147
                trace.log_exception_quietly()
149
148
                raise
150
149
        finally:
151
150
            self._stopped.set()
238
237
SmartTCPServer.hooks = SmartServerHooks()
239
238
 
240
239
 
 
240
class SmartTCPServer_for_testing(SmartTCPServer):
 
241
    """Server suitable for use by transport tests.
 
242
 
 
243
    This server is backed by the process's cwd.
 
244
    """
 
245
 
 
246
    def __init__(self, thread_name_suffix=''):
 
247
        SmartTCPServer.__init__(self, None)
 
248
        self.client_path_extra = None
 
249
        self.thread_name_suffix = thread_name_suffix
 
250
 
 
251
    def get_backing_transport(self, backing_transport_server):
 
252
        """Get a backing transport from a server we are decorating."""
 
253
        return transport.get_transport(backing_transport_server.get_url())
 
254
 
 
255
    def setUp(self, backing_transport_server=None,
 
256
              client_path_extra='/extra/'):
 
257
        """Set up server for testing.
 
258
 
 
259
        :param backing_transport_server: backing server to use.  If not
 
260
            specified, a LocalURLServer at the current working directory will
 
261
            be used.
 
262
        :param client_path_extra: a path segment starting with '/' to append to
 
263
            the root URL for this server.  For instance, a value of '/foo/bar/'
 
264
            will mean the root of the backing transport will be published at a
 
265
            URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
 
266
            `bzr://127.0.0.1:nnnn/`.  Default value is `extra`, so that tests
 
267
            by default will fail unless they do the necessary path translation.
 
268
        """
 
269
        if not client_path_extra.startswith('/'):
 
270
            raise ValueError(client_path_extra)
 
271
        from bzrlib.transport.chroot import ChrootServer
 
272
        if backing_transport_server is None:
 
273
            from bzrlib.transport.local import LocalURLServer
 
274
            backing_transport_server = LocalURLServer()
 
275
        self.chroot_server = ChrootServer(
 
276
            self.get_backing_transport(backing_transport_server))
 
277
        self.chroot_server.setUp()
 
278
        self.backing_transport = transport.get_transport(
 
279
            self.chroot_server.get_url())
 
280
        self.root_client_path = self.client_path_extra = client_path_extra
 
281
        self.start_background_thread(self.thread_name_suffix)
 
282
 
 
283
    def tearDown(self):
 
284
        self.stop_background_thread()
 
285
        self.chroot_server.tearDown()
 
286
 
 
287
    def get_url(self):
 
288
        url = super(SmartTCPServer_for_testing, self).get_url()
 
289
        return url[:-1] + self.client_path_extra
 
290
 
 
291
    def get_bogus_url(self):
 
292
        """Return a URL which will fail to connect"""
 
293
        return 'bzr://127.0.0.1:1/'
 
294
 
 
295
 
 
296
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
 
297
    """Get a readonly server for testing."""
 
298
 
 
299
    def get_backing_transport(self, backing_transport_server):
 
300
        """Get a backing transport from a server we are decorating."""
 
301
        url = 'readonly+' + backing_transport_server.get_url()
 
302
        return transport.get_transport(url)
 
303
 
 
304
 
 
305
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
 
306
    """A variation of SmartTCPServer_for_testing that limits the client to
 
307
    using RPCs in protocol v2 (i.e. bzr <= 1.5).
 
308
    """
 
309
 
 
310
    def get_url(self):
 
311
        url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
 
312
        url = 'bzr-v2://' + url[len('bzr://'):]
 
313
        return url
 
314
 
 
315
 
 
316
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
 
317
    """Get a readonly server for testing."""
 
318
 
 
319
    def get_backing_transport(self, backing_transport_server):
 
320
        """Get a backing transport from a server we are decorating."""
 
321
        url = 'readonly+' + backing_transport_server.get_url()
 
322
        return transport.get_transport(url)
 
323
 
 
324
 
241
325
def _local_path_for_transport(transport):
242
326
    """Return a local path for transport, if reasonably possible.
243
327
    
261
345
            return None
262
346
 
263
347
 
264
 
class BzrServerFactory(object):
265
 
    """Helper class for serve_bzr."""
 
348
class BzrServerMaker(object):
266
349
 
267
350
    def __init__(self, userdir_expander=None, get_base_path=None):
268
351
        self.cleanups = []
277
360
 
278
361
    def _expand_userdirs(self, path):
279
362
        """Translate /~/ or /~user/ to e.g. /home/foo, using
280
 
        self.userdir_expander (os.path.expanduser by default).
 
363
        os.path.expanduser.
281
364
 
282
365
        If the translated path would fall outside base_path, or the path does
283
366
        not start with ~, then no translation is applied.
303
386
        """Chroot transport, and decorate with userdir expander."""
304
387
        self.base_path = self.get_base_path(transport)
305
388
        chroot_server = chroot.ChrootServer(transport)
306
 
        chroot_server.start_server()
307
 
        self.cleanups.append(chroot_server.stop_server)
 
389
        chroot_server.setUp()
 
390
        self.cleanups.append(chroot_server.tearDown)
308
391
        transport = get_transport(chroot_server.get_url())
309
392
        if self.base_path is not None:
310
393
            # Decorate the server's backing transport with a filter that can
311
394
            # expand homedirs.
312
395
            expand_userdirs = self._make_expand_userdirs_filter(transport)
313
 
            expand_userdirs.start_server()
314
 
            self.cleanups.append(expand_userdirs.stop_server)
 
396
            expand_userdirs.setUp()
 
397
            self.cleanups.append(expand_userdirs.tearDown)
315
398
            transport = get_transport(expand_userdirs.get_url())
316
399
        self.transport = transport
317
400
 
343
426
        ui.ui_factory = ui.SilentUIFactory()
344
427
        lockdir._DEFAULT_TIMEOUT_SECONDS = 0
345
428
 
346
 
    def set_up(self, transport, host, port, inet):
 
429
    def setUp(self, transport, host, port, inet):
347
430
        self._make_backing_transport(transport)
348
431
        self._make_smart_server(host, port, inet)
349
432
        self._change_globals()
350
433
 
351
 
    def tear_down(self):
 
434
    def tearDown(self):
352
435
        for cleanup in reversed(self.cleanups):
353
436
            cleanup()
354
437
 
355
438
 
356
439
def serve_bzr(transport, host=None, port=None, inet=False):
357
 
    """This is the default implementation of 'bzr serve'.
358
 
    
359
 
    It creates a TCP or pipe smart server on 'transport, and runs it.  The
360
 
    transport will be decorated with a chroot and pathfilter (using
361
 
    os.path.expanduser).
362
 
    """
363
 
    bzr_server = BzrServerFactory()
 
440
    bzr_server = BzrServerMaker()
364
441
    try:
365
 
        bzr_server.set_up(transport, host, port, inet)
 
442
        bzr_server.setUp(transport, host, port, inet)
366
443
        bzr_server.smart_server.serve()
367
444
    finally:
368
 
        bzr_server.tear_down()
 
445
        bzr_server.tearDown()
369
446