← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

  • Committer: Mark Hammond
  • Date: 2009-01-12 01:55:34 UTC
  • mto: (3995.8.2 prepare-1.12)
  • mto: This revision was merged to the branch mainline in revision 4007.
  • Revision ID: mhammond@skippinet.com.au-20090112015534-yfxg50p7mpds9j4v
Include all .html files from the tortoise doc directory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/server.py
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:
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()
162
152
 
163
153
    def serve_conn(self, conn, thread_name_suffix):
164
154
        # For WIN32, where the timeout value from the listening socket
165
 
        # propagates to the newly accepted socket.
 
155
        # propogates to the newly accepted socket.
166
156
        conn.setblocking(True)
167
157
        conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
168
158
        handler = medium.SmartServerSocketStreamMedium(
188
178
        self._should_terminate = True
189
179
        # close the socket - gives error to connections from here on in,
190
180
        # rather than a connection reset error to connections made during
191
 
        # the period between setting _should_terminate = True and
 
181
        # the period between setting _should_terminate = True and 
192
182
        # the current request completing/aborting. It may also break out the
193
183
        # main loop if it was currently in accept() (on some platforms).
194
184
        try:
218
208
        notified.
219
209
        """
220
210
        Hooks.__init__(self)
221
 
        self.create_hook(HookPoint('server_started',
222
 
            "Called by the bzr server when it starts serving a directory. "
223
 
            "server_started is called with (backing urls, public url), "
224
 
            "where backing_url is a list of URLs giving the "
225
 
            "server-specific directory locations, and public_url is the "
226
 
            "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
 
        self.create_hook(HookPoint('server_stopped',
232
 
            "Called by the bzr server when it stops serving a directory. "
233
 
            "server_stopped is called with the same parameters as the "
234
 
            "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'] = []
235
219
 
236
220
SmartTCPServer.hooks = SmartServerHooks()
237
221
 
238
222
 
239
223
class SmartTCPServer_for_testing(SmartTCPServer):
240
224
    """Server suitable for use by transport tests.
241
 
 
 
225
    
242
226
    This server is backed by the process's cwd.
243
227
    """
244
228
 
246
230
        SmartTCPServer.__init__(self, None)
247
231
        self.client_path_extra = None
248
232
        self.thread_name_suffix = thread_name_suffix
249
 
 
 
233
        
250
234
    def get_backing_transport(self, backing_transport_server):
251
235
        """Get a backing transport from a server we are decorating."""
252
236
        return transport.get_transport(backing_transport_server.get_url())
253
237
 
254
 
    def start_server(self, backing_transport_server=None,
 
238
    def setUp(self, backing_transport_server=None,
255
239
              client_path_extra='/extra/'):
256
240
        """Set up server for testing.
257
 
 
 
241
        
258
242
        :param backing_transport_server: backing server to use.  If not
259
243
            specified, a LocalURLServer at the current working directory will
260
244
            be used.
273
257
            backing_transport_server = LocalURLServer()
274
258
        self.chroot_server = ChrootServer(
275
259
            self.get_backing_transport(backing_transport_server))
276
 
        self.chroot_server.start_server()
 
260
        self.chroot_server.setUp()
277
261
        self.backing_transport = transport.get_transport(
278
262
            self.chroot_server.get_url())
279
263
        self.root_client_path = self.client_path_extra = client_path_extra
280
264
        self.start_background_thread(self.thread_name_suffix)
281
265
 
282
 
    def stop_server(self):
 
266
    def tearDown(self):
283
267
        self.stop_background_thread()
284
 
        self.chroot_server.stop_server()
 
268
        self.chroot_server.tearDown()
285
269
 
286
270
    def get_url(self):
287
271
        url = super(SmartTCPServer_for_testing, self).get_url()
321
305
        return transport.get_transport(url)
322
306
 
323
307
 
324
 
def _local_path_for_transport(transport):
325
 
    """Return a local path for transport, if reasonably possible.
326
 
    
327
 
    This function works even if transport's url has a "readonly+" prefix,
328
 
    unlike local_path_from_url.
329
 
    
330
 
    This essentially recovers the --directory argument the user passed to "bzr
331
 
    serve" from the transport passed to serve_bzr.
332
 
    """
333
 
    try:
334
 
        base_url = transport.external_url()
335
 
    except (errors.InProcessTransport, NotImplementedError):
336
 
        return None
337
 
    else:
338
 
        # Strip readonly prefix
339
 
        if base_url.startswith('readonly+'):
340
 
            base_url = base_url[len('readonly+'):]
341
 
        try:
342
 
            return urlutils.local_path_from_url(base_url)
343
 
        except errors.InvalidURL:
344
 
            return None
345
 
 
346
 
 
347
 
class BzrServerFactory(object):
348
 
    """Helper class for serve_bzr."""
349
 
 
350
 
    def __init__(self, userdir_expander=None, get_base_path=None):
351
 
        self.cleanups = []
352
 
        self.base_path = None
353
 
        self.backing_transport = None
354
 
        if userdir_expander is None:
355
 
            userdir_expander = os.path.expanduser
356
 
        self.userdir_expander = userdir_expander
357
 
        if get_base_path is None:
358
 
            get_base_path = _local_path_for_transport
359
 
        self.get_base_path = get_base_path
360
 
 
361
 
    def _expand_userdirs(self, path):
362
 
        """Translate /~/ or /~user/ to e.g. /home/foo, using
363
 
        self.userdir_expander (os.path.expanduser by default).
364
 
 
365
 
        If the translated path would fall outside base_path, or the path does
366
 
        not start with ~, then no translation is applied.
367
 
 
368
 
        If the path is inside, it is adjusted to be relative to the base path.
369
 
 
370
 
        e.g. if base_path is /home, and the expanded path is /home/joe, then
371
 
        the translated path is joe.
372
 
        """
373
 
        result = path
374
 
        if path.startswith('~'):
375
 
            expanded = self.userdir_expander(path)
376
 
            if not expanded.endswith('/'):
377
 
                expanded += '/'
378
 
            if expanded.startswith(self.base_path):
379
 
                result = expanded[len(self.base_path):]
380
 
        return result
381
 
 
382
 
    def _make_expand_userdirs_filter(self, transport):
383
 
        return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
384
 
 
385
 
    def _make_backing_transport(self, transport):
386
 
        """Chroot transport, and decorate with userdir expander."""
387
 
        self.base_path = self.get_base_path(transport)
388
 
        chroot_server = chroot.ChrootServer(transport)
389
 
        chroot_server.start_server()
390
 
        self.cleanups.append(chroot_server.stop_server)
391
 
        transport = get_transport(chroot_server.get_url())
392
 
        if self.base_path is not None:
393
 
            # Decorate the server's backing transport with a filter that can
394
 
            # expand homedirs.
395
 
            expand_userdirs = self._make_expand_userdirs_filter(transport)
396
 
            expand_userdirs.start_server()
397
 
            self.cleanups.append(expand_userdirs.stop_server)
398
 
            transport = get_transport(expand_userdirs.get_url())
399
 
        self.transport = transport
400
 
 
401
 
    def _make_smart_server(self, host, port, inet):
402
 
        if inet:
403
 
            smart_server = medium.SmartServerPipeStreamMedium(
404
 
                sys.stdin, sys.stdout, self.transport)
405
 
        else:
406
 
            if host is None:
407
 
                host = medium.BZR_DEFAULT_INTERFACE
408
 
            if port is None:
409
 
                port = medium.BZR_DEFAULT_PORT
410
 
            smart_server = SmartTCPServer(self.transport, host=host, port=port)
411
 
            trace.note('listening on port: %s' % smart_server.port)
412
 
        self.smart_server = smart_server
413
 
 
414
 
    def _change_globals(self):
415
 
        from bzrlib import lockdir, ui
416
 
        # For the duration of this server, no UI output is permitted. note
417
 
        # that this may cause problems with blackbox tests. This should be
418
 
        # changed with care though, as we dont want to use bandwidth sending
419
 
        # progress over stderr to smart server clients!
420
 
        old_factory = ui.ui_factory
421
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
422
 
        def restore_default_ui_factory_and_lockdir_timeout():
423
 
            ui.ui_factory = old_factory
424
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
425
 
        self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
426
 
        ui.ui_factory = ui.SilentUIFactory()
427
 
        lockdir._DEFAULT_TIMEOUT_SECONDS = 0
428
 
 
429
 
    def set_up(self, transport, host, port, inet):
430
 
        self._make_backing_transport(transport)
431
 
        self._make_smart_server(host, port, inet)
432
 
        self._change_globals()
433
 
 
434
 
    def tear_down(self):
435
 
        for cleanup in reversed(self.cleanups):
436
 
            cleanup()
437
 
 
438
 
 
439
 
def serve_bzr(transport, host=None, port=None, inet=False):
440
 
    """This is the default implementation of 'bzr serve'.
441
 
    
442
 
    It creates a TCP or pipe smart server on 'transport, and runs it.  The
443
 
    transport will be decorated with a chroot and pathfilter (using
444
 
    os.path.expanduser).
445
 
    """
446
 
    bzr_server = BzrServerFactory()
447
 
    try:
448
 
        bzr_server.set_up(transport, host, port, inet)
449
 
        bzr_server.smart_server.serve()
450
 
    finally:
451
 
        bzr_server.tear_down()
452