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)
34
bzr_plugin_version as version_info,
35
bzr_compatible_versions,
35
38
if __name__ == 'bzrlib.plugins.loggerhead':
37
40
from bzrlib.api import require_any_api
39
require_any_api(bzrlib, [(1, 11, 0), (1, 13, 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
42
require_any_api(bzrlib, bzr_compatible_versions)
46
44
# NB: Normally plugins should lazily load almost everything, but this
47
45
# seems reasonable to have in-line here: bzrlib.commands and options are
48
46
# 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')
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'
57
58
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.filesystem import BranchesFromFileSystemRoot
75
from paste.httpexceptions import HTTPExceptionHandler
76
from paste.httpserver import serve
77
a = HTTPExceptionHandler(BranchesFromFileSystemRoot('.'))
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(':')
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
82
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)
84
serve(a, host=host, port=port)
86
super(cmd_serve, self).run(*args, **kw)
88
register_command(cmd_serve)
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
added
removed
__init__.py
