← 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: 2010-02-24 07:22:43 UTC
  • Revision ID: grantw@unimelb.edu.au-20100224072243-xq5w2we8iuoteen1
Reword and reformat the tour a bit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
25
25
object.
26
26
"""
27
27
 
28
 
import mod_python
29
 
from mod_python import (util, Session, Cookie)
 
28
try:
 
29
    import mod_python.Session
 
30
    import mod_python.Cookie
 
31
    import mod_python.util
 
32
except ImportError:
 
33
    # This needs to be importable from outside Apache.
 
34
    pass
 
35
 
 
36
import os.path
30
37
 
31
38
import ivle.util
32
 
import ivle.conf
33
39
import ivle.database
34
 
import plugins.console # XXX: Relies on www/ being in the Python path.
 
40
from ivle.webapp.base.plugins import CookiePlugin
35
41
 
36
42
class Request:
37
43
    """An IVLE request object. This is presented to the IVLE apps as a way of
73
79
        location (write)
74
80
            String. Response "Location" header value. Used with HTTP redirect
75
81
            responses.
76
 
        title (write)
77
 
            String. HTML page title. Used if write_html_head_foot is True, in
78
 
            the HTML title element text.
79
 
        styles (write)
80
 
            List of strings. Write a list of URLs to CSS files here, and they
81
 
            will be incorporated as <link rel="stylesheet" type="text/css">
82
 
            elements 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 (write)
86
 
            List of strings. Write a list of URLs to JS files here, and they
87
 
            will be incorporated as <script type="text/javascript"> elements
88
 
            in the head, if write_html_head_foot is True.
89
 
            URLs should be relative to the IVLE root; they will be fixed up
90
 
            to be site-relative.
91
 
        scripts_init (write)
92
 
            List of strings. Write a list of JS function names, and they
93
 
            will be added as window.addListener('load', ..., false); calls
94
 
            in the head, if write_html_head_foot is True.
95
 
            This is the propper way to specify functions that need to run at 
96
 
            page load time.
97
 
        write_html_head_foot (write)
98
 
            Boolean. If True, dispatch assumes that this is an XHTML page, and
99
 
            will immediately write a full HTML head, open the body element,
100
 
            and write heading contents to the page, before any bytes are
101
 
            written. It will then write footer contents and close the body and
102
 
            html elements at the end of execution.  
103
 
 
104
 
            This value should be set to true by all applications for all HTML
105
 
            output (unless there is a good reason, eg. exec). The
106
 
            applications should therefore output HTML content assuming that
107
 
            it will be written inside the body tag. Do not write opening or
108
 
            closing <html> or <body> tags.
109
82
    """
110
83
 
111
84
    # Special code for an OK response.
115
88
 
116
89
    # HTTP status codes
117
90
 
118
 
    HTTP_CONTINUE                     = 100
119
 
    HTTP_SWITCHING_PROTOCOLS          = 101
120
 
    HTTP_PROCESSING                   = 102
121
91
    HTTP_OK                           = 200
122
 
    HTTP_CREATED                      = 201
123
 
    HTTP_ACCEPTED                     = 202
124
 
    HTTP_NON_AUTHORITATIVE            = 203
125
 
    HTTP_NO_CONTENT                   = 204
126
 
    HTTP_RESET_CONTENT                = 205
127
 
    HTTP_PARTIAL_CONTENT              = 206
128
 
    HTTP_MULTI_STATUS                 = 207
129
 
    HTTP_MULTIPLE_CHOICES             = 300
130
 
    HTTP_MOVED_PERMANENTLY            = 301
131
92
    HTTP_MOVED_TEMPORARILY            = 302
132
 
    HTTP_SEE_OTHER                    = 303
133
 
    HTTP_NOT_MODIFIED                 = 304
134
 
    HTTP_USE_PROXY                    = 305
135
 
    HTTP_TEMPORARY_REDIRECT           = 307
136
 
    HTTP_BAD_REQUEST                  = 400
137
 
    HTTP_UNAUTHORIZED                 = 401
138
 
    HTTP_PAYMENT_REQUIRED             = 402
139
93
    HTTP_FORBIDDEN                    = 403
140
94
    HTTP_NOT_FOUND                    = 404
141
 
    HTTP_METHOD_NOT_ALLOWED           = 405
142
 
    HTTP_NOT_ACCEPTABLE               = 406
143
 
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
144
 
    HTTP_REQUEST_TIME_OUT             = 408
145
 
    HTTP_CONFLICT                     = 409
146
 
    HTTP_GONE                         = 410
147
 
    HTTP_LENGTH_REQUIRED              = 411
148
 
    HTTP_PRECONDITION_FAILED          = 412
149
 
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
150
 
    HTTP_REQUEST_URI_TOO_LARGE        = 414
151
 
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
152
 
    HTTP_RANGE_NOT_SATISFIABLE        = 416
153
 
    HTTP_EXPECTATION_FAILED           = 417
154
 
    HTTP_UNPROCESSABLE_ENTITY         = 422
155
 
    HTTP_LOCKED                       = 423
156
 
    HTTP_FAILED_DEPENDENCY            = 424
157
95
    HTTP_INTERNAL_SERVER_ERROR        = 500
158
 
    HTTP_NOT_IMPLEMENTED              = 501
159
 
    HTTP_BAD_GATEWAY                  = 502
160
 
    HTTP_SERVICE_UNAVAILABLE          = 503
161
 
    HTTP_GATEWAY_TIME_OUT             = 504
162
 
    HTTP_VERSION_NOT_SUPPORTED        = 505
163
 
    HTTP_VARIANT_ALSO_VARIES          = 506
164
 
    HTTP_INSUFFICIENT_STORAGE         = 507
165
 
    HTTP_NOT_EXTENDED                 = 510
166
 
 
167
 
    def __init__(self, req, write_html_head):
168
 
        """Builds an IVLE request object from a mod_python request object.
