summaryrefslogtreecommitdiff
path: root/repoze/bfg/router.py
blob: cd040c0c87bc1f42663e63b3090755fd7d03c663 (plain)
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
from cgi import escape

from zope.component import getAdapter
from zope.component import queryUtility
from zope.component.event import dispatch
from zope.interface import directlyProvides
from zope.interface import implements

from webob import Request
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 ITraverserFactory
from repoze.bfg.interfaces import IRequest
from repoze.bfg.interfaces import IRouter
from repoze.bfg.interfaces import ISettings

from repoze.bfg.registry import registry_manager
from repoze.bfg.registry import makeRegistry

from repoze.bfg.view import render_view_to_response
from repoze.bfg.view import view_execution_permitted

_marker = ()

class Router(object):
    """ WSGI application which routes requests to 'view' code based on
    a view registry"""

    implements(IRouter)
    
    def __init__(self, root_policy, registry):
        self.root_policy = root_policy
        self.registry = registry

    def __call__(self, environ, start_response):
        registry_manager.set(self.registry)
        request = Request(environ)
        directlyProvides(request, IRequest)
        dispatch(NewRequest(request))
        root = self.root_policy(environ)
        traverser = getAdapter(root, ITraverserFactory)
        settings = queryUtility(ISettings)
        context, name, subpath = traverser(environ)

        request.context = context
        request.view_name = name
        request.subpath = subpath

        permitted = view_execution_permitted(context, request, name)
        debug_authorization = settings and settings.debug_authorization

        if debug_authorization:
            logger = queryUtility(ILogger, 'repoze.bfg.debug')
            logger and logger.debug(
                'debug_authorization of url %s (view name %r against context '
                '%r): %s' % (request.url, 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, name,
                                           secure=False)

        if response is None:
            debug_notfound = settings and settings.debug_notfound
            if debug_notfound:
                logger = 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, name, subpath)
                    )
                logger and logger.debug(msg)
            else:
                msg = request.url
            app = HTTPNotFound(escape(msg))
            return app(environ, start_response)

        dispatch(NewResponse(response))

        start_response(response.status, response.headerlist)
        return response.app_iter

def make_app(root_policy, package=None, filename='configure.zcml',
             options=None):
    """ Create a view registry based on the application's ZCML.  and
    return a Router object, representing a ``repoze.bfg`` WSGI
    application.  ``root_policy`` must be a callable that accepts a
    WSGI environment and returns a graph 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
    view registry.  ``options``, if used, should be a dictionary
    containing bfg-specific runtime options, with each key
    representing the option and the key's value representing the
    specific option value, e.g. ``{'reload_templates':True}``"""
    registry = makeRegistry(filename, package, options)
    app = Router(root_policy, registry)

    try:
        registry_manager.set(registry)
        dispatch(WSGIApplicationCreatedEvent(app))
    finally:
        registry_manager.clear()

    return app