← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

  • Committer: William Grant
  • Date: 2009-05-28 02:43:56 UTC
  • Revision ID: grantw@unimelb.edu.au-20090528024356-mlrhizz7omnr71hd
Test ivle.mimetypes.nice_filetype.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
22
22
Apache send all requests to be handled by the module 'dispatch'.
23
23
 
24
24
Top-level handler. Handles all requests to all pages in IVLE.
25
 
Handles authentication (not authorization).
26
 
Then passes the request along to the appropriate ivle app.
 
25
Handles authentication and delegates to views for authorization,
 
26
then passes the request along to the appropriate view.
27
27
"""
28
28
 
29
29
import sys
40
40
import routes
41
41
 
42
42
from ivle import util
43
 
import ivle.conf
44
 
import ivle.conf.apps
 
43
import ivle.config
45
44
from ivle.dispatch.request import Request
46
 
from ivle.dispatch import login
 
45
import ivle.webapp.security
47
46
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
48
 
from ivle.webapp.errors import HTTPError, Unauthorized
49
 
import apps
50
 
import html
51
 
 
52
 
def generate_route_mapper(view_plugins, attr):
 
47
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
 
48
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
 
49
 
 
50
config = ivle.config.Config()
 
51
 
 
52
def generate_router(view_plugins, attr):
53
53
    """
54
54
    Build a Mapper object for doing URL matching using 'routes', based on the
55
55
    given plugin registry.
65
65
            m.connect(routex, view=view_class, **kwargs_dict)
66
66
    return m
67
67
 
68
 
def handler(req):
69
 
    """Handles a request which may be to anywhere in the site except media.
 
68
def handler(apachereq):
 
69
    """Handles an HTTP request.
 
70
 
70
71
    Intended to be called by mod_python, as a handler.
71
72
 
72
 
    req: An Apache request object.
73
 
    """
74
 
    # Make the request object into an IVLE request which can be passed to apps
75
 
    apachereq = req
76
 
    try:
77
 
        req = Request(req, html.write_html_head)
78
 
    except Exception:
79
 
        # Pass the apachereq to error reporter, since ivle req isn't created
80
 
        # yet.
81
 
        handle_unknown_exception(apachereq, *sys.exc_info())
82
 
        # Tell Apache not to generate its own errors as well
83
 
        return mod_python.apache.OK
84
 
 
85
 
    # Run the main handler, and catch all exceptions
86
 
    try:
87
 
        return handler_(req, apachereq)
88
 
    except mod_python.apache.SERVER_RETURN:
89
 
        # An apache error. We discourage these, but they might still happen.
90
 
        # Just raise up.
91
 
        raise
92
 
    except Exception:
93
 
        handle_unknown_exception(req, *sys.exc_info())
94
 
        # Tell Apache not to generate its own errors as well
95
 
        return mod_python.apache.OK
96
 
 
97
 
def handler_(req, apachereq):
98
 
    """
99
 
    Nested handler function. May raise exceptions. The top-level handler is
100
 
    just used to catch exceptions.
101
 
    Takes both an IVLE request and an Apache req.
102
 
    """
 
73
    @param apachereq: An Apache request object.
 
74
    """
 
75
    # Make the request object into an IVLE request which can be given to views
 
76
    req = Request(apachereq, config)
 
77
 
103
78
    # Hack? Try and get the user login early just in case we throw an error
104
79
    # (most likely 404) to stop us seeing not logged in even when we are.
105
80
    if not req.publicmode:
106
 
        user = login.get_user_details(req)
 
81
        user = ivle.webapp.security.get_user_details(req)
107
82
 
108
83
        # Don't set the user if it is disabled or hasn't accepted the ToS.
109
84
        if user and user.valid:
110
85
            req.user = user
111
86
 
112
 
    conf = ivle.config.Config()
113
 
    req.config = conf
114
 
 
115
 
    ### BEGIN New plugins framework ###
