← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Martin Pool
  • Date: 2009-01-23 22:36:38 UTC
  • mto: This revision was merged to the branch mainline in revision 298.
  • Revision ID: mbp@sourcefrog.net-20090123223638-s57mqtpu4um3stes
Act as a plugin only when loaded by bzr; update docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
1
 
# Copyright 2009, 2010, 2011 Canonical Ltd
 
1
# Copyright 2009 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
26
26
 
27
27
"""Loggerhead web viewer for Bazaar branches.
28
28
 
29
 
This provides a new option "--http" to the "bzr serve" command, that
 
29
This provides a new option "--http" to the "bzr serve" command, that 
30
30
starts a web server to browse the contents of a branch.
31
31
"""
32
32
 
33
 
import sys
34
 
 
35
 
from info import (
36
 
    bzr_plugin_version as version_info,
37
 
    bzr_compatible_versions,
38
 
    )
 
33
version_info = (1, 11, 0)
39
34
 
40
35
if __name__ == 'bzrlib.plugins.loggerhead':
41
36
    import bzrlib
42
 
    from bzrlib.api import require_any_api
43
 
    from bzrlib import commands
44
 
 
45
 
    require_any_api(bzrlib, bzr_compatible_versions)
46
 
 
47
 
    from bzrlib.transport import transport_server_registry
48
 
 
49
 
    DEFAULT_HOST = '0.0.0.0'
 
37
    from bzrlib.api import require_api
 
38
 
 
39
    require_api(bzrlib, (1, 11, 0))
 
40
 
 
41
    # TODO: This should provide a new type of server that can be used by bzr
 
42
    # serve, maybe through a registry, rather than overriding the command.  Though
 
43
    # maybe we should keep the wrapper to work with older bzr releases, at least
 
44
    # for a bit.
 
45
 
 
46
    # NB: Normally plugins should lazily load almost everything, but this
 
47
    # seems reasonable to have in-line here: bzrlib.commands and options are
 
48
    # normally loaded, and the rest of loggerhead won't be loaded until serve
 
49
    # --http is run.
 
50
        
 
51
    import bzrlib.builtins
 
52
    from bzrlib.commands import get_cmd_object, register_command
 
53
    from bzrlib.option import Option
 
54
 
 
55
    _original_command = get_cmd_object('serve')
 
56
 
50
57
    DEFAULT_PORT = 8080
51
 
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
52
 
            (DEFAULT_PORT,))
53
 
 
54
 
    def _ensure_loggerhead_path():
55
 
        """Ensure that you can 'import loggerhead' and get the root."""
56
 
        # loggerhead internal code will try to 'import loggerhead', so
57
 
        # let's put it on the path if we can't find it in the existing path
58
 
        try:
59
 
            import loggerhead.apps.transport
60
 
        except ImportError:
61
 
            import os.path, sys
62
 
            sys.path.append(os.path.dirname(__file__))
63
 
 
64
 
    def serve_http(transport, host=None, port=None, inet=None):
65
 
        from paste.httpexceptions import HTTPExceptionHandler
66
 
        from paste.httpserver import serve
67
 
 
68
 
        _ensure_loggerhead_path()
69
 
 
70
 
        from loggerhead.apps.transport import BranchesFromTransportRoot
71
 
        from loggerhead.config import LoggerheadConfig
72
 
        from loggerhead.main import setup_logging
73
 
 
74
 
        if host is None:
75
 
            host = DEFAULT_HOST
76
 
        if port is None:
77
 
            port = DEFAULT_PORT
78
 
        argv = ['--host', host, '--port', str(port), '--', transport.base]
79
 
        if not transport.is_readonly():
80
 
            argv.insert(0, '--allow-writes')
81
 
        config = LoggerheadConfig(argv)
82
 
        setup_logging(config, init_logging=False, log_file=sys.stderr)
83
 
        app = BranchesFromTransportRoot(transport.base, config)
84
 
        app = HTTPExceptionHandler(app)
85
 
        serve(app, host=host, port=port)
86
 
 
87
 
    transport_server_registry.register('http', serve_http, help=HELP)
88
 
 
89
 
    class cmd_load_test_loggerhead(commands.Command):
90
 
        """Run a load test against a live loggerhead instance.
91
 
 
92
 
        Pass in the name of a script file to run. See loggerhead/load_test.py
93
 
        for a description of the file format.
94
 
        """
95
 
 
96
 
        takes_args = ["filename"]
97
 
 
98
 
        def run(self, filename):
99
 
            from bzrlib.plugins.loggerhead.loggerhead import load_test
100
 
            script = load_test.run_script(filename)
101
 
            for thread_id in sorted(script._threads):
102
 
                worker = script._threads[thread_id][0]
103
 
                for url, success, time in worker.stats:
104
 
                    self.outf.write(' %5.3fs %s %s\n'
105
 
                                    % (time, str(success)[0], url))
106
 
 
107
 
    commands.register_command(cmd_load_test_loggerhead)
108
 
 
109
 
    def load_tests(standard_tests, module, loader):
110
 
        _ensure_loggerhead_path()
111
 
        standard_tests.addTests(loader.loadTestsFromModuleNames(
112
 
            ['bzrlib.plugins.loggerhead.loggerhead.tests']))
113
 
        return standard_tests
 
58
 
 
59
    class cmd_serve(bzrlib.builtins.cmd_serve):
 
60
        __doc__ = _original_command.__doc__
 
61
 
 
62
        takes_options = _original_command.takes_options + [
 
63
            Option('http',
 
64
                help='Run an http (Loggerhead) server to browse code, '
 
65
                    'by default on port %s.' % DEFAULT_PORT)]
 
66
 
 
67
        def run(self, *args, **kw):
 
68
            if 'http' in kw:
 
69
                # loggerhead internal code will try to 'import loggerhead', so
 
70
                # let's put it on the path
 
71
                import os.path, sys
 
72
                sys.path.append(os.path.dirname(__file__))
 
73
 
 
74
                from loggerhead.apps.filesystem import BranchesFromFileSystemRoot
 
75
                from paste.httpexceptions import HTTPExceptionHandler
 
76
                from paste.httpserver import serve
 
77
                a = HTTPExceptionHandler(BranchesFromFileSystemRoot('.'))
 
78
                port = kw.get('port', DEFAULT_PORT)
 
79
                if ':' in port:
 
80
                    host, port = port.split(':')
 
81
                else:
 
82
                    host = '0.0.0.0'
 
83
                serve(a, host=host, port=port)
 
84
            else:
 
85
                super(cmd_serve, self).run(*args, **kw)
 
86
 
 
87
    register_command(cmd_serve)