169
 
        This results in an object with all of the necessary methods and
170
 
        additional fields.
171
 
 
172
 
        req: A mod_python request object.
173
 
        write_html_head: Function which is called when writing the automatic
174
 
            HTML header. Accepts a single argument, the IVLE request object.
 
96
 
 
97
    def __init__(self, req, config):
 
98
        """Create an IVLE request from a mod_python one.
 
99
 
 
100
        @param req: A mod_python request.
 
101
        @param config: An IVLE configuration.
175
102
        """
176
103
 
177
104
        # Methods are mostly wrappers around the Apache request object
178
105
        self.apache_req = req
179
 
        self.func_write_html_head = write_html_head
 
106
        self.config = config
180
107
        self.headers_written = False
181
108
 
182
109
        # Determine if the browser used the public host name to make the
183
110
        # request (in which case we are in "public mode")
184
 
        if req.hostname == ivle.conf.public_host:
 
111
        if req.hostname == config['urls']['public_host']:
185
112
            self.publicmode = True
186
113
        else:
187
114
            self.publicmode = False
191
118
        self.uri = req.uri
192
119
        # Split the given path into the app (top-level dir) and sub-path
193
120
        # (after first stripping away the root directory)
194
 
        path = ivle.util.unmake_path(req.uri)
195
 
        (self.app, self.path) = (ivle.util.split_path(path))
 
121
        (self.app, self.path) = (ivle.util.split_path(req.uri))
196
122
        self.user = None
197
123
        self.hostname = req.hostname
198
124
        self.headers_in = req.headers_in
200
126
 
201
127
        # Open a database connection and transaction, keep it around for users
202
128
        # of the Request object to use
203
 
        self.store = ivle.database.get_store()
 
129
        self.store = ivle.database.get_store(config)
204
130
 
205
131
        # Default values for the output members
206
132
        self.status = Request.HTTP_OK
207
133
        self.content_type = None        # Use Apache's default
208
134
        self.location = None
209
 
        self.title = None     # Will be set by dispatch before passing to app
210
 
        self.styles = []
211
 
        self.scripts = []
212
 
        self.scripts_init = []
213
 
        self.write_html_head_foot = False
214
135
        # In some cases we don't want the template JS (such as the username
215
136
        # and public FQDN) in the output HTML. In that case, set this to 0.
216
137
        self.write_javascript_settings = True
224
145
        """Writes out the HTTP and HTML headers before any real data is
225
146
        written."""
226
147
        self.headers_written = True
227
 
        
228
 
        # app is the App object for the chosen app
229
 
        try:
230
 
            app = ivle.conf.apps.app_url[self.app]
231
 
        except KeyError:
232
 
            app = None
233
 
 
234
 
        # Write any final modifications to header content
235
 
        if app and app.useconsole and self.user:
236
 
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
237
 
                self.scripts_init)
238
148
 
239
149
        # Prepare the HTTP and HTML headers before the first write is made
240
150
        if self.content_type != None:
242
152
        self.apache_req.status = self.status
243
153
        if self.location != None:
244
154
            self.apache_req.headers_out['Location'] = self.location
245
 
        if self.write_html_head_foot:
246
 
            # Write the HTML header, pass "self" (request object)
247
 
            self.func_write_html_head(self)
248
155
 
249
156
    def ensure_headers_written(self):
250
157
        """Writes out the HTTP and HTML headers if they haven't already been
270
177
    def logout(self):
271
178
        """Log out the current user by destroying the session state.
272
179
        Then redirect to the top-level IVLE page."""
273
 
        # List of cookies that IVLE uses (to be removed at logout)
274
 
        ivle_cookies = ["ivleforumcookie", "clipboard"]
275
 
        
276
180
        if hasattr(self, 'session'):
277
181
            self.session.invalidate()
278
182
            self.session.delete()
279
183
            # Invalidates all IVLE cookies
280
 
            all_cookies = Cookie.get_cookies(self)
281
 
            for cookie in all_cookies:
282
 
                if cookie in ivle_cookies:
283
 
                    self.add_cookie(Cookie.Cookie(cookie,'',expires=1,path='/'))
284
 
        self.throw_redirect(ivle.util.make_path('')) 
 
184
            all_cookies = mod_python.Cookie.get_cookies(self)
 
185
 
 
186
            # Create cookies for plugins that might request them.
 
187
            for plugin in self.config.plugin_index[CookiePlugin]:
 
188
                for cookie in plugin.cookies:
 
189
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
 
190
                                                    expires=1, path='/'))
 
191
        self.throw_redirect(self.make_path(''))
285
192
 
286
193
 
287
194
    def flush(self):
302
209
        else:
303
210
            return self.apache_req.read(len)
304
211
 
305
 
    def throw_error(self, httpcode, message=None):
306
 
        """Writes out an HTTP error of the specified code. Raises an exception
