← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Tres Seaver
  • Date: 2010-03-23 15:44:51 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323154451-enjul7pa2crkk18b
Add Sphinx-based documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
 
1
# Copyright 2009 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
version_info = (1, 17, 0)
 
34
 
 
35
if __name__ == 'bzrlib.plugins.loggerhead':
 
36
    import bzrlib
 
37
    from bzrlib.api import require_any_api
 
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
 
55
 
 
56
    DEFAULT_HOST = '0.0.0.0'
 
57
    DEFAULT_PORT = 8080
 
58
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
 
59
            (DEFAULT_PORT,))
 
60
 
 
61
    def serve_http(transport, host=None, port=None, inet=None):
 
62
        from paste.httpexceptions import HTTPExceptionHandler
 
63
        from paste.httpserver import serve
 
64
 
 
65
        # loggerhead internal code will try to 'import loggerhead', so
 
66
        # let's put it on the path if we can't find it in the existing path
 
67
        try:
 
68
            import loggerhead
 
69
        except ImportError:
 
70
            import os.path, sys
 
71
            sys.path.append(os.path.dirname(__file__))
 
72
 
 
73
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
74
        from loggerhead.config import LoggerheadConfig
 
75
 
 
76
        if host is None:
 
77
            host = DEFAULT_HOST
 
78
        if port is None:
 
79
            port = DEFAULT_PORT
 
80
        argv = ['--host', host, '--port', str(port), '--', transport.base]
 
81
        if not transport.is_readonly():
 
82
            argv.insert(0, '--allow-writes')
 
83
        config = LoggerheadConfig(argv)
 
84
        app = BranchesFromTransportRoot(transport.base, config)
 
85
        app = HTTPExceptionHandler(app)
 
86
        serve(app, host=host, port=port)
 
87
 
 
88
    if transport_server_registry is not None:
 
89
        transport_server_registry.register('http', serve_http, help=HELP)
 
90
    else:
 
91
        import bzrlib.builtins
 
92
        from bzrlib.commands import get_cmd_object, register_command
 
93
        from bzrlib.option import Option
 
94
 
 
95
        _original_command = get_cmd_object('serve')
 
96
 
 
97
        class cmd_serve(bzrlib.builtins.cmd_serve):
 
98
            __doc__ = _original_command.__doc__
 
99
 
 
100
            takes_options = _original_command.takes_options + [
 
101
                Option('http', help=HELP)]
 
102
 
 
103
            def run(self, *args, **kw):
 
104
                if 'http' in kw:
 
105
                    from bzrlib.transport import get_transport
 
106
                    allow_writes = kw.get('allow_writes', False)
 
107
                    path = kw.get('directory', '.')
 
108
                    port = kw.get('port', DEFAULT_PORT)
 
109
                    # port might be an int already...
 
110
                    if isinstance(port, basestring) and ':' in port:
 
111
                        host, port = port.split(':')
 
112
                    else:
 
113
                        host = DEFAULT_HOST
 
114
                    if allow_writes:
 
115
                        transport = get_transport(path)
 
116
                    else:
 
117
                        transport = get_transport('readonly+' + path)
 
118
                    serve_http(transport, host, port)
 
119
                else:
 
120
                    super(cmd_serve, self).run(*args, **kw)
 
121
 
 
122
        register_command(cmd_serve)