~loggerhead-team/loggerhead/trunk-rich

262.2.1 by Martin Pool
Stub code to allow loggerhead to load as a plugin
1
# Copyright 2009 Canonical Ltd
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
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
262.2.1 by Martin Pool
Stub code to allow loggerhead to load as a plugin
17
18
# This file allows loggerhead to be treated as a plugin for bzr.
19
#
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
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
"""
262.2.1 by Martin Pool
Stub code to allow loggerhead to load as a plugin
32
262.2.2 by Martin Pool
Merge in 'serve --http' based on code from mwh
33
version_info = (1, 11, 0)
34
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
35
if __name__ == 'bzrlib.plugins.loggerhead':
36
    import bzrlib
262.2.5 by Martin Pool
This loggerhead will work with bzr 1.13
37
    from bzrlib.api import require_any_api
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
38
342 by Matt Nordhoff
Mark as compatible with bzrlib 1.15
39
    require_any_api(bzrlib, [(1, 11, 0), (1, 13, 0), (1, 15, 0)])
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
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
57
    DEFAULT_PORT = 8080
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
336.2.3 by Matt Nordhoff
Review:
74
                from loggerhead.apps.transport import BranchesFromTransportRoot
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
75
                from paste.httpexceptions import HTTPExceptionHandler
76
                from paste.httpserver import serve
336.2.3 by Matt Nordhoff
Review:
77
                a = HTTPExceptionHandler(BranchesFromTransportRoot('.'))
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
78
                port = kw.get('port', DEFAULT_PORT)
262.2.6 by Martin Pool
optparse may have already parsed port as an int
79
                # port might be an int already...
80
                if isinstance(port, basestring) and ':' in port:
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
81
                    host, port = port.split(':')
82
                else:
83
                    host = '0.0.0.0'
84
                serve(a, host=host, port=port)
262.2.3 by Martin Pool
serve --http handles the --port option
85
            else:
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
86
                super(cmd_serve, self).run(*args, **kw)
262.2.2 by Martin Pool
Merge in 'serve --http' based on code from mwh
87
262.2.4 by Martin Pool
Act as a plugin only when loaded by bzr; update docs
88
    register_command(cmd_serve)