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.
34
bzr_plugin_version as version_info,
35
bzr_compatible_versions,
33
version_info = (1, 11, 0)
38
35
if __name__ == 'bzrlib.plugins.loggerhead':
40
37
from bzrlib.api import require_any_api
42
require_any_api(bzrlib, bzr_compatible_versions)
39
require_any_api(bzrlib, [(1, 11, 0), (1, 13, 0), (1, 15, 0)])
44
41
# NB: Normally plugins should lazily load almost everything, but this
45
42
# seems reasonable to have in-line here: bzrlib.commands and options are
46
43
# normally loaded, and the rest of loggerhead won't be loaded until serve
49
46
# transport_server_registry was added in bzr 1.16. When we drop support for
50
47
# older releases, we can remove the code to override cmd_serve.
57
54
DEFAULT_HOST = '0.0.0.0'
58
55
DEFAULT_PORT = 8080
59
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
56
HELP = ('Loggerhead 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."""
59
def serve_http(transport, host=None, port=None, inet=None):
76
60
# 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__))
61
# let's put it on the path
63
sys.path.append(os.path.dirname(__file__))
84
def serve_http(transport, host=None, port=None, inet=None):
65
from loggerhead.apps.transport import BranchesFromTransportRoot
66
from loggerhead.config import LoggerheadConfig
85
67
from paste.httpexceptions import HTTPExceptionHandler
86
68
from paste.httpserver import serve
88
_ensure_loggerhead_path()
90
from loggerhead.apps.transport import BranchesFromTransportRoot
91
from loggerhead.config import LoggerheadConfig
94
70
host = DEFAULT_HOST
96
72
port = DEFAULT_PORT
97
argv = ['--host', host, '--port', str(port), '--', transport.base]
98
if not transport.is_readonly():
99
argv.insert(0, '--allow-writes')
73
argv = ['--host', host, '--port', str(port), transport.base]
100
74
config = LoggerheadConfig(argv)
101
setup_logging(config)
102
app = BranchesFromTransportRoot(transport.base, config)
75
app = BranchesFromTransportRoot(transport, config)
103
76
app = HTTPExceptionHandler(app)
104
77
serve(app, host=host, port=port)
121
94
def run(self, *args, **kw):
123
96
from bzrlib.transport import get_transport
124
allow_writes = kw.get('allow_writes', False)
125
97
path = kw.get('directory', '.')
126
98
port = kw.get('port', DEFAULT_PORT)
127
99
# port might be an int already...
129
101
host, port = port.split(':')
131
103
host = DEFAULT_HOST
133
transport = get_transport(path)
135
transport = get_transport('readonly+' + path)
104
transport = get_transport(path)
136
105
serve_http(transport, host, port)
138
107
super(cmd_serve, self).run(*args, **kw)
140
109
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