← 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: Matt Giuca
  • Date: 2010-03-22 06:05:32 UTC
  • Revision ID: matt.giuca@gmail.com-20100322060532-5365361xrx9mh32v
https://launchpad.net/bugs/543936
Changed database.py get_svn_url to take a req; include the req.user.login in the Subversion URL. This allows you to check out repositories without separately supplying the IVLE URL (as Subversion won't ask for a username by default). Also removed --username= from the lecturer project view, as it's redundant now. This fixes Launchpad bug #543936.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
25
25
object.
26
26
"""
27
27
 
28
 
import mod_python
29
 
from mod_python import (util, Session, Cookie)
 
28
try:
 
29
    import mod_python.Session
 
30
    import mod_python.Cookie
 
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
 
47
except ImportError:
 
48
    # This needs to be importable from outside Apache.
 
49
    pass
 
50
 
 
51
import os.path
30
52
 
31
53
import ivle.util
32
 
import ivle.conf
33
54
import ivle.database
34
 
import plugins.console # XXX: Relies on www/ being in the Python path.
 
55
from ivle.webapp.base.plugins import CookiePlugin
 
56
import ivle.webapp.security
 
57
 
35
58
 
36
59
class Request:
37
60
    """An IVLE request object. This is presented to the IVLE apps as a way of
73
96
        location (write)
74
97
            String. Response "Location" header value. Used with HTTP redirect
75
98
            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.
109
99
    """
110
100
 
111
101
    # Special code for an OK response.
115
105
 
116
106
    # HTTP status codes
117
107
 
118
 
    HTTP_CONTINUE                     = 100
119
 
    HTTP_SWITCHING_PROTOCOLS          = 101
120
 
    HTTP_PROCESSING                   = 102
121
108
    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
131
109
    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
139
110
    HTTP_FORBIDDEN                    = 403
140
111
    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
157
112
    HTTP_INTERNAL_SERVER_ERROR        = 500
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.
 
113
 
 
114
    _store = None
 
115
 
 
116
    def __init__(self, req, config):
 
117
        """Create an IVLE request from a mod_python one.
 
118
 
 
119
        @param req: A mod_python request.
 
120
        @param config: An IVLE configuration.
175
121
        """
176
122
 
177
123
        # Methods are mostly wrappers around the Apache request object
178
124
        self.apache_req = req
179
 
        self.func_write_html_head = write_html_head
 
125
        self.config = config
180
126
        self.headers_written = False
181
127
 
182
128
        # Determine if the browser used the public host name to make the
183
129
        # request (in which case we are in "public mode")
184
 
        if req.hostname == ivle.conf.public_host:
 
130
        if req.hostname == config['urls']['public_host']:
185
131
            self.publicmode = True
186
132
        else:
187
133
            self.publicmode = False
191
137
        self.uri = req.uri
192
138
        # Split the given path into the app (top-level dir) and sub-path
193
139
        # (after first stripping away the root directory)
194
 
        path = ivle.util.unmake_path(req.uri)
195
 
        (self.app, self.path) = (ivle.util.split_path(path))
196
 
        self.user = None
 
140
        (self.app, self.path) = (ivle.util.split_path(req.uri))
197
141
        self.hostname = req.hostname
198
142
        self.headers_in = req.headers_in
199
143
        self.headers_out = req.headers_out
200
144
 
201
 
        # Open a database connection and transaction, keep it around for users
202
 
        # of the Request object to use
203
 
        self.store = ivle.database.get_store()
204
 
 
205
145
        # Default values for the output members
206
146
        self.status = Request.HTTP_OK
207
147
        self.content_type = None        # Use Apache's default
208
148
        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
214
149
        # In some cases we don't want the template JS (such as the username
215
150
        # and public FQDN) in the output HTML. In that case, set this to 0.
216
151
        self.write_javascript_settings = True
217
152
        self.got_common_vars = False
218
153
 
219
154
    def __del__(self):
220
 
        """Cleanup."""
221
 
        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()
222
167
 
223
168
    def __writeheaders(self):
224
169
        """Writes out the HTTP and HTML headers before any real data is
225
170
        written."""
226
171
        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)
238
172
 
239
173
        # Prepare the HTTP and HTML headers before the first write is made
240
174
        if self.content_type != None:
242
176
        self.apache_req.status = self.status
243
177
        if self.location != None:
244
178
            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)
248
179
 
249
180
    def ensure_headers_written(self):
250
181
        """Writes out the HTTP and HTML headers if they haven't already been
267
198
            # This includes binary strings.
268
199
            self.apache_req.write(string, flush)
269
200
 
 
201
    def logout(self):
 
202
        """Log out the current user by destroying the session state.
 
203
        Then redirect to the top-level IVLE page."""
 
204
        if hasattr(self, 'session'):
 
205
            self.session.invalidate()
 
206
            self.session.delete()
 
207
            # Invalidates all IVLE cookies
 
208
            all_cookies = mod_python.Cookie.get_cookies(self)
 
209
 
 
210
            # Create cookies for plugins that might request them.
 
211
            for plugin in self.config.plugin_index[CookiePlugin]:
 
212
                for cookie in plugin.cookies:
 
213
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
 
214
                                                    expires=1, path='/'))
 
