1
# Copyright 2009, 2010 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
42
require_any_api(bzrlib, bzr_compatible_versions)
44
from bzrlib.transport import transport_server_registry
46
DEFAULT_HOST = '0.0.0.0'
48
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
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."""
64
# loggerhead internal code will try to 'import loggerhead', so
65
# let's put it on the path if we can't find it in the existing path
67
import loggerhead.apps.transport
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()
78
from loggerhead.apps.transport import BranchesFromTransportRoot
79
from loggerhead.config import LoggerheadConfig
85
argv = ['--host', host, '--port', str(port), '--', transport.base]
86
if not transport.is_readonly():
87
argv.insert(0, '--allow-writes')
88
config = LoggerheadConfig(argv)
90
app = BranchesFromTransportRoot(transport.base, config)
91
app = HTTPExceptionHandler(app)
92
serve(app, host=host, port=port)
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