/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/smart/server.py

  • Committer: John Arbash Meinel
  • Date: 2009-09-18 15:08:09 UTC
  • mfrom: (4704 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4705.
  • Revision ID: john@arbash-meinel.com-20090918150809-t4kow9vdc8mosvkw
Bring in bzr.dev 4704 resolve NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
"""Server for smart-server protocol."""
18
18
 
19
19
import errno
 
20
import os.path
20
21
import socket
21
22
import sys
22
23
import threading
30
31
from bzrlib.lazy_import import lazy_import
31
32
lazy_import(globals(), """
32
33
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
    )
33
42
""")
34
43
 
35
44
 
313
322
        return transport.get_transport(url)
314
323
 
315
324
 
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)
 
325
def _local_path_for_transport(transport):
 
326
    """Return a local path for transport, if reasonably possible.
 
327
    
 
328
    This function works even if transport's url has a "readonly+" prefix,
 
329
    unlike local_path_from_url.
 
330
    
 
331
    This essentially recovers the --directory argument the user passed to "bzr
 
332
    serve" from the transport passed to serve_bzr.
 
333
    """
 
334
    try:
 
335
        base_url = transport.external_url()
 
336
    except (errors.InProcessTransport, NotImplementedError):
 
337
        return None
326
338
    else:
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:
 
339
        # Strip readonly prefix
 
340
        if base_url.startswith('readonly+'):
 
341
            base_url = base_url[len('readonly+'):]
 
342
        try:
 
343
            return urlutils.local_path_from_url(base_url)
 
344
        except errors.InvalidURL:
 
345
            return None
 
346
 
 
347
 
 
348
class BzrServerFactory(object):
 
349
    """Helper class for serve_bzr."""
 
350
 
 
351
    def __init__(self, userdir_expander=None, get_base_path=None):
 
352
        self.cleanups = []
 
353
        self.base_path = None
 
354
        self.backing_transport = None
 
355
        if userdir_expander is None:
 
356
            userdir_expander = os.path.expanduser
 
357
        self.userdir_expander = userdir_expander
 
358
        if get_base_path is None:
 
359
            get_base_path = _local_path_for_transport
 
360
        self.get_base_path = get_base_path
 
361
 
 
362
    def _expand_userdirs(self, path):
 
363
        """Translate /~/ or /~user/ to e.g. /home/foo, using
 
364
        self.userdir_expander (os.path.expanduser by default).
 
365
 
 
366
        If the translated path would fall outside base_path, or the path does
 
367
        not start with ~, then no translation is applied.
 
368
 
 
369
        If the path is inside, it is adjusted to be relative to the base path.
 
370
 
 
371
        e.g. if base_path is /home, and the expanded path is /home/joe, then
 
372
        the translated path is joe.
 
373
        """
 
374
        result = path
 
375
        if path.startswith('~'):
 
376
            expanded = self.userdir_expander(path)
 
377
            if not expanded.endswith('/'):
 
378
                expanded += '/'
 
379
            if expanded.startswith(self.base_path):
 
380
                result = expanded[len(self.base_path):]
 
381
        return result
 
382
 
 
383
    def _make_expand_userdirs_filter(self, transport):
 
384
        return pathfilter.PathFilteringServer(transport, self._expand_userdirs)
 
385
 
 
386
    def _make_backing_transport(self, transport):
 
387
        """Chroot transport, and decorate with userdir expander."""
 
388
        self.base_path = self.get_base_path(transport)
 
389
        chroot_server = chroot.ChrootServer(transport)
 
390
        chroot_server.setUp()
 
391
        self.cleanups.append(chroot_server.tearDown)
 
392
        transport = get_transport(chroot_server.get_url())
 
393
        if self.base_path is not None:
 
394
            # Decorate the server's backing transport with a filter that can
 
395
            # expand homedirs.
 
396
            expand_userdirs = self._make_expand_userdirs_filter(transport)
 
397
            expand_userdirs.setUp()
 
398
            self.cleanups.append(expand_userdirs.tearDown)
 
399
            transport = get_transport(expand_userdirs.get_url())
 
400
        self.transport = transport
 
401
 
 
402
    def _make_smart_server(self, host, port, inet):
 
403
        if inet:
 
404
            smart_server = medium.SmartServerPipeStreamMedium(
 
405
                sys.stdin, sys.stdout, self.transport)
 
406
        else:
 
407
            if host is None:
 
408
                host = medium.BZR_DEFAULT_INTERFACE
 
409
            if port is None:
 
410
                port = medium.BZR_DEFAULT_PORT
 
411
            smart_server = SmartTCPServer(self.transport, host=host, port=port)
 
412
            trace.note('listening on port: %s' % smart_server.port)
 
413
        self.smart_server = smart_server
 
414
 
 
415
    def _change_globals(self):
 
416
        from bzrlib import lockdir, ui
 
417
        # For the duration of this server, no UI output is permitted. note
 
418
        # that this may cause problems with blackbox tests. This should be
 
419
        # changed with care though, as we dont want to use bandwidth sending
 
420
        # progress over stderr to smart server clients!
 
421
        old_factory = ui.ui_factory
 
422
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
423
        def restore_default_ui_factory_and_lockdir_timeout():
 
424
            ui.ui_factory = old_factory
 
425
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
426
        self.cleanups.append(restore_default_ui_factory_and_lockdir_timeout)
340
427
        ui.ui_factory = ui.SilentUIFactory()
341
428
        lockdir._DEFAULT_TIMEOUT_SECONDS = 0
342
 
        smart_server.serve()
 
429
 
 
430
    def set_up(self, transport, host, port, inet):
 
431
        self._make_backing_transport(transport)
 
432
        self._make_smart_server(host, port, inet)
 
433
        self._change_globals()
 
434
 
 
435
    def tear_down(self):
 
436
        for cleanup in reversed(self.cleanups):
 
437
            cleanup()
 
438
 
 
439
 
 
440
def serve_bzr(transport, host=None, port=None, inet=False):
 
441
    """This is the default implementation of 'bzr serve'.
 
442
    
 
443
    It creates a TCP or pipe smart server on 'transport, and runs it.  The
 
444
    transport will be decorated with a chroot and pathfilter (using
 
445
    os.path.expanduser).
 
446
    """
 
447
    bzr_server = BzrServerFactory()
 
448
    try:
 
449
        bzr_server.set_up(transport, host, port, inet)
 
450
        bzr_server.smart_server.serve()
343
451
    finally:
344
 
        ui.ui_factory = old_factory
345
 
        lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
452
        bzr_server.tear_down()
346
453