215
        self.throw_redirect(self.make_path(''))
 
216
 
 
217
 
270
218
    def flush(self):
271
219
        """Flushes the output buffer."""
272
220
        self.apache_req.flush()
285
233
        else:
286
234
            return self.apache_req.read(len)
287
235
 
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
 
 
298
236
    def throw_redirect(self, location):
299
237
        """Writes out an HTTP redirect to the specified URL. Raises an
300
238
        exception which is caught by the dispatch or web server, so any
310
248
    def add_cookie(self, cookie, value=None, **attributes):
311
249
        """Inserts a cookie into this request object's headers."""
312
250
        if value is None:
313
 
            Cookie.add_cookie(self.apache_req, cookie)
 
251
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
314
252
        else:
315
 
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
253
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
254
 
 
255
    def make_path(self, path):
 
256
        """Prepend the IVLE URL prefix to the given path.
 
257
 
 
258
        This is used when generating URLs to send to the client.
 
259
 
 
260
        This method is DEPRECATED. We no longer support use of a prefix.
 
261
        """
 
262
        return os.path.join(self.config['urls']['root'], path)
316
263
 
317
264
    def get_session(self):
318
265
        """Returns a mod_python Session object for this request.
319
266
        Note that this is dependent on mod_python and may need to change
320
 
        interface if porting away from mod_python."""
 
267
        interface if porting away from mod_python.
 
268
 
 
269
        IMPORTANT: Call unlock() on the session as soon as you are done with
 
270
                   it! If you don't, all other requests will block!
 
271
        """
321
272
        # Cache the session object and set the timeout to 24 hours.
322
273
        if not hasattr(self, 'session'):
323
 
            self.session = Session.FileSession(self.apache_req,
324
 
                                               timeout = 60 * 60 * 24)
 
274
            self.session = PotentiallySecureFileSession(
 
275
                self.apache_req, timeout = 60 * 60 * 24)
325
276
        return self.session
326
277
 
327
278
    def get_fieldstorage(self):
330
281
        interface if porting away from mod_python."""
331
282
        # Cache the fieldstorage object
332
283
        if not hasattr(self, 'fields'):
333
 
            self.fields = util.FieldStorage(self.apache_req)
 
284
            self.fields = mod_python.util.FieldStorage(self.apache_req)
334
285
        return self.fields
335
286
 
336
287
    def get_cgi_environ(self):
342
293
            self.got_common_vars = True
343
294
        return self.apache_req.subprocess_env
344
295
 
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
 
        """
 
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.
353
309
        try:
354
 
            return http_codenames[code]
355
 
        except KeyError:
356
 
            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
357
321
 
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
 
}