← 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: mattgiuca
  • Date: 2008-02-01 07:46:26 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:375
www/common/makeuser.py:
    Now accepts a large number of arguments for all the fields of the user.
    (password, full name, nick name, student id, role)
    Creates a new user in the DB.
    Creates a Unix account for the user on the current machine. (This will
    need to change to create one on the central machine to be propagated).
makeuser script: Accepts all the arguments as above and passes them along to
    www/common/makeuser.py.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
1
 
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2009 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
 
# Author: Matt Giuca, Will Grant
19
 
 
20
 
"""
21
 
This is a mod_python handler program. The correct way to call it is to have
22
 
Apache send all requests to be handled by the module 'dispatch'.
23
 
 
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.
27
 
"""
28
 
 
29
 
import sys
30
 
import os
31
 
import os.path
32
 
import urllib
33
 
import cgi
34
 
import traceback
35
 
import logging
36
 
import socket
37
 
import time
38
 
 
39
 
import mod_python
40
 
import routes
41
 
 
42
 
from ivle import util
43
 
import ivle.conf
44
 
import ivle.conf.apps
45
 
from ivle.dispatch.request import Request
46
 
from ivle.dispatch import login
47
 
import apps
48
 
import html
49
 
import plugins.console # XXX: Relies on www/ being in the Python path.
50
 
 
51
 
# XXX List of plugins, which will eventually be read in from conf
52
 
plugins_HACK = [
53
 
    'ivle.webapp.admin.user#Plugin',
54
 
    'ivle.webapp.tutorial#Plugin',
55
 
    'ivle.webapp.admin.subject#Plugin',
56
 
    'ivle.webapp.filesystem.browser#Plugin',
57
 
    'ivle.webapp.filesystem.diff#Plugin',
58
 
    'ivle.webapp.groups#Plugin',
59
 
    'ivle.webapp.console#Plugin',
60
 
    'ivle.webapp.security#Plugin',
61
 
]
62
 
 
63
 
def get_routes_mapper():
64
 
    """
65
 
    Build a Mapper object for doing URL matching using 'routes', based on the
66
 
    plugins config.
67
 
    """
68
 
    m = routes.Mapper(explicit=True)
69
 
    for pluginstr in plugins_HACK:
70
 
        plugin_path, classname = pluginstr.split('#')
71
 
        # Load the plugin module from somewhere in the Python path
72
 
        # (Note that plugin_path is a fully-qualified Python module name).
73
 
        plugin = getattr(__import__(plugin_path, fromlist=[classname]),
74
 
            classname)
75
 
        # Establish a URL pattern for each element of plugin.urls
76
 
        for url in plugin.urls:
77
 
            routex = url[0]
78
 
            view_class = url[1]
79
 
            kwargs_dict = url[2] if len(url) >= 3 else {}
80
 
            m.connect(routex, view=view_class, **kwargs_dict)
81
 
    return m
82
 
 
83
 
def handler(req):
84
 
    """Handles a request which may be to anywhere in the site except media.
85
 
    Intended to be called by mod_python, as a handler.
86
 
 
87
 
    req: An Apache request object.
88
 
    """
89
 
    # Make the request object into an IVLE request which can be passed to apps
90
 
    apachereq = req
91
 
    try:
92
 
        req = Request(req, html.write_html_head)
93
 
    except Exception:
94
 
        # Pass the apachereq to error reporter, since ivle req isn't created
95
 
        # yet.
96
 
        handle_unknown_exception(apachereq, *sys.exc_info())
97
 
        # Tell Apache not to generate its own errors as well
98
 
        return mod_python.apache.OK
99
 
 
100
 
    # Run the main handler, and catch all exceptions
101
 
    try:
102
 
        return handler_(req, apachereq)
103
 
    except mod_python.apache.SERVER_RETURN:
104
 
        # An apache error. We discourage these, but they might still happen.
105
 
        # Just raise up.
106
 
        raise
107
 
    except Exception:
108
 
        handle_unknown_exception(req, *sys.exc_info())
109
 
        # Tell Apache not to generate its own errors as well
110
 
        return mod_python.apache.OK
111
 
 
112
 
def handler_(req, apachereq):
113
 
    """
114
 
    Nested handler function. May raise exceptions. The top-level handler is
115
 
    just used to catch exceptions.
116
 
    Takes both an IVLE request and an Apache req.
117
 
    """
118
 
    # Hack? Try and get the user login early just in case we throw an error
119
 
    # (most likely 404) to stop us seeing not logged in even when we are.
120
 
    if not req.publicmode:
121
 
        req.user = login.get_user_details(req)
122
 
 
123
 
    ### BEGIN New plugins framework ###
124
 
    # XXX This should be done ONCE per Python process, not per request.
125
 
    # (Wait till WSGI)
126
 
    # XXX No authentication is done here
127
 
    req.mapper = get_routes_mapper()
128
 
    matchdict = req.mapper.match(req.uri)
129
 
    if matchdict is not None:
130
 
        viewcls = matchdict['view']
131
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
132
 
        # (The latter two seem to be built-in, and we don't want them).
133
 
        kwargs = matchdict.copy()
