← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to serve-branches

  • Committer: Tom Haddon
  • Date: 2008-11-24 20:26:26 UTC
  • mto: This revision was merged to the branch mainline in revision 246.
  • Revision ID: tom.haddon@canonical.com-20081124202626-x0sva3e7zxlqtckw
Allow the script to run as root or another user, but start the loggerhead process as the correct user

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
25
 
from bzrlib.transport import get_transport
 
22
from optparse import OptionParser
26
23
 
27
24
from paste import httpserver
28
 
from paste.httpexceptions import HTTPExceptionHandler, HTTPInternalServerError
 
25
from paste.httpexceptions import HTTPExceptionHandler
29
26
from paste.translogger import TransLogger
30
27
 
31
28
from loggerhead import __version__
32
 
from loggerhead.apps.transport import (
33
 
    BranchesFromTransportRoot, UserBranchesFromTransportRoot)
34
 
from loggerhead.config import LoggerheadConfig
 
29
from loggerhead.apps.filesystem import (
 
30
    BranchesFromFileSystemRoot, UserBranchesFromFileSystemRoot)
35
31
from loggerhead.util import Reloader
36
32
from loggerhead.apps.error import ErrorHandlerApp
37
33
 
38
34
 
39
 
def get_config_and_path(args):
40
 
    config = LoggerheadConfig()
41
 
 
42
 
    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:
43
71
        print "loggerhead %s" % __version__
44
72
        sys.exit(0)
45
73
 
46
 
    if config.arg_count > 1:
47
 
        config.print_help()
48
 
        sys.exit(1)
49
 
    elif config.arg_count == 1:
50
 
        base = config.get_arg(0)
51
 
    else:
52
 
        base = '.'
53
 
 
54
 
    if not config.get_option('allow_writes'):
55
 
        base = 'readonly+' + base
56
 
 
57
 
    return config, base
58
 
 
59
 
 
60
 
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()
61
105
    logging.basicConfig()
62
106
    logging.getLogger('').setLevel(logging.DEBUG)
63
 
    logger = logging.getLogger('loggerhead')
64
 
    if config.get_option('log_folder'):
65
 
        logfile_path = os.path.join(
66
 
            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')
67
110
    else:
68
111
        logfile_path = 'serve-branches.log'
69
112
    logfile = logging.FileHandler(logfile_path, 'a')
72
115
    logfile.setFormatter(formatter)
73
116
    logfile.setLevel(logging.DEBUG)
74
117
    logger.addHandler(logfile)
75
 
    return logger
76
 
 
77
 
 
78
 
def make_app_for_config_and_path(config, base):
79
 
    if config.get_option('trunk_dir') and not config.get_option('user_dirs'):
80
 
        print "--trunk-dir is only valid with --user-dirs"
81
 
        sys.exit(1)
82
 
 
83
 
    if config.get_option('reload'):
84
 
        if Reloader.is_installed():
85
 
            Reloader.install()
86
 
        else:
87
 
            return Reloader.restart_with_reloader()
88
 
 
89
 
    if config.get_option('user_dirs'):
90
 
        if not config.get_option('trunk_dir'):
91
 
            print "You didn't specify a directory for the trunk directories."
92
 
            sys.exit(1)
93
 
        app = UserBranchesFromTransportRoot(base, config)
94
 
    else:
95
 
        app = BranchesFromTransportRoot(base, config)
96
 
 
97
 
    setup_logging(config)
98
 
 
99
 
    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:
100
123
        from loggerhead.middleware.profile import LSProfMiddleware
101
124
        app = LSProfMiddleware(app)
102
 
    if config.get_option('memory_profile'):
103
 
        from dozer import Dozer
104
 
        app = Dozer(app)
105
125
 
106
 
    if not config.get_option('user_prefix'):
 
126
    if not options.user_prefix:
107
127
        prefix = '/'
108
128
    else:
109
 
        prefix = config.get_option('user_prefix')
110
 
        if not prefix.startswith('/'):
111
 
            prefix = '/' + prefix
 
129
        prefix = options.user_prefix
112
130
 
113
131
    try:
114
132
        from paste.deploy.config import PrefixMiddleware
115
133
    except ImportError:
116
 
        cant_proxy_correctly_message = (
117
 
            'Unsupported configuration: PasteDeploy not available, but '
118
 
            'loggerhead appears to be behind a proxy.')
119
 
        def check_not_proxied(app):
120
 
            def wrapped(environ, start_response):
121
 
                if 'HTTP_X_FORWARDED_SERVER' in environ:
122
 
                    exc = HTTPInternalServerError()
123
 
                    exc.explanation = cant_proxy_correctly_message
124
 
                    raise exc
125
 
                return app(environ, start_response)
126
 
            return wrapped
127
 
        app = check_not_proxied(app)
 
134
        pass
128
135
    else:
129
136
        app = PrefixMiddleware(app, prefix=prefix)
130
137
 
131
 
    app = HTTPExceptionHandler(app)
132
 
    app = ErrorHandlerApp(app)
133
 
    app = TransLogger(app, logger=logging.getLogger('loggerhead'))
134
 
 
135
 
    return app
136
 
 
137
 
 
138
 
def main(args):
139
 
    load_plugins()
140
 
 
141
 
    config, path = get_config_and_path(args)
142
 
 
143
 
    app = make_app_for_config_and_path(config, path)
144
 
 
145
 
    if not config.get_option('user_port'):
 
138
    if not options.user_port:
146
139
        port = '8080'
147
140
    else:
148
 
        port = config.get_option('user_port')
 
141
        port = options.user_port
149
142
 
150
 
    if not config.get_option('user_host'):
 
143
    if not options.user_host:
151
144
        host = '0.0.0.0'
152
145
    else:
153
 
        host = config.get_option('user_host')
 
146
        host = options.user_host
154
147
 
155
148
    httpserver.serve(app, host=host, port=port)
 
149
 
 
150
 
 
151
if __name__ == "__main__":
 
152
    main(sys.argv)