← 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-01-12 12:57:30 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:197
dispatch.html, ivle.css: Main IVLE header is now an h1/h2 pair, styled to the
    left with absolute positioning (one over the top of the other).

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 and delegates to views for authorization,
26
 
then passes the request along to the appropriate view.
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
 
from ivle.dispatch.request import Request
45
 
import ivle.webapp.security
46
 
from ivle.webapp.base.plugins import ViewPlugin, PublicViewPlugin
47
 
from ivle.webapp.base.xhtml import XHTMLView, XHTMLErrorView
48
 
from ivle.webapp.errors import HTTPError, Unauthorized, NotFound
49
 
 
50
 
def generate_route_mapper(view_plugins, attr):
51
 
    """
52
 
    Build a Mapper object for doing URL matching using 'routes', based on the
53
 
    given plugin registry.
54
 
    """
55
 
    m = routes.Mapper(explicit=True)
56
 
    for plugin in view_plugins:
57
 
        # Establish a URL pattern for each element of plugin.urls
58
 
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
59
 
        for url in getattr(plugin, attr):
60
 
            routex = url[0]
61
 
            view_class = url[1]
62
 
            kwargs_dict = url[2] if len(url) >= 3 else {}
63
 
            m.connect(routex, view=view_class, **kwargs_dict)
64
 
    return m
65
 
 
66
 
def handler(apachereq):
67
 
    """Handles an HTTP request.
68
 
 
69
 
    Intended to be called by mod_python, as a handler.
70
 
 
71
 
    @param apachereq: An Apache request object.
72
 
    """
73
 
    # Make the request object into an IVLE request which can be given to views
74
 
    req = Request(apachereq)
75
 
 
76
 
    # Hack? Try and get the user login early just in case we throw an error
77
 
    # (most likely 404) to stop us seeing not logged in even when we are.
78
 
    if not req.publicmode:
79
 
        user = ivle.webapp.security.get_user_details(req)
80
 
 
81
 
        # Don't set the user if it is disabled or hasn't accepted the ToS.
82
 
        if user and user.valid:
83
 
            req.user = user
84
 
 
85
 
    conf = ivle.config.Config()
86
 
    req.config = conf
87
 
 
88
 
    if req.publicmode:
89
 
        req.mapper = generate_route_mapper(conf.plugin_index[PublicViewPlugin],
90
 
                                           'public_urls')
91
 
    else:
92
 
        req.mapper = generate_route_mapper(conf.plugin_index[ViewPlugin],
93
 
                                           'urls')
94
 
 
95
 
    matchdict = req.mapper.match(req.uri)
96
 
    if matchdict is not None:
97
 
        viewcls = matchdict['view']
98
 
        # Get the remaining arguments, less 'view', 'action' and 'controller'
99
 
        # (The latter two seem to be built-in, and we don't want them).
100
 
        kwargs = matchdict.copy()
101
 
        del kwargs['view']
102
 
        try:
103
 
            # Instantiate the view, which should be a BaseView class
104
 
            view = viewcls(req, **kwargs)
105
 
 
106
 
            # Check that the request (mainly the user) is permitted to access
107
 
            # the view.
108
 
            if not view.authorize(req):
109
 
                raise Unauthorized()
110
 
            # Render the output
111
 
            view.render(req)
112
 
        except HTTPError, e:
113
 
            # A view explicitly raised an HTTP error. Respect it.
114
 
            req.status = e.code
115
 
 
116
 
            # Try to find a custom error view.
117
 
            if hasattr(viewcls, 'get_error_view'):
118
 
                errviewcls = viewcls.get_error_view(e)
119
 
            else:
120
 
                errviewcls = XHTMLView.get_error_view(e)
121
 
 
122
 
            if errviewcls:
123
 
                errview = errviewcls(req, e)
124
 
                errview.render(req)
125
 
                return req.OK
126
 
            elif e.message:
127
 
                req.write(e.message)
128
 
                return req.OK
129
 
            else:
130
 
                return e.code
131
 
        except mod_python.apache.SERVER_RETURN:
132
 
            # A mod_python-specific Apache error.
133
 
            # XXX: We need to raise these because req.throw_error() uses them.
134
 
            # Remove this after Google Code issue 117 is fixed.
135
 
            raise
136
 
        except Exception, e:
137
 
            # A non-HTTPError appeared. We have an unknown exception. Panic.
138
 
            handle_unknown_exception(req, *sys.exc_info())
139
 
            return req.OK
140
 
        else:
141
 
            req.store.commit()
142
 
            return req.OK
143
 
    else:
144
 
        XHTMLErrorView(req, NotFound()).render(req)
