← 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: David Coles
  • Date: 2009-08-13 05:15:17 UTC
  • mto: (1294.2.124 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: coles.david@gmail.com-20090813051517-b5zxrzdt9rc8kxyv
Let the publisher generate help entry URLs for us.

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