← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-03 07:15:11 UTC
  • mfrom: (4580.1.2 408199-check-2a)
  • Revision ID: pqm@pqm.ubuntu.com-20090803071511-dwb041qzak0vjzdk
(mbp) check blackbox tests now handle the root being included in the
        file-id count

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
 
import select
22
20
import socket
23
21
import sys
24
22
import threading
32
30
from bzrlib.lazy_import import lazy_import
33
31
lazy_import(globals(), """
34
32
from bzrlib.smart import medium
35
 
from bzrlib.transport import (
36
 
    chroot,
37
 
    get_transport,
38
 
    pathfilter,
39
 
    )
40
 
from bzrlib import (
41
 
    urlutils,
42
 
    )
43
33
""")
44
34
 
45
35
 
52
42
    hooks: An instance of SmartServerHooks.
53
43
    """
54
44
 
55
 
    def __init__(self, backing_transport, root_client_path='/'):
 
45
    def __init__(self, backing_transport, host='127.0.0.1', port=0,
 
46
                 root_client_path='/'):
56
47
        """Construct a new server.
57
48
 
58
49
        To actually start it running, call either start_background_thread or
59
50
        serve.
60
51
 
61
52
        :param backing_transport: The transport to serve.
 
53
        :param host: Name of the interface to listen on.
 
54
        :param port: TCP port to listen on, or 0 to allocate a transient port.
62
55
        :param root_client_path: The client path that will correspond to root
63
56
            of backing_transport.
64
57
        """
65
 
        self.backing_transport = backing_transport
66
 
        self.root_client_path = root_client_path
67
 
 
68
 
    def start_server(self, host, port):
69
 
        """Create the server listening socket.
70
 
 
71
 
        :param host: Name of the interface to listen on.
72
 
        :param port: TCP port to listen on, or 0 to allocate a transient port.
73
 
        """
74
58
        # let connections timeout so that we get a chance to terminate
75
59
        # Keep a reference to the exceptions we want to catch because the socket
76
60
        # module's globals get set to None during interpreter shutdown.
96
80
        self.port = self._sockname[1]
97
81
        self._server_socket.listen(1)
98
82
        self._server_socket.settimeout(1)
 
83
        self.backing_transport = backing_transport
99
84
        self._started = threading.Event()
100
85
        self._stopped = threading.Event()
 
86
        self.root_client_path = root_client_path
101
87
 
102
 
    def _backing_urls(self):
 
88
    def serve(self, thread_name_suffix=''):
 
89
        self._should_terminate = False
 
90
        # for hooks we are letting code know that a server has started (and
 
91
        # later stopped).
103
92
        # There are three interesting urls:
104
93
        # The URL the server can be contacted on. (e.g. bzr://host/)
105
94
        # The URL that a commit done on the same machine as the server will
115
104
        # The latter two urls are different aliases to the servers url,
116
105
        # so we group those in a list - as there might be more aliases
117
106
        # in the future.
118
 
        urls = [self.backing_transport.base]
 
107
        backing_urls = [self.backing_transport.base]
119
108
        try:
120
 
            urls.append(self.backing_transport.external_url())
 
109
            backing_urls.append(self.backing_transport.external_url())
121
110
        except errors.InProcessTransport:
122
111
            pass
123
 
        return urls
124
 
 
125
 
    def run_server_started_hooks(self, backing_urls=None):
126
 
        if backing_urls is None:
127
 
            backing_urls = self._backing_urls()
128
112
        for hook in SmartTCPServer.hooks['server_started']:
129
113
            hook(backing_urls, self.get_url())
130
114
        for hook in SmartTCPServer.hooks['server_started_ex']:
131
115
            hook(backing_urls, self)
132
 
 
133
 
    def run_server_stopped_hooks(self, backing_urls=None):
134
 
        if backing_urls is None:
135
 
            backing_urls = self._backing_urls()
136
 
        for hook in SmartTCPServer.hooks['server_stopped']:
137
 
            hook(backing_urls, self.get_url())
138
 
 
139
 
    def serve(self, thread_name_suffix=''):
140
 
        self._should_terminate = False
141
 
        # for hooks we are letting code know that a server has started (and
142
 
        # later stopped).
143
 
        self.run_server_started_hooks()
144
116
        self._started.set()
145
117
        try:
146
118
            try:
157
129
                        if e.args[0] != errno.EBADF:
158
130
                            trace.warning("listening socket error: %s", e)
159
131
                    else:
160
 
                        if self._should_terminate:
161
 
                            break
162
132
                        self.serve_conn(conn, thread_name_suffix)
163
133
            except KeyboardInterrupt:
164
134
                # dont log when CTRL-C'd.
165
135
                raise
166
136
            except Exception, e:
167
 
                trace.report_exception(sys.exc_info(), sys.stderr)
 
137
                trace.error("Unhandled smart server error.")
 
138
                trace.log_exception_quietly()
168
139
                raise
169
140
        finally:
170
141
            self._stopped.set()
174
145
            except self._socket_error:
175
146
                # ignore errors on close
176
147
                pass
177
 
            self.run_server_stopped_hooks()
 
148
            for hook in SmartTCPServer.hooks['server_stopped']:
 
149
                hook(backing_urls, self.get_url())
178
150
 
179
151
    def get_url(self):
180
152
        """Return the url of the server"""
190
162
        thread_name = 'smart-server-child' + thread_name_suffix
191
163
        connection_thread = threading.Thread(
192
164
            None, handler.serve, name=thread_name)
193
 
        # FIXME: This thread is never joined, it should at least be collected
194
 
        # somewhere so that tests that want to check for leaked threads can get
195
 
        # rid of them -- vila 20100531
196
165
        connection_thread.setDaemon(True)
197
166
        connection_thread.start()
198
 
        return connection_thread
199
167
 
200
168
    def start_background_thread(self, thread_name_suffix=''):
201
169
        self._started.clear()
260
228
SmartTCPServer.hooks = SmartServerHooks()
261
229
 
262
230
 
263
 
def _local_path_for_transport(transport):
264
 
    """Return a local path for transport, if reasonably possible.
