← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:11:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113031104-03my054s02i9l2pe
Bump version to 1.12 and add news template

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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
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
24
23
 
25
 
from bzrlib.hooks import HookPoint, Hooks
 
24
from bzrlib.hooks import Hooks
26
25
from bzrlib import (
27
26
    errors,
28
27
    trace,
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
 
71
62
        from socket import error as socket_error
72
63
        self._socket_error = socket_error
73
64
        self._socket_timeout = socket_timeout
74
 
        addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
 
65
        addrs = socket.getaddrinfo(host, port, socket.AF_UNSPEC, 
75
66
            socket.SOCK_STREAM, 0, socket.AI_PASSIVE)[0]
76
67
 
77
68
        (family, socktype, proto, canonname, sockaddr) = addrs
107
98
        # We need all three because:
108
99
        #  * other machines see the first
109
100
        #  * local commits on this machine should be able to be mapped to
110
 
        #    this server
 
101
        #    this server 
111
102
        #  * commits the server does itself need to be mapped across to this
112
103
        #    server.
113
104
        # The latter two urls are different aliases to the servers url,
114
 
        # so we group those in a list - as there might be more aliases
 
105
        # so we group those in a list - as there might be more aliases 
115
106
        # in the future.
116
107
        backing_urls = [self.backing_transport.base]
117
108
        try:
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:
138
127
                        if e.args[0] != errno.EBADF:
139
128
                            trace.warning("listening socket error: %s", e)
140
129
                    else:
141
 
                        if self._should_terminate:
142
 
                            break
143
130
                        self.serve_conn(conn, thread_name_suffix)
144
131
            except KeyboardInterrupt:
145
132
                # dont log when CTRL-C'd.
146
133
                raise
147
134
            except Exception, e:
148
 
                trace.report_exception(sys.exc_info(), sys.stderr)
 
135
                trace.error("Unhandled smart server error.")
 
136
                trace.log_exception_quietly()
149
137
                raise
150
138
        finally:
151
139
            self._stopped.set()
164
152
 
165
153
    def serve_conn(self, conn, thread_name_suffix):
166
154
        # For WIN32, where the timeout value from the listening socket
167
 
        # propagates to the newly accepted socket.
 
155
        # propogates to the newly accepted socket.
168
156
        conn.setblocking(True)
169
157
        conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
170
158
        handler = medium.SmartServerSocketStreamMedium(
190
178
        self._should_terminate = True
191
179
        # close the socket - gives error to connections from here on in,
192
180
        # rather than a connection reset error to connections made during
193
 
        # the period between setting _should_terminate = True and
 
181
        # the period between setting _should_terminate = True and 
194
182
        # the current request completing/aborting. It may also break out the
195
183
        # main loop if it was currently in accept() (on some platforms).
196
184
        try:
220
208
        notified.
221
209
        """
222
210
        Hooks.__init__(self)
223
 
        self.create_hook(HookPoint('server_started',
224
 
            "Called by the bzr server when it starts serving a directory. "
225
 
            "server_started is called with (backing urls, public url), "
226
 
            "where backing_url is a list of URLs giving the "
227
 
            "server-specific directory locations, and public_url is the "
228
 
            "public URL for the directory being served.", (0, 16), None))
229
 
        self.create_hook(HookPoint('server_started_ex',
230
 
            "Called by the bzr server when it starts serving a directory. "
231
 
            "server_started is called with (backing_urls, server_obj).",
232
 
            (1, 17), None))
233
 
        self.create_hook(HookPoint('server_stopped',
234
 
            "Called by the bzr server when it stops serving a directory. "
235
 
            "server_stopped is called with the same parameters as the "
236
 
            "server_started hook: (backing_urls, public_url).", (0, 16), None))
 
211
        # Introduced in 0.16:
 
212
        # invoked whenever the server starts serving a directory.
 
213
        # The api signature is (backing urls, public url).
 
214
        self['server_started'] = []
 
215
        # Introduced in 0.16:
 
216
        # invoked whenever the server stops serving a directory.
 
217
        # The api signature is (backing urls, public url).
 
218
        self['server_stopped'] = []
237
219
 
238
220
SmartTCPServer.hooks = SmartServerHooks()
239
221
 
240
222
 
241
 
def _local_path_for_transport(transport):
242
 
    """Return a local path for transport, if reasonably possible.
243
 
    
244
 
    This function works even if transport's url has a "readonly+" prefix,
245
 
    unlike local_path_from_url.
246
 
    
247
 
    This essentially recovers the --directory argument the user passed to "bzr
248
 
    serve" from the transport passed to serve_bzr.
 
223
class SmartTCPServer_for_testing(SmartTCPServer):
 
224
    """Server suitable for use by transport tests.
 
225
    
 
226
    This server is backed by the process's cwd.
249
227
    """
250
 
    try:
251
 
        base_url = transport.external_url()
252
 
    except (errors.InProcessTransport, NotImplementedError):
253
 
        return None
254
 
    else:
255
 
        # Strip readonly prefix
256
 
        if base_url.startswith('readonly+'):
257
 
            base_url = base_url[len('readonly+'):]
258
 
        try:
259
 
            return urlutils.local_path_from_url(base_url)
260
 
        except errors.InvalidURL:
261
 
            return None
262
 
 
263
 
 
264
 
class BzrServerFactory(object):
265
 
    """Helper class for serve_bzr."""
266
 
 
267
 
    def __init__(self, userdir_expander=None, get_base_path=None):
268
 
        self.cleanups = []
269
 
        self.base_path = None
270
 
        self.backing_transport = None
271
 
        if userdir_expander is None:
272
 
            userdir_expander = os.path.expanduser
273
 
        self.userdir_expander = userdir_expander
274
 
        if get_base_path is None:
275
 
            get_base_path = _local_path_for_transport
276
 
        self.get_base_path = get_base_path
277
 
 
278
 
    def _expand_userdirs(self, path):
279
 
        """Translate /~/ or /~user/ to e.g. /home/foo, using
280
 
        self.userdir_expander (os.path.expanduser by default).
281
 
 
282
 
        If the translated path would fall outside base_path, or the path does
283
 
        not start with ~, then no translation is applied.
284
 
 
285
 
        If the path is inside, it is adjusted to be relative to the base path.
286
 
 
287
 
        e.g. if base_path is /home, and the expanded path is /home/joe, then
288
 
        the translated path is joe.
 
228
 
 
229
    def __init__(self, thread_name_suffix=''):
 
230
        SmartTCPServer.__init__(self, None)
 
231
        self.client_path_extra = None
 
232
        self.thread_name_suffix = thread_name_suffix
 
233
        
 
234
    def get_backing_transport(self, backing_transport_server):
 
235
        """Get a backing transport from a server we are decorating."""
 
236
        return transport.get_transport(backing_transport_server.get_url())
 
237
 
 
238
    def setUp(self, backing_transport_server=None,
 
239
              client_path_extra='/extra/'):
 
240
        """Set up server for testing.
 
241
        
 
242
        :param backing_transport_server: backing server to use.  If not
 
243
            specified, a LocalURLServer at the current working directory will
 
244
            be used.
 
245
        :param client_path_extra: a path segment starting with '/' to append to
 
246
            the root URL for this server.  For instance, a value of '/foo/bar/'
 
247
            will mean the root of the backing transport will be published at a
 
248
            URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
 
249
            `bzr://127.0.0.1:nnnn/`.  Default value is `extra`, so that tests
 
250
            by default will fail unless they do the necessary path translation.
289
251
        """
290
 
        result = path
291
 
        if path.startswith('~'):
292
 
            expanded = self.userdir_expander(path)
293
 
            if not expanded.endswith('/'):
294
 
                expanded += '/'
295
 
            if expanded.startswith(self.base_path):
296
 
                result = expanded[len(self.base_path):]
297
 
        return result
298
 
 
299
 
    def _make_expand_userdirs_filter(self, transport):
300
 
        return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
301
 
 
302
 
    def _make_backing_transport(self, transport):
303
 
        """Chroot transport, and decorate with userdir expander."""
304
 
        self.base_path = self.get_base_path(transport)
305
 
        chroot_server = chroot.ChrootServer(transport)
306
 
        chroot_server.start_server()
307
 
        self.cleanups.append(chroot_server.stop_server)
308
 
        transport = get_transport(chroot_server.get_url())
309
 
        if self.base_path is not None:
310
 
            # Decorate the server's backing transport with a filter that can
311
 
            # expand homedirs.
312
 
            expand_userdirs = self._make_expand_userdirs_filter(transport)
313
 
            expand_userdirs.start_server()
314
 
            self.cleanups.append(expand_userdirs.stop_server)
315
 
            transport = get_transport(expand_userdirs.get_url())
316
 
        self.transport = transport
317
 
 
318
 
    def _make_smart_server(self, host, port, inet):
319
 
        if inet:
320
 
            smart_server = medium.SmartServerPipeStreamMedium(
321
 
                sys.stdin, sys.stdout, self.transport)
322
 
        else:
323
 
            if host is None:
324
 
                host = medium.BZR_DEFAULT_INTERFACE
325
 
            if port is None:
326
 
                port = medium.BZR_DEFAULT_PORT
327
 
            smart_server = SmartTCPServer(self.transport, host=host, port=port)
328
 
            trace.note('listening on port: %s' % smart_server.port)
329
 
        self.smart_server = smart_server
330
 
 
331
 
    def _change_globals(self):
332
 
        from bzrlib import lockdir, ui
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
 
        def restore_default_ui_factory_and_lockdir_timeout():
340
 
            ui.ui_factory = old_factory
341
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
342
 
        self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
343
 
        ui.ui_factory = ui.SilentUIFactory()
344
 
        lockdir._DEFAULT_TIMEOUT_SECONDS = 0
345
 
 
346
 
    def set_up(self, transport, host, port, inet):
347
 
        self._make_backing_transport(transport)
348
 
        self._make_smart_server(host, port, inet)
349
 
        self._change_globals()
350
 
 
351
 
    def tear_down(self):
352
 
        for cleanup in reversed(self.cleanups):
353
 
            cleanup()
354
 
 
355
 
 
356
 
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).
 
252
        if not client_path_extra.startswith('/'):
 
253
            raise ValueError(client_path_extra)
 
254
        from bzrlib.transport.chroot import ChrootServer
 
255
        if backing_transport_server is None:
 
256
            from bzrlib.transport.local import LocalURLServer
 
257
            backing_transport_server = LocalURLServer()
 
258
        self.chroot_server = ChrootServer(
 
259
            self.get_backing_transport(backing_transport_server))
 
260
        self.chroot_server.setUp()
 
261
        self.backing_transport = transport.get_transport(
 
262
            self.chroot_server.get_url())
 
263
        self.root_client_path = self.client_path_extra = client_path_extra
 
264
        self.start_background_thread(self.thread_name_suffix)
 
265
 
 
266
    def tearDown(self):
 
267
        self.stop_background_thread()
 
268
        self.chroot_server.tearDown()
 
269
 
 
270
    def get_url(self):
 
271
        url = super(SmartTCPServer_for_testing, self).get_url()
 
272
        return url[:-1] + self.client_path_extra
 
273
 
 
274
    def get_bogus_url(self):
 
275
        """Return a URL which will fail to connect"""
 
276
        return 'bzr://127.0.0.1:1/'
 
277
 
 
278
 
 
279
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
 
280
    """Get a readonly server for testing."""
 
281
 
 
282
    def get_backing_transport(self, backing_transport_server):
 
283
        """Get a backing transport from a server we are decorating."""
 
284
        url = 'readonly+' + backing_transport_server.get_url()
 
285
        return transport.get_transport(url)
 
286
 
 
287
 
 
288
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
 
289
    """A variation of SmartTCPServer_for_testing that limits the client to
 
290
    using RPCs in protocol v2 (i.e. bzr <= 1.5).
362
291
    """
363
 
    bzr_server = BzrServerFactory()
364
 
    try:
365
 
        bzr_server.set_up(transport, host, port, inet)
366
 
        bzr_server.smart_server.serve()
367
 
    finally:
368
 
        bzr_server.tear_down()
 
292
 
 
293
    def get_url(self):
 
294
        url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
 
295
        url = 'bzr-v2://' + url[len('bzr://'):]
 
296
        return url
 
297
 
 
298
 
 
299
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
 
300
    """Get a readonly server for testing."""
 
301
 
 
302
    def get_backing_transport(self, backing_transport_server):
 
303
        """Get a backing transport from a server we are decorating."""
 
304
        url = 'readonly+' + backing_transport_server.get_url()
 
305
        return transport.get_transport(url)
 
306
 
369
307