~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

  • Committer: Matt Giuca
  • Date: 2009-03-24 03:14:44 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: matt.giuca@gmail.com-20090324031444-dbpn1bj6dr4zh4sx
Added auto-generated (and hand-modified) Sphinx files (conf, Makefile and
    index).
    Our IVLE documentation will be stored as Sphinx files.
    make html to generate the documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
37
37
import time
38
38
 
39
39
import mod_python
 
40
import routes
40
41
 
41
42
from ivle import util
42
 
import ivle.config
 
43
import ivle.conf
43
44
from ivle.dispatch.request import Request
44
45
import ivle.webapp.security
45
46
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
46
47
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
47
48
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
48
 
from ivle.webapp.routing import Router, RoutingError
49
 
from ivle.webapp import ApplicationRoot
50
 
 
51
 
config = ivle.config.Config()
52
 
 
53
 
def generate_router(view_plugins, root):
 
49
 
 
50
def generate_route_mapper(view_plugins, attr):
54
51
    """
55
52
    Build a Mapper object for doing URL matching using 'routes', based on the
56
53
    given plugin registry.
57
54
    """
58
 
    r = Router(root=root)
59
 
 
60
 
    r.add_set_switch('api', 'api')
61
 
 
 
55
    m = routes.Mapper(explicit=True)
62
56
    for plugin in view_plugins:
63
 
        if hasattr(plugin, 'forward_routes'):
64
 
            for fr in plugin.forward_routes:
65
 
                # An annotated function can also be passed in directly.
66
 
                if hasattr(fr, '_forward_route_meta'):
67
 
                    r.add_forward_func(fr)
68
 
                else:
69
 
                    r.add_forward(*fr)
70
 
 
71
 
        if hasattr(plugin, 'reverse_routes'):
72
 
            for rr in plugin.reverse_routes:
73
 
                # An annotated function can also be passed in directly.
74
 
                if hasattr(rr, '_reverse_route_src'):
75
 
                    r.add_reverse_func(rr)
76
 
                else:
77
 
                    r.add_reverse(*rr)
78
 
 
79
 
        if hasattr(plugin, 'views'):
80
 
            for v in plugin.views:
81
 
                r.add_view(*v)
82
 
 
83
 
    return r
 
57
        # Establish a URL pattern for each element of plugin.urls
 
58
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
 
59
        for url in getattr(plugin, attr):
 
60
            routex = url[0]
 
61
            view_class = url[1]
 
62
            kwargs_dict = url[2] if len(url) >= 3 else {}
 
63
            m.connect(routex, view=view_class, **kwargs_dict)
 
64
    return m
84
65
 
85
66
def handler(apachereq):
86
67
    """Handles an HTTP request.
90
71
    @param apachereq: An Apache request object.
91
72
    """
92
73
    # Make the request object into an IVLE request which can be given to views
93
 
    req = Request(apachereq, config)
 
74
    req = Request(apachereq)
94
75
 
95
76
    # Hack? Try and get the user login early just in case we throw an error
96
77
    # (most likely 404) to stop us seeing not logged in even when we are.
101
82
        if user and user.valid:
102
83
            req.user = user
103
84
 
 
85
    conf = ivle.config.Config()
 
86
    req.config = conf
 
87
 
104
88
    if req.publicmode:
105
 
        raise NotImplementedError("no public mode with obtrav yet!")
106
 
 
107
 
    req.router = generate_router(config.plugin_index[ViewPlugin],
108
 
                                 ApplicationRoot(req.config, req.store))
109
 
 
110
 
    try:
111
 
        obj, viewcls, subpath = req.router.resolve(req.uri.decode('utf-8'))
 
89
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
 
90
                                           'public_urls')
 
91
    else:
 
92
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
 
93
                                           'urls')
 
94
 
 
95
    matchdict = req.mapper.match(req.uri)
 
96
    if matchdict is not None:
 
97
        viewcls = matchdict['view']
 
98
        # Get the remaining arguments, less 'view', 'action' and 'controller'
 
