← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/dispatch/request.py

  • Committer: William Grant
  • Date: 2009-05-26 01:34:43 UTC
  • Revision ID: grantw@unimelb.edu.au-20090526013443-f0vajadtez6ly479
Add __test__ = False to ivle.webapp.tutorial.test, to keep nose away.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/request.py
1
 
# IVLE - Informatics Virtual Learning Environment
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.request
19
 
# Author: Matt Giuca
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 common.util
27
 
import mod_python
28
 
from mod_python import (util, Session, Cookie)
29
 
import conf
30
 
import plugins.console
31
 
 
32
 
class Request:
33
 
    """An IVLE request object. This is presented to the IVLE apps as a way of
34
 
    interacting with the web server and the dispatcher.
35
 
 
36
 
    Request object attributes:
37
 
        method (read)
38
 
            String. The request method (eg. 'GET', 'POST', etc)
39
 
        uri (read)
40
 
            String. The path portion of the URI.
41
 
        app (read)
42
 
            String. Name of the application specified in the URL, or None.
43
 
        path (read)
44
 
            String. The path specified in the URL *not including* the
45
 
            application or the IVLE location prefix. eg. a URL of
46
 
            "/ivle/files/joe/myfiles" has a path of "joe/myfiles".
47
 
        user (read)
48
 
            User object. Details of the user who is currently logged in, or
49
 
            None.
50
 
        hostname (read)
51
 
            String. Hostname the server is running on.
52
 
        headers_in (read)
53
 
            Table object representing headers sent by the client.
54
 
        headers_out (read, can be written to)
55
 
            Table object representing headers to be sent to the client.
56
 
        publicmode (read)
57
 
            Bool. True if the request came for the "public host" as
58
 
            configured in conf.py. Note that public mode requests do not
59
 
            have an app (app is set to None).
60
 
 
61
 
        status (write)
62
 
            Int. Response status number. Use one of the status codes defined
63
 
            in class Request.
64
 
        content_type (write)
65
 
            String. The Content-Type (mime type) header value.
66
 
        location (write)
67
 
            String. Response "Location" header value. Used with HTTP redirect
68
 
            responses.
69
 
        title (write)
70
 
            String. HTML page title. Used if write_html_head_foot is True, in
71
 
            the HTML title element text.
72
 
        styles (write)
73
 
            List of strings. Write a list of URLs to CSS files here, and they
74
 
            will be incorporated as <link rel="stylesheet" type="text/css">
75
 
            elements in the head, if write_html_head_foot is True.
76
 
            URLs should be relative to the IVLE root; they will be fixed up
77
 
            to be site-relative.
78
 
        scripts (write)
79
 
            List of strings. Write a list of URLs to JS files here, and they
80
 
            will be incorporated as <script type="text/javascript"> elements
81
 
            in the head, if write_html_head_foot is True.
82
 
            URLs should be relative to the IVLE root; they will be fixed up
83
 
            to be site-relative.
84
 
        scripts_init (write)
85
 
            List of strings. Write a list of JS function names, and they
86
 
            will be added as window.addListener('load', ..., false); calls
87
 
            in the head, if write_html_head_foot is True.
88
 
            This is the propper way to specify functions that need to run at 
89
 
            page load time.
90
 
        write_html_head_foot (write)
91
 
            Boolean. If True, dispatch assumes that this is an XHTML page, and
92
 
            will immediately write a full HTML head, open the body element,
93
 
            and write heading contents to the page, before any bytes are
94
 
            written. It will then write footer contents and close the body and
95
 
            html elements at the end of execution.  
96
 
 
97
 
            This value should be set to true by all applications for all HTML
98
 
            output (unless there is a good reason, eg. exec). The
99
 
            applications should therefore output HTML content assuming that
100
 
            it will be written inside the body tag. Do not write opening or
101
 
            closing <html> or <body> tags.
102
 
    """
103
 
 
104
 
    # Special code for an OK response.
105
 
    # Do not use HTTP_OK; for some reason Apache produces an "OK" error
106
 
    # message if you do that.
107
 
    OK  = 0