116
87
    if req.publicmode:
117
 
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
118
 
                                           'public_urls')
 
88
        req.mapper = generate_router(config.plugin_index[PublicViewPlugin],
 
89
                                    'public_urls')
119
90
    else:
120
 
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
121
 
                                           'urls')
 
91
        req.mapper = generate_router(config.plugin_index[ViewPlugin], 'urls')
122
92
 
123
93
    matchdict = req.mapper.match(req.uri)
124
94
    if matchdict is not None:
145
115
            if hasattr(viewcls, 'get_error_view'):
146
116
                errviewcls = viewcls.get_error_view(e)
147
117
            else:
148
 
                errviewcls = None
 
118
                errviewcls = XHTMLView.get_error_view(e)
149
119
 
150
120
            if errviewcls:
151
121
                errview = errviewcls(req, e)
156
126
                return req.OK
157
127
            else:
158
128
                return e.code
 
129
        except mod_python.apache.SERVER_RETURN:
 
130
            # A mod_python-specific Apache error.
 
131
            # XXX: We need to raise these because req.throw_error() uses them.
 
132
            # Remove this after Google Code issue 117 is fixed.
 
133
            raise
159
134
        except Exception, e:
160
135
            # A non-HTTPError appeared. We have an unknown exception. Panic.
161
136
            handle_unknown_exception(req, *sys.exc_info())
164
139
            req.store.commit()
165
140
            return req.OK
166
141
    else:
167
 
        # We had no matching URL! Check if it matches an old-style app. If
168
 
        # not, 404.
169
 
        if req.app not in ivle.conf.apps.app_url:
170
 
            return req.HTTP_NOT_FOUND # TODO: Prettify.
171
 
    ### END New plugins framework ###
172
 
 
173
 
 
174
 
    ### BEGIN legacy application framework ###
175
 
    # We have no public apps back here.
176
 
    assert not req.publicmode
177
 
 
178
 
    # app is the App object for the chosen app
179
 
    if req.app is None:
180
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
181
 
    else:
182
 
        app = ivle.conf.apps.app_url[req.app]
183
 
 
184
 
    # Check if app requires auth. If so, perform authentication and login.
185
 
    # This will either return a User object, None, or perform a redirect
186
 
    # which we will not catch here.
187
 
    if app.requireauth:
188
 
        logged_in = req.user is not None
189
 
    else:
190
 
        logged_in = True
191
 
 
192
 
    assert logged_in # XXX
193
 
 
194
 
    if logged_in:
195
 
        # Keep the user's session alive by writing to the session object.
196
 
        # req.get_session().save()
197
 
        # Well, it's a fine idea, but it creates considerable grief in the
198
 
        # concurrent update department, so instead, we'll just make the
199
 
        # sessions not time out.
200
 
        req.get_session().unlock()
201
 
 
202
 
        # Call the specified app with the request object
203
 
        apps.call_app(app.dir, req)
204
 
 
205
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
206
 
    # wouldn't happen if nothing else ever got written, so we have to make
207
 
    # sure.
208
 
    req.ensure_headers_written()
209
 
 
210
 
    # When done, write out the HTML footer if the app has requested it
211
 
    if req.write_html_head_foot:
212
 
        html.write_html_foot(req)
213
 
 
214
 
    # Note: Apache will not write custom HTML error messages here.
215
 
    # Use req.throw_error to do that.
216
 
    return req.OK
 
142
        XHTMLErrorView(req, NotFound()).render(req)
 
143
        return req.OK
217
144
 
218
145
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
219
146
    """
222
149
    This is a full handler. It assumes nothing has been written, and writes a
223
150
    complete HTML page.
224
151
    req: May be EITHER an IVLE req or an Apache req.
225
 
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
226
 
    the handler code may pass an apache req if an exception occurs before
 
152
    The handler code may pass an apache req if an exception occurs before
227
153
    the IVLE request is created.
228
154
    """
