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)])
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
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)])
46
43
# NB: Normally plugins should lazily load almost everything, but this
47
44
# seems reasonable to have in-line here: bzrlib.commands and options are
48
45
# normally loaded, and the rest of loggerhead won't be loaded until serve
51
import bzrlib.builtins
52
from bzrlib.commands import get_cmd_object, register_command
53
from bzrlib.option import Option
55
_original_command = get_cmd_object('serve')
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.
52
from bzrlib.transport import transport_server_registry
54
transport_server_registry = None
56
DEFAULT_HOST = '0.0.0.0'
57
57
DEFAULT_PORT = 8080
59
class cmd_serve(bzrlib.builtins.cmd_serve):
60
__doc__ = _original_command.__doc__
62
takes_options = _original_command.takes_options + [
64
help='Run an http (Loggerhead) server to browse code, '
65
'by default on port %s.' % DEFAULT_PORT)]
67
def run(self, *args, **kw):
69
# loggerhead internal code will try to 'import loggerhead', so
70
# let's put it on the path
72
sys.path.append(os.path.dirname(__file__))
74
from loggerhead.apps.transport import BranchesFromTransportRoot
75
from paste.httpexceptions import HTTPExceptionHandler
76
from paste.httpserver import serve
77
a = HTTPExceptionHandler(BranchesFromTransportRoot('.'))
78
port = kw.get('port', DEFAULT_PORT)
79
# port might be an int already...
80
if isinstance(port, basestring) and ':' in port:
81
host, port = port.split(':')
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)
73
def _ensure_loggerhead_path():
74
"""Ensure that you can 'import loggerhead' and get the root."""
75
# loggerhead internal code will try to 'import loggerhead', so
76
# let's put it on the path if we can't find it in the existing path
78
import loggerhead.apps.transport
81
sys.path.append(os.path.dirname(__file__))
83
def serve_http(transport, host=None, port=None, inet=None):
84
from paste.httpexceptions import HTTPExceptionHandler
85
from paste.httpserver import serve
87
_ensure_loggerhead_path()
89
from loggerhead.apps.transport import BranchesFromTransportRoot
90
from loggerhead.config import LoggerheadConfig
96
argv = ['--host', host, '--port', str(port), '--', transport.base]
97
if not transport.is_readonly():
98
argv.insert(0, '--allow-writes')
99
config = LoggerheadConfig(argv)
100
setup_logging(config)
101
app = BranchesFromTransportRoot(transport.base, config)
102
app = HTTPExceptionHandler(app)
103
serve(app, host=host, port=port)
105
if transport_server_registry is not None:
106
transport_server_registry.register('http', serve_http, help=HELP)
108
import bzrlib.builtins
109
from bzrlib.commands import get_cmd_object, register_command
110
from bzrlib.option import Option
112
_original_command = get_cmd_object('serve')
114
class cmd_serve(bzrlib.builtins.cmd_serve):
115
__doc__ = _original_command.__doc__
117
takes_options = _original_command.takes_options + [
118
Option('http', help=HELP)]
120
def run(self, *args, **kw):
122
from bzrlib.transport import get_transport
123
allow_writes = kw.get('allow_writes', False)
124
path = kw.get('directory', '.')
125
port = kw.get('port', DEFAULT_PORT)
126
# port might be an int already...
127
if isinstance(port, basestring) and ':' in port:
128
host, port = port.split(':')
132
transport = get_transport(path)
134
transport = get_transport('readonly+' + path)
135
serve_http(transport, host, port)
84
serve(a, host=host, port=port)
86
super(cmd_serve, self).run(*args, **kw)
88
register_command(cmd_serve)
137
super(cmd_serve, self).run(*args, **kw)
139
register_command(cmd_serve)
141
def load_tests(standard_tests, module, loader):
142
_ensure_loggerhead_path()
143
standard_tests.addTests(loader.loadTestsFromModuleNames(
144
['bzrlib.plugins.loggerhead.loggerhead.tests']))
145
return standard_tests
added
removed
__init__.py