265
 
    
266
 
    This function works even if transport's url has a "readonly+" prefix,
267
 
    unlike local_path_from_url.
268
 
    
269
 
    This essentially recovers the --directory argument the user passed to "bzr
270
 
    serve" from the transport passed to serve_bzr.
271
 
    """
272
 
    try:
273
 
        base_url = transport.external_url()
274
 
    except (errors.InProcessTransport, NotImplementedError):
275
 
        return None
 
231
class SmartTCPServer_for_testing(SmartTCPServer):
 
232
    """Server suitable for use by transport tests.
 
233
 
 
234
    This server is backed by the process's cwd.
 
235
    """
 
236
 
 
237
    def __init__(self, thread_name_suffix=''):
 
238
        SmartTCPServer.__init__(self, None)
 
239
        self.client_path_extra = None
 
240
        self.thread_name_suffix = thread_name_suffix
 
241
 
 
242
    def get_backing_transport(self, backing_transport_server):
 
243
        """Get a backing transport from a server we are decorating."""
 
244
        return transport.get_transport(backing_transport_server.get_url())
 
245
 
 
246
    def setUp(self, backing_transport_server=None,
 
247
              client_path_extra='/extra/'):
 
248
        """Set up server for testing.
 
249
 
 
250
        :param backing_transport_server: backing server to use.  If not
 
251
            specified, a LocalURLServer at the current working directory will
 
252
            be used.
 
253
        :param client_path_extra: a path segment starting with '/' to append to
 
254
            the root URL for this server.  For instance, a value of '/foo/bar/'
 
255
            will mean the root of the backing transport will be published at a
 
256
            URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
 
257
            `bzr://127.0.0.1:nnnn/`.  Default value is `extra`, so that tests
 
258
            by default will fail unless they do the necessary path translation.
 