307
 
        which is caught by the dispatch or web server, so any code following
308
 
        this call will not be executed.
309
 
 
310
 
        httpcode: An HTTP response status code. Pass a constant from the
311
 
        Request class.
312
 
        """
313
 
        raise ivle.util.IVLEError(httpcode, message)
314
 
 
315
212
    def throw_redirect(self, location):
316
213
        """Writes out an HTTP redirect to the specified URL. Raises an
317
214
        exception which is caught by the dispatch or web server, so any
327
224
    def add_cookie(self, cookie, value=None, **attributes):
328
225
        """Inserts a cookie into this request object's headers."""
329
226
        if value is None:
330
 
            Cookie.add_cookie(self.apache_req, cookie)
 
227
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
331
228
        else:
332
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
229
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
230
 
 
231
    def make_path(self, path):
 
232
        """Prepend the IVLE URL prefix to the given path.
 
233
 
 
234
        This is used when generating URLs to send to the client.
 
235
 
 
236
        This method is DEPRECATED. We no longer support use of a prefix.
 
237
        """
 
238
        return os.path.join(self.config['urls']['root'], path)
333
239
 
334
240
    def get_session(self):
335
241
        """Returns a mod_python Session object for this request.
336
242
        Note that this is dependent on mod_python and may need to change
337
 
        interface if porting away from mod_python."""
 
243
        interface if porting away from mod_python.
 
244
 
 
245
        IMPORTANT: Call unlock() on the session as soon as you are done with
 
246
                   it! If you don't, all other requests will block!
 
247
        """
338
248
        # Cache the session object and set the timeout to 24 hours.
339
249
        if not hasattr(self, 'session'):
340
 
            self.session = Session.FileSession(self.apache_req,
 
250
            self.session = mod_python.Session.FileSession(self.apache_req,
341
251
                                               timeout = 60 * 60 * 24)
342
252
        return self.session
343
253
 
347
257
        interface if porting away from mod_python."""
348
258
        # Cache the fieldstorage object
349
259
        if not hasattr(self, 'fields'):
350
 
            self.fields = util.FieldStorage(self.apache_req)
 
260
            self.fields = mod_python.util.FieldStorage(self.apache_req)
351
261
        return self.fields
352
262
 
353
263
    def get_cgi_environ(self):
359
269
            self.got_common_vars = True
360
270
        return self.apache_req.subprocess_env
361
271
 
362
 
    @staticmethod
363
 
    def get_http_codename(code):
364
 
        """Given a HTTP error code int, returns a (name, description)
365
 
        pair, suitable for displaying to the user.
366
 
        May return (None,None) if code is unknown.
367
 
        Only lists common 4xx and 5xx codes (since this is just used
368
 
        to display throw_error error messages).
369
 
        """
370
 
        try:
371
 
            return http_codenames[code]
372
 
        except KeyError:
373
 
            return None, None
374
 
 
375
 
# Human strings for HTTP response codes
376
 
http_codenames = {
377
 
    Request.HTTP_BAD_REQUEST:
378
 
        ("Bad Request",
379
 
        "Your browser sent a request IVLE did not understand."),
380
 
    Request.HTTP_UNAUTHORIZED:
381
 
        ("Unauthorized",
382
 
        "You are not allowed to view this part of IVLE."),
383
 
    Request.HTTP_FORBIDDEN:
384
 
        ("Forbidden",
385
 
        "You are not allowed to view this part of IVLE."),
386
 
    Request.HTTP_NOT_FOUND:
387
 
        ("Not Found",
388
 
        "The application or file you requested does not exist."),
389
 
    Request.HTTP_METHOD_NOT_ALLOWED:
390
 
        ("Method Not Allowed",
391
 
        "Your browser is interacting with IVLE in the wrong way."
392
 
        "This is probably a bug in IVLE. "
393
 
        "Please report it to the administrators."),
394
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
395
 
        ("Internal Server Error",
396
 
        "An unknown error occured in IVLE."),
397
 
    Request.HTTP_NOT_IMPLEMENTED:
398
 
        ("Not Implemented",
399
 
        "The application or file you requested has not been implemented "
400
 
        "in IVLE."),
401
 
    Request.HTTP_SERVICE_UNAVAILABLE:
402
 
        ("Service Unavailable",
403
 
        "IVLE is currently experiencing technical difficulties. "
404
 
        "Please try again later."),
405
 
}