← 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: William Grant
  • Date: 2010-02-26 06:30:50 UTC
  • Revision ID: grantw@unimelb.edu.au-20100226063050-nwkscx3qsvigtv31
Fix diffservice and svnlogservice to create authentication-capable pysvn.Clients, so they don't crash if credentials aren't cached.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
29
29
    import mod_python.Session
30
30
    import mod_python.Cookie
31
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
32
47
except ImportError:
33
48
    # This needs to be importable from outside Apache.
34
49
    pass
38
53
import ivle.util
39
54
import ivle.database
40
55
from ivle.webapp.base.plugins import CookiePlugin
 
56
import ivle.webapp.security
 
57
 
41
58
 
42
59
class Request:
43
60
    """An IVLE request object. This is presented to the IVLE apps as a way of
79
96
        location (write)
80
97
            String. Response "Location" header value. Used with HTTP redirect
81
98
            responses.
82
 
        styles (write)
83
 
            List of strings. Write a list of URLs to CSS files here, and they
84
 
            will be incorporated as <link rel="stylesheet" type="text/css">
85
 
            elements in the head, if write_html_head_foot is True.
86
 
            URLs should be relative to the IVLE root; they will be fixed up
87
 
            to be site-relative.
88
 
        scripts (write)
89
 
            List of strings. Write a list of URLs to JS files here, and they
90
 
            will be incorporated as <script type="text/javascript"> elements
91
 
            in the head, if write_html_head_foot is True.
92
 
            URLs should be relative to the IVLE root; they will be fixed up
93
 
            to be site-relative.
94
 
        scripts_init (write)
95
 
            List of strings. Write a list of JS function names, and they
96
 
            will be added as window.addListener('load', ..., false); calls
97
 
            in the head, if write_html_head_foot is True.
98
 
            This is the propper way to specify functions that need to run at 
99
 
            page load time.
100
99
    """
101
100
 
102
101
    # Special code for an OK response.
106
105
 
107
106
    # HTTP status codes
108
107
 
109
 
    HTTP_CONTINUE                     = 100
110
 
    HTTP_SWITCHING_PROTOCOLS          = 101
111
 
    HTTP_PROCESSING                   = 102
112
108
    HTTP_OK                           = 200
113
 
    HTTP_CREATED                      = 201
114
 
    HTTP_ACCEPTED                     = 202
115
 
    HTTP_NON_AUTHORITATIVE            = 203
116
 
    HTTP_NO_CONTENT                   = 204
117
 
    HTTP_RESET_CONTENT                = 205
118
 
    HTTP_PARTIAL_CONTENT              = 206
119
 
    HTTP_MULTI_STATUS                 = 207
120
 
    HTTP_MULTIPLE_CHOICES             = 300
121
 
    HTTP_MOVED_PERMANENTLY            = 301
122
109
    HTTP_MOVED_TEMPORARILY            = 302
123
 
    HTTP_SEE_OTHER                    = 303
124
 
    HTTP_NOT_MODIFIED                 = 304
125
 
    HTTP_USE_PROXY                    = 305
126
 
    HTTP_TEMPORARY_REDIRECT           = 307
127
 
    HTTP_BAD_REQUEST                  = 400
128
 
    HTTP_UNAUTHORIZED                 = 401
129
 
    HTTP_PAYMENT_REQUIRED             = 402
130
110
    HTTP_FORBIDDEN                    = 403
131
111
    HTTP_NOT_FOUND                    = 404
132
 
    HTTP_METHOD_NOT_ALLOWED           = 405
133
 
    HTTP_NOT_ACCEPTABLE               = 406
134
 
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
135
 
    HTTP_REQUEST_TIME_OUT             = 408
136
 
    HTTP_CONFLICT                     = 409
137
 
    HTTP_GONE                         = 410
138
 
    HTTP_LENGTH_REQUIRED              = 411
139
 
    HTTP_PRECONDITION_FAILED          = 412
140
 
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
141
 
    HTTP_REQUEST_URI_TOO_LARGE        = 414
142
 
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
143
 
    HTTP_RANGE_NOT_SATISFIABLE        = 416
144
 
    HTTP_EXPECTATION_FAILED           = 417
145
 
    HTTP_UNPROCESSABLE_ENTITY         = 422
146
 
    HTTP_LOCKED                       = 423
147
 
    HTTP_FAILED_DEPENDENCY            = 424
148
112
    HTTP_INTERNAL_SERVER_ERROR        = 500
149
 
    HTTP_NOT_IMPLEMENTED              = 501
150
 
    HTTP_BAD_GATEWAY                  = 502
151
 
    HTTP_SERVICE_UNAVAILABLE          = 503
152
 
    HTTP_GATEWAY_TIME_OUT             = 504
153
 
    HTTP_VERSION_NOT_SUPPORTED        = 505
154
 
    HTTP_VARIANT_ALSO_VARIES          = 506
155
 
    HTTP_INSUFFICIENT_STORAGE         = 507
156
 
    HTTP_NOT_EXTENDED                 = 510
 
113
 
 
114
    _store = None
157
115
 
158
116
    def __init__(self, req, config):
