1
# Copyright 2009, 2010, 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# This file allows loggerhead to be treated as a plugin for bzr.
20
# XXX: Because loggerhead already contains a loggerhead directory, much of the
21
# code is going to appear loaded at bzrlib.plugins.loggerhead.loggerhead.
22
# This seems like the easiest thing, because bzrlib wants the top-level plugin
23
# directory to be the module, but when it's used as a library people expect
24
# the source directory to contain a directory called loggerhead. -- mbp
27
"""Loggerhead web viewer for Bazaar branches.
29
This provides a new option "--http" to the "bzr serve" command, that
30
starts a web server to browse the contents of a branch.
34
bzr_plugin_version as version_info,
35
bzr_compatible_versions,
38
if __name__ == 'bzrlib.plugins.loggerhead':
40
from bzrlib.api import require_any_api
41
from bzrlib import commands
43
require_any_api(bzrlib, bzr_compatible_versions)
45
# NB: Normally plugins should lazily load almost everything, but this
46
# seems reasonable to have in-line here: bzrlib.commands and options are
47
# normally loaded, and the rest of loggerhead won't be loaded until serve
50
# transport_server_registry was added in bzr 1.16. When we drop support for
51
# older releases, we can remove the code to override cmd_serve.
54
from bzrlib.transport import transport_server_registry
56
transport_server_registry = None
58
DEFAULT_HOST = '0.0.0.0'
60
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
63
def setup_logging(config):
67
logger = logging.getLogger('loggerhead')
68
handler = logging.StreamHandler(sys.stderr)
69
handler.setLevel(logging.DEBUG)
70
logger.addHandler(handler)
71
logging.getLogger('simpleTAL').addHandler(handler)
72
logging.getLogger('simpleTALES').addHandler(handler)
75
def _ensure_loggerhead_path():
76
"""Ensure that you can 'import loggerhead' and get the root."""
77
# loggerhead internal code will try to 'import loggerhead', so
78
# let's put it on the path if we can't find it in the existing path
80
import loggerhead.apps.transport
83
sys.path.append(os.path.dirname(__file__))
85
def serve_http(transport, host=None, port=None, inet=None):
86
from paste.httpexceptions import HTTPExceptionHandler
87
from paste.httpserver import serve
89
_ensure_loggerhead_path()
91
from loggerhead.apps.transport import BranchesFromTransportRoot
92
from loggerhead.config import LoggerheadConfig
98
argv = ['--host', host, '--port', str(port), '--', transport.base]
99
if not transport.is_readonly():
100
argv.insert(0, '--allow-writes')
101
config = LoggerheadConfig(argv)
102
setup_logging(config)
103
app = BranchesFromTransportRoot(transport.base, config)
104
app = HTTPExceptionHandler(app)
105
serve(app, host=host, port=port)
107
if transport_server_registry is not None:
108
transport_server_registry.register('http', serve_http, help=HELP)
110
import bzrlib.builtins
111
from bzrlib.option import Option
113
_original_command = commands.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)
138
super(cmd_serve, self).run(*args, **kw)
140
commands.register_command(cmd_serve)
142
class cmd_load_test_loggerhead(commands.Command):
143
"""Run a load test against a live loggerhead instance.
145
Pass in the name of a script file to run. See loggerhead/load_test.py
146
for a description of the file format.
149
takes_args = ["filename"]
151
def run(self, filename):
152
from bzrlib.plugins.loggerhead.loggerhead import load_test
153
script = load_test.run_script(filename)
154
for thread_id in sorted(script._threads):
155
worker = script._threads[thread_id][0]
156
for url, success, time in worker.stats:
157
self.outf.write(' %5.3fs %s %s\n'
158
% (time, str(success)[0], url))
160
commands.register_command(cmd_load_test_loggerhead)
162
def load_tests(standard_tests, module, loader):
163
_ensure_loggerhead_path()
164
standard_tests.addTests(loader.loadTestsFromModuleNames(
165
['bzrlib.plugins.loggerhead.loggerhead.tests']))
166
return standard_tests
added
removed
__init__.py
