← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to serve-branches

  • Committer: Martin Pool
  • Date: 2009-01-23 22:36:38 UTC
  • mto: This revision was merged to the branch mainline in revision 298.
  • Revision ID: mbp@sourcefrog.net-20090123223638-s57mqtpu4um3stes
Act as a plugin only when loaded by bzr; update docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
serve-branches
1
 
#
2
 
# Copyright (C) 2008, 2009 Canonical Ltd
3
 
#
 
1
#!/usr/bin/env python
4
2
# This program is free software; you can redistribute it and/or modify
5
3
# it under the terms of the GNU General Public License as published by
6
4
# the Free Software Foundation; either version 2 of the License, or
21
19
import os
22
20
import sys
23
21
 
24
 
from bzrlib.plugin import load_plugins
 
22
from optparse import OptionParser
25
23
 
26
24
from paste import httpserver
27
 
from paste.httpexceptions import HTTPExceptionHandler, HTTPInternalServerError
 
25
from paste.httpexceptions import HTTPExceptionHandler
28
26
from paste.translogger import TransLogger
29
27
 
30
28
from loggerhead import __version__
31
 
from loggerhead.apps.transport import (
32
 
    BranchesFromTransportRoot, UserBranchesFromTransportRoot)
33
 
from loggerhead.config import LoggerheadConfig
 
29
from loggerhead.apps.filesystem import (
 
30
    BranchesFromFileSystemRoot, UserBranchesFromFileSystemRoot)
34
31
from loggerhead.util import Reloader
35
32
from loggerhead.apps.error import ErrorHandlerApp
36
33
 
37
34
 
38
 
def get_config_and_path(args):
39
 
    config = LoggerheadConfig(args)
40
 
 
41
 
    if config.get_option('show_version'):
 
35
def command_line_parser():
 
36
    parser = OptionParser("%prog [options] <path>")
 
37
    parser.set_defaults(
 
38
        user_dirs=False,
 
39
        show_version=False,
 
40
        log_folder=None,
 
41
        )
 
42
    parser.add_option("--user-dirs", action="store_true", dest="user_dirs",
 
43
                      help="Serve user directories as ~user.")
 
44
    parser.add_option("--trunk-dir", metavar="DIR",
 
45
                      help="The directory that contains the trunk branches.")
 
46
    parser.add_option("--port", dest="user_port",
 
47
                      help=("Port Loggerhead should listen on "
 
48
                            "(defaults to 8080)."))
 
49
    parser.add_option("--host", dest="user_host",
 
50
                      help="Host Loggerhead should listen on.")
 
51
    parser.add_option("--prefix", dest="user_prefix",
 
52
                      help="Specify host prefix.")
 
53
    parser.add_option("--profile", action="store_true", dest="profile",
 
54
                      help="Generate callgrind profile data to "
 
55
                        "%d-stats.callgrind on each request.")
 
56
    parser.add_option("--reload", action="store_true", dest="reload",
 
57
                      help="Restarts the application when changing python"
 
58
                           " files. Only used for development purposes.")
 
59
    parser.add_option('--log-folder', dest="log_folder",
 
60
                      type=str, help="The directory to place log files in.")
 
61
    parser.add_option("--version", action="store_true", dest="show_version",
 
62
                      help="Print the software version and exit")
 
63
    return parser
 
64
 
 
65
 
 
66
def main(args):
 
67
    parser = command_line_parser()
 
68
    (options, args) = parser.parse_args(sys.argv[1:])
 
69
 
 
70
    if options.show_version:
42
71
        print "loggerhead %s" % __version__
43
72
        sys.exit(0)
44
73
 
45
 
    if config.arg_count > 1:
46
 
        config.print_help()
47
 
        sys.exit(1)
48
 
    elif config.arg_count == 1:
49
 
        base = config.get_arg(0)
50
 
    else:
51
 
        base = '.'
52
 
 
53
 
    if not config.get_option('allow_writes'):
54
 
        base = 'readonly+' + base
55
 
 
56
 
    return config, base
57
 
 
58
 
 
59
 
def setup_logging(config):
 
74
    if len(args) > 1:
 
75
        parser.print_help()
 
76
        sys.exit(1)
 
77
    elif len(args) == 1:
 
78
        [path] = args
 
79
    else:
 
80
        path = '.'
 
81
 
 
82
    if not os.path.isdir(path):
 
83
        print "%s is not a directory" % path
 
84
        sys.exit(1)
 
85
 
 
86
    if options.trunk_dir and not options.user_dirs:
 
87
        print "--trunk-dir is only valid with --user-dirs"
 
88
        sys.exit(1)
 
89
 
 
90
    if options.reload:
 
91
        if Reloader.is_installed():
 
92
            Reloader.install()
 
93
        else:
 
94
            return Reloader.restart_with_reloader()
 
95
 
 
96
    if options.user_dirs:
 
97
        if not options.trunk_dir:
 
