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

« back to all changes in this revision

Viewing changes to www/dispatch/__init__.py

  • Committer: mattgiuca
  • Date: 2008-02-22 00:53:35 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:540
Refactored error handling and reporting. Much friendlier error messages, for
both developers and users.

Note that PythonDebug is now going to be ignored. IVLE itself selects when to
display a traceback. (So IVLE will display tracebacks even in a production
environment, for internal server errors).

common/util.py: Added class IVLEError, which is now used for throwing
user-readable errors inside IVLE instead of throwing apache SERVER_RETURN
exceptions.

dispatch/request: throw_error now throws an IVLEError instead of a
SERVER_RETURN. It also takes a new argument, "message", which can be used to
place an optional message inside the exception which will be displayed to the
user.
Finally, added a method get_http_codename which returns the name and
description of common HTTP error codes. (Used to report errors which don't
have a message supplied).

dispatch/__init__: Added a wrapper around handler which catches all exceptions
thrown out of IVLE.
The handler for this selectively handles exceptions.
4xx level exceptions thrown are user errors, so these are reported in a very
friendly way, with no traceback, and in the familiar IVLE environment.
5xx level exceptions and any other exceptions are reported in a minimal
environment (to avoid cascading errors) with a traceback and a request for the
user to report it to the administrators.

As many calls to req.throw_error as possible should now have a message
included, to make identifying errors easier.

Show diffs side-by-side

added added

removed removed

Lines of Context:
29
29
import mod_python
30
30
from mod_python import apache
31
31
 
 
32
import sys
32
33
import os
33
34
import os.path
34
35
import conf
39
40
import html
40
41
import login
41
42
from common import (util, forumutil)
 
43
import traceback
 
44
import cStringIO
42
45
 
43
46
def handler(req):
44
47
    """Handles a request which may be to anywhere in the site except media.
48
51
    """
49
52
    # Make the request object into an IVLE request which can be passed to apps
50
53
    apachereq = req
51
 
    req = Request(req, html.write_html_head)
52
 
 
 
54
    try:
 
55
        req = Request(req, html.write_html_head)
 
56
    except Exception:
 
57
        # Pass the apachereq to error reporter, since ivle req isn't created
 
58
        # yet.
 
59
        handle_unknown_exception(apachereq, *sys.exc_info())
 
60
        # Tell Apache not to generate its own errors as well
 
61
        return apache.OK
 
62
 
 
63
    # Run the main handler, and catch all exceptions
 
64
    try:
 
65
        return handler_(req, apachereq)
 
66
    except mod_python.apache.SERVER_RETURN:
 
67
        # An apache error. We discourage these, but they might still happen.
 
68
        # Just raise up.
 
69
        raise
 
70
    except Exception:
 
71
        handle_unknown_exception(req, *sys.exc_info())
 
72
        # Tell Apache not to generate its own errors as well
 
73
        return apache.OK
 
74
 
 
75
def handler_(req, apachereq):
 
76
    """
 
77
    Nested handler function. May raise exceptions. The top-level handler is
 
78
    just used to catch exceptions.
 
79
    Takes both an IVLE request and an Apache req.
 
80
    """
53
81
    # Check req.app to see if it is valid. 404 if not.
54
82
    if req.app is not None and req.app not in conf.apps.app_url:
55
83
        # Maybe it is a special app!
104
132
 
105
133
        # Call the specified app with the request object
106
134
        apps.call_app(app.dir, req)
 
135
 
107
136
    # if not logged in, login.login will have written the login box.
108
137
    # Just clean up and exit.
109
138
 
128
157
    session.delete()
129
158
    req.add_cookie(forumutil.invalidated_forum_cookie())
130
159
    req.throw_redirect(util.make_path(''))
 
160
 
 
161
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
 