259
        """
 
260
        if not client_path_extra.startswith('/'):
 
261
            raise ValueError(client_path_extra)
 
262
        from bzrlib.transport.chroot import ChrootServer
 
263
        if backing_transport_server is None:
 
264
            from bzrlib.transport.local import LocalURLServer
 
265
            backing_transport_server = LocalURLServer()
 
266
        self.chroot_server = ChrootServer(
 
267
            self.get_backing_transport(backing_transport_server))
 
268
        self.chroot_server.setUp()
 
269
        self.backing_transport = transport.get_transport(
 
270
            self.chroot_server.get_url())
 
271
        self.root_client_path = self.client_path_extra = client_path_extra
 
272
        self.start_background_thread(self.thread_name_suffix)
 
273
 
 
274
    def tearDown(self):
 
275
        self.stop_background_thread()
 
276
        self.chroot_server.tearDown()
 
277
 
 
278
    def get_url(self):
 
279
        url = super(SmartTCPServer_for_testing, self).get_url()
 
280
        return url[:-1] + self.client_path_extra
 
281
 
 
282
    def get_bogus_url(self):
 
283
        """Return a URL which will fail to connect"""
 
284
        return 'bzr://127.0.0.1:1/'
 
285
 
 
286
 
 
287
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
 
288
    """Get a readonly server for testing."""
 
289
 
 
290
    def get_backing_transport(self, backing_transport_server):
 
291
        """Get a backing transport from a server we are decorating."""
 
292
        url = 'readonly+' + backing_transport_server.get_url()
 
293
        return transport.get_transport(url)
 
294
 
 
295
 
 
296
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
 
297
    """A variation of SmartTCPServer_for_testing that limits the client to
 
298
    using RPCs in protocol v2 (i.e. bzr <= 1.5).
 
299
    """
 
300
 
 
301
    def get_url(self):
 
302
        url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
 
303
        url = 'bzr-v2://' + url[len('bzr://'):]
 
304
        return url
 
305
 
 
306
 
 
307
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
 
308
    """Get a readonly server for testing."""
 
309
 
 
310
    def get_backing_transport(self, backing_transport_server):
 
311
        """Get a backing transport from a server we are decorating."""
 
312
        url = 'readonly+' + backing_transport_server.get_url()
 
313
        return transport.get_transport(url)
 
314
 
 
315
 
 
316
def serve_bzr(transport, host=None, port=None, inet=False):
 
317
    from bzrlib import lockdir, ui
 
318
    from bzrlib.transport import get_transport
 
319
    from bzrlib.transport.chroot import ChrootServer
 
320
    chroot_server = ChrootServer(transport)
 
321
    chroot_server.setUp()
 
322
    transport = get_transport(chroot_server.get_url())
 
323
    if inet:
 
324
        smart_server = medium.SmartServerPipeStreamMedium(
 
325
            sys.stdin, sys.stdout, transport)
276
326
    else:
277
 
        # Strip readonly prefix
278
 
        if base_url.startswith('readonly+'):
279
 
            base_url = base_url[len('readonly+'):]
280
 
        try:
281
 
            return urlutils.local_path_from_url(base_url)
282
 
        except errors.InvalidURL:
283
 
            return None
284
 
 
285
 
 
286
 
class BzrServerFactory(object):
287
 
    """Helper class for serve_bzr."""
288
 
 
289
 
    def __init__(self, userdir_expander=None, get_base_path=None):
290
 
        self.cleanups = []
291
 
        self.base_path = None
292
 
        self.backing_transport = None
293
 
        if userdir_expander is None:
294
 
            userdir_expander = os.path.expanduser
295
 
        self.userdir_expander = userdir_expander
296
 
        if get_base_path is None:
297
 
            get_base_path = _local_path_for_transport
298
 
        self.get_base_path = get_base_path
299
 
 
300
 
    def _expand_userdirs(self, path):
301
 
        """Translate /~/ or /~user/ to e.g. /home/foo, using
302
 
        self.userdir_expander (os.path.expanduser by default).
303
 
 
304
 
        If the translated path would fall outside base_path, or the path does
305
 
        not start with ~, then no translation is applied.
306
 
 
307
 
        If the path is inside, it is adjusted to be relative to the base path.
308
 
 
309
 
        e.g. if base_path is /home, and the expanded path is /home/joe, then
310
 
        the translated path is joe.
