← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Matt Nordhoff
  • Date: 2009-10-21 13:21:02 UTC
  • Revision ID: mnordhoff@mattnordhoff.com-20091021132102-t9zuspd8y52u8klr
Mention bug #348308 in NEWS.

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, 17, 0)
39
34
 
40
35
if __name__ == 'bzrlib.plugins.loggerhead':
41
36
    import bzrlib
42
37
    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
 
38
 
 
39
    require_any_api(bzrlib, [
 
40
        (1, 13, 0), (1, 15, 0), (1, 16, 0), (1, 17, 0), (1, 18, 0),
 
41
        (2, 0, 0), (2, 1, 0)])
 
42
 
 
43
    # NB: Normally plugins should lazily load almost everything, but this
 
44
    # seems reasonable to have in-line here: bzrlib.commands and options are
 
45
    # normally loaded, and the rest of loggerhead won't be loaded until serve
 
46
    # --http is run.
 
47
 
 
48
    # transport_server_registry was added in bzr 1.16. When we drop support for
 
49
    # older releases, we can remove the code to override cmd_serve.
 
50
 
 
51
    try:
 
52
        from bzrlib.transport import transport_server_registry
 
53
    except ImportError:
 
54
        transport_server_registry = None
48
55
 
49
56
    DEFAULT_HOST = '0.0.0.0'
50
57
    DEFAULT_PORT = 8080
51
58
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
52
59
            (DEFAULT_PORT,))
53
60
 
54
 
    def _ensure_loggerhead_path():
55
 
        """Ensure that you can 'import loggerhead' and get the root."""
 
61
    def serve_http(transport, host=None, port=None, inet=None):
56
62
        # loggerhead internal code will try to 'import loggerhead', so
57
63
        # let's put it on the path if we can't find it in the existing path
58
64
        try:
59
 
            import loggerhead.apps.transport
 
65
            import loggerhead
60
66
        except ImportError:
61
67
            import os.path, sys
62
68
            sys.path.append(os.path.dirname(__file__))
63
69
 
64
 
    def serve_http(transport, host=None, port=None, inet=None):
 
70
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
71
        from loggerhead.config import LoggerheadConfig
65
72
        from paste.httpexceptions import HTTPExceptionHandler
66
73
        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
74
        if host is None:
75
75
            host = DEFAULT_HOST
76
76
        if port is None:
79
79
        if not transport.is_readonly():
80
80
            argv.insert(0, '--allow-writes')
81
81
        config = LoggerheadConfig(argv)
82
 
        setup_logging(config, init_logging=False, log_file=sys.stderr)
83
82
        app = BranchesFromTransportRoot(transport.base, config)
84
83
        app = HTTPExceptionHandler(app)
85
84
        serve(app, host=host, port=port)
86
85
 
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
 
86
    if transport_server_registry is not None:
 
87
        transport_server_registry.register('http', serve_http, help=HELP)
 
88
    else:
 
89
        import bzrlib.builtins
 
90
        from bzrlib.commands import get_cmd_object, register_command
 
91
        from bzrlib.option import Option
 
92
 
 
93
        _original_command = get_cmd_object('serve')
 
94
 
 
95
        class cmd_serve(bzrlib.builtins.cmd_serve):
 
96
            __doc__ = _original_command.__doc__
 
97
 
 
98
            takes_options = _original_command.takes_options + [
 
99
                Option('http', help=HELP)]
 
100
 
 
101
            def run(self, *args, **kw):
 
102
                if 'http' in kw:
 
103
                    from bzrlib.transport import get_transport
 
104
                    allow_writes = kw.get('allow_writes', False)
 
105
                    path = kw.get('directory', '.')
 
106
                    port = kw.get('port', DEFAULT_PORT)
 
107
                    # port might be an int already...
 
108
                    if isinstance(port, basestring) and ':' in port:
 
109
                        host, port = port.split(':')
 
110
                    else:
 
111
                        host = DEFAULT_HOST
 
112
                    if allow_writes:
 
113
                        transport = get_transport(path)
 
114
                    else:
 
115
                        transport = get_transport('readonly+' + path)
 
116
                    serve_http(transport, host, port)
 
117
                else:
 
118
                    super(cmd_serve, self).run(*args, **kw)
 
119
 
 
120
        register_command(cmd_serve)