99
        # (The latter two seem to be built-in, and we don't want them).
 
100
        kwargs = matchdict.copy()
 
101
        del kwargs['view']
112
102
        try:
113
 
            # We 404 if we have a subpath but the view forbids it.
114
 
            if not viewcls.subpath_allowed and subpath:
115
 
                raise NotFound()
116
 
 
117
103
            # Instantiate the view, which should be a BaseView class
118
 
            view = viewcls(req, obj, subpath)
 
104
            view = viewcls(req, **kwargs)
119
105
 
120
106
            # Check that the request (mainly the user) is permitted to access
121
107
            # the view.
154
140
        else:
155
141
            req.store.commit()
156
142
            return req.OK
157
 
    except RoutingError, e:
158
 
        if req.user.admin:
159
 
            XHTMLErrorView(req, NotFound('Not found: ' +
160
 
                                         str(e.args))).render(req)
161
 
        else:
162
 
            XHTMLErrorView(req, NotFound()).render(req)
163
 
 
 
143
    else:
 
144
        XHTMLErrorView(req, NotFound()).render(req)
164
145
        return req.OK
165
146
 
166
147
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
174
155
    the IVLE request is created.
175
156
    """
176
157
    req.content_type = "text/html"
177
 
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
 
158
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
178
159
    logfail = False
179
 
 
180
 
    # XXX: This remains here for ivle.interpret's IVLEErrors. Once we rewrite
181
 
    #      fileservice, req.status should always be 500 (ISE) here.
182
160
    try:
183
161
        httpcode = exc_value.httpcode
184
162
        req.status = httpcode
185
163
    except AttributeError:
186
164
        httpcode = None
187
165
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
188
 
 
189
166
    try:
190
167
        publicmode = req.publicmode
191
168
    except AttributeError:
214
191
    # misbehaves (which is currently very easy, if things aren't set up
215
192
    # correctly).
216
193
    # Write the traceback.
217
 
 
218
 
    # We need to special-case IVLEJailError, as we can get another
 
194
    # If this is a non-4xx IVLEError, get the message and httpcode and
 
195
    # make the error message a bit nicer (but still include the
 
196
    # traceback).
 
197
    # We also need to special-case IVLEJailError, as we can get another
219
198
    # almost-exception out of it.
 
199
 
 
200
    codename, msg = None, None
 
201
 
220
202
    if exc_type is util.IVLEJailError:
 
203
        msg = exc_value.type_str + ": " + exc_value.message
221
204
        tb = 'Exception information extracted from IVLEJailError:\n'
222
205
        tb += urllib.unquote(exc_value.info)
223
206
    else:
 
207
        try:
 
208
            codename, msg = req.get_http_codename(httpcode)
 
209
        except AttributeError:
 
210
            pass
 
211
 
224
212
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
225
213
                                                exc_traceback))
226
214
 
227
 
    logging.error('\n' + tb)
 
215
    logging.error('%s\n%s'%(str(msg), tb))
228
216
 
229
217
    # Error messages are only displayed is the user is NOT a student,
230
218
    # or if there has been a problem logging the error message
234
222
<html xmlns="http://www.w3.org/1999/xhtml">
235
223
<head><title>IVLE Internal Server Error</title></head>
236
224
<body>
237
 
<h1>IVLE Internal Server Error</h1>
 
225
<h1>IVLE Internal Server Error""")
 
226
    if show_errors:
 
227
        if codename is not None and \
 
228
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
 
229
            req.write(": %s" % cgi.escape(codename))
 
230
 
 
231
    req.write("""</h1>
238
232
<p>An error has occured which is the fault of the IVLE developers or
239
233
administrators. """)
240
234
 
246
240
    req.write("</p>")
247
241
 
248
242
    if show_errors:
 
243
        if msg is not None:
 
244
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
245
        if httpcode is not None:
 
246
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
249
247
        req.write("<h2>Debugging information</h2>")
 
248
 
250
249
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
251
250
    req.write("</body></html>")