229
155
    req.content_type = "text/html"
230
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
 
156
    logfile = os.path.join(config['paths']['logs'], 'ivle_error.log')
231
157
    logfail = False
232
 
    # For some reason, some versions of mod_python have "_server" instead of
233
 
    # "main_server". So we check for both.
234
 
    try:
235
 
        admin_email = mod_python.apache.main_server.server_admin
236
 
    except AttributeError:
237
 
        try:
238
 
            admin_email = mod_python.apache._server.server_admin
239
 
        except AttributeError:
240
 
            admin_email = ""
241
158
    try:
242
159
        httpcode = exc_value.httpcode
243
160
        req.status = httpcode
252
169
        login = req.user.login
253
170
    except AttributeError:
254
171
        login = None
255
 
    try:
256
 
        role = req.user.role
257
 
    except AttributeError:
258
 
        role = None
259
172
 
260
173
    # Log File
261
174
    try:
271
184
            filemode='a')
272
185
    except IOError:
273
186
        logfail = True
274
 
    logging.debug('Logging Unhandled Exception')
275
 
 
276
 
    # We handle 3 types of error.
277
 
    # IVLEErrors with 4xx response codes (client error).
278
 
    # IVLEErrors with 5xx response codes (handled server error).
279
 
    # Other exceptions (unhandled server error).
280
 
    # IVLEErrors should not have other response codes than 4xx or 5xx
281
 
    # (eg. throw_redirect should have been used for 3xx codes).
282
 
    # Therefore, that is treated as an unhandled error.
283
 
 
284
 
    if (exc_type == util.IVLEError and httpcode >= 400
285
 
        and httpcode <= 499):
286
 
        # IVLEErrors with 4xx response codes are client errors.
287
 
        # Therefore, these have a "nice" response (we even coat it in the IVLE
288
 
        # HTML wrappers).
289
 
        
290
 
        req.write_html_head_foot = True
291
 
        req.write_javascript_settings = False
292
 
        req.write('<div id="ivle_padding">\n')
 
187
 
 
188
    # A "bad" error message. We shouldn't get here unless IVLE
 
189
    # misbehaves (which is currently very easy, if things aren't set up
 
190
    # correctly).
 
191
    # Write the traceback.
 
192
    # If this is a non-4xx IVLEError, get the message and httpcode and
 
193
    # make the error message a bit nicer (but still include the
 
194
    # traceback).
 
195
    # We also need to special-case IVLEJailError, as we can get another
 
196
    # almost-exception out of it.
 
197
 
 
198
    codename, msg = None, None
 
199
 
 
200
    if exc_type is util.IVLEJailError:
 
201
        msg = exc_value.type_str + ": " + exc_value.message
 
202
        tb = 'Exception information extracted from IVLEJailError:\n'
 
203
        tb += urllib.unquote(exc_value.info)
 
204
    else:
293
205
        try:
294
206
            codename, msg = req.get_http_codename(httpcode)
295
207
        except AttributeError:
296
 
            codename, msg = None, None
297
 
        # Override the default message with the supplied one,
298
 
        # if available.
299
 
        if exc_value.message is not None:
300
 
            msg = exc_value.message
301
 
        if codename is not None:
302
 
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
303
 
        else:
304
 
            req.write("<h1>Error</h1>\n")
305
 
        if msg is not None:
306
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
307
 
        else:
308
 
            req.write("<p>An unknown error occured.</p>\n")
309
 
        
310
 
        # Logging
311
 
        logging.info(str(msg))
312
 
        
313
 
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
314
 
        if logfail:
315
 
            req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
316
 
                %cgi.escape(logfile))
317
 
        req.write('</div>\n')
318
 
        html.write_html_foot(req)
319
 
    else:
320
 
        # A "bad" error message. We shouldn't get here unless IVLE
321
 
        # misbehaves (which is currently very easy, if things aren't set up
322
 
        # correctly).
