← 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: dcoles
  • Date: 2008-02-13 04:10:55 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:443
Added Forum application along with unmodifed version of phpBB3 "Olympus" 3.0.0

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.
80
80
            in the head, if write_html_head_foot is True.
81
81
            URLs should be relative to the IVLE root; they will be fixed up
82
82
            to be site-relative.
83
 
        scripts_init (write)
84
 
            List of strings. Write a list of JS function names, and they
85
 
            will be added as window.addListener('load', ..., false); calls
86
 
            in the head, if write_html_head_foot is True.
87
 
            This is the propper way to specify functions that need to run at 
88
 
            page load time.
89
83
        write_html_head_foot (write)
90
84
            Boolean. If True, dispatch assumes that this is an XHTML page, and
91
85
            will immediately write a full HTML head, open the body element,
186
180
        path = common.util.unmake_path(req.uri)
187
181
        if self.publicmode:
188
182
            self.app = None
189
 
            (_, self.path) = (common.util.split_path(path))
 
183
            self.path = path
190
184
        else:
191
185
            (self.app, self.path) = (common.util.split_path(path))
192
 
        self.user = None
 
186
        self.username = None
193
187
        self.hostname = req.hostname
194
188
        self.headers_in = req.headers_in
195
189
        self.headers_out = req.headers_out
201
195
        self.title = None     # Will be set by dispatch before passing to app
202
196
        self.styles = []
203
197
        self.scripts = []
204
 
        self.scripts_init = []
205
198
        self.write_html_head_foot = False
206
199
        self.got_common_vars = False
207
200
 
258
251
        else:
259
252
            return self.apache_req.read(len)
260
253
 
261
 
    def throw_error(self, httpcode, message=None):
 
254
    def throw_error(self, httpcode):
262
255
        """Writes out an HTTP error of the specified code. Raises an exception
263
256
        which is caught by the dispatch or web server, so any code following
264
257
        this call will not be executed.
266
259
        httpcode: An HTTP response status code. Pass a constant from the
267
260
        Request class.
268
261
        """
269
 
        raise common.util.IVLEError(httpcode, message)
 
262
        raise mod_python.apache.SERVER_RETURN, httpcode
270
263
 
271
264
    def throw_redirect(self, location):
272
265
        """Writes out an HTTP redirect to the specified URL. Raises an
278
271
        """
279
272
        mod_python.util.redirect(self.apache_req, location)
280
273
 
281
 
    def add_cookie(self, cookie, value=None, **attributes):
282
 
        """Inserts a cookie into this request object's headers."""
283
 
        if value is None:
284
 
            Cookie.add_cookie(self.apache_req, cookie)
285
 
        else:
286
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
287
 
 
288
274
    def get_session(self):
289
275
        """Returns a mod_python Session object for this request.
290
276
        Note that this is dependent on mod_python and may need to change
291
277
        interface if porting away from mod_python."""
292
 
        # Cache the session object and set the timeout to 24 hours.
 
278
        # Cache the session object
293
279
        if not hasattr(self, 'session'):
294
 
            self.session = Session.FileSession(self.apache_req,
295
 
                                               timeout = 60 * 60 * 24)
 
280
            self.session = Session.FileSession(self.apache_req)
296
281
        return self.session
297
282
 
298
283
    def get_fieldstorage(self):
312
297
            self.apache_req.add_common_vars()
313
298
            self.got_common_vars = True
314
299
        return self.apache_req.subprocess_env
315
 
 
316
 
    @staticmethod
317
 
    def get_http_codename(code):
318
 
        """Given a HTTP error code int, returns a (name, description)
319
 
        pair, suitable for displaying to the user.
320
 
        May return (None,None) if code is unknown.
321
 
        Only lists common 4xx and 5xx codes (since this is just used
322
 
        to display throw_error error messages).
323
 
        """
324
 
        try:
325
 
            return http_codenames[code]
326
 
        except KeyError:
327
 
            return None, None
328
 
 
329
 
# Human strings for HTTP response codes
330
 
http_codenames = {
331
 
    Request.HTTP_BAD_REQUEST:
332
 
        ("Bad Request",
333
 
        "Your browser sent a request IVLE did not understand."),
334
 
    Request.HTTP_UNAUTHORIZED:
335
 
        ("Unauthorized",
336
 
        "You are not allowed to view this part of IVLE."),
337
 
    Request.HTTP_FORBIDDEN:
338
 
        ("Forbidden",
339
 
        "You are not allowed to view this part of IVLE."),
340
 
    Request.HTTP_NOT_FOUND:
341
 
        ("Not Found",
342
 
        "The application or file you requested does not exist."),
343
 
    Request.HTTP_METHOD_NOT_ALLOWED:
344
 
        ("Method Not Allowed",
345
 
        "Your browser is interacting with IVLE in the wrong way."
346
 
        "This is probably a bug in IVLE. "
347
 
        "Please report it to the administrators."),
348
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
349
 
        ("Internal Server Error",
350
 
        "An unknown error occured in IVLE."),
351
 
    Request.HTTP_NOT_IMPLEMENTED:
352
 
        ("Not Implemented",
353
 
        "The application or file you requested has not been implemented "
354
 
        "in IVLE."),
355
 
    Request.HTTP_SERVICE_UNAVAILABLE:
356
 
        ("Service Unavailable",
357
 
        "IVLE is currently experiencing technical difficulties. "
358
 
        "Please try again later."),
359
 
}