1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
import sys
from cgi import escape
from zope.component.event import dispatch
from zope.interface import implements
from webob.exc import HTTPNotFound
from webob.exc import HTTPUnauthorized
from repoze.bfg.events import NewRequest
from repoze.bfg.events import NewResponse
from repoze.bfg.events import WSGIApplicationCreatedEvent
from repoze.bfg.interfaces import ILogger
from repoze.bfg.interfaces import IRequestFactory
from repoze.bfg.interfaces import IRootFactory
from repoze.bfg.interfaces import IRouter
from repoze.bfg.interfaces import IRoutesMapper
from repoze.bfg.interfaces import ITraverserFactory
from repoze.bfg.interfaces import ISettings
from repoze.bfg.log import make_stream_logger
from repoze.bfg.registry import Registry
from repoze.bfg.registry import registry_manager
from repoze.bfg.registry import populateRegistry
from repoze.bfg.request import HTTP_METHOD_FACTORIES
from repoze.bfg.request import Request
from repoze.bfg.settings import Settings
from repoze.bfg.urldispatch import RoutesRootFactory
from repoze.bfg.view import render_view_to_response
from repoze.bfg.view import view_execution_permitted
_marker = ()
class Router(object):
""" The main repoze.bfg WSGI application. """
implements(IRouter)
def __init__(self, registry):
self.registry = registry
@property
def root_policy(self):
""" Backwards compatibility alias """
return self.registry.getUtility(IRootFactory)
def __call__(self, environ, start_response):
"""
Accept ``environ`` and ``start_response``; route requests to
'view' code based on registrations within the application
registry; call ``start_response`` and return an iterable.
"""
reg = self.registry
registry_manager.push(reg)
try:
request_factory = reg.queryUtility(IRequestFactory)
if request_factory is None:
method = environ.get('REQUEST_METHOD', 'GET')
request_factory = HTTP_METHOD_FACTORIES.get(method, Request)
request = request_factory(environ)
reg.notify(NewRequest(request))
root_factory = reg.getUtility(IRootFactory)
root = root_factory(environ)
traverser = reg.getAdapter(root, ITraverserFactory)
context, view_name, subpath = traverser(environ)
# XXX webob.Request's __setattr__ is slow here: investigate.
request.root = root
request.context = context
request.view_name = view_name
request.subpath = subpath
permitted = view_execution_permitted(context, request, view_name)
settings = reg.queryUtility(ISettings)
debug_authorization = settings and settings.debug_authorization
logger = None
if debug_authorization:
logger = reg.queryUtility(ILogger, 'repoze.bfg.debug')
logger and logger.debug(
'debug_authorization of url %s (view name %r against '
'context %r): %s' % (
request.url, view_name, context, permitted.msg)
)
if not permitted:
if debug_authorization:
msg = permitted.msg
else:
msg = 'Unauthorized: failed security policy check'
app = HTTPUnauthorized(escape(msg))
return app(environ, start_response)
response = render_view_to_response(context, request, view_name,
secure=False)
if response is None:
debug_notfound = settings and settings.debug_notfound
if debug_notfound:
if logger is None:
logger = reg.queryUtility(ILogger, 'repoze.bfg.debug')
msg = (
'debug_notfound of url %s; path_info: %r, context: %r, '
'view_name: %r, subpath: %r' % (
request.url, request.path_info, context, view_name,
subpath)
)
logger and logger.debug(msg)
else:
msg = request.url
app = HTTPNotFound(escape(msg))
return app(environ, start_response)
reg.notify(NewResponse(response))
start_response(response.status, response.headerlist)
return response.app_iter
finally:
registry_manager.pop()
def make_app(root_factory, package=None, filename='configure.zcml',
options=None):
""" Return a Router object, representing a ``repoze.bfg`` WSGI
application. ``root_factory`` must be a callable that accepts a
WSGI environment and returns a root object. ``package`` is a
Python module representing the application's package, ``filename``
is the filesystem path to a ZCML file (optionally relative to the
package path) that should be parsed to create the application
registry. ``options``, if used, should be a dictionary containing
runtime options (e.g. the key/value pairs in an app section of a
PasteDeploy file), with each key representing the option and the
key's value representing the specific option value,
e.g. ``{'reload_templates':True}``"""
if options is None:
options = {}
regname = filename
if package:
regname = package.__name__
registry = Registry(regname)
debug_logger = make_stream_logger('repoze.bfg.debug', sys.stderr)
registry.registerUtility(debug_logger, ILogger, 'repoze.bfg.debug')
settings = Settings(options)
registry.registerUtility(settings, ISettings)
mapper = RoutesRootFactory(root_factory)
registry.registerUtility(mapper, IRoutesMapper)
populateRegistry(registry, filename, package)
if mapper.has_routes():
# if the user had any <route/> statements in his configuration,
# use the RoutesRootFactory as the root factory
root_factory = mapper
else:
# otherwise, use only the supplied root_factory (unless it's None)
if root_factory is None:
raise ValueError(
'root_factory (aka get_root) was None and no routes connected')
registry.registerUtility(root_factory, IRootFactory)
app = Router(registry)
# We push the registry on to the stack here in case any ZCA API is
# used in listeners subscribed to the WSGIApplicationCreatedEvent
# we send.
registry_manager.push(registry)
try:
# use dispatch here instead of registry.notify to make unit
# tests possible
dispatch(WSGIApplicationCreatedEvent(app))
finally:
registry_manager.pop()
return app
|