323
 
        # Write the traceback.
324
 
        # If this is a non-4xx IVLEError, get the message and httpcode and
325
 
        # make the error message a bit nicer (but still include the
326
 
        # traceback).
327
 
        # We also need to special-case IVLEJailError, as we can get another
328
 
        # almost-exception out of it.
329
 
 
330
 
        codename, msg = None, None
331
 
 
332
 
        if exc_type is util.IVLEJailError:
333
 
            msg = exc_value.type_str + ": " + exc_value.message
334
 
            tb = 'Exception information extracted from IVLEJailError:\n'
335
 
            tb += urllib.unquote(exc_value.info)
336
 
        else:
337
 
            try:
338
 
                codename, msg = req.get_http_codename(httpcode)
339
 
            except AttributeError:
340
 
                pass
341
 
            # Override the default message with the supplied one,
342
 
            # if available.
343
 
            if hasattr(exc_value, 'message') and exc_value.message is not None:
344
 
                msg = exc_value.message
345
 
                # Prepend the exception type
346
 
                if exc_type != util.IVLEError:
347
 
                    msg = exc_type.__name__ + ": " + repr(msg)
348
 
 
349
 
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
350
 
                                                    exc_traceback))
351
 
 
352
 
        # Logging
353
 
        logging.error('%s\n%s'%(str(msg), tb))
354
 
        # Error messages are only displayed is the user is NOT a student,
355
 
        # or if there has been a problem logging the error message
356
 
        show_errors = (not publicmode) and ((login and \
357
 
                            str(role) != "student") or logfail)
358
 
        req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
 
208
            pass
 
209
 
 
210
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
211
                                                exc_traceback))
 
212
 
 
213
    logging.error('%s\n%s'%(str(msg), tb))
 
214
 
 
215
    # Error messages are only displayed is the user is NOT a student,
 
216
    # or if there has been a problem logging the error message
 
217
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
 
218
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
359
219
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
360
220
<html xmlns="http://www.w3.org/1999/xhtml">
361
221
<head><title>IVLE Internal Server Error</title></head>
362
222
<body>
363
223
<h1>IVLE Internal Server Error""")
364
 
        if (show_errors):
365
 
            if (codename is not None
366
 
                        and httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR):
367
 
                req.write(": %s" % cgi.escape(codename))
368
 
        
369
 
        req.write("""</h1>
 
224
    if show_errors:
 
225
        if codename is not None and \
 
226
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
 
227
            req.write(": %s" % cgi.escape(codename))
 
228
 
 
229
    req.write("""</h1>
370
230
<p>An error has occured which is the fault of the IVLE developers or
371
 
administration. The developers have been notified.</p>
372
 
""")
373
 
        if (show_errors):
374
 
            if msg is not None:
375
 
                req.write("<p>%s</p>\n" % cgi.escape(msg))
376
 
            if httpcode is not None:
377
 
                req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
378
 
            req.write("""
379
 
    <p>Please report this to <a href="mailto:%s">%s</a> (the system
380
 
    administrator). Include the following information:</p>
381
 
    """ % (cgi.escape(admin_email), cgi.escape(admin_email)))
382
 
 
383
 
            req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
384
 
            if logfail:
385
 
                req.write("<p>Warning: Could not open Error Log: '%s'</p>\n"
386
 
                    %cgi.escape(logfile))
387
 
        req.write("</body></html>")
 
231
administrators. """)
 
232
 
 
233
    if logfail:
 
234
        req.write("Please report this issue to the server administrators, "
 
235
                  "along with the following information.")
 
236
    else:
 
237
        req.write("Details have been logged for further examination.")
 
238
    req.write("</p>")
 
239
 
 
240
    if show_errors:
 
241
        if msg is not None:
 
242
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
243
        if httpcode is not None:
 
244
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
245
        req.write("<h2>Debugging information</h2>")
 
246
 
 
247
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
 
248
    req.write("</body></html>")