← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/dispatch/__init__.py

  • Committer: mattgiuca
  • Date: 2008-07-15 07:19:34 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:875
Added "migrations" directory, which contains incremental database update
    scripts.
Updated users.sql, uniqueness key on offering table.
Added migration matching this update to the migrations directory. Mm handy!

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/__init__.py
 
1
# IVLE
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Module: dispatch
 
19
# Author: Matt Giuca
 
20
# Date: 11/12/2007
 
21
 
 
22
# This is a mod_python handler program. The correct way to call it is to have
 
23
# Apache send all requests to be handled by the module 'dispatch'.
 
24
 
 
25
# Top-level handler. Handles all requests to all pages in IVLE.
 
26
# Handles authentication (not authorization).
 
27
# Then passes the request along to the appropriate ivle app.
 
28
 
 
29
import mod_python
 
30
from mod_python import apache
 
31
 
 
32
import sys
 
33
import os
 
34
import os.path
 
35
import urllib
 
36
 
 
37
import conf
 
38
import conf.apps
 
39
import apps
 
40
 
 
41
from request import Request
 
42
import html
 
43
import cgi
 
44
import login
 
45
from common import (util, forumutil)
 
46
import traceback
 
47
 
 
48
def handler(req):
 
49
    """Handles a request which may be to anywhere in the site except media.
 
50
    Intended to be called by mod_python, as a handler.
 
51
 
 
52
    req: An Apache request object.
 
53
    """
 
54
    # Make the request object into an IVLE request which can be passed to apps
 
55
    apachereq = req
 
56
    try:
 
57
        req = Request(req, html.write_html_head)
 
58
    except Exception:
 
59
        # Pass the apachereq to error reporter, since ivle req isn't created
 
60
        # yet.
 
61
        handle_unknown_exception(apachereq, *sys.exc_info())
 
62
        # Tell Apache not to generate its own errors as well
 
63
        return apache.OK
 
64
 
 
65
    # Run the main handler, and catch all exceptions
 
66
    try:
 
67
        return handler_(req, apachereq)
 
68
    except mod_python.apache.SERVER_RETURN:
 
69
        # An apache error. We discourage these, but they might still happen.
 
70
        # Just raise up.
 
71
        raise
 
72
    except Exception:
 
73
        handle_unknown_exception(req, *sys.exc_info())
 
74
        # Tell Apache not to generate its own errors as well
 
75
        return apache.OK
 
76
 
 
77
def handler_(req, apachereq):
 
78
    """
 
79
    Nested handler function. May raise exceptions. The top-level handler is
 
80
    just used to catch exceptions.
 
81
    Takes both an IVLE request and an Apache req.
 
82
    """
 
83
    # Check req.app to see if it is valid. 404 if not.
 
84
    if req.app is not None and req.app not in conf.apps.app_url:
 
85
        # Maybe it is a special app!
 
86
        if req.app == 'logout':
 
87
            logout(req)
 
88
        else:
 
89
            req.throw_error(Request.HTTP_NOT_FOUND,
 
90
                "There is no application called %s." % repr(req.app))
 
91
 
 
92
    # Special handling for public mode - just call public app and get out
 
93
    # NOTE: This will not behave correctly if the public app uses
 
94
    # write_html_head_foot, but "serve" does not.
 
95
    if req.publicmode:
 
96
        app = conf.apps.app_url[conf.apps.public_app]
 
97
        apps.call_app(app.dir, req)
 
98
        return req.OK
 
99
 
 
100
    # app is the App object for the chosen app
 
101
    if req.app is None:
 
102
        app = conf.apps.app_url[conf.apps.default_app]
 
103
    else:
 
104
        app = conf.apps.app_url[req.app]
 
105
 
 
106
    # Check if app requires auth. If so, perform authentication and login.
 
107
    # This will either return a User object, None, or perform a redirect
 
108
    # which we will not catch here.
 
109
    if app.requireauth:
 
110
        req.user = login.login(req)
 
111
        logged_in = req.user is not None
 
112
    else:
 
113
        req.user = login.get_user_details(req)
 
114
        logged_in = True
 
115
 
 
116
    if logged_in:
 
117
        # Keep the user's session alive by writing to the session object.
 
118
        # req.get_session().save()
 
119
        # Well, it's a fine idea, but it creates considerable grief in the
 
120
        # concurrent update department, so instead, we'll just make the
 
121
        # sessions not time out.
 
122
        
 
123
        # If user did not specify an app, HTTP redirect to default app and
 
124
        # exit.
 
125
        if req.app is None:
 
126
            req.throw_redirect(util.make_path(conf.apps.default_app))
 
127
 
 
128
        # Set the default title to the app's tab name, if any. Otherwise URL
 
129
        # name.
 
130
        if app.name is not None:
 
131
            req.title = app.name
 
132
        else:
 
133
            req.title = req.app
 
134
 
 
135
        # Call the specified app with the request object
 
136
        apps.call_app(app.dir, req)
 
137
 
 
138
    # if not logged in, login.login will have written the login box.
 
139
    # Just clean up and exit.
 
140
 
 
141
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
 
142
    # wouldn't happen if nothing else ever got written, so we have to make
 
143
    # sure.
 
144
    req.ensure_headers_written()
 
145
 
 
146
    # When done, write out the HTML footer if the app has requested it
 
147
    if req.write_html_head_foot:
 
148
        html.write_html_foot(req)
 
149
 
 
150
    # Note: Apache will not write custom HTML error messages here.
 
151
    # Use req.throw_error to do that.
 
152
    return req.OK
 
153
 
 
154
def logout(req):
 
