switch from ddportfolio to debianmemberportfolio
[debianmemberportfolio.git] / debianmemberportfolio / config / middleware.py
1 # -*- python -*-
2 # -*- coding: utf-8 -*-
3 #
4 # Debian Member Portfolio Service middleware configuration
5 #
6 # Copyright © 2009-2014 Jan Dittberner <jan@dittberner.info>
7 #
8 # This file is part of the Debian Member Portfolio Service.
9 #
10 # Debian Member Portfolio Service is free software: you can redistribute it
11 # and/or modify it under the terms of the GNU Affero General Public License as
12 # published by the Free Software Foundation, either version 3 of the License,
13 # or (at your option) any later version.
14 #
15 # Debian Member Portfolio Service is distributed in the hope that it will be
16 # useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero
18 # General Public License for more details.
19 #
20 # You should have received a copy of the GNU Affero General Public License
21 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
22 #
23 """
24 Pylons middleware initialization
25
26 """
27
28 from beaker.middleware import SessionMiddleware
29 from paste.cascade import Cascade
30 from paste.registry import RegistryManager
31 from paste.urlparser import StaticURLParser
32 from paste.deploy.converters import asbool
33 from pylons.middleware import ErrorHandler, StatusCodeRedirect
34 from pylons.wsgiapp import PylonsApp
35 from routes.middleware import RoutesMiddleware
36
37 from debianmemberportfolio.config.environment import load_environment
38
39
40 def make_app(global_conf, full_stack=True, static_files=True, **app_conf):
41     """
42     Create a Pylons WSGI application and return it
43
44     ``global_conf``
45         The inherited configuration for this application. Normally from
46         the [DEFAULT] section of the Paste ini file.
47
48     ``full_stack``
49         Whether this application provides a full WSGI stack (by default,
50         meaning it handles its own exceptions and errors). Disable
51         full_stack when this application is "managed" by another WSGI
52         middleware.
53
54     ``static_files``
55         Whether this application serves its own static files; disable
56         when another web server is responsible for serving them.
57
58     ``app_conf``
59         The application's local configuration. Normally specified in
60         the [app:<name>] section of the Paste ini file (where <name>
61         defaults to main).
62
63     """
64     # Configure the Pylons environment
65     config = load_environment(global_conf, app_conf)
66
67     # The Pylons WSGI app
68     app = PylonsApp(config=config)
69
70     # Routing/Session/Cache Middleware
71     app = RoutesMiddleware(app, config['routes.map'])
72     app = SessionMiddleware(app, config)
73
74     # CUSTOM MIDDLEWARE HERE (filtered by error handling middlewares)
75
76     if asbool(full_stack):
77         # Handle Python exceptions
78         app = ErrorHandler(app, global_conf, **config['pylons.errorware'])
79
80         # Display error documents for 401, 403, 404 status codes (and
81         # 500 when debug is disabled)
82         if asbool(config['debug']):
83             app = StatusCodeRedirect(app)
84         else:
85             app = StatusCodeRedirect(app, [400, 401, 403, 404, 500])
86
87     # Establish the Registry for this application
88     app = RegistryManager(app)
89
90     if asbool(static_files):
91         # Serve static files
92         static_app = StaticURLParser(config['pylons.paths']['static_files'])
93         app = Cascade([static_app, app])
94     app.config = config
95     return app