108
 
 
109
 
    # HTTP status codes
110
 
 
111
 
    HTTP_CONTINUE                     = 100
112
 
    HTTP_SWITCHING_PROTOCOLS          = 101
113
 
    HTTP_PROCESSING                   = 102
114
 
    HTTP_OK                           = 200
115
 
    HTTP_CREATED                      = 201
116
 
    HTTP_ACCEPTED                     = 202
117
 
    HTTP_NON_AUTHORITATIVE            = 203
118
 
    HTTP_NO_CONTENT                   = 204
119
 
    HTTP_RESET_CONTENT                = 205
120
 
    HTTP_PARTIAL_CONTENT              = 206
121
 
    HTTP_MULTI_STATUS                 = 207
122
 
    HTTP_MULTIPLE_CHOICES             = 300
123
 
    HTTP_MOVED_PERMANENTLY            = 301
124
 
    HTTP_MOVED_TEMPORARILY            = 302
125
 
    HTTP_SEE_OTHER                    = 303
126
 
    HTTP_NOT_MODIFIED                 = 304
127
 
    HTTP_USE_PROXY                    = 305
128
 
    HTTP_TEMPORARY_REDIRECT           = 307
129
 
    HTTP_BAD_REQUEST                  = 400
130
 
    HTTP_UNAUTHORIZED                 = 401
131
 
    HTTP_PAYMENT_REQUIRED             = 402
132
 
    HTTP_FORBIDDEN                    = 403
133
 
    HTTP_NOT_FOUND                    = 404
134
 
    HTTP_METHOD_NOT_ALLOWED           = 405
135
 
    HTTP_NOT_ACCEPTABLE               = 406
136
 
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
137
 
    HTTP_REQUEST_TIME_OUT             = 408
138
 
    HTTP_CONFLICT                     = 409
139
 
    HTTP_GONE                         = 410
140
 
    HTTP_LENGTH_REQUIRED              = 411
141
 
    HTTP_PRECONDITION_FAILED          = 412
142
 
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
143
 
    HTTP_REQUEST_URI_TOO_LARGE        = 414
144
 
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
145
 
    HTTP_RANGE_NOT_SATISFIABLE        = 416
146
 
    HTTP_EXPECTATION_FAILED           = 417
147
 
    HTTP_UNPROCESSABLE_ENTITY         = 422
148
 
    HTTP_LOCKED                       = 423
149
 
    HTTP_FAILED_DEPENDENCY            = 424
150
 
    HTTP_INTERNAL_SERVER_ERROR        = 500
151
 
    HTTP_NOT_IMPLEMENTED              = 501
152
 
    HTTP_BAD_GATEWAY                  = 502
153
 
    HTTP_SERVICE_UNAVAILABLE          = 503
154
 
    HTTP_GATEWAY_TIME_OUT             = 504
155
 
    HTTP_VERSION_NOT_SUPPORTED        = 505
156
 
    HTTP_VARIANT_ALSO_VARIES          = 506
157
 
    HTTP_INSUFFICIENT_STORAGE         = 507
158
 
    HTTP_NOT_EXTENDED                 = 510
159
 
 
160
 
    def __init__(self, req, write_html_head):
161
 
        """Builds an IVLE request object from a mod_python request object.
162
 
        This results in an object with all of the necessary methods and
163
 
        additional fields.
164
 
 
165
 
        req: A mod_python request object.
166
 
        write_html_head: Function which is called when writing the automatic
167
 
            HTML header. Accepts a single argument, the IVLE request object.
168
 
        """
169
 
 
170
 
        # Methods are mostly wrappers around the Apache request object
171
 
        self.apache_req = req
172
 
        self.func_write_html_head = write_html_head
173
 
        self.headers_written = False
174
 
 
175
 
        # Determine if the browser used the public host name to make the
176
 
        # request (in which case we are in "public mode")
177
 
        if req.hostname == conf.public_host:
178
 
            self.publicmode = True
179
 
        else:
180
 
            self.publicmode = False
181
 
 
182
 
        # Inherit values for the input members
