← 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: matt.giuca
  • Date: 2009-01-14 06:52:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1090.
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:branches%2Fstorm:1127
New module: ivle.database. Classes and utilities for Storm ORM.
    Can currently get a Storm store.
ivle.dispatch.request: Heading comments to new standards.
    Added 'store' attribute to Request object. Creates and destroys it
    appropriately.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
25
25
object.
26
26
"""
27
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
 
28
import mod_python
 
29
from mod_python import (util, Session, Cookie)
52
30
 
53
31
import ivle.util
 
32
import ivle.conf
54
33
import ivle.database
55
 
from ivle.webapp.base.plugins import CookiePlugin
56
 
import ivle.webapp.security
57
 
 
 
34
import plugins.console # XXX: Relies on www/ being in the Python path.
58
35
 
59
36
class Request:
60
37
    """An IVLE request object. This is presented to the IVLE apps as a way of
65
42
            String. The request method (eg. 'GET', 'POST', etc)
66
43
        uri (read)
67
44
            String. The path portion of the URI.
68
 
        unparsed_uri (read)
69
 
            String. The path portion of the URI, unparsed with query string.
70
45
        app (read)
71
46
            String. Name of the application specified in the URL, or None.
72
47
        path (read)
98
73
        location (write)
99
74
            String. Response "Location" header value. Used with HTTP redirect
100
75
            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.
101
109
    """
102
110
 
103
111
    # Special code for an OK response.
107
115
 
108
116
    # HTTP status codes
109
117
 
 
118
    HTTP_CONTINUE                     = 100
 
119
    HTTP_SWITCHING_PROTOCOLS          = 101
 
120
    HTTP_PROCESSING                   = 102
110
121
    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
111
131
    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
112
139
    HTTP_FORBIDDEN                    = 403
113
140
    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
114
157
    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.
 
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.
123
175
        """
124
176
 
125
177
        # Methods are mostly wrappers around the Apache request object
126
178
        self.apache_req = req
127
 
        self.config = config
 
179
        self.func_write_html_head = write_html_head
128
180
        self.headers_written = False
129
181
 
130
182
        # Determine if the browser used the public host name to make the
131
183
        # request (in which case we are in "public mode")
132
 
        if req.hostname == config['urls']['public_host']:
 
184
        if req.hostname == ivle.conf.public_host:
133
185
            self.publicmode = True
134
186
        else:
135
187
            self.publicmode = False
137
189
        # Inherit values for the input members
138
190
        self.method = req.method
139
191
        self.uri = req.uri
140
 
        self.unparsed_uri = req.unparsed_uri
141
192
        # Split the given path into the app (top-level dir) and sub-path
142
193
        # (after first stripping away the root directory)
143
 
        (self.app, self.path) = (ivle.util.split_path(req.uri))
 
194
        path = ivle.util.unmake_path(req.uri)
 
195
        (self.app, self.path) = (ivle.util.split_path(path))
 
196
        self.user = None
144
197
        self.hostname = req.hostname
145
198
        self.headers_in = req.headers_in
146
199
        self.headers_out = req.headers_out
147
200
 
 
201
        # Open a database connection and transaction, keep it around for users
 
202
        # of the Request object to use
 
203
        self.store = ivle.database.get_store()
 
204
 
148
205
        # Default values for the output members
149
206
        self.status = Request.HTTP_OK
150
207
        self.content_type = None        # Use Apache's default
151
208
        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
152
214
        # In some cases we don't want the template JS (such as the username
153
215
        # and public FQDN) in the output HTML. In that case, set this to 0.
154
216
        self.write_javascript_settings = True
155
217
        self.got_common_vars = False
156
218
 
157
219
    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()
 
220
        """Cleanup."""
 
221
        self.store.close()
170
222
 
171
223
    def __writeheaders(self):
172
224
        """Writes out the HTTP and HTML headers before any real data is
173
225
        written."""
174
226
        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)
175
238
 
176
239
        # Prepare the HTTP and HTML headers before the first write is made
177
240
        if self.content_type != None:
179
242
        self.apache_req.status = self.status
180
243
        if self.location != None:
181
244
            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)
182
248
 
183
249
    def ensure_headers_written(self):
