~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

Improve escaping of filenames in revision views. Fixes a couple of XSS holes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright 2009, 2010, 2011 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
30
30
starts a web server to browse the contents of a branch.
31
31
"""
32
32
 
33
 
import sys
34
 
 
35
33
from info import (
36
34
    bzr_plugin_version as version_info,
37
35
    bzr_compatible_versions,
40
38
if __name__ == 'bzrlib.plugins.loggerhead':
41
39
    import bzrlib
42
40
    from bzrlib.api import require_any_api
43
 
    from bzrlib import commands
44
41
 
45
42
    require_any_api(bzrlib, bzr_compatible_versions)
46
43
 
47
 
    from bzrlib.transport import transport_server_registry
 
44
    # NB: Normally plugins should lazily load almost everything, but this
 
45
    # seems reasonable to have in-line here: bzrlib.commands and options are
 
46
    # normally loaded, and the rest of loggerhead won't be loaded until serve
 
47
    # --http is run.
 
48
 
 
49
    # transport_server_registry was added in bzr 1.16. When we drop support for
 
50
    # older releases, we can remove the code to override cmd_serve.
 
51
 
 
52
    try:
 
53
        from bzrlib.transport import transport_server_registry
 
54
    except ImportError:
 
55
        transport_server_registry = None
48
56
 
49
57
    DEFAULT_HOST = '0.0.0.0'
50
58
    DEFAULT_PORT = 8080
51
59
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
52
60
            (DEFAULT_PORT,))
53
61
 
 
62
    def setup_logging(config):
 
63
        import logging
 
64
        import sys
 
65
 
 
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)
 
72
 
 
73
 
54
74
    def _ensure_loggerhead_path():
55
75
        """Ensure that you can 'import loggerhead' and get the root."""
56
76
        # loggerhead internal code will try to 'import loggerhead', so
62
82
            sys.path.append(os.path.dirname(__file__))
63
83
 
64
84
    def serve_http(transport, host=None, port=None, inet=None):
65
 
        # TODO: if we supported inet to pass requests in and respond to them,
66
 
        #       then it would be easier to test the full stack, but it probably
67
 
        #       means routing around paste.httpserver.serve which probably
68
 
        #       isn't testing the full stack
69
85
        from paste.httpexceptions import HTTPExceptionHandler
70
86
        from paste.httpserver import serve
71
87
 
72
88
        _ensure_loggerhead_path()
73
89
 
74
 
        from loggerhead.apps.http_head import HeadMiddleware
75
90
        from loggerhead.apps.transport import BranchesFromTransportRoot
76
91
        from loggerhead.config import LoggerheadConfig
77
 
        from loggerhead.main import setup_logging
78
92
 
79
93
        if host is None:
80
94
            host = DEFAULT_HOST
84
98
        if not transport.is_readonly():
85
99
            argv.insert(0, '--allow-writes')
86
100
        config = LoggerheadConfig(argv)
87
 
        setup_logging(config, init_logging=False, log_file=sys.stderr)
 
101
        setup_logging(config)
88
102
        app = BranchesFromTransportRoot(transport.base, config)
89
 
        # Bug #758618, HeadMiddleware seems to break HTTPExceptionHandler from
90
 
        # actually sending appropriate return codes to the client. Since nobody
91
 
        # desperately needs HeadMiddleware right now, just ignoring it.
92
 
        # app = HeadMiddleware(app)
93
103
        app = HTTPExceptionHandler(app)
94
104
        serve(app, host=host, port=port)
95
105
 
96
 
    transport_server_registry.register('http', serve_http, help=HELP)
97
 
 
98
 
    class cmd_load_test_loggerhead(commands.Command):
99
 
        """Run a load test against a live loggerhead instance.
100
 
 
101
 
        Pass in the name of a script file to run. See loggerhead/load_test.py
102
 
        for a description of the file format.
103
 
        """
104
 
 
105
 
        takes_args = ["filename"]
106
 
 
107
 
        def run(self, filename):
108
 
            from bzrlib.plugins.loggerhead.loggerhead import load_test
109
 
            script = load_test.run_script(filename)
110
 
            for thread_id in sorted(script._threads):
111
 
                worker = script._threads[thread_id][0]
112
 
                for url, success, time in worker.stats:
113
 
                    self.outf.write(' %5.3fs %s %s\n'
114
 
                                    % (time, str(success)[0], url))
115
 
 
116
 
    commands.register_command(cmd_load_test_loggerhead)
 
106
    if transport_server_registry is not None:
 
107
        transport_server_registry.register('http', serve_http, help=HELP)
 
108
    else:
 
109
        import bzrlib.builtins
 
110
        from bzrlib.commands import get_cmd_object, register_command
 
111
        from bzrlib.option import Option
 
112
 
 
113
        _original_command = get_cmd_object('serve')
 
114
 
 
115
        class cmd_serve(bzrlib.builtins.cmd_serve):
 
116
            __doc__ = _original_command.__doc__
 
117
 
 
118
            takes_options = _original_command.takes_options + [
 
119
                Option('http', help=HELP)]
 
120
 
 
121
            def run(self, *args, **kw):
 
122
                if 'http' in 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(':')
 
130
                    else:
 
131
                        host = DEFAULT_HOST
 
132
                    if allow_writes:
 
133
                        transport = get_transport(path)
 
134
                    else:
 
135
                        transport = get_transport('readonly+' + path)
 
136
                    serve_http(transport, host, port)
 
137
                else:
 
138
                    super(cmd_serve, self).run(*args, **kw)
 
139
 
 
140
        register_command(cmd_serve)
117
141
 
118
142
    def load_tests(standard_tests, module, loader):
119
143
        _ensure_loggerhead_path()