← 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-01-25 03:00:17 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:303
dispatch/html: Do a CGI escape on all text being rendered into the HTML.
tutorial: Set HTML title to the relevant subject/worksheet.

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.
180
180
        path = common.util.unmake_path(req.uri)
181
181
        if self.publicmode:
182
182
            self.app = None
183
 
            (_, self.path) = (common.util.split_path(path))
 
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
224
224
 
225
225
        if not self.headers_written:
226
226
            self.__writeheaders()
227
 
        if isinstance(string, unicode):
228
 
            # Encode unicode strings as UTF-8
229
 
            # (Otherwise cannot handle being written to a bytestream)
230
 
            self.apache_req.write(string.encode('utf8'), flush)
231
 
        else:
232
 
            # 8-bit clean strings just get written directly.
233
 
            # This includes binary strings.
234
 
            self.apache_req.write(string, flush)
 
227
        self.apache_req.write(string, flush)
235
228
 
236
229
    def flush(self):
237
230
        """Flushes the output buffer."""
251
244
        else:
252
245
            return self.apache_req.read(len)
253
246
 
254
 
    def throw_error(self, httpcode, message=None):
 
247
    def throw_error(self, httpcode):
255
248
        """Writes out an HTTP error of the specified code. Raises an exception
256
249
        which is caught by the dispatch or web server, so any code following
257
250
        this call will not be executed.
259
252
        httpcode: An HTTP response status code. Pass a constant from the
260
253
        Request class.
261
254
        """
262
 
        raise common.util.IVLEError(httpcode, message)
 
255
        raise mod_python.apache.SERVER_RETURN, httpcode
263
256
 
264
257
    def throw_redirect(self, location):
265
258
        """Writes out an HTTP redirect to the specified URL. Raises an
271
264
        """
272
265
        mod_python.util.redirect(self.apache_req, location)
273
266
 
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
267
    def get_session(self):
282
268
        """Returns a mod_python Session object for this request.
283
269
        Note that this is dependent on mod_python and may need to change
284
270
        interface if porting away from mod_python."""
285
 
        # Cache the session object and set the timeout to 24 hours.
 
271
        # Cache the session object
286
272
        if not hasattr(self, 'session'):
287
 
            self.session = Session.FileSession(self.apache_req,
288
 
                                               timeout = 60 * 60 * 24)
 
273
            self.session = Session.Session(self.apache_req)
289
274
        return self.session
290
275
 
291
276
    def get_fieldstorage(self):
305
290
            self.apache_req.add_common_vars()
306
291
            self.got_common_vars = True
307
292
        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
 
}