1
# Copyright 2009, 2010 Canonical Ltd
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.
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.
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
1
# Copyright 2009 Canonical Ltd
18
3
# This file allows loggerhead to be treated as a plugin for bzr.
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
27
"""Loggerhead web viewer for Bazaar branches.
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.
34
bzr_plugin_version as version_info,
35
bzr_compatible_versions,
38
if __name__ == 'bzrlib.plugins.loggerhead':
40
from bzrlib.api import require_any_api
42
require_any_api(bzrlib, bzr_compatible_versions)
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
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.
53
from bzrlib.transport import transport_server_registry
55
transport_server_registry = None
57
DEFAULT_HOST = '0.0.0.0'
59
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
62
def setup_logging(config):
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)
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
79
import loggerhead.apps.transport
5
# XXX: Because loggerhead already contains a loggerhead directory, much of the code
6
# is going to live in bzrlib.plugins.loggerhead.loggerhead. But moving it can
7
# wait. When we do move it, we may need to guard the plugin code by __name__
8
# so it can be used as a library from other places. -- mbp 20090123
10
"""Loggerhead web viewer for Bazaar branches."""
13
from bzrlib.api import require_api
15
version_info = (1, 11, 0)
17
require_api(bzrlib, (1, 11, 0))
20
# TODO: All the following should be in a lazily-loaded module.
22
# TODO: This should provide a new type of server that can be used by bzr
23
# serve, maybe through a registry, rather than overriding the command. Though
24
# maybe we should keep the wrapper to work with older bzr releases, at least
27
# TODO: If a --port option is given, use that.
29
import bzrlib.builtins
30
from bzrlib.commands import get_cmd_object, register_command
31
from bzrlib.option import Option
33
_original_command = get_cmd_object('serve')
35
class cmd_serve(bzrlib.builtins.cmd_serve):
36
__doc__ = _original_command.__doc__
38
takes_options = _original_command.takes_options + [
40
help='Run an http (Loggerhead) server to browse code.')]
42
def run(self, *args, **kw):
44
# hack around loggerhead expecting to be loaded from the module
81
46
import os.path, sys
82
47
sys.path.append(os.path.dirname(__file__))
84
def serve_http(transport, host=None, port=None, inet=None):
85
from paste.httpexceptions import HTTPExceptionHandler
86
from paste.httpserver import serve
88
_ensure_loggerhead_path()
90
from loggerhead.apps.transport import BranchesFromTransportRoot
91
from loggerhead.config import LoggerheadConfig
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)
106
if transport_server_registry is not None:
107
transport_server_registry.register('http', serve_http, help=HELP)
109
import bzrlib.builtins
110
from bzrlib.commands import get_cmd_object, register_command
111
from bzrlib.option import Option
113
_original_command = get_cmd_object('serve')
115
class cmd_serve(bzrlib.builtins.cmd_serve):
116
__doc__ = _original_command.__doc__
118
takes_options = _original_command.takes_options + [
119
Option('http', help=HELP)]
121
def run(self, *args, **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(':')
133
transport = get_transport(path)
135
transport = get_transport('readonly+' + path)
136
serve_http(transport, host, port)
138
super(cmd_serve, self).run(*args, **kw)
140
register_command(cmd_serve)
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
48
from loggerhead.apps.filesystem import BranchesFromFileSystemRoot
49
from paste.httpexceptions import HTTPExceptionHandler
50
from paste.httpserver import serve
51
a = HTTPExceptionHandler(BranchesFromFileSystemRoot('.'))
52
serve(a, host='0.0.0.0', port='9876')
54
super(cmd_serve, self).run(*args, **kw)
56
register_command(cmd_serve)
added
removed
__init__.py
