~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Matt Nordhoff
  • Date: 2009-06-18 00:26:05 UTC
  • Revision ID: mnordhoff@mattnordhoff.com-20090618002605-t3y4fh1okvzenx52
Mark as compatible with bzr 1.16 and 1.17.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
from info import (
34
 
    bzr_plugin_version as version_info,
35
 
    bzr_compatible_versions,
36
 
    )
 
33
version_info = (1, 11, 0)
37
34
 
38
35
if __name__ == 'bzrlib.plugins.loggerhead':
39
36
    import bzrlib
40
37
    from bzrlib.api import require_any_api
41
 
    from bzrlib import commands
42
 
 
43
 
    require_any_api(bzrlib, bzr_compatible_versions)
44
 
 
45
 
    from bzrlib.transport import transport_server_registry
 
38
 
 
39
    require_any_api(bzrlib, [(1, 13, 0), (1, 15, 0), (1, 16, 0), (1, 17, 0)])
 
40
 
 
41
    # NB: Normally plugins should lazily load almost everything, but this
 
42
    # seems reasonable to have in-line here: bzrlib.commands and options are
 
43
    # normally loaded, and the rest of loggerhead won't be loaded until serve
 
44
    # --http is run.
 
45
 
 
46
    # transport_server_registry was added in bzr 1.16. When we drop support for
 
47
    # older releases, we can remove the code to override cmd_serve.
 
48
 
 
49
    try:
 
50
        from bzrlib.transport import transport_server_registry
 
51
    except ImportError:
 
52
        transport_server_registry = None
46
53
 
47
54
    DEFAULT_HOST = '0.0.0.0'
48
55
    DEFAULT_PORT = 8080
49
56
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
50
57
            (DEFAULT_PORT,))
51
58
 
52
 
    def setup_logging(config):
53
 
        import logging
54
 
        import sys
55
 
 
56
 
        logger = logging.getLogger('loggerhead')
57
 
        handler = logging.StreamHandler(sys.stderr)
58
 
        handler.setLevel(logging.DEBUG)
59
 
        logger.addHandler(handler)
60
 
        logging.getLogger('simpleTAL').addHandler(handler)
61
 
        logging.getLogger('simpleTALES').addHandler(handler)
62
 
 
63
 
    def _ensure_loggerhead_path():
64
 
        """Ensure that you can 'import loggerhead' and get the root."""
 
59
    def serve_http(transport, host=None, port=None, inet=None):
65
60
        # loggerhead internal code will try to 'import loggerhead', so
66
61
        # let's put it on the path if we can't find it in the existing path
67
62
        try:
68
 
            import loggerhead.apps.transport
 
63
            import loggerhead
69
64
        except ImportError:
70
65
            import os.path, sys
71
66
            sys.path.append(os.path.dirname(__file__))
72
67
 
73
 
    def serve_http(transport, host=None, port=None, inet=None):
 
68
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
69
        from loggerhead.config import LoggerheadConfig
74
70
        from paste.httpexceptions import HTTPExceptionHandler
75
71
        from paste.httpserver import serve
76
 
 
77
 
        _ensure_loggerhead_path()
78
 
 
79
 
        from loggerhead.apps.transport import BranchesFromTransportRoot
80
 
        from loggerhead.config import LoggerheadConfig
81
 
 
82
72
        if host is None:
83
73
            host = DEFAULT_HOST
84
74
        if port is None:
87
77
        if not transport.is_readonly():
88
78
            argv.insert(0, '--allow-writes')
89
79
        config = LoggerheadConfig(argv)
90
 
        setup_logging(config)
91
 
        app = BranchesFromTransportRoot(transport.base, config)
 
80
        app = BranchesFromTransportRoot(transport, config)
92
81
        app = HTTPExceptionHandler(app)
93
82
        serve(app, host=host, port=port)
94
83
 
95
 
    transport_server_registry.register('http', serve_http, help=HELP)
96
 
 
97
 
    class cmd_load_test_loggerhead(commands.Command):
98
 
        """Run a load test against a live loggerhead instance.
99
 
 
100
 
        Pass in the name of a script file to run. See loggerhead/load_test.py
101
 
        for a description of the file format.
102
 
        """
103
 
 
104
 
        takes_args = ["filename"]
105
 
 
106
 
        def run(self, filename):
107
 
            from bzrlib.plugins.loggerhead.loggerhead import load_test
108
 
            script = load_test.run_script(filename)
109
 
            for thread_id in sorted(script._threads):
110
 
                worker = script._threads[thread_id][0]
111
 
                for url, success, time in worker.stats:
112
 
                    self.outf.write(' %5.3fs %s %s\n'
113
 
                                    % (time, str(success)[0], url))
114
 
 
115
 
    commands.register_command(cmd_load_test_loggerhead)
116
 
 
117
 
    def load_tests(standard_tests, module, loader):
118
 
        _ensure_loggerhead_path()
119
 
        standard_tests.addTests(loader.loadTestsFromModuleNames(
120
 
            ['bzrlib.plugins.loggerhead.loggerhead.tests']))
121
 
        return standard_tests
 
84
    if transport_server_registry is not None:
 
85
        transport_server_registry.register('http', serve_http, help=HELP)
 
86
    else:
 
87
        import bzrlib.builtins
 
88
        from bzrlib.commands import get_cmd_object, register_command
 
89
        from bzrlib.option import Option
 
90
 
 
91
        _original_command = get_cmd_object('serve')
 
92
 
 
93
        class cmd_serve(bzrlib.builtins.cmd_serve):
 
94
            __doc__ = _original_command.__doc__
 
95
 
 
96
            takes_options = _original_command.takes_options + [
 
97
                Option('http', help=HELP)]
 
98
 
 
99
            def run(self, *args, **kw):
 
100
                if 'http' in kw:
 
101
                    from bzrlib.transport import get_transport
 
102
                    allow_writes = kw.get('allow_writes', False)
 
103
                    path = kw.get('directory', '.')
 
104
                    port = kw.get('port', DEFAULT_PORT)
 
105
                    # port might be an int already...
 
106
                    if isinstance(port, basestring) and ':' in port:
 
107
                        host, port = port.split(':')
 
108
                    else:
 
109
                        host = DEFAULT_HOST
 
110
                    if allow_writes:
 
111
                        transport = get_transport(path)
 
112
                    else:
 
113
                        transport = get_transport('readonly+' + path)
 
114
                    serve_http(transport, host, port)
 
115
                else:
 
116
                    super(cmd_serve, self).run(*args, **kw)
 
117
 
 
118
        register_command(cmd_serve)