~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Ian Clatworthy
  • Date: 2010-04-22 08:52:59 UTC
  • mfrom: (405.1.8 small-cleanups)
  • Revision ID: ian.clatworthy@canonical.com-20100422085259-1nb59i53emu2ny5b
Merge John's minor cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright 2009 Canonical Ltd
 
1
# Copyright 2009, 2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
26
26
 
27
27
"""Loggerhead web viewer for Bazaar branches.
28
28
 
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.
31
31
"""
32
32
 
33
 
version_info = (1, 11, 0)
 
33
version_info = (1, 17, 0)
34
34
 
35
35
if __name__ == 'bzrlib.plugins.loggerhead':
36
36
    import bzrlib
37
37
    from bzrlib.api import require_any_api
38
38
 
39
 
    require_any_api(bzrlib, [(1, 11, 0), (1, 13, 0), (1, 15, 0)])
40
 
 
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
44
 
    # for a bit.
 
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), (2, 2, 0)])
45
42
 
46
43
    # NB: Normally plugins should lazily load almost everything, but this
47
44
    # seems reasonable to have in-line here: bzrlib.commands and options are
48
45
    # normally loaded, and the rest of loggerhead won't be loaded until serve
49
46
    # --http is run.
50
 
        
51
 
    import bzrlib.builtins
52
 
    from bzrlib.commands import get_cmd_object, register_command
53
 
    from bzrlib.option import Option
54
 
 
55
 
    _original_command = get_cmd_object('serve')
56
 
 
 
47
 
 
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.
 
50
 
 
51
    try:
 
52
        from bzrlib.transport import transport_server_registry
 
53
    except ImportError:
 
54
        transport_server_registry = None
 
55
 
 
56
    DEFAULT_HOST = '0.0.0.0'
57
57
    DEFAULT_PORT = 8080
58
 
 
59
 
    class cmd_serve(bzrlib.builtins.cmd_serve):
60
 
        __doc__ = _original_command.__doc__
61
 
 
62
 
        takes_options = _original_command.takes_options + [
63
 
            Option('http',
64
 
                help='Run an http (Loggerhead) server to browse code, '
65
 
                    'by default on port %s.' % DEFAULT_PORT)]
66
 
 
67
 
        def run(self, *args, **kw):
68
 
            if 'http' in kw:
69
 
                # loggerhead internal code will try to 'import loggerhead', so
70
 
                # let's put it on the path
71
 
                import os.path, sys
72
 
                sys.path.append(os.path.dirname(__file__))
73
 
 
74
 
                from bzrlib.transport import get_transport
75
 
                from loggerhead.apps.transport import BranchesFromTransportRoot
76
 
                from loggerhead.config import LoggerheadConfig
77
 
                from paste.httpexceptions import HTTPExceptionHandler
78
 
                from paste.httpserver import serve
79
 
                path = kw.get('directory', '.')
80
 
                port = kw.get('port', DEFAULT_PORT)
81
 
                # port might be an int already...
82
 
                if isinstance(port, basestring) and ':' in port:
83
 
                    host, port = port.split(':')
 
58
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
 
59
            (DEFAULT_PORT,))
 
60
 
 
61
    def setup_logging(config):
 
62
        import logging
 
63
        import sys
 
64
 
 
65
        logger = logging.getLogger('loggerhead')
 
66
        handler = logging.StreamHandler(sys.stderr)
 
67
        handler.setLevel(logging.DEBUG)
 
68
        logger.addHandler(handler)
 
69
        logging.getLogger('simpleTAL').addHandler(handler)
 
70
        logging.getLogger('simpleTALES').addHandler(handler)
 
71
 
 
72
    def serve_http(transport, host=None, port=None, inet=None):
 
73
        from paste.httpexceptions import HTTPExceptionHandler
 
74
        from paste.httpserver import serve
 
75
 
 
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
 
78
        try:
 
79
            import loggerhead.apps.transport
 
80
        except ImportError:
 
81
            import os.path, sys
 
82
            sys.path.append(os.path.dirname(__file__))
 
83
 
 
84
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
85
        from loggerhead.config import LoggerheadConfig
 
86
 
 
87
        if host is None:
 
88
            host = DEFAULT_HOST
 
89
        if port is None:
 
90
            port = DEFAULT_PORT
 
91
        argv = ['--host', host, '--port', str(port), '--', transport.base]
 
92
        if not transport.is_readonly():
 
93
            argv.insert(0, '--allow-writes')
 
94
        config = LoggerheadConfig(argv)
 
95
        setup_logging(config)
 
96
        app = BranchesFromTransportRoot(transport.base, config)
 
97
        app = HTTPExceptionHandler(app)
 
98
        serve(app, host=host, port=port)
 
99
 
 
100
    if transport_server_registry is not None:
 
101
        transport_server_registry.register('http', serve_http, help=HELP)
 
102
    else:
 
103
        import bzrlib.builtins
 
104
        from bzrlib.commands import get_cmd_object, register_command
 
105
        from bzrlib.option import Option
 
106
 
 
107
        _original_command = get_cmd_object('serve')
 
108
 
 
109
        class cmd_serve(bzrlib.builtins.cmd_serve):
 
110
            __doc__ = _original_command.__doc__
 
111
 
 
112
            takes_options = _original_command.takes_options + [
 
113
                Option('http', help=HELP)]
 
114
 
 
115
            def run(self, *args, **kw):
 
116
                if 'http' in kw:
 
117
                    from bzrlib.transport import get_transport
 
118
                    allow_writes = kw.get('allow_writes', False)
 
119
                    path = kw.get('directory', '.')
 
120
                    port = kw.get('port', DEFAULT_PORT)
 
121
                    # port might be an int already...
 
122
                    if isinstance(port, basestring) and ':' in port:
 
123
                        host, port = port.split(':')
 
124
                    else:
 
125
                        host = DEFAULT_HOST
 
126
                    if allow_writes:
 
127
                        transport = get_transport(path)
 
128
                    else:
 
129
                        transport = get_transport('readonly+' + path)
 
130
                    serve_http(transport, host, port)
84
131
                else:
85
 
                    host = '0.0.0.0'
86
 
                argv = ['--host', host, '--port', str(port), path]
87
 
                config = LoggerheadConfig(argv)
88
 
                transport = get_transport(path)
89
 
                app = BranchesFromTransportRoot(transport, config)
90
 
                app = HTTPExceptionHandler(app)
91
 
                serve(app, host=host, port=port)
92
 
            else:
93
 
                super(cmd_serve, self).run(*args, **kw)
 
132
                    super(cmd_serve, self).run(*args, **kw)
94
133
 
95
 
    register_command(cmd_serve)
 
134
        register_command(cmd_serve)