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, 17, 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, [
40
(1, 13, 0), (1, 15, 0), (1, 16, 0), (1, 17, 0), (1, 18, 0),
41
(2, 0, 0), (2, 1, 0)])
43
# NB: Normally plugins should lazily load almost everything, but this
44
# seems reasonable to have in-line here: bzrlib.commands and options are
45
# normally loaded, and the rest of loggerhead won't be loaded until 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
42
require_any_api(bzrlib, bzr_compatible_versions)
44
from bzrlib.transport import transport_server_registry
56
46
DEFAULT_HOST = '0.0.0.0'
57
47
DEFAULT_PORT = 8080
58
48
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
61
def serve_http(transport, host=None, port=None, inet=None):
51
def setup_logging(config):
55
logger = logging.getLogger('loggerhead')
56
handler = logging.StreamHandler(sys.stderr)
57
handler.setLevel(logging.DEBUG)
58
logger.addHandler(handler)
59
logging.getLogger('simpleTAL').addHandler(handler)
60
logging.getLogger('simpleTALES').addHandler(handler)
62
def _ensure_loggerhead_path():
63
"""Ensure that you can 'import loggerhead' and get the root."""
62
64
# loggerhead internal code will try to 'import loggerhead', so
63
65
# let's put it on the path if we can't find it in the existing path
67
import loggerhead.apps.transport
66
68
except ImportError:
67
69
import os.path, sys
68
70
sys.path.append(os.path.dirname(__file__))
72
def serve_http(transport, host=None, port=None, inet=None):
73
from paste.httpexceptions import HTTPExceptionHandler
74
from paste.httpserver import serve
76
_ensure_loggerhead_path()
70
78
from loggerhead.apps.transport import BranchesFromTransportRoot
71
79
from loggerhead.config import LoggerheadConfig
72
from paste.httpexceptions import HTTPExceptionHandler
73
from paste.httpserver import serve
75
82
host = DEFAULT_HOST
79
86
if not transport.is_readonly():
80
87
argv.insert(0, '--allow-writes')
81
88
config = LoggerheadConfig(argv)
82
90
app = BranchesFromTransportRoot(transport.base, config)
83
91
app = HTTPExceptionHandler(app)
84
92
serve(app, host=host, port=port)
86
if transport_server_registry is not None:
87
transport_server_registry.register('http', serve_http, help=HELP)
89
import bzrlib.builtins
90
from bzrlib.commands import get_cmd_object, register_command
91
from bzrlib.option import Option
93
_original_command = get_cmd_object('serve')
95
class cmd_serve(bzrlib.builtins.cmd_serve):
96
__doc__ = _original_command.__doc__
98
takes_options = _original_command.takes_options + [
99
Option('http', help=HELP)]
101
def run(self, *args, **kw):
103
from bzrlib.transport import get_transport
104
allow_writes = kw.get('allow_writes', False)
105
path = kw.get('directory', '.')
106
port = kw.get('port', DEFAULT_PORT)
107
# port might be an int already...
108
if isinstance(port, basestring) and ':' in port:
109
host, port = port.split(':')
113
transport = get_transport(path)
115
transport = get_transport('readonly+' + path)
116
serve_http(transport, host, port)
118
super(cmd_serve, self).run(*args, **kw)
120
register_command(cmd_serve)
94
transport_server_registry.register('http', serve_http, help=HELP)
96
def load_tests(standard_tests, module, loader):
97
_ensure_loggerhead_path()
98
standard_tests.addTests(loader.loadTestsFromModuleNames(
99
['bzrlib.plugins.loggerhead.loggerhead.tests']))
100
return standard_tests