← 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: mattgiuca
  • Date: 2008-02-05 01:41:15 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:409
Moved www/conf and www/common to a new directory lib. This separates the "web"
part of IVLE from what is becoming less web oriented (at least from Apache's
standpoint).
Modified setup.py to install this lib directory correctly and write conf in
the right place. Also adds the lib directory to ivle.pth.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/request.py
25
25
 
26
26
import common.util
27
27
import mod_python
28
 
from mod_python import (util, Session, Cookie)
 
28
from mod_python import (util, Session)
29
29
import conf
30
30
 
31
31
class Request:
43
43
            String. The path specified in the URL *not including* the
44
44
            application or the IVLE location prefix. eg. a URL of
45
45
            "/ivle/files/joe/myfiles" has a path of "joe/myfiles".
46
 
        user (read)
47
 
            User object. Details of the user who is currently logged in, or
 
46
        username (read)
 
47
            String. Login name of the user who is currently logged in, or
48
48
            None.
49
49
        hostname (read)
50
50
            String. Hostname the server is running on.
183
183
            self.path = path
184
184
        else:
185
185
            (self.app, self.path) = (common.util.split_path(path))
186
 
        self.user = None
 
186
        self.username = None
187
187
        self.hostname = req.hostname
188
188
        self.headers_in = req.headers_in
189
189
        self.headers_out = req.headers_out
251
251
        else:
252
252
            return self.apache_req.read(len)
253
253
 
254
 
    def throw_error(self, httpcode, message=None):
 
254
    def throw_error(self, httpcode):
255
255
        """Writes out an HTTP error of the specified code. Raises an exception
256
256
        which is caught by the dispatch or web server, so any code following
257
257
        this call will not be executed.
259
259
        httpcode: An HTTP response status code. Pass a constant from the
260
260
        Request class.
261
261
        """
262
 
        raise common.util.IVLEError(httpcode, message)
 
262
        raise mod_python.apache.SERVER_RETURN, httpcode
263
263
 
264
264
    def throw_redirect(self, location):
265
265
        """Writes out an HTTP redirect to the specified URL. Raises an
271
271
        """
272
272
        mod_python.util.redirect(self.apache_req, location)
273
273
 
274
 
    def add_cookie(self, cookie, value=None, **attributes):
275
 
        """Inserts a cookie into this request object's headers."""
276
 
        if value is None:
277
 
            Cookie.add_cookie(self.apache_req, cookie)
278
 
        else:
279
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
280
 
 
281
274
    def get_session(self):
282
275
        """Returns a mod_python Session object for this request.
283
276
        Note that this is dependent on mod_python and may need to change
284
277
        interface if porting away from mod_python."""
285
 
        # Cache the session object and set the timeout to 24 hours.
 
278
        # Cache the session object
286
279
        if not hasattr(self, 'session'):
287
 
            self.session = Session.FileSession(self.apache_req,
288
 
                                               timeout = 60 * 60 * 24)
 
280
            self.session = Session.FileSession(self.apache_req)
289
281
        return self.session
290
282
 
291
283
    def get_fieldstorage(self):
305
297
            self.apache_req.add_common_vars()
306
298
            self.got_common_vars = True
307
299
        return self.apache_req.subprocess_env
308
 
 
309
 
    @staticmethod
310
 
    def get_http_codename(code):
311
 
        """Given a HTTP error code int, returns a (name, description)
312
 
        pair, suitable for displaying to the user.
313
 
        May return (None,None) if code is unknown.
314
 
        Only lists common 4xx and 5xx codes (since this is just used
315
 
        to display throw_error error messages).
316
 
        """
317
 
        try:
318
 
            return http_codenames[code]
319
 
        except KeyError:
320
 
            return None, None
321
 
 
322
 
# Human strings for HTTP response codes
323
 
http_codenames = {
324
 
    Request.HTTP_BAD_REQUEST:
325
 
        ("Bad Request",
326
 
        "Your browser sent a request IVLE did not understand."),
327
 
    Request.HTTP_UNAUTHORIZED:
328
 
        ("Unauthorized",
329
 
        "You are not allowed to view this part of IVLE."),
330
 
    Request.HTTP_FORBIDDEN:
331
 
        ("Forbidden",
332
 
        "You are not allowed to view this part of IVLE."),
333
 
    Request.HTTP_NOT_FOUND:
334
 
        ("Not Found",
335
 
        "The application or file you requested does not exist."),
336
 
    Request.HTTP_METHOD_NOT_ALLOWED:
337
 
        ("Method Not Allowed",
338
 
        "Your browser is interacting with IVLE in the wrong way."
339
 
        "This is probably a bug in IVLE. "
340
 
        "Please report it to the administrators."),
341
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
342
 
        ("Internal Server Error",
343
 
        "An unknown error occured in IVLE."),
344
 
    Request.HTTP_NOT_IMPLEMENTED:
345
 
        ("Not Implemented",
346
 
        "The application or file you requested has not been implemented "
347
 
        "in IVLE."),
348
 
    Request.HTTP_SERVICE_UNAVAILABLE:
349
 
        ("Service Unavailable",
350
 
        "IVLE is currently experiencing technical difficulties. "
351
 
        "Please try again later."),
352
 
}