145
 
        return req.OK
146
 
 
147
 
def handle_unknown_exception(req, exc_type, exc_value, exc_traceback):
148
 
    """
149
 
    Given an exception that has just been thrown from IVLE, print its details
150
 
    to the request.
151
 
    This is a full handler. It assumes nothing has been written, and writes a
152
 
    complete HTML page.
153
 
    req: May be EITHER an IVLE req or an Apache req.
154
 
    The handler code may pass an apache req if an exception occurs before
155
 
    the IVLE request is created.
156
 
    """
157
 
    req.content_type = "text/html"
158
 
    logfile = os.path.join(ivle.conf.log_path, 'ivle_error.log')
159
 
    logfail = False
160
 
    try:
161
 
        httpcode = exc_value.httpcode
162
 
        req.status = httpcode
163
 
    except AttributeError:
164
 
        httpcode = None
165
 
        req.status = mod_python.apache.HTTP_INTERNAL_SERVER_ERROR
166
 
    try:
167
 
        publicmode = req.publicmode
168
 
    except AttributeError:
169
 
        publicmode = True
170
 
    try:
171
 
        login = req.user.login
172
 
    except AttributeError:
173
 
        login = None
174
 
 
175
 
    # Log File
176
 
    try:
177
 
        for h in logging.getLogger().handlers:
178
 
            logging.getLogger().removeHandler(h)
179
 
        logging.basicConfig(level=logging.INFO,
180
 
            format='%(asctime)s %(levelname)s: ' +
181
 
                '(HTTP: ' + str(req.status) +
182
 
                ', Ref: ' + str(login) + '@' +
183
 
                str(socket.gethostname()) + str(req.uri) +
184
 
                ') %(message)s',
185
 
            filename=logfile,
186
 
            filemode='a')
187
 
    except IOError:
188
 
        logfail = True
189
 
 
190
 
    # A "bad" error message. We shouldn't get here unless IVLE
191
 
    # misbehaves (which is currently very easy, if things aren't set up
192
 
    # correctly).
193
 
    # Write the traceback.
194
 
    # If this is a non-4xx IVLEError, get the message and httpcode and
195
 
    # make the error message a bit nicer (but still include the
196
 
    # traceback).
197
 
    # We also need to special-case IVLEJailError, as we can get another
198
 
    # almost-exception out of it.
199
 
 
200
 
    codename, msg = None, None
201
 
 
202
 
    if exc_type is util.IVLEJailError:
203
 
        msg = exc_value.type_str + ": " + exc_value.message
204
 
        tb = 'Exception information extracted from IVLEJailError:\n'
205
 
        tb += urllib.unquote(exc_value.info)
206
 
    else:
207
 
        try:
208
 
            codename, msg = req.get_http_codename(httpcode)
209
 
        except AttributeError:
210
 
            pass
211
 
 
212
 
        tb = ''.join(traceback.format_exception(exc_type, exc_value,
213
 
                                                exc_traceback))
214
 
 
215
 
    logging.error('%s\n%s'%(str(msg), tb))
216
 
 
217
 
    # Error messages are only displayed is the user is NOT a student,
218
 
    # or if there has been a problem logging the error message
219
 
    show_errors = (not publicmode) and ((login and req.user.admin) or logfail)
220
 
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"                 
221
 
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                      
222
 
<html xmlns="http://www.w3.org/1999/xhtml">
223
 
<head><title>IVLE Internal Server Error</title></head>
224
 
<body>
225
 
<h1>IVLE Internal Server Error""")
226
 
    if show_errors:
227
 
        if codename is not None and \
228
 
           httpcode != mod_python.apache.HTTP_INTERNAL_SERVER_ERROR:
229
 
            req.write(": %s" % cgi.escape(codename))
230
 
 
231
 
    req.write("""</h1>
232
 
<p>An error has occured which is the fault of the IVLE developers or
233
 
administrators. """)
234
 
 
235
 
    if logfail:
236
 
        req.write("Please report this issue to the server administrators, "
237
 
                  "along with the following information.")
238
 
    else:
239
 
        req.write("Details have been logged for further examination.")
240
 
    req.write("</p>")
241
 
 
242
 
    if show_errors:
243
 
        if msg is not None:
244
 
            req.write("<p>%s</p>\n" % cgi.escape(msg))
245
 
        if httpcode is not None:
246
 
            req.write("<p>(HTTP error code %d)</p>\n" % httpcode)
247
 
        req.write("<h2>Debugging information</h2>")
248
 
 
249
 
        req.write("<pre>\n%s\n</pre>\n"%cgi.escape(tb))
250
 
    req.write("</body></html>")