← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Max Kanat-Alexander
  • Date: 2010-11-11 03:30:43 UTC
  • Revision ID: mkanat@bugzilla.org-20101111033043-rmxnwrkxfkcrqq60
Tags: loggerhead-1.18
Release 1.18

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
 
1
# Copyright 2009, 2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
# This file allows loggerhead to be treated as a plugin for bzr.
 
19
#
 
20
# XXX: Because loggerhead already contains a loggerhead directory, much of the
 
21
# code is going to appear loaded at bzrlib.plugins.loggerhead.loggerhead.
 
22
# This seems like the easiest thing, because bzrlib wants the top-level plugin
 
23
# directory to be the module, but when it's used as a library people expect
 
24
# the source directory to contain a directory called loggerhead.  -- mbp
 
25
# 20090123
 
26
 
 
27
"""Loggerhead web viewer for Bazaar branches.
 
28
 
 
29
This provides a new option "--http" to the "bzr serve" command, that
 
30
starts a web server to browse the contents of a branch.
 
31
"""
 
32
 
 
33
from info import (
 
34
    bzr_plugin_version as version_info,
 
35
    bzr_compatible_versions,
 
36
    )
 
37
 
 
38
if __name__ == 'bzrlib.plugins.loggerhead':
 
39
    import bzrlib
 
40
    from bzrlib.api import require_any_api
 
41
 
 
42
    require_any_api(bzrlib, bzr_compatible_versions)
 
43
 
 
44
    # NB: Normally plugins should lazily load almost everything, but this
 
45
    # seems reasonable to have in-line here: bzrlib.commands and options are
 
46
    # normally loaded, and the rest of loggerhead won't be loaded until serve
 
47
    # --http is run.
 
48
 
 
49
    # transport_server_registry was added in bzr 1.16. When we drop support for
 
50
    # older releases, we can remove the code to override cmd_serve.
 
51
 
 
52
    try:
 
53
        from bzrlib.transport import transport_server_registry
 
54
    except ImportError:
 
55
        transport_server_registry = None
 
56
 
 
57
    DEFAULT_HOST = '0.0.0.0'
 
58
    DEFAULT_PORT = 8080
 
59
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
 
60
            (DEFAULT_PORT,))
 
61
 
 
62
    def setup_logging(config):
 
63
        import logging
 
64
        import sys
 
65
 
 
66
        logger = logging.getLogger('loggerhead')
 
67
        handler = logging.StreamHandler(sys.stderr)
 
68
        handler.setLevel(logging.DEBUG)
 
69
        logger.addHandler(handler)
 
70
        logging.getLogger('simpleTAL').addHandler(handler)
 
71
        logging.getLogger('simpleTALES').addHandler(handler)
 
72
 
 
73
 
 
74
    def _ensure_loggerhead_path():
 
75
        """Ensure that you can 'import loggerhead' and get the root."""
 
76
        # loggerhead internal code will try to 'import loggerhead', so
 
77
        # let's put it on the path if we can't find it in the existing path
 
78
        try:
 
79
            import loggerhead.apps.transport
 
80
        except ImportError:
 
81
            import os.path, sys
 
82
            sys.path.append(os.path.dirname(__file__))
 
83
 
 
84
    def serve_http(transport, host=None, port=None, inet=None):
 
85
        from paste.httpexceptions import HTTPExceptionHandler
 
86
        from paste.httpserver import serve
 
87
 
 
88
        _ensure_loggerhead_path()
 
89
 
 
90
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
91
        from loggerhead.config import LoggerheadConfig
 
92
 
 
93
        if host is None:
 
94
            host = DEFAULT_HOST
 
95
        if port is None:
 
96
            port = DEFAULT_PORT
 
97
        argv = ['--host', host, '--port', str(port), '--', transport.base]
 
98
        if not transport.is_readonly():
 
99
            argv.insert(0, '--allow-writes')
 
100
        config = LoggerheadConfig(argv)
 
101
        setup_logging(config)
 
102
        app = BranchesFromTransportRoot(transport.base, config)
 
103
        app = HTTPExceptionHandler(app)
 
104
        serve(app, host=host, port=port)
 
105
 
 
106
    if transport_server_registry is not None:
 
107
        transport_server_registry.register('http', serve_http, help=HELP)
 
108
    else:
 
109
        import bzrlib.builtins
 
110
        from bzrlib.commands import get_cmd_object, register_command
 
111
        from bzrlib.option import Option
 
112
 
 
113
        _original_command = get_cmd_object('serve')
 
114
 
 
115
        class cmd_serve(bzrlib.builtins.cmd_serve):
 
116
            __doc__ = _original_command.__doc__
 
117
 
 
118
            takes_options = _original_command.takes_options + [
 
119
                Option('http', help=HELP)]
 
120
 
 
121
            def run(self, *args, **kw):
 
122
                if 'http' in kw:
 
123
                    from bzrlib.transport import get_transport
 
124
                    allow_writes = kw.get('allow_writes', False)
 
125
                    path = kw.get('directory', '.')
 
126
                    port = kw.get('port', DEFAULT_PORT)
 
127
                    # port might be an int already...
 
128
                    if isinstance(port, basestring) and ':' in port:
 
129
                        host, port = port.split(':')
 
130
                    else:
 
131
                        host = DEFAULT_HOST
 
132
                    if allow_writes:
 
133
                        transport = get_transport(path)
 
134
                    else:
 
135
                        transport = get_transport('readonly+' + path)
 
136
                    serve_http(transport, host, port)
 
137
                else:
 
138
                    super(cmd_serve, self).run(*args, **kw)
 
139
 
 
140
        register_command(cmd_serve)
 
141
 
 
142
    def load_tests(standard_tests, module, loader):
 
143
        _ensure_loggerhead_path()
 
144
        standard_tests.addTests(loader.loadTestsFromModuleNames(
 
145
            ['bzrlib.plugins.loggerhead.loggerhead.tests']))
 
146
        return standard_tests