183
 
        self.method = req.method
184
 
        self.uri = req.uri
185
 
        # Split the given path into the app (top-level dir) and sub-path
186
 
        # (after first stripping away the root directory)
187
 
        path = common.util.unmake_path(req.uri)
188
 
        (self.app, self.path) = (common.util.split_path(path))
189
 
        self.user = None
190
 
        self.hostname = req.hostname
191
 
        self.headers_in = req.headers_in
192
 
        self.headers_out = req.headers_out
193
 
 
194
 
        # Default values for the output members
195
 
        self.status = Request.HTTP_OK
196
 
        self.content_type = None        # Use Apache's default
197
 
        self.location = None
198
 
        self.title = None     # Will be set by dispatch before passing to app
199
 
        self.styles = []
200
 
        self.scripts = []
201
 
        self.scripts_init = []
202
 
        self.write_html_head_foot = False
203
 
        # In some cases we don't want the template JS (such as the username
204
 
        # and public FQDN) in the output HTML. In that case, set this to 0.
205
 
        self.write_javascript_settings = True
206
 
        self.got_common_vars = False
207
 
 
208
 
    def __writeheaders(self):
209
 
        """Writes out the HTTP and HTML headers before any real data is
210
 
        written."""
211
 
        self.headers_written = True
212
 
        
213
 
        # app is the App object for the chosen app
214
 
        try:
215
 
            app = conf.apps.app_url[self.app]
216
 
        except KeyError:
217
 
            app = None
218
 
 
219
 
        # Write any final modifications to header content
220
 
        if app and app.useconsole and self.user:
221
 
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
222
 
                self.scripts_init)
223
 
 
224
 
        # Prepare the HTTP and HTML headers before the first write is made
225
 
        if self.content_type != None:
226
 
            self.apache_req.content_type = self.content_type
227
 
        self.apache_req.status = self.status
228
 
        if self.location != None:
229
 
            self.apache_req.headers_out['Location'] = self.location
230
 
        if self.write_html_head_foot:
231
 
            # Write the HTML header, pass "self" (request object)
232
 
            self.func_write_html_head(self)
233
 
 
234
 
    def ensure_headers_written(self):
235
 
        """Writes out the HTTP and HTML headers if they haven't already been
236
 
        written."""
237
 
        if not self.headers_written:
238
 
            self.__writeheaders()
239
 
 
240
 
    def write(self, string, flush=1):
241
 
        """Writes string directly to the client, then flushes the buffer,
242
 
        unless flush is 0."""
243
 
 
244
 
        if not self.headers_written:
245
 
            self.__writeheaders()
246
 
        if isinstance(string, unicode):
247
 
            # Encode unicode strings as UTF-8
248
 
            # (Otherwise cannot handle being written to a bytestream)
249
 
            self.apache_req.write(string.encode('utf8'), flush)
250
 
        else:
251
 
            # 8-bit clean strings just get written directly.
252
 
            # This includes binary strings.
253
 
            self.apache_req.write(string, flush)
254
 
 
255
 
    def flush(self):
256
 
        """Flushes the output buffer."""
257
 
        self.apache_req.flush()
258
 
 
259
 
    def sendfile(self, filename):
260
 
        """Sends the named file directly to the client."""
261
 
        if not self.headers_written:
262
 
            self.__writeheaders()
263
 
        self.apache_req.sendfile(filename)
264
 
 
265
 
    def read(self, len=None):
266
 
        """Reads at most len bytes directly from the client. (See mod_python
267
 
        Request.read)."""
268
 
        if len is None:
269
 
            return self.apache_req.read()
270
 
        else:
271
 
            return self.apache_req.read(len)
272
 
 
273
 
    def throw_error(self, httpcode, message=None):
274
 
        """Writes out an HTTP error of the specified code. Raises an exception
275
 
        which is caught by the dispatch or web server, so any code following
276
 
        this call will not be executed.
277
 
 
278
 
        httpcode: An HTTP response status code. Pass a constant from the
279
 
        Request class.
280
 
        """
281
 
        raise common.util.IVLEError(httpcode, message)
