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

« back to all changes in this revision

Viewing changes to www/dispatch/request.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:
251
251
        else:
252
252
            return self.apache_req.read(len)
253
253
 
254
 
    def throw_error(self, httpcode):
 
254
    def throw_error(self, httpcode, message=None):
255
255
        """Writes out an HTTP error of the specified code. Raises an exception
256
256
        which is caught by the dispatch or web server, so any code following
257
257
        this call will not be executed.
259
259
        httpcode: An HTTP response status code. Pass a constant from the
260
260
        Request class.
261
261
        """
262
 
        raise mod_python.apache.SERVER_RETURN, httpcode
 
262
        raise common.util.IVLEError(httpcode, message)
263
263
 
264
264
    def throw_redirect(self, location):
265
265
        """Writes out an HTTP redirect to the specified URL. Raises an
305
305
            self.apache_req.add_common_vars()
306
306
            self.got_common_vars = True
307
307
        return self.apache_req.subprocess_env
 
308
 
 
309
    @staticmethod
 
310
    def get_http_codename(code):
 
311
        """Given a HTTP error code int, returns a (name, description)
 
312
        pair, suitable for displaying to the user.
 
313
        May return (None,None) if code is unknown.
 
314
        Only lists common 4xx and 5xx codes (since this is just used
 
315
        to display throw_error error messages).
 
316
        """
 
317
        try:
 
318
            return http_codenames[code]
 
319
        except KeyError:
 
320
            return None, None
 
321
 
 
322
# Human strings for HTTP response codes
 
323
http_codenames = {
 
324
    Request.HTTP_BAD_REQUEST:
 
325
        ("Bad Request",
 
326
        "Your browser sent a request IVLE did not understand."),
 
327
    Request.HTTP_UNAUTHORIZED:
 
328
        ("Unauthorized",
 
329
        "You are not allowed to view this part of IVLE."),
 
330
    Request.HTTP_FORBIDDEN:
 
331
        ("Forbidden",
 
332
        "You are not allowed to view this part of IVLE."),
 
333
    Request.HTTP_NOT_FOUND:
 
334
        ("Not Found",
 
335
        "The application or file you requested does not exist."),
 
336
    Request.HTTP_METHOD_NOT_ALLOWED:
 
337
        ("Method Not Allowed",
 
338
        "Your browser is interacting with IVLE in the wrong way."
 
339
        "This is probably a bug in IVLE. "
 
340
        "Please report it to the administrators."),
 
341
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
342
        ("Internal Server Error",
 
343
        "An unknown error occured in IVLE."),
 
344
    Request.HTTP_NOT_IMPLEMENTED:
 
345
        ("Not Implemented",
 
346
        "The application or file you requested has not been implemented "
 
347
        "in IVLE."),
 
348
    Request.HTTP_SERVICE_UNAVAILABLE:
 
349
        ("Service Unavailable",
 
350
        "IVLE is currently experiencing technical difficulties. "
 
351
        "Please try again later."),
 
352
}