← 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: me at id
  • Date: 2009-01-15 03:27:59 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:1153
bin/ivle-{showenrolment,enrolallusers}: Don't use ivle.db.get_user(); use
    ivle.database.User.get_by_login() instead.

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
 
except ImportError:
33
 
    # This needs to be importable from outside Apache.
34
 
    pass
35
 
 
36
 
import os.path
 
28
import mod_python
 
29
from mod_python import (util, Session, Cookie)
37
30
 
38
31
import ivle.util
 
32
import ivle.conf
39
33
import ivle.database
40
 
from ivle.webapp.base.plugins import CookiePlugin
 
34
import plugins.console # XXX: Relies on www/ being in the Python path.
41
35
 
42
36
class Request:
43
37
    """An IVLE request object. This is presented to the IVLE apps as a way of
79
73
        location (write)
80
74
            String. Response "Location" header value. Used with HTTP redirect
81
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.
82
109
    """
83
110
 
84
111
    # Special code for an OK response.
88
115
 
89
116
    # HTTP status codes
90
117
 
 
118
    HTTP_CONTINUE                     = 100
 
119
    HTTP_SWITCHING_PROTOCOLS          = 101
 
120
    HTTP_PROCESSING                   = 102
91
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
92
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
93
139
    HTTP_FORBIDDEN                    = 403
94
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
95
157
    HTTP_INTERNAL_SERVER_ERROR        = 500
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.
 
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.
102
175
        """
103
176
 
104
177
        # Methods are mostly wrappers around the Apache request object
105
178
        self.apache_req = req
106
 
        self.config = config
 
179
        self.func_write_html_head = write_html_head
107
180
        self.headers_written = False
108
181
 
109
182
        # Determine if the browser used the public host name to make the
110
183
        # request (in which case we are in "public mode")
111
 
        if req.hostname == config['urls']['public_host']:
 
184
        if req.hostname == ivle.conf.public_host:
112
185
            self.publicmode = True
113
186
        else:
114
187
            self.publicmode = False
118
191
        self.uri = req.uri
119
192
        # Split the given path into the app (top-level dir) and sub-path
120
193
        # (after first stripping away the root directory)
121
 
        (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))
122
196
        self.user = None
123
197
        self.hostname = req.hostname
124
198
        self.headers_in = req.headers_in
126
200
 
127
201
        # Open a database connection and transaction, keep it around for users
128
202
        # of the Request object to use
129
 
        self.store = ivle.database.get_store(config)
 
203
        self.store = ivle.database.get_store()
130
204
 
131
205
        # Default values for the output members
132
206
        self.status = Request.HTTP_OK
133
207
        self.content_type = None        # Use Apache's default
134
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
135
214
        # In some cases we don't want the template JS (such as the username
136
215
        # and public FQDN) in the output HTML. In that case, set this to 0.
137
216
        self.write_javascript_settings = True
145
224
        """Writes out the HTTP and HTML headers before any real data is
146
225
        written."""
147
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)
148
238
 
149
239
        # Prepare the HTTP and HTML headers before the first write is made
150
240
        if self.content_type != None:
152
242
        self.apache_req.status = self.status
153
243
        if self.location != None:
154
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)
155
248
 
156
249
    def ensure_headers_written(self):
157
250
        """Writes out the HTTP and HTML headers if they haven't already been
174
267
            # This includes binary strings.
175
268
            self.apache_req.write(string, flush)
176
269
 
177
 
    def logout(self):
178
 
        """Log out the current user by destroying the session state.
179
 
        Then redirect to the top-level IVLE page."""
180
 
        if hasattr(self, 'session'):
181
 
            self.session.invalidate()
182
 
            self.session.delete()
183
 
            # Invalidates all IVLE cookies
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(''))
192
 
 
193
 
 
194
270
    def flush(self):
195
271
        """Flushes the output buffer."""
196
272
        self.apache_req.flush()
209
285
        else:
210
286
            return self.apache_req.read(len)
211
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
 
212
298
    def throw_redirect(self, location):
213
299
        """Writes out an HTTP redirect to the specified URL. Raises an
214
300
        exception which is caught by the dispatch or web server, so any
224
310
    def add_cookie(self, cookie, value=None, **attributes):
225
311
        """Inserts a cookie into this request object's headers."""
226
312
        if value is None:
227
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
313
            Cookie.add_cookie(self.apache_req, cookie)
228
314
        else:
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)
 
315
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
239
316
 
240
317
    def get_session(self):
241
318
        """Returns a mod_python Session object for this request.
242
319
        Note that this is dependent on mod_python and may need to change
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
 
        """
 
320
        interface if porting away from mod_python."""
248
321
        # Cache the session object and set the timeout to 24 hours.
249
322
        if not hasattr(self, 'session'):
250
 
            self.session = mod_python.Session.FileSession(self.apache_req,
 
323
            self.session = Session.FileSession(self.apache_req,
251
324
                                               timeout = 60 * 60 * 24)
252
325
        return self.session
253
326
 
257
330
        interface if porting away from mod_python."""
258
331
        # Cache the fieldstorage object
259
332
        if not hasattr(self, 'fields'):
260
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
333
            self.fields = util.FieldStorage(self.apache_req)
261
334
        return self.fields
262
335
 
263
336
    def get_cgi_environ(self):
269
342
            self.got_common_vars = True
270
343
        return self.apache_req.subprocess_env
271
344
 
 
345
    @staticmethod
 
346
    def get_http_codename(code):
 
347
        """Given a HTTP error code int, returns a (name, description)
 
348
        pair, suitable for displaying to the user.
 
349
        May return (None,None) if code is unknown.
 
350
        Only lists common 4xx and 5xx codes (since this is just used
 
351
        to display throw_error error messages).
 
352
        """
 
353
        try:
 
354
            return http_codenames[code]
 
355
        except KeyError:
 
356
            return None, None
 
357
 
 
358
# Human strings for HTTP response codes
 
359
http_codenames = {
 
360
    Request.HTTP_BAD_REQUEST:
 
361
        ("Bad Request",
 
362
        "Your browser sent a request IVLE did not understand."),
 
363
    Request.HTTP_UNAUTHORIZED:
 
364
        ("Unauthorized",
 
365
        "You are not allowed to view this part of IVLE."),
 
366
    Request.HTTP_FORBIDDEN:
 
367
        ("Forbidden",
 
368
        "You are not allowed to view this part of IVLE."),
 
369
    Request.HTTP_NOT_FOUND:
 
370
        ("Not Found",
 
371
        "The application or file you requested does not exist."),
 
372
    Request.HTTP_METHOD_NOT_ALLOWED:
 
373
        ("Method Not Allowed",
 
374
        "Your browser is interacting with IVLE in the wrong way."
 
375
        "This is probably a bug in IVLE. "
 
376
        "Please report it to the administrators."),
 
377
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
378
        ("Internal Server Error",
 
379
        "An unknown error occured in IVLE."),
 
380
    Request.HTTP_NOT_IMPLEMENTED:
 
381
        ("Not Implemented",
 
382
        "The application or file you requested has not been implemented "
 
383
        "in IVLE."),
 
384
    Request.HTTP_SERVICE_UNAVAILABLE:
 
385
        ("Service Unavailable",
 
386
        "IVLE is currently experiencing technical difficulties. "
 
387
        "Please try again later."),
 
388
}