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