← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

  • Committer: William Grant
  • Date: 2009-01-13 01:36:15 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1123
Merge setup-refactor branch. This completely breaks existing installations;
every path (both filesystem and Python) has changed. Do not upgrade without
knowing what you are doing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
1
1
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2009 The University of Melbourne
 
2
# Copyright (C) 2007-2008 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
17
 
 
18
# Module: dispatch.request
18
19
# Author: Matt Giuca
19
 
 
20
 
"""
21
 
IVLE Request Object
22
 
 
23
 
Builds an IVLE request object from a mod_python request object.
24
 
See design notes/apps/dispatch.txt for a full specification of this request
25
 
object.
26
 
"""
27
 
 
28
 
try:
29
 
    import mod_python.Session
30
 
    import mod_python.Cookie
31
 
    import mod_python.util
32
 
    import mod_python.apache
33
 
 
34
 
    class PotentiallySecureFileSession(mod_python.Session.FileSession):
35
 
        """A mod_python FileSession that sets secure cookie when appropriate.
36
 
 
37
 
        A secure cookie will be set if the request itself is over HTTPS, or if
38
 
        a proxy in front has set X-Forwarded-Proto: https. Otherwise the cookie
39
 
        will be insecure.
40
 
        """
41
 
        def make_cookie(self):
42
 
            cookie = super(PotentiallySecureFileSession, self).make_cookie()
43
 
            if (self._req.is_https() or
44
 
                self._req.headers_in.get('X-Forwarded-Proto') == 'https'):
45
 
                cookie.secure = True
46
 
            return cookie
47
 
except ImportError:
48
 
    # This needs to be importable from outside Apache.
49
 
    pass
50
 
 
51
 
import os.path
 
20
# Date:   12/12/2007
 
21
 
 
22
# Builds an IVLE request object from a mod_python request object.
 
23
# See design notes/apps/dispatch.txt for a full specification of this request
 
24
# object.
 
25
 
 
26
import mod_python
 
27
from mod_python import (util, Session, Cookie)
52
28
 
53
29
import ivle.util
54
 
import ivle.database
55
 
from ivle.webapp.base.plugins import CookiePlugin
56
 
import ivle.webapp.security
57
 
 
 
30
import ivle.conf
 
31
import plugins.console # XXX: Relies on www/ being in the Python path.
58
32
 
59
33
class Request:
60
34
    """An IVLE request object. This is presented to the IVLE apps as a way of
65
39
            String. The request method (eg. 'GET', 'POST', etc)
66
40
        uri (read)
67
41
            String. The path portion of the URI.
68
 
        unparsed_uri (read)
69
 
            String. The path portion of the URI, unparsed with query string.
70
42
        app (read)
71
43
            String. Name of the application specified in the URL, or None.
72
44
        path (read)
76
48
        user (read)
77
49
            User object. Details of the user who is currently logged in, or
78
50
            None.
79
 
        store (read)
80
 
            storm.store.Store instance. Holds a database transaction open,
81
 
            which is available for the entire lifetime of the request.
82
51
        hostname (read)
83
52
            String. Hostname the server is running on.
84
53
        headers_in (read)
98
67
        location (write)
99
68
            String. Response "Location" header value. Used with HTTP redirect
100
69
            responses.
 
70
        title (write)
 
71
            String. HTML page title. Used if write_html_head_foot is True, in
 
72
            the HTML title element text.
 
73
        styles (write)
 
74
            List of strings. Write a list of URLs to CSS files here, and they
 
75
            will be incorporated as <link rel="stylesheet" type="text/css">
 
76
            elements in the head, if write_html_head_foot is True.
 
77
            URLs should be relative to the IVLE root; they will be fixed up
 
78
            to be site-relative.
 
79
        scripts (write)
 
80
            List of strings. Write a list of URLs to JS files here, and they
 
81
            will be incorporated as <script type="text/javascript"> elements
 
82
            in the head, if write_html_head_foot is True.
 
83
            URLs should be relative to the IVLE root; they will be fixed up
 
84
            to be site-relative.
 
85
        scripts_init (write)
 
86
            List of strings. Write a list of JS function names, and they
 
87
            will be added as window.addListener('load', ..., false); calls
 
88
            in the head, if write_html_head_foot is True.
 
89
            This is the propper way to specify functions that need to run at 
 
90
            page load time.
 
91
        write_html_head_foot (write)
 
92
            Boolean. If True, dispatch assumes that this is an XHTML page, and
 
93
            will immediately write a full HTML head, open the body element,
 
94
            and write heading contents to the page, before any bytes are
 
95
            written. It will then write footer contents and close the body and
 
96
            html elements at the end of execution.  
 
97
 
 
98
            This value should be set to true by all applications for all HTML
 
99
            output (unless there is a good reason, eg. exec). The
 
100
            applications should therefore output HTML content assuming that
 
101
            it will be written inside the body tag. Do not write opening or
 
102
            closing <html> or <body> tags.
101
103
    """
