1
# Copyright 2009 Canonical Ltd
1
# Copyright 2009, 2010 Canonical Ltd
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
27
27
"""Loggerhead web viewer for Bazaar branches.
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.
33
version_info = (1, 11, 0)
33
version_info = (1, 17, 0)
35
35
if __name__ == 'bzrlib.plugins.loggerhead':
37
37
from bzrlib.api import require_any_api
39
require_any_api(bzrlib, [(1, 11, 0), (1, 13, 0), (1, 15, 0)])
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), (2, 2, 0)])
41
43
# NB: Normally plugins should lazily load almost everything, but this
42
44
# seems reasonable to have in-line here: bzrlib.commands and options are
43
45
# normally loaded, and the rest of loggerhead won't be loaded until serve
46
48
# transport_server_registry was added in bzr 1.16. When we drop support for
47
49
# older releases, we can remove the code to override cmd_serve.
54
56
DEFAULT_HOST = '0.0.0.0'
55
57
DEFAULT_PORT = 8080
56
HELP = ('Loggerhead web-based code viewer and server. (default port: %d)' %
58
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
61
def setup_logging(config):
65
logger = logging.getLogger('loggerhead')
66
handler = logging.StreamHandler(sys.stderr)
67
handler.setLevel(logging.DEBUG)
68
logger.addHandler(handler)
69
logging.getLogger('simpleTAL').addHandler(handler)
70
logging.getLogger('simpleTALES').addHandler(handler)
59
72
def serve_http(transport, host=None, port=None, inet=None):
73
from paste.httpexceptions import HTTPExceptionHandler
74
from paste.httpserver import serve
60
76
# loggerhead internal code will try to 'import loggerhead', so
61
# let's put it on the path
63
sys.path.append(os.path.dirname(__file__))
77
# let's put it on the path if we can't find it in the existing path
79
import loggerhead.apps.transport
82
sys.path.append(os.path.dirname(__file__))
65
84
from loggerhead.apps.transport import BranchesFromTransportRoot
66
85
from loggerhead.config import LoggerheadConfig
67
from paste.httpexceptions import HTTPExceptionHandler
68
from paste.httpserver import serve
70
88
host = DEFAULT_HOST
72
90
port = DEFAULT_PORT
73
argv = ['--host', host, '--port', str(port), transport.base]
91
argv = ['--host', host, '--port', str(port), '--', transport.base]
92
if not transport.is_readonly():
93
argv.insert(0, '--allow-writes')
74
94
config = LoggerheadConfig(argv)
75
app = BranchesFromTransportRoot(transport, config)
96
app = BranchesFromTransportRoot(transport.base, config)
76
97
app = HTTPExceptionHandler(app)
77
98
serve(app, host=host, port=port)
94
115
def run(self, *args, **kw):
96
117
from bzrlib.transport import get_transport
118
allow_writes = kw.get('allow_writes', False)
97
119
path = kw.get('directory', '.')
98
120
port = kw.get('port', DEFAULT_PORT)
99
121
# port might be an int already...
101
123
host, port = port.split(':')
103
125
host = DEFAULT_HOST
104
transport = get_transport(path)
127
transport = get_transport(path)
129
transport = get_transport('readonly+' + path)
105
130
serve_http(transport, host, port)
107
132
super(cmd_serve, self).run(*args, **kw)