184
250
        """Writes out the HTTP and HTML headers if they haven't already been
201
267
            # This includes binary strings.
202
268
            self.apache_req.write(string, flush)
203
269
 
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
270
    def flush(self):
222
271
        """Flushes the output buffer."""
223
272
        self.apache_req.flush()
236
285
        else:
237
286
            return self.apache_req.read(len)
238
287
 
 
288
    def throw_error(self, httpcode, message=None):
 
289
        """Writes out an HTTP error of the specified code. Raises an exception
 
290
        which is caught by the dispatch or web server, so any code following
 
291
        this call will not be executed.
 
292
 
 
293
        httpcode: An HTTP response status code. Pass a constant from the
 
294
        Request class.
 
295
        """
 
296
        raise ivle.util.IVLEError(httpcode, message)
 
297
 
239
298
    def throw_redirect(self, location):
240
299
        """Writes out an HTTP redirect to the specified URL. Raises an
241
300
        exception which is caught by the dispatch or web server, so any
244
303
        httpcode: An HTTP response status code. Pass a constant from the
245
304
        Request class.
246
305
        """
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"))
 
306
        mod_python.util.redirect(self.apache_req, location)
250
307
 
251
308
    def add_cookie(self, cookie, value=None, **attributes):
252
309
        """Inserts a cookie into this request object's headers."""
253
310
        if value is None:
254
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
311
            Cookie.add_cookie(self.apache_req, cookie)
255
312
        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)
 
313
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
266
314
 
267
315
    def get_session(self):
268
316
        """Returns a mod_python Session object for this request.
269
317
        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
 
        """
 
318
        interface if porting away from mod_python."""
275
319
        # Cache the session object and set the timeout to 24 hours.
276
320
        if not hasattr(self, 'session'):
277
 
            self.session = PotentiallySecureFileSession(
278
 
                self.apache_req, timeout = 60 * 60 * 24)
 
321
            self.session = Session.FileSession(self.apache_req,
 
322
                                               timeout = 60 * 60 * 24)
279
323
        return self.session
280
324
 
281
325
    def get_fieldstorage(self):
284
328
        interface if porting away from mod_python."""
285
329
        # Cache the fieldstorage object
286
330
        if not hasattr(self, 'fields'):
287
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
331
            self.fields = util.FieldStorage(self.apache_req)
288
332
        return self.fields
289
333
 
290
334
    def get_cgi_environ(self):
296
340
            self.got_common_vars = True
297
341
        return self.apache_req.subprocess_env
298
342
 
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.
 
343
    @staticmethod
 
344
    def get_http_codename(code):
 
345
        """Given a HTTP error code int, returns a (name, description)
 
346
        pair, suitable for displaying to the user.
 
347
        May return (None,None) if code is unknown.
 
348
        Only lists common 4xx and 5xx codes (since this is just used
 
349
        to display throw_error error messages).
 
350
        """
312
351
        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
 
352
            return http_codenames[code]
 
353
        except KeyError:
 
354
            return None, None
324
355
 
 
356
# Human strings for HTTP response codes
 
357
http_codenames = {
 
358
    Request.HTTP_BAD_REQUEST:
 
359
        ("Bad Request",
 
360
        "Your browser sent a request IVLE did not understand."),
 
361
    Request.HTTP_UNAUTHORIZED:
 
362
        ("Unauthorized",
 
363
        "You are not allowed to view this part of IVLE."),
 
364
    Request.HTTP_FORBIDDEN:
 
365
        ("Forbidden",
 
366
        "You are not allowed to view this part of IVLE."),
 
367
    Request.HTTP_NOT_FOUND:
 
368
        ("Not Found",
 
369
        "The application or file you requested does not exist."),
 
370
    Request.HTTP_METHOD_NOT_ALLOWED:
 
371
        ("Method Not Allowed",
 
372
        "Your browser is interacting with IVLE in the wrong way."
 
373
        "This is probably a bug in IVLE. "
 
374
        "Please report it to the administrators."),
 
375
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
376
        ("Internal Server Error",
 
377
        "An unknown error occured in IVLE."),
 
378
    Request.HTTP_NOT_IMPLEMENTED:
 
379
        ("Not Implemented",
 
380
        "The application or file you requested has not been implemented "
 
381
        "in IVLE."),
 
382
    Request.HTTP_SERVICE_UNAVAILABLE:
 
383
        ("Service Unavailable",
 
384
        "IVLE is currently experiencing technical difficulties. "
 
385
        "Please try again later."),
 
386
}