102
104
 
103
105
    # Special code for an OK response.
107
109
 
108
110
    # HTTP status codes
109
111
 
 
112
    HTTP_CONTINUE                     = 100
 
113
    HTTP_SWITCHING_PROTOCOLS          = 101
 
114
    HTTP_PROCESSING                   = 102
110
115
    HTTP_OK                           = 200
 
116
    HTTP_CREATED                      = 201
 
117
    HTTP_ACCEPTED                     = 202
 
118
    HTTP_NON_AUTHORITATIVE            = 203
 
119
    HTTP_NO_CONTENT                   = 204
 
120
    HTTP_RESET_CONTENT                = 205
 
121
    HTTP_PARTIAL_CONTENT              = 206
 
122
    HTTP_MULTI_STATUS                 = 207
 
123
    HTTP_MULTIPLE_CHOICES             = 300
 
124
    HTTP_MOVED_PERMANENTLY            = 301
111
125
    HTTP_MOVED_TEMPORARILY            = 302
 
126
    HTTP_SEE_OTHER                    = 303
 
127
    HTTP_NOT_MODIFIED                 = 304
 
128
    HTTP_USE_PROXY                    = 305
 
129
    HTTP_TEMPORARY_REDIRECT           = 307
 
130
    HTTP_BAD_REQUEST                  = 400
 
131
    HTTP_UNAUTHORIZED                 = 401
 
132
    HTTP_PAYMENT_REQUIRED             = 402
112
133
    HTTP_FORBIDDEN                    = 403
113
134
    HTTP_NOT_FOUND                    = 404
 
135
    HTTP_METHOD_NOT_ALLOWED           = 405
 
136
    HTTP_NOT_ACCEPTABLE               = 406
 
137
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
 
138
    HTTP_REQUEST_TIME_OUT             = 408
 
139
    HTTP_CONFLICT                     = 409
 
140
    HTTP_GONE                         = 410
 
141
    HTTP_LENGTH_REQUIRED              = 411
 
142
    HTTP_PRECONDITION_FAILED          = 412
 
143
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
 
144
    HTTP_REQUEST_URI_TOO_LARGE        = 414
 
145
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
 
146
    HTTP_RANGE_NOT_SATISFIABLE        = 416
 
147
    HTTP_EXPECTATION_FAILED           = 417
 
148
    HTTP_UNPROCESSABLE_ENTITY         = 422
 
149
    HTTP_LOCKED                       = 423
 
150
    HTTP_FAILED_DEPENDENCY            = 424
114
151
    HTTP_INTERNAL_SERVER_ERROR        = 500
115
 
 
116
 
    _store = None
117
 
 
118
 
    def __init__(self, req, config):
119
 
        """Create an IVLE request from a mod_python one.
120
 
 
121
 
        @param req: A mod_python request.
122
 
        @param config: An IVLE configuration.
 
152
    HTTP_NOT_IMPLEMENTED              = 501
 
153
    HTTP_BAD_GATEWAY                  = 502
 
154
    HTTP_SERVICE_UNAVAILABLE          = 503
 
155
    HTTP_GATEWAY_TIME_OUT             = 504
 
156
    HTTP_VERSION_NOT_SUPPORTED        = 505
 
157
    HTTP_VARIANT_ALSO_VARIES          = 506
 
158
    HTTP_INSUFFICIENT_STORAGE         = 507
 
159
    HTTP_NOT_EXTENDED                 = 510
 
160
 
 
161
    def __init__(self, req, write_html_head):
 
162
        """Builds an IVLE request object from a mod_python request object.
 
163
        This results in an object with all of the necessary methods and
 
164
        additional fields.
 
165
 
 
166
        req: A mod_python request object.
 
167
        write_html_head: Function which is called when writing the automatic
 
168
            HTML header. Accepts a single argument, the IVLE request object.