162
    """
 
163
    Given an exception that has just been thrown from IVLE, print its details
 
164
    to the request.
 
165
    This is a full handler. It assumes nothing has been written, and writes a
 
166
    complete HTML page.
 
167
    req: May be EITHER an IVLE req or an Apache req.
 
168
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
 
169
    the handler code may pass an apache req if an exception occurs before
 
170
    the IVLE request is created.
 
171
    """
 
172
    req.content_type = "text/html"
 
173
    admin_email = apache._server.server_admin
 
174
    try:
 
175
        httpcode = exc_value.httpcode
 
176
        req.status = httpcode
 
177
    except AttributeError:
 
178
        httpcode = None
 
179
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
180
    # We handle 3 types of error.
 
181
    # IVLEErrors with 4xx response codes (client error).
 
182
    # IVLEErrors with 5xx response codes (handled server error).
 
183
    # Other exceptions (unhandled server error).
 
184
    # IVLEErrors should not have other response codes than 4xx or 5xx
 
185
    # (eg. throw_redirect should have been used for 3xx codes).
 
186
    # Therefore, that is treated as an unhandled error.
 
187
 
 
188
    if (exc_type == util.IVLEError and httpcode >= 400
 
189
        and httpcode <= 499):
 
190
        # IVLEErrors with 4xx response codes are client errors.
 
191
        # Therefore, these have a "nice" response (we even coat it in the IVLE
 
192
        # HTML wrappers).
 
193
        req.write_html_head_foot = True
 
194
        req.write('<div id="ivle_padding">\n')
 
195
        try:
 
196
            codename, msg = req.get_http_codename(httpcode)
 
197
        except AttributeError:
 
198
            codename, msg = None, None
 
199
        # Override the default message with the supplied one,
 
200
        # if available.
 
201
        if exc_value.message is not None:
 
202
            msg = exc_value.message
 
203
        if codename is not None:
 
204
            req.write("<h1>Error: %s</h1>\n" % codename)
 
205
        else:
 
206
            req.write("<h1>Error</h1>\n")
 
207
        if msg is not None:
 
208
            req.write("<p>%s</p>\n" % msg)
 
209
        else:
 
210
            req.write("<p>An unknown error occured.</p>\n")
 
211
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
212
        req.write('</div>\n')
 
213
    else:
 
214
        # A "bad" error message. We shouldn't get here unless IVLE
 
215
        # misbehaves (which is currently very easy, if things aren't set up
 
216
        # correctly).
 
217
        # Write the traceback.
 
218
        # If this is a non-4xx IVLEError, get the message and httpcode and
 
219
        # make the error message a bit nicer (but still include the
 
220
        # traceback).
 
221
        try:
 
222
            codename, msg = req.get_http_codename(httpcode)
 
223
        except AttributeError:
 
224
            codename, msg = None, None
 
225
        # Override the default message with the supplied one,
 
226
        # if available.
 
227
        if hasattr(exc_value, 'message') and exc_value.message is not None:
 
228
            msg = exc_value.message
 
229
 
 
230
        req.write("""<html>
 
231
<head><title>IVLE Internal Server Error</title></head>
 
232
<body>
 
233
<h1>IVLE Internal Server Error""")
 
234
        if (codename is not None
 
235
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
 
236
            req.write(": %s" % codename)
 
237
        req.write("""</h1>
 
238
<p>An error has occured which is the fault of the IVLE developers or
 
239
administration.</p>
 
240
""")
 
241
        if msg is not None:
 
242
            req.write("<p>%s</p>\n" % msg)
 
243
        if httpcode is not None:
 
244
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
245
        req.write("""
 
246
<p>Please report this to <a href="mailto:%s">%s</a> (the system
 
247
administrator). Include the following information:</p>
 
248
""" % (admin_email, admin_email))
 
249
 
 
250
        tb_print = cStringIO.StringIO()
 
251
        traceback.print_exception(exc_type, exc_value, exc_traceback,
 
252
            file=tb_print)
 
253
        req.write("<pre>\n")
 
254
        req.write(tb_print.getvalue())
 
255
        req.write("</pre>\n</body>\n")