134
 
        del kwargs['view']
135
 
        # Instantiate the view, which should be a BaseView class
136
 
        view = viewcls(req, **kwargs)
137
 
        # Render the output
138
 
        view.render(req)
139
 
        req.store.commit()
140
 
        return req.OK
141
 
    ### END New plugins framework ###
142
 
 
143
 
    # Check req.app to see if it is valid. 404 if not.
144
 
    if req.app is not None and req.app not in ivle.conf.apps.app_url:
145
 
        req.throw_error(Request.HTTP_NOT_FOUND,
146
 
            "There is no application called %s." % repr(req.app))
147
 
 
148
 
    # Special handling for public mode - only allow the public app, call it
149
 
    # and get out.
150
 
    # NOTE: This will not behave correctly if the public app uses
151
 
    # write_html_head_foot, but "serve" does not.
152
 
    if req.publicmode:
153
 
        if req.app != ivle.conf.apps.public_app:
154
 
            req.throw_error(Request.HTTP_FORBIDDEN,
155
 
                "This application is not available on the public site.")
156
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.public_app]
157
 
        apps.call_app(app.dir, req)
158
 
        return req.OK
159
 
 
160
 
    # app is the App object for the chosen app
161
 
    if req.app is None:
162
 
        app = ivle.conf.apps.app_url[ivle.conf.apps.default_app]
163
 
    else:
164
 
        app = ivle.conf.apps.app_url[req.app]
165
 
 
166
 
    # Check if app requires auth. If so, perform authentication and login.
167
 
    # This will either return a User object, None, or perform a redirect
168
 
    # which we will not catch here.
169
 
    if app.requireauth:
170
 
        req.user = login.login(req)
171
 
        logged_in = req.user is not None
172
 
    else:
173
 
        req.user = login.get_user_details(req)
174
 
        logged_in = True
175
 
 
176
 
    if logged_in:
177
 
        # Keep the user's session alive by writing to the session object.
178
 
        # req.get_session().save()
179
 
        # Well, it's a fine idea, but it creates considerable grief in the
180
 
        # concurrent update department, so instead, we'll just make the
181
 
        # sessions not time out.
182
 
        req.get_session().unlock()
183
 
 
184
 
        # If user did not specify an app, HTTP redirect to default app and
185
 
        # exit.
186
 
        if req.app is None:
187
 
            req.throw_redirect(util.make_path(ivle.conf.apps.default_app))
188
 
 
189
 
        # Set the default title to the app's tab name, if any. Otherwise URL
190
 
        # name.
191
 
        if app.name is not None:
192
 
            req.title = app.name
193
 
        else:
194
 
            req.title = req.app
195
 
 
196
 
        # Call the specified app with the request object
197
 
        apps.call_app(app.dir, req)
198
 
 
199
 
    # if not logged in, login.login will have written the login box.
200
 
    # Just clean up and exit.
201
 
 
202
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
203
 
    # wouldn't happen if nothing else ever got written, so we have to make
204
 
    # sure.
205
 
    req.ensure_headers_written()
206
 
 
207
 
    # When done, write out the HTML footer if the app has requested it
208
 
    if req.write_html_head_foot:
209
 
        # Show the console if required
210
 
        if logged_in and app.useconsole:
211
 
            plugins.console.present(req, windowpane=True)
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
217
 
 
218
 
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
219
 
    """
220
 
    Given an exception that has just been thrown from IVLE, print its details
221
 
    to the request.
222
 
    This is a full handler. It assumes nothing has been written, and writes a
223
 
    complete HTML page.
224
 
    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
227
 
    the IVLE request is created.
228
 
    """
229
 
    req.content_type = "text/html"
230
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
231
 
    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
 
    try:
242
 
        httpcode = exc_value.httpcode
243
 
        req.status = httpcode
244
 
    except AttributeError:
245
 
        httpcode = None
246
 
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
247
 
    try:
248
 
        publicmode = req.publicmode
249
 
    except AttributeError:
250
 
        publicmode = True
251
 
    try:
252
 
        login = req.user.login
253
 
    except AttributeError:
254
 
        login = None
255
 
    try:
256
 
        role = req.user.role
257
 
    except AttributeError:
258
 
        role = None
259
 
 
260
 
    # Log File
261
 
    try:
262
 
        for h in logging.getLogger().handlers:
263
 
            logging.getLogger().removeHandler(h)
264
 
        logging.basicConfig(level=logging.INFO,
265
 
            format='%(asctime)s %(levelname)s: ' +
266
 
                '(HTTP: ' + str(req.status) +
267
 
                ', Ref: ' + str(login) + '@' +
268
 
                str(socket.gethostname()) + str(req.uri) +
269
 
                ') %(message)s',
270
 
            filename=logfile,
271
 
            filemode='a')
272
 
    except IOError:
273
 
        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')
293
 
        try:
294
 
            codename, msg = req.get_http_codename(httpcode)
295
 
        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__ + ": " + 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"                 
359
 
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
360
 
<html xmlns="http://www.w3.org/1999/xhtml">
361
 
<head><title>IVLE Internal Server Error</title></head>
362
 
<body>
363
 
<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>
370
 
<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>")