282
 
 
283
 
    def throw_redirect(self, location):
284
 
        """Writes out an HTTP redirect to the specified URL. Raises an
285
 
        exception which is caught by the dispatch or web server, so any
286
 
        code following this call will not be executed.
287
 
 
288
 
        httpcode: An HTTP response status code. Pass a constant from the
289
 
        Request class.
290
 
        """
291
 
        mod_python.util.redirect(self.apache_req, location)
292
 
 
293
 
    def add_cookie(self, cookie, value=None, **attributes):
294
 
        """Inserts a cookie into this request object's headers."""
295
 
        if value is None:
296
 
            Cookie.add_cookie(self.apache_req, cookie)
297
 
        else:
298
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
299
 
 
300
 
    def get_session(self):
301
 
        """Returns a mod_python Session object for this request.
302
 
        Note that this is dependent on mod_python and may need to change
303
 
        interface if porting away from mod_python."""
304
 
        # Cache the session object and set the timeout to 24 hours.
305
 
        if not hasattr(self, 'session'):
306
 
            self.session = Session.FileSession(self.apache_req,
307
 
                                               timeout = 60 * 60 * 24)
308
 
        return self.session
309
 
 
310
 
    def get_fieldstorage(self):
311
 
        """Returns a mod_python FieldStorage object for this request.
312
 
        Note that this is dependent on mod_python and may need to change
313
 
        interface if porting away from mod_python."""
314
 
        # Cache the fieldstorage object
315
 
        if not hasattr(self, 'fields'):
316
 
            self.fields = util.FieldStorage(self.apache_req)
317
 
        return self.fields
318
 
 
319
 
    def get_cgi_environ(self):
320
 
        """Returns the CGI environment emulation for this request. (Calls
321
 
        add_common_vars). The environment is returned as a mapping
322
 
        compatible with os.environ."""
323
 
        if not self.got_common_vars:
324
 
            self.apache_req.add_common_vars()
325
 
            self.got_common_vars = True
326
 
        return self.apache_req.subprocess_env
327
 
 
328
 
    @staticmethod
329
 
    def get_http_codename(code):
330
 
        """Given a HTTP error code int, returns a (name, description)
331
 
        pair, suitable for displaying to the user.
332
 
        May return (None,None) if code is unknown.
333
 
        Only lists common 4xx and 5xx codes (since this is just used
334
 
        to display throw_error error messages).
335
 
        """
336
 
        try:
337
 
            return http_codenames[code]
338
 
        except KeyError:
339
 
            return None, None
340
 
 
341
 
# Human strings for HTTP response codes
342
 
http_codenames = {
343
 
    Request.HTTP_BAD_REQUEST:
344
 
        ("Bad Request",
345
 
        "Your browser sent a request IVLE did not understand."),
346
 
    Request.HTTP_UNAUTHORIZED:
347
 
        ("Unauthorized",
348
 
        "You are not allowed to view this part of IVLE."),
349
 
    Request.HTTP_FORBIDDEN:
350
 
        ("Forbidden",
351
 
        "You are not allowed to view this part of IVLE."),
352
 
    Request.HTTP_NOT_FOUND:
353
 
        ("Not Found",
354
 
        "The application or file you requested does not exist."),
355
 
    Request.HTTP_METHOD_NOT_ALLOWED:
356
 
        ("Method Not Allowed",
357
 
        "Your browser is interacting with IVLE in the wrong way."
358
 
        "This is probably a bug in IVLE. "
359
 
        "Please report it to the administrators."),
360
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
361
 
        ("Internal Server Error",
362
 
        "An unknown error occured in IVLE."),
363
 
    Request.HTTP_NOT_IMPLEMENTED:
364
 
        ("Not Implemented",
365
 
        "The application or file you requested has not been implemented "
366
 
        "in IVLE."),
367
 
    Request.HTTP_SERVICE_UNAVAILABLE:
368
 
        ("Service Unavailable",
369
 
        "IVLE is currently experiencing technical difficulties. "
370
 
        "Please try again later."),
371
 
}