← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to serve-branches

  • Committer: Martin Albisetti
  • Author(s): Jelmer Vernooij
  • Date: 2008-08-05 17:31:23 UTC
  • mfrom: (197.1.1 trunk)
  • Revision ID: argentina@gmail.com-20080805173123-srwhfyqbinpz2ol3
Add manual page for serve-branches

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
34
 
from loggerhead.util import Reloader
35
 
from loggerhead.apps.error import ErrorHandlerApp
36
 
 
37
 
 
38
 
def get_config_and_path(args):
39
 
    config = LoggerheadConfig(args)
40
 
 
41
 
    if config.get_option('show_version'):
 
29
from loggerhead.apps.filesystem import (
 
30
    BranchesFromFileSystemRoot, UserBranchesFromFileSystemRoot)
 
31
 
 
32
 
 
33
def command_line_parser():
 
34
    parser = OptionParser("%prog [options] <path>")
 
35
    parser.set_defaults(
 
36
        user_dirs=False,
 
37
        show_version=False,
 
38
        )
 
39
    parser.add_option("--user-dirs", action="store_true", dest="user_dirs",
 
40
                      help="Serve user directories as ~user.")
 
41
    parser.add_option("--trunk-dir", metavar="DIR",
 
42
                      help="The directory that contains the trunk branches.")
 
43
    parser.add_option("--version", action="store_true", dest="show_version",
 
44
                      help="Print the software version and exit")
 
45
    return parser
 
46
 
 
47
 
 
48
def main(args):
 
49
    logging.basicConfig()
 
50
    logging.getLogger().setLevel(logging.DEBUG)
 
51
 
 
52
    parser = command_line_parser()
 
53
    (options, args) = parser.parse_args(sys.argv[1:])
 
54
 
 
55
    if options.show_version:
42
56
        print "loggerhead %s" % __version__
43
57
        sys.exit(0)
44
58
 
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):
60
 
    logging.basicConfig()
61
 
    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')
66
 
    else:
67
 
        logfile_path = 'serve-branches.log'
68
 
    logfile = logging.FileHandler(logfile_path, 'a')
69
 
    formatter = logging.Formatter('%(asctime)s %(levelname)-8s %(name)s:'
70
 
                                  ' %(message)s')
71
 
    logfile.setFormatter(formatter)
72
 
    logfile.setLevel(logging.DEBUG)
73
 
    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'):
 
59
    if len(args) > 1:
 
60
        parser.print_help()
 
61
        sys.exit(1)
 
62
    elif len(args) == 1:
 
63
        [path] = args
 
64
    else:
 
65
        path = '.'
 
66
 
 
67
    if not os.path.isdir(path):
 
68
        print "%s is not a directory" % path
 
69
        sys.exit(1)
 
70
 
 
71
    if options.trunk_dir and not options.user_dirs:
79
72
        print "--trunk-dir is only valid with --user-dirs"
80
73
        sys.exit(1)
81
74
 
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'):
 
75
    if options.user_dirs:
 
76
        if not options.trunk_dir:
90
77
            print "You didn't specify a directory for the trunk directories."
91
78
            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'):
99
 
        from loggerhead.middleware.profile import LSProfMiddleware
100
 
        app = LSProfMiddleware(app)
101
 
    if config.get_option('memory_profile'):
102
 
        from dozer import Dozer
103
 
        app = Dozer(app)
104
 
 
105
 
    if not config.get_option('user_prefix'):
106
 
        prefix = '/'
107
 
    else:
108
 
        prefix = config.get_option('user_prefix')
109
 
        if not prefix.startswith('/'):
110
 
            prefix = '/' + prefix
 
79
        app = UserBranchesFromFileSystemRoot(path, options.trunk_dir)
 
80
    else:
 
81
        app = BranchesFromFileSystemRoot(path)
 
82
    app = HTTPExceptionHandler(app)
 
83
    app = TransLogger(app)
111
84
 
112
85
    try:
113
86
        from paste.deploy.config import PrefixMiddleware
114
87
    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)
127
 
    else:
128
 
        app = PrefixMiddleware(app, prefix=prefix)
129
 
 
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'):
145
 
        port = '8080'
146
 
    else:
147
 
        port = config.get_option('user_port')
148
 
 
149
 
    if not config.get_option('user_host'):
150
 
        host = '0.0.0.0'
151
 
    else:
152
 
        host = config.get_option('user_host')
153
 
 
154
 
    httpserver.serve(app, host=host, port=port)
 
88
        pass
 
89
    else:
 
90
        app = PrefixMiddleware(app)
 
91
 
 
92
    httpserver.serve(app, host='0.0.0.0', port='8080')
 
93
 
 
94
 
 
95
if __name__ == "__main__":
 
96
    main(sys.argv)