159
117
        """Create an IVLE request from a mod_python one.
179
137
        self.uri = req.uri
180
138
        # Split the given path into the app (top-level dir) and sub-path
181
139
        # (after first stripping away the root directory)
182
 
        path = self.unmake_path(req.uri)
183
 
        (self.app, self.path) = (ivle.util.split_path(path))
184
 
        self.user = None
 
140
        (self.app, self.path) = (ivle.util.split_path(req.uri))
185
141
        self.hostname = req.hostname
186
142
        self.headers_in = req.headers_in
187
143
        self.headers_out = req.headers_out
188
144
 
189
 
        # Open a database connection and transaction, keep it around for users
190
 
        # of the Request object to use
191
 
        self.store = ivle.database.get_store(config)
192
 
 
193
145
        # Default values for the output members
194
146
        self.status = Request.HTTP_OK
195
147
        self.content_type = None        # Use Apache's default
196
148
        self.location = None
197
 
        self.styles = []
198
 
        self.scripts = []
199
 
        self.scripts_init = []
200
149
        # In some cases we don't want the template JS (such as the username
201
150
        # and public FQDN) in the output HTML. In that case, set this to 0.
202
151
        self.write_javascript_settings = True
203
152
        self.got_common_vars = False
204
153
 
205
154
    def __del__(self):
206
 
        """Cleanup."""
207
 
        self.store.close()
 
155
        self.cleanup()
 
156
 
 
157
    def cleanup(self):
 
158
        """Cleanup."""
 
159
        if self._store is not None:
 
160
            self._store.close()
 
161
            self._store = None
 
162
 
 
163
    def commit(self):
 
164
        """Cleanup."""
 
165
        if self._store is not None:
 
166
            self._store.commit()
208
167
 
209
168
    def __writeheaders(self):
210
169
        """Writes out the HTTP and HTML headers before any real data is
302
261
        """
303
262
        return os.path.join(self.config['urls']['root'], path)
304
263
 
305
 
    def unmake_path(self, path):
306
 
        """Strip the IVLE URL prefix from the given path, if present.
307
 
 
308
 
        Also normalises the path.
309
 
 
310
 
        This method is DEPRECATED. We no longer support use of a prefix.
311
 
        """
312
 
        path = os.path.normpath(path)
313
 
        root = os.path.normpath(self.config['urls']['root'])
314
 
 
315
 
        if path.startswith(root):
316
 
            path = path[len(root):]
317
 
            # Take out the slash as well
318
 
            if len(path) > 0 and path[0] == os.sep:
319
 
                path = path[1:]
320
 
 
321
 
        return path
322
 
 
323
264
    def get_session(self):
324
265
        """Returns a mod_python Session object for this request.
325
266
        Note that this is dependent on mod_python and may need to change
330
271
        """
331
272
        # Cache the session object and set the timeout to 24 hours.
332
273
        if not hasattr(self, 'session'):
333
 
            self.session = mod_python.Session.FileSession(self.apache_req,
334
 
                                               timeout = 60 * 60 * 24)
 
274
            self.session = PotentiallySecureFileSession(
 
275
                self.apache_req, timeout = 60 * 60 * 24)
335
276
        return self.session
336
277
 
337
278
    def get_fieldstorage(self):
352
293
            self.got_common_vars = True
353
294
        return self.apache_req.subprocess_env
354
295
 
355
 
    @staticmethod
356
 
    def get_http_codename(code):
357
 
        """Given a HTTP error code int, returns a (name, description)
358
 
        pair, suitable for displaying to the user.
359
 
        May return (None,None) if code is unknown.
360
 
        Only lists common 4xx and 5xx codes (since this is just used
361
 
        to display throw_error error messages).
362
 
        """
 
296
    @property
 
297
    def store(self):
 
298
        # Open a database connection and transaction, keep it around for users
 
299
        # of the Request object to use.
 
300
        if self._store is None:
 
301
            self._store = ivle.database.get_store(self.config)
 
302
        return self._store
 
303
 
 
304
    @property
 
305
    def user(self):
 
306
        # Get and cache the request user, or None if it's not valid.
 
307
        # This is a property so that we don't create a store unless
 
308
        # some code actually requests the user.
363
309
        try:
364
 
            return http_codenames[code]
365
 
        except KeyError:
366
 
            return None, None
 
310
            return self._user
 
311
        except AttributeError:
 
312
            if self.publicmode:
 
313
                self._user = None
 
314
            else:
 
315
                temp_user = ivle.webapp.security.get_user_details(self)
 
316
                if temp_user and temp_user.valid:
 
317
                    self._user = temp_user
 
318
                else:
 
319
                    self._user = None
 
320
            return self._user
367
321
 
368
 
# Human strings for HTTP response codes
369
 
http_codenames = {
370
 
    Request.HTTP_BAD_REQUEST:
371
 
        ("Bad Request",
372
 
        "Your browser sent a request IVLE did not understand."),
373
 
    Request.HTTP_UNAUTHORIZED:
374
 
        ("Unauthorized",
375
 
        "You are not allowed to view this part of IVLE."),
376
 
    Request.HTTP_FORBIDDEN:
377
 
        ("Forbidden",
378
 
        "You are not allowed to view this part of IVLE."),
379
 
    Request.HTTP_NOT_FOUND:
380
 
        ("Not Found",
381
 
        "The application or file you requested does not exist."),
382
 
    Request.HTTP_METHOD_NOT_ALLOWED:
383
 
        ("Method Not Allowed",
384
 
        "Your browser is interacting with IVLE in the wrong way."
385
 
        "This is probably a bug in IVLE. "
386
 
        "Please report it to the administrators."),
387
 
    Request.HTTP_INTERNAL_SERVER_ERROR:
388
 
        ("Internal Server Error",
389
 
        "An unknown error occured in IVLE."),
390
 
    Request.HTTP_NOT_IMPLEMENTED:
391
 
        ("Not Implemented",
392
 
        "The application or file you requested has not been implemented "
393
 
        "in IVLE."),
394
 
    Request.HTTP_SERVICE_UNAVAILABLE:
395
 
        ("Service Unavailable",
396
 
        "IVLE is currently experiencing technical difficulties. "
397
 
        "Please try again later."),
398
 
}