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 bzrlib.transport import get_transport
75
from loggerhead.apps.transport import BranchesFromTransportRoot
76
from loggerhead.config import LoggerheadConfig
77
from paste.httpexceptions import HTTPExceptionHandler
78
from paste.httpserver import serve
79
path = kw.get('directory', '.')
80
port = kw.get('port', DEFAULT_PORT)
81
# port might be an int already...
82
if isinstance(port, basestring) and ':' in port:
83
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)
72
def serve_http(transport, host=None, port=None, inet=None):
73
from paste.httpexceptions import HTTPExceptionHandler
74
from paste.httpserver import serve
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
82
sys.path.append(os.path.dirname(__file__))
84
from loggerhead.apps.transport import BranchesFromTransportRoot
85
from loggerhead.config import LoggerheadConfig
91
argv = ['--host', host, '--port', str(port), '--', transport.base]
92
if not transport.is_readonly():
93
argv.insert(0, '--allow-writes')
94
config = LoggerheadConfig(argv)
96
app = BranchesFromTransportRoot(transport.base, config)
97
app = HTTPExceptionHandler(app)
98
serve(app, host=host, port=port)
100
if transport_server_registry is not None:
101
transport_server_registry.register('http', serve_http, help=HELP)
103
import bzrlib.builtins
104
from bzrlib.commands import get_cmd_object, register_command
105
from bzrlib.option import Option
107
_original_command = get_cmd_object('serve')
109
class cmd_serve(bzrlib.builtins.cmd_serve):
110
__doc__ = _original_command.__doc__
112
takes_options = _original_command.takes_options + [
113
Option('http', help=HELP)]
115
def run(self, *args, **kw):
117
from bzrlib.transport import get_transport
118
allow_writes = kw.get('allow_writes', False)
119
path = kw.get('directory', '.')
120
port = kw.get('port', DEFAULT_PORT)
121
# port might be an int already...
122
if isinstance(port, basestring) and ':' in port:
123
host, port = port.split(':')
127
transport = get_transport(path)
129
transport = get_transport('readonly+' + path)
130
serve_http(transport, host, port)
86
argv = ['--host', host, '--port', str(port), path]
87
config = LoggerheadConfig(argv)
88
transport = get_transport(path)
89
app = BranchesFromTransportRoot(transport, config)
90
app = HTTPExceptionHandler(app)
91
serve(app, host=host, port=port)
93
super(cmd_serve, self).run(*args, **kw)
132
super(cmd_serve, self).run(*args, **kw)
95
register_command(cmd_serve)
134
register_command(cmd_serve)