98
            print "You didn't specify a directory for the trunk directories."
 
99
            sys.exit(1)
 
100
        app = UserBranchesFromFileSystemRoot(path, options.trunk_dir)
 
101
    else:
 
102
        app = BranchesFromFileSystemRoot(path)
 
103
 
 
104
    # setup_logging()
60
105
    logging.basicConfig()
61
106
    logging.getLogger('').setLevel(logging.DEBUG)
62
 
    logger = logging.getLogger('loggerhead')
63
 
    if config.get_option('log_folder'):
64
 
        logfile_path = os.path.join(
65
 
            config.get_option('log_folder'), 'serve-branches.log')
 
107
    logger = getattr(app, 'log', logging.getLogger('loggerhead'))
 
108
    if options.log_folder:
 
109
        logfile_path = os.path.join(options.log_folder, 'serve-branches.log')
66
110
    else:
67
111
        logfile_path = 'serve-branches.log'
68
112
    logfile = logging.FileHandler(logfile_path, 'a')
71
115
    logfile.setFormatter(formatter)
72
116
    logfile.setLevel(logging.DEBUG)
73
117
    logger.addHandler(logfile)
74
 
    return logger
75
 
 
76
 
 
77
 
def make_app_for_config_and_path(config, base):
78
 
    if config.get_option('trunk_dir') and not config.get_option('user_dirs'):
79
 
        print "--trunk-dir is only valid with --user-dirs"
80
 
        sys.exit(1)
81
 
 
82
 
    if config.get_option('reload'):
83
 
        if Reloader.is_installed():
84
 
            Reloader.install()
85
 
        else:
86
 
            return Reloader.restart_with_reloader()
87
 
 
88
 
    if config.get_option('user_dirs'):
89
 
        if not config.get_option('trunk_dir'):
90
 
            print "You didn't specify a directory for the trunk directories."
91
 
            sys.exit(1)
92
 
        app = UserBranchesFromTransportRoot(base, config)
93
 
    else:
94
 
        app = BranchesFromTransportRoot(base, config)
95
 
 
96
 
    setup_logging(config)
97
 
 
98
 
    if config.get_option('profile'):
 
118
    # setup_logging() #end
 
119
    app = ErrorHandlerApp(app)
 
120
    app = HTTPExceptionHandler(app)
 
121
    app = TransLogger(app, logger=logger)
 
122
    if options.profile:
99
123
        from loggerhead.middleware.profile import LSProfMiddleware
100
124
        app = LSProfMiddleware(app)
101
 
    if config.get_option('memory_profile'):
102
 
        from dozer import Dozer
103
 
        app = Dozer(app)
104
125
 
105
 
    if not config.get_option('user_prefix'):
 
126
    if not options.user_prefix:
106
127
        prefix = '/'
107
128
    else:
108
 
        prefix = config.get_option('user_prefix')
109
 
        if not prefix.startswith('/'):
110
 
            prefix = '/' + prefix
 
129
        prefix = options.user_prefix
111
130
 
112
131
    try:
113
132
        from paste.deploy.config import PrefixMiddleware
114
133
    except ImportError:
115
 
        cant_proxy_correctly_message = (
116
 
            'Unsupported configuration: PasteDeploy not available, but '
117
 
            'loggerhead appears to be behind a proxy.')
118
 
        def check_not_proxied(app):
119
 
            def wrapped(environ, start_response):
120
 
                if 'HTTP_X_FORWARDED_SERVER' in environ:
121
 
                    exc = HTTPInternalServerError()
122
 
                    exc.explanation = cant_proxy_correctly_message
123
 
                    raise exc
124
 
                return app(environ, start_response)
125
 
            return wrapped
126
 
        app = check_not_proxied(app)
 
134
        pass
127
135
    else:
128
136
        app = PrefixMiddleware(app, prefix=prefix)
129
137
 
130
 
    app = HTTPExceptionHandler(app)
131
 
    app = ErrorHandlerApp(app)
132
 
    app = TransLogger(app, logger=logging.getLogger('loggerhead'))
133
 
 
134
 
    return app
135
 
 
136
 
 
137
 
def main(args):
138
 
    load_plugins()
139
 
 
140
 
    config, path = get_config_and_path(args)
141
 
 
142
 
    app = make_app_for_config_and_path(config, path)
143
 
 
144
 
    if not config.get_option('user_port'):
 
138
    if not options.user_port:
145
139
        port = '8080'
146
140
    else:
147
 
        port = config.get_option('user_port')
 
141
        port = options.user_port
148
142
 
149
 
    if not config.get_option('user_host'):
 
143
    if not options.user_host:
150
144
        host = '0.0.0.0'
151
145
    else:
152
 
        host = config.get_option('user_host')
 
146
        host = options.user_host
153
147
 
154
148
    httpserver.serve(app, host=host, port=port)
 
149
 
 
150
 
 
151
if __name__ == "__main__":
 
152
    main(sys.argv)