123
169
        """
124
170
 
125
171
        # Methods are mostly wrappers around the Apache request object
126
172
        self.apache_req = req
127
 
        self.config = config
 
173
        self.func_write_html_head = write_html_head
128
174
        self.headers_written = False
129
175
 
130
176
        # Determine if the browser used the public host name to make the
131
177
        # request (in which case we are in "public mode")
132
 
        if req.hostname == config['urls']['public_host']:
 
178
        if req.hostname == ivle.conf.public_host:
133
179
            self.publicmode = True
134
180
        else:
135
181
            self.publicmode = False
137
183
        # Inherit values for the input members
138
184
        self.method = req.method
139
185
        self.uri = req.uri
140
 
        self.unparsed_uri = req.unparsed_uri
141
186
        # Split the given path into the app (top-level dir) and sub-path
142
187
        # (after first stripping away the root directory)
143
 
        (self.app, self.path) = (ivle.util.split_path(req.uri))
 
188
        path = ivle.util.unmake_path(req.uri)
 
189
        (self.app, self.path) = (ivle.util.split_path(path))
 
190
        self.user = None
144
191
        self.hostname = req.hostname
145
192
        self.headers_in = req.headers_in
146
193
        self.headers_out = req.headers_out
149
196
        self.status = Request.HTTP_OK
150
197
        self.content_type = None        # Use Apache's default
151
198
        self.location = None
 
199
        self.title = None     # Will be set by dispatch before passing to app
 
200
        self.styles = []
 
201
        self.scripts = []
 
202
        self.scripts_init = []
 
203
        self.write_html_head_foot = False
152
204
        # In some cases we don't want the template JS (such as the username
153
205
        # and public FQDN) in the output HTML. In that case, set this to 0.
154
206
        self.write_javascript_settings = True
155
207
        self.got_common_vars = False
156
208
 
157
 
    def __del__(self):
158
 
        self.cleanup()
159
 
 
160
 
    def cleanup(self):
161
 
        """Cleanup."""
162
 
        if self._store is not None:
163
 
            self._store.close()
164
 
            self._store = None
165
 
 
166
 
    def commit(self):
167
 
        """Cleanup."""
168
 
        if self._store is not None:
169
 
            self._store.commit()
170
 
 
171
209
    def __writeheaders(self):
172
210
        """Writes out the HTTP and HTML headers before any real data is
173
211
        written."""
174
212
        self.headers_written = True
 
213
        
 
214
        # app is the App object for the chosen app
 
215
        try:
 
216
            app = ivle.conf.apps.app_url[self.app]
 
217
        except KeyError:
 
218
            app = None
 
219
 
 
220
        # Write any final modifications to header content
 
221
        if app and app.useconsole and self.user:
 
222
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
 
223
                self.scripts_init)
175
224
 
176
225
        # Prepare the HTTP and HTML headers before the first write is made
177
226
        if self.content_type != None:
179
228
        self.apache_req.status = self.status
180
229
        if self.location != None:
181
230
            self.apache_req.headers_out['Location'] = self.location
 
231
        if self.write_html_head_foot:
 
232
            # Write the HTML header, pass "self" (request object)
 
233
            self.func_write_html_head(self)
182
234
 
183
235
    def ensure_headers_written(self):
184
236
        """Writes out the HTTP and HTML headers if they haven't already been
201
253
            # This includes binary strings.
202
254
            self.apache_req.write(string, flush)
203
255
 
204
 
    def logout(self):
205
 
        """Log out the current user by destroying the session state.
206
 
        Then redirect to the top-level IVLE page."""
207
 
        if hasattr(self, 'session'):
208
 
            self.session.invalidate()
209
 
            self.session.delete()
210
 
            # Invalidates all IVLE cookies
211
 
            all_cookies = mod_python.Cookie.get_cookies(self)
212
 
 
213
 
            # Create cookies for plugins that might request them.
214
 
            for plugin in self.config.plugin_index[CookiePlugin]:
215
 
                for cookie in plugin.cookies:
216
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
217
 
                                                    expires=1, path='/'))
218
 
        self.throw_redirect(self.make_path(''))
219
 
 
220
 
 
221
256
    def flush(self):
222
257
        """Flushes the output buffer."""
223
258
        self.apache_req.flush()
236
271
        else:
237
272
            return self.apache_req.read(len)
238
273
 
 
274
    def throw_error(self, httpcode, message=None):
 
275
        """Writes out an HTTP error of the specified code. Raises an exception
 
276
        which is caught by the dispatch or web server, so any code following
 
277
        this call will not be executed.
 
278
 
 
279
        httpcode: An HTTP response status code. Pass a constant from the
 
280
        Request class.
 
281
        """
 
282
        raise ivle.util.IVLEError(httpcode, message)
 
283
 
239
284
    def throw_redirect(self, location):
240
285
        """Writes out an HTTP redirect to the specified URL. Raises an
241
286
        exception which is caught by the dispatch or web server, so any
244
289
        httpcode: An HTTP response status code. Pass a constant from the
245
290
        Request class.
246
291
        """
247
 
        # Note: location may be a unicode, but it MUST only have ASCII
248
 
        # characters (non-ascii characters should be URL-encoded).
249
 
        mod_python.util.redirect(self.apache_req, location.encode("ascii"))
 
292
        mod_python.util.redirect(self.apache_req, location)