155
    """Log out the current user (if any) by destroying the session state.
 
156
    Then redirect to the top-level IVLE page."""
 
157
    session = req.get_session()
 
158
    session.invalidate()
 
159
    session.delete()
 
160
    req.add_cookie(forumutil.invalidated_forum_cookie())
 
161
    req.throw_redirect(util.make_path(''))
 
162
 
 
163
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
 
164
    """
 
165
    Given an exception that has just been thrown from IVLE, print its details
 
166
    to the request.
 
167
    This is a full handler. It assumes nothing has been written, and writes a
 
168
    complete HTML page.
 
169
    req: May be EITHER an IVLE req or an Apache req.
 
170
    IVLE reqs may have the HTML head/foot written (on a 400 error), but
 
171
    the handler code may pass an apache req if an exception occurs before
 
172
    the IVLE request is created.
 
173
    """
 
174
    req.content_type = "text/html"
 
175
    # For some reason, some versions of mod_python have "_server" instead of
 
176
    # "main_server". So we check for both.
 
177
    try:
 
178
        admin_email = apache.main_server.server_admin
 
179
    except AttributeError:
 
180
        try:
 
181
            admin_email = apache._server.server_admin
 
182
        except AttributeError:
 
183
            admin_email = ""
 
184
    try:
 
185
        httpcode = exc_value.httpcode
 
186
        req.status = httpcode
 
187
    except AttributeError:
 
188
        httpcode = None
 
189
        req.status = apache.HTTP_INTERNAL_SERVER_ERROR
 
190
    # We handle 3 types of error.
 
191
    # IVLEErrors with 4xx response codes (client error).
 
192
    # IVLEErrors with 5xx response codes (handled server error).
 
193
    # Other exceptions (unhandled server error).
 
194
    # IVLEErrors should not have other response codes than 4xx or 5xx
 
195
    # (eg. throw_redirect should have been used for 3xx codes).
 
196
    # Therefore, that is treated as an unhandled error.
 
197
 
 
198
    if (exc_type == util.IVLEError and httpcode >= 400
 
199
        and httpcode <= 499):
 
200
        # IVLEErrors with 4xx response codes are client errors.
 
201
        # Therefore, these have a "nice" response (we even coat it in the IVLE
 
202
        # HTML wrappers).
 
203
        req.write_html_head_foot = True
 
204
        req.write('<div id="ivle_padding">\n')
 
205
        try:
 
206
            codename, msg = req.get_http_codename(httpcode)
 
207
        except AttributeError:
 
208
            codename, msg = None, None
 
209
        # Override the default message with the supplied one,
 
210
        # if available.
 
211
        if exc_value.message is not None:
 
212
            msg = exc_value.message
 
213
        if codename is not None:
 
214
            req.write("<h1>Error: %s</h1>\n" % cgi.escape(codename))
 
215
        else:
 
216
            req.write("<h1>Error</h1>\n")
 
217
        if msg is not None:
 
218
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
219
        else:
 
220
            req.write("<p>An unknown error occured.</p>\n")
 
221
        req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
222
        req.write('</div>\n')
 
223
    else:
 
224
        # A "bad" error message. We shouldn't get here unless IVLE
 
225
        # misbehaves (which is currently very easy, if things aren't set up
 
226
        # correctly).
 
227
        # Write the traceback.
 
228
        # If this is a non-4xx IVLEError, get the message and httpcode and
 
229
        # make the error message a bit nicer (but still include the
 
230
        # traceback).
 
231
        # We also need to special-case IVLEJailError, as we can get another
 
232
        # almost-exception out of it.
 
233
 
 
234
        codename, msg = None, None
 
235
 
 
236
        if exc_type is util.IVLEJailError:
 
237
            msg = exc_value.type_str + ": " + exc_value.message
 
238
            tb = 'Exception information extracted from IVLEJailError:\n'
 
239
            tb += urllib.unquote(exc_value.info)
 
240
        else:
 
241
            try:
 
242
                codename, msg = req.get_http_codename(httpcode)
 
243
            except AttributeError:
 
244
                pass
 
245
            # Override the default message with the supplied one,
 
246
            # if available.
 
247
            if hasattr(exc_value, 'message') and exc_value.message is not None:
 
248
                msg = exc_value.message
 
249
                # Prepend the exception type
 
250
                if exc_type != util.IVLEError:
 
251
                    msg = exc_type.__name__ + ": " + msg
 
252
 
 
253
            tb = ''.join(traceback.format_exception(exc_type, exc_value,
 
254
                                                    exc_traceback))
 
255
 
 
256
        req.write("""<html>
 
257
<head><title>IVLE Internal Server Error</title></head>
 
258
<body>
 
259
<h1>IVLE Internal Server Error""")
 
260
        if (codename is not None
 
261
            and httpcode != apache.HTTP_INTERNAL_SERVER_ERROR):
 
262
            req.write(": %s" % cgi.escape(codename))
 
263
        req.write("""</h1>
 
264
<p>An error has occured which is the fault of the IVLE developers or
 
265
administration.</p>
 
266
""")
 
267
        if msg is not None:
 
268
            req.write("<p>%s</p>\n" % cgi.escape(msg))
 
269
        if httpcode is not None:
 
270
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
 
271
        req.write("""
 
272
<p>Please report this to <a href="mailto:%s">%s</a> (the system
 
273
administrator). Include the following information:</p>
 
274
""" % (cgi.escape(admin_email), cgi.escape(admin_email)))
 
275
 
 
276
        req.write("<pre>\n")
 
277
        req.write(cgi.escape(tb))
 
278
        req.write("</pre>\n</body>\n")