311
 
        """
312
 
        result = path
313
 
        if path.startswith('~'):
314
 
            expanded = self.userdir_expander(path)
315
 
            if not expanded.endswith('/'):
316
 
                expanded += '/'
317
 
            if expanded.startswith(self.base_path):
318
 
                result = expanded[len(self.base_path):]
319
 
        return result
320
 
 
321
 
    def _make_expand_userdirs_filter(self, transport):
322
 
        return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
323
 
 
324
 
    def _make_backing_transport(self, transport):
325
 
        """Chroot transport, and decorate with userdir expander."""
326
 
        self.base_path = self.get_base_path(transport)
327
 
        chroot_server = chroot.ChrootServer(transport)
328
 
        chroot_server.start_server()
329
 
        self.cleanups.append(chroot_server.stop_server)
330
 
        transport = get_transport(chroot_server.get_url())
331
 
        if self.base_path is not None:
332
 
            # Decorate the server's backing transport with a filter that can
333
 
            # expand homedirs.
334
 
            expand_userdirs = self._make_expand_userdirs_filter(transport)
335
 
            expand_userdirs.start_server()
336
 
            self.cleanups.append(expand_userdirs.stop_server)
337
 
            transport = get_transport(expand_userdirs.get_url())
338
 
        self.transport = transport
339
 
 
340
 
    def _make_smart_server(self, host, port, inet):
341
 
        if inet:
342
 
            smart_server = medium.SmartServerPipeStreamMedium(
343
 
                sys.stdin, sys.stdout, self.transport)
344
 
        else:
345
 
            if host is None:
346
 
                host = medium.BZR_DEFAULT_INTERFACE
347
 
            if port is None:
348
 
                port = medium.BZR_DEFAULT_PORT
349
 
            smart_server = SmartTCPServer(self.transport)
350
 
            smart_server.start_server(host, port)
351
 
            trace.note('listening on port: %s' % smart_server.port)
352
 
        self.smart_server = smart_server
353
 
 
354
 
    def _change_globals(self):
355
 
        from bzrlib import lockdir, ui
356
 
        # For the duration of this server, no UI output is permitted. note
357
 
        # that this may cause problems with blackbox tests. This should be
358
 
        # changed with care though, as we dont want to use bandwidth sending
359
 
        # progress over stderr to smart server clients!
360
 
        old_factory = ui.ui_factory
361
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
362
 
        def restore_default_ui_factory_and_lockdir_timeout():
363
 
            ui.ui_factory = old_factory
364
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
365
 
        self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
 
327
        if host is None:
 
328
            host = medium.BZR_DEFAULT_INTERFACE
 
329
        if port is None:
 
330
            port = medium.BZR_DEFAULT_PORT
 
331
        smart_server = SmartTCPServer(transport, host=host, port=port)
 
332
        trace.note('listening on port: %s' % smart_server.port)
 
333
    # For the duration of this server, no UI output is permitted. note
 
334
    # that this may cause problems with blackbox tests. This should be
 
335
    # changed with care though, as we dont want to use bandwidth sending
 
336
    # progress over stderr to smart server clients!
 
337
    old_factory = ui.ui_factory
 
338
    old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
339
    try:
366
340
        ui.ui_factory = ui.SilentUIFactory()
367
341
        lockdir._DEFAULT_TIMEOUT_SECONDS = 0
368
 
 
369
 
    def set_up(self, transport, host, port, inet):
370
 
        self._make_backing_transport(transport)
371
 
        self._make_smart_server(host, port, inet)
372
 
        self._change_globals()
373
 
 
374
 
    def tear_down(self):
375
 
        for cleanup in reversed(self.cleanups):
376
 
            cleanup()
377
 
 
378
 
 
379
 
def serve_bzr(transport, host=None, port=None, inet=False):
380
 
    """This is the default implementation of 'bzr serve'.
381
 
    
382
 
    It creates a TCP or pipe smart server on 'transport, and runs it.  The
383
 
    transport will be decorated with a chroot and pathfilter (using
384
 
    os.path.expanduser).
385
 
    """
386
 
    bzr_server = BzrServerFactory()
387
 
    try:
388
 
        bzr_server.set_up(transport, host, port, inet)
389
 
        bzr_server.smart_server.serve()
 
342
        smart_server.serve()
390
343
    finally:
391
 
        bzr_server.tear_down()
 
344
        ui.ui_factory = old_factory
 
345
        lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
392
346