250
293
 
251
294
    def add_cookie(self, cookie, value=None, **attributes):
252
295
        """Inserts a cookie into this request object's headers."""
253
296
        if value is None:
254
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
297
            Cookie.add_cookie(self.apache_req, cookie)
255
298
        else:
256
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
257
 
 
258
 
    def make_path(self, path):
259
 
        """Prepend the IVLE URL prefix to the given path.
260
 
 
261
 
        This is used when generating URLs to send to the client.
262
 
 
263
 
        This method is DEPRECATED. We no longer support use of a prefix.
264
 
        """
265
 
        return os.path.join(self.config['urls']['root'], path)
 
299
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
266
300
 
267
301
    def get_session(self):
268
302
        """Returns a mod_python Session object for this request.
269
303
        Note that this is dependent on mod_python and may need to change
270
 
        interface if porting away from mod_python.
271
 
 
272
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
273
 
                   it! If you don't, all other requests will block!
274
 
        """
 
304
        interface if porting away from mod_python."""
275
305
        # Cache the session object and set the timeout to 24 hours.
276
306
        if not hasattr(self, 'session'):
277
 
            self.session = PotentiallySecureFileSession(
278
 
                self.apache_req, timeout = 60 * 60 * 24)
 
307
            self.session = Session.FileSession(self.apache_req,
 
308
                                               timeout = 60 * 60 * 24)
279
309
        return self.session
280
310
 
281
311
    def get_fieldstorage(self):
284
314
        interface if porting away from mod_python."""
285
315
        # Cache the fieldstorage object
286
316
        if not hasattr(self, 'fields'):
287
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
317
            self.fields = util.FieldStorage(self.apache_req)
288
318
        return self.fields
289
319
 
290
320
    def get_cgi_environ(self):
296
326
            self.got_common_vars = True
297
327
        return self.apache_req.subprocess_env
298
328
 
299
 
    @property
300
 
    def store(self):
301
 
        # Open a database connection and transaction, keep it around for users
302
 
        # of the Request object to use.
303
 
        if self._store is None:
304
 
            self._store = ivle.database.get_store(self.config)
305
 
        return self._store
306
 
 
307
 
    @property
308
 
    def user(self):
309
 
        # Get and cache the request user, or None if it's not valid.
310
 
        # This is a property so that we don't create a store unless
311
 
        # some code actually requests the user.
 
329
    @staticmethod
 
330
    def get_http_codename(code):
 
331
        """Given a HTTP error code int, returns a (name, description)
 
332
        pair, suitable for displaying to the user.
 
333
        May return (None,None) if code is unknown.
 
334
        Only lists common 4xx and 5xx codes (since this is just used
 
335
        to display throw_error error messages).
 
336
        """
312
337
        try:
313
 
            return self._user
314
 
        except AttributeError:
315
 
            if self.publicmode:
316
 
                self._user = None
317
 
            else:
318
 
                temp_user = ivle.webapp.security.get_user_details(self)
319
 
                if temp_user and temp_user.valid:
320
 
                    self._user = temp_user
321
 
                else:
322
 
                    self._user = None
323
 
            return self._user
 
338
            return http_codenames[code]
 
339
        except KeyError:
 
340
            return None, None
324
341
 
 
342
# Human strings for HTTP response codes
 
343
http_codenames = {
 
344
    Request.HTTP_BAD_REQUEST:
 
345
        ("Bad Request",
 
346
        "Your browser sent a request IVLE did not understand."),
 
347
    Request.HTTP_UNAUTHORIZED:
 
348
        ("Unauthorized",
 
349
        "You are not allowed to view this part of IVLE."),
 
350
    Request.HTTP_FORBIDDEN:
 
351
        ("Forbidden",
 
352
        "You are not allowed to view this part of IVLE."),
 
353
    Request.HTTP_NOT_FOUND:
 
354
        ("Not Found",
 
355
        "The application or file you requested does not exist."),
 
356
    Request.HTTP_METHOD_NOT_ALLOWED:
 
357
        ("Method Not Allowed",
 
358
        "Your browser is interacting with IVLE in the wrong way."
 
359
        "This is probably a bug in IVLE. "
 
360
        "Please report it to the administrators."),
 
361
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
362
        ("Internal Server Error",
 
363
        "An unknown error occured in IVLE."),
 
364
    Request.HTTP_NOT_IMPLEMENTED:
 
365
        ("Not Implemented",
 
366
        "The application or file you requested has not been implemented "
 
367
        "in IVLE."),
 
368
    Request.HTTP_SERVICE_UNAVAILABLE:
 
369
        ("Service Unavailable",
 
370
        "IVLE is currently experiencing technical difficulties. "
 
371
        "Please try again later."),
 
372
}