← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

ivle.webapp.tutorial: Port www/apps/tutorial to new framework.

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
47
32
except ImportError:
48
33
    # This needs to be importable from outside Apache.
49
34
    pass
50
35
 
51
 
import os.path
52
 
 
53
36
import ivle.util
 
37
import ivle.conf
54
38
import ivle.database
55
 
from ivle.webapp.base.plugins import CookiePlugin
56
 
import ivle.webapp.security
57
 
 
 
39
import plugins.console # XXX: Relies on www/ being in the Python path.
58
40
 
59
41
class Request:
60
42
    """An IVLE request object. This is presented to the IVLE apps as a way of
65
47
            String. The request method (eg. 'GET', 'POST', etc)
66
48
        uri (read)
67
49
            String. The path portion of the URI.
68
 
        unparsed_uri (read)
69
 
            String. The path portion of the URI, unparsed with query string.
70
50
        app (read)
71
51
            String. Name of the application specified in the URL, or None.
72
52
        path (read)
98
78
        location (write)
99
79
            String. Response "Location" header value. Used with HTTP redirect
100
80
            responses.
 
81
        title (write)
 
82
            String. HTML page title. Used if write_html_head_foot is True, in
 
83
            the HTML title element text.
 
84
        styles (write)
 
85
            List of strings. Write a list of URLs to CSS files here, and they
 
86
            will be incorporated as <link rel="stylesheet" type="text/css">
 
87
            elements in the head, if write_html_head_foot is True.
 
88
            URLs should be relative to the IVLE root; they will be fixed up
 
89
            to be site-relative.
 
90
        scripts (write)
 
91
            List of strings. Write a list of URLs to JS files here, and they
 
92
            will be incorporated as <script type="text/javascript"> elements
 
93
            in the head, if write_html_head_foot is True.
 
94
            URLs should be relative to the IVLE root; they will be fixed up
 
95
            to be site-relative.
 
96
        scripts_init (write)
 
97
            List of strings. Write a list of JS function names, and they
 
98
            will be added as window.addListener('load', ..., false); calls
 
99
            in the head, if write_html_head_foot is True.
 
100
            This is the propper way to specify functions that need to run at 
 
101
            page load time.
 
102
        write_html_head_foot (write)
 
103
            Boolean. If True, dispatch assumes that this is an XHTML page, and
 
104
            will immediately write a full HTML head, open the body element,
 
105
            and write heading contents to the page, before any bytes are
 
106
            written. It will then write footer contents and close the body and
 
107
            html elements at the end of execution.  
 
108
 
 
109
            This value should be set to true by all applications for all HTML
 
110
            output (unless there is a good reason, eg. exec). The
 
111
            applications should therefore output HTML content assuming that
 
112
            it will be written inside the body tag. Do not write opening or
 
113
            closing <html> or <body> tags.
101
114
    """
102
115
 
103
116
    # Special code for an OK response.
107
120
 
108
121
    # HTTP status codes
109
122
 
 
123
    HTTP_CONTINUE                     = 100
 
124
    HTTP_SWITCHING_PROTOCOLS          = 101
 
125
    HTTP_PROCESSING                   = 102
110
126
    HTTP_OK                           = 200
 
127
    HTTP_CREATED                      = 201
 
128
    HTTP_ACCEPTED                     = 202
 
129
    HTTP_NON_AUTHORITATIVE            = 203
 
130
    HTTP_NO_CONTENT                   = 204
 
131
    HTTP_RESET_CONTENT                = 205
 
132
    HTTP_PARTIAL_CONTENT              = 206
 
133
    HTTP_MULTI_STATUS                 = 207
 
134
    HTTP_MULTIPLE_CHOICES             = 300
 
135
    HTTP_MOVED_PERMANENTLY            = 301
111
136
    HTTP_MOVED_TEMPORARILY            = 302
 
137
    HTTP_SEE_OTHER                    = 303
 
138
    HTTP_NOT_MODIFIED                 = 304
 
139
    HTTP_USE_PROXY                    = 305
 
140
    HTTP_TEMPORARY_REDIRECT           = 307
 
141
    HTTP_BAD_REQUEST                  = 400
 
142
    HTTP_UNAUTHORIZED                 = 401
 
143
    HTTP_PAYMENT_REQUIRED             = 402
112
144
    HTTP_FORBIDDEN                    = 403
113
145
    HTTP_NOT_FOUND                    = 404
 
146
    HTTP_METHOD_NOT_ALLOWED           = 405
 
147
    HTTP_NOT_ACCEPTABLE               = 406
 
148
    HTTP_PROXY_AUTHENTICATION_REQUIRED= 407
 
149
    HTTP_REQUEST_TIME_OUT             = 408
 
150
    HTTP_CONFLICT                     = 409
 
151
    HTTP_GONE                         = 410
 
152
    HTTP_LENGTH_REQUIRED              = 411
 
153
    HTTP_PRECONDITION_FAILED          = 412
 
154
    HTTP_REQUEST_ENTITY_TOO_LARGE     = 413
 
155
    HTTP_REQUEST_URI_TOO_LARGE        = 414
 
156
    HTTP_UNSUPPORTED_MEDIA_TYPE       = 415
 
157
    HTTP_RANGE_NOT_SATISFIABLE        = 416
 
158
    HTTP_EXPECTATION_FAILED           = 417
 
159
    HTTP_UNPROCESSABLE_ENTITY         = 422
 
160
    HTTP_LOCKED                       = 423
 
161
    HTTP_FAILED_DEPENDENCY            = 424
114
162
    HTTP_INTERNAL_SERVER_ERROR        = 500
115
 
 
116
 
    _store = None
117
 
 
118
 
    def __init__(self, req, config):
119
 
        """Create an IVLE request from a mod_python one.
120
 
 
121
 
        @param req: A mod_python request.
122
 
        @param config: An IVLE configuration.
 
163
    HTTP_NOT_IMPLEMENTED              = 501
 
164
    HTTP_BAD_GATEWAY                  = 502
 
165
    HTTP_SERVICE_UNAVAILABLE          = 503
 
166
    HTTP_GATEWAY_TIME_OUT             = 504
 
167
    HTTP_VERSION_NOT_SUPPORTED        = 505
 
168
    HTTP_VARIANT_ALSO_VARIES          = 506
 
169
    HTTP_INSUFFICIENT_STORAGE         = 507
 
170
    HTTP_NOT_EXTENDED                 = 510
 
171
 
 
172
    def __init__(self, req, write_html_head):
 
173
        """Builds an IVLE request object from a mod_python request object.
 
174
        This results in an object with all of the necessary methods and
 
175
        additional fields.
 
176
 
 
177
        req: A mod_python request object.
 
178
        write_html_head: Function which is called when writing the automatic
 
179
            HTML header. Accepts a single argument, the IVLE request object.
123
180
        """
124
181
 
125
182
        # Methods are mostly wrappers around the Apache request object
126
183
        self.apache_req = req
127
 
        self.config = config
 
184
        self.func_write_html_head = write_html_head
128
185
        self.headers_written = False
129
186
 
130
187
        # Determine if the browser used the public host name to make the
131
188
        # request (in which case we are in "public mode")
132
 
        if req.hostname == config['urls']['public_host']:
 
189
        if req.hostname == ivle.conf.public_host:
133
190
            self.publicmode = True
134
191
        else:
135
192
            self.publicmode = False
137
194
        # Inherit values for the input members
138
195
        self.method = req.method
139
196
        self.uri = req.uri
140
 
        self.unparsed_uri = req.unparsed_uri
141
197
        # Split the given path into the app (top-level dir) and sub-path
142
198
        # (after first stripping away the root directory)
143
 
        (self.app, self.path) = (ivle.util.split_path(req.uri))
 
199
        path = ivle.util.unmake_path(req.uri)
 
200
        (self.app, self.path) = (ivle.util.split_path(path))
 
201
        self.user = None
144
202
        self.hostname = req.hostname
145
203
        self.headers_in = req.headers_in
146
204
        self.headers_out = req.headers_out
147
205
 
 
206
        # Open a database connection and transaction, keep it around for users
 
207
        # of the Request object to use
 
208
        self.store = ivle.database.get_store()
 
209
 
148
210
        # Default values for the output members
149
211
        self.status = Request.HTTP_OK
150
212
        self.content_type = None        # Use Apache's default
151
213
        self.location = None
 
214
        self.title = None     # Will be set by dispatch before passing to app
 
215
        self.styles = []
 
216
        self.scripts = []
 
217
        self.scripts_init = []
 
218
        self.write_html_head_foot = False
152
219
        # In some cases we don't want the template JS (such as the username
153
220
        # and public FQDN) in the output HTML. In that case, set this to 0.
154
221
        self.write_javascript_settings = True
155
222
        self.got_common_vars = False
156
223
 
157
224
    def __del__(self):
158
 
        self.cleanup()
159
 
 
160
 
    def cleanup(self):
161
 
        """Cleanup."""
162
 
        if self._store is not None:
163
 
            self._store.close()
164
 
            self._store = None
165
 
 
166
 
    def commit(self):
167
 
        """Cleanup."""
168
 
        if self._store is not None:
169
 
            self._store.commit()
 
225
        """Cleanup."""
 
226
        self.store.close()
170
227
 
171
228
    def __writeheaders(self):
172
229
        """Writes out the HTTP and HTML headers before any real data is
173
230
        written."""
174
231
        self.headers_written = True
 
232
        
 
233
        # app is the App object for the chosen app
 
234
        try:
 
235
            app = ivle.conf.apps.app_url[self.app]
 
236
        except KeyError:
 
237
            app = None
 
238
 
 
239
        # Write any final modifications to header content
 
240
        if app and app.useconsole and self.user:
 
241
            plugins.console.insert_scripts_styles(self.scripts, self.styles, \
 
242
                self.scripts_init)
175
243
 
176
244
        # Prepare the HTTP and HTML headers before the first write is made
177
245
        if self.content_type != None:
179
247
        self.apache_req.status = self.status
180
248
        if self.location != None:
181
249
            self.apache_req.headers_out['Location'] = self.location
 
250
        if self.write_html_head_foot:
 
251
            # Write the HTML header, pass "self" (request object)
 
252
            self.func_write_html_head(self)
182
253
 
183
254
    def ensure_headers_written(self):
184
255
        """Writes out the HTTP and HTML headers if they haven't already been
204
275
    def logout(self):
205
276
        """Log out the current user by destroying the session state.
206
277
        Then redirect to the top-level IVLE page."""
 
278
        # List of cookies that IVLE uses (to be removed at logout)
 
279
        ivle_cookies = ["ivleforumcookie", "clipboard"]
 
280
        
207
281
        if hasattr(self, 'session'):
208
282
            self.session.invalidate()
209
283
            self.session.delete()
210
284
            # Invalidates all IVLE cookies
211
285
            all_cookies = mod_python.Cookie.get_cookies(self)
212
 
 
213
 
            # Create cookies for plugins that might request them.
214
 
            for plugin in self.config.plugin_index[CookiePlugin]:
215
 
                for cookie in plugin.cookies:
216
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
217
 
                                                    expires=1, path='/'))
218
 
        self.throw_redirect(self.make_path(''))
 
286
            for cookie in all_cookies:
 
287
                if cookie in ivle_cookies:
 
288
                    self.add_cookie(mod_python.Cookie.Cookie(cookie,'',expires=1,path='/'))
 
289
        self.throw_redirect(ivle.util.make_path('')) 
219
290
 
220
291
 
221
292
    def flush(self):
236
307
        else:
237
308
            return self.apache_req.read(len)
238
309
 
 
310
    def throw_error(self, httpcode, message=None):
 
311
        """Writes out an HTTP error of the specified code. Raises an exception
 
312
        which is caught by the dispatch or web server, so any code following
 
313
        this call will not be executed.
 
314
 
 
315
        httpcode: An HTTP response status code. Pass a constant from the
 
316
        Request class.
 
317
        """
 
318
        raise ivle.util.IVLEError(httpcode, message)
 
319
 
239
320
    def throw_redirect(self, location):
240
321
        """Writes out an HTTP redirect to the specified URL. Raises an
241
322
        exception which is caught by the dispatch or web server, so any
255
336
        else:
256
337
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
257
338
 
258
 
    def make_path(self, path):
259
 
        """Prepend the IVLE URL prefix to the given path.
260
 
 
261
 
        This is used when generating URLs to send to the client.
262
 
 
263
 
        This method is DEPRECATED. We no longer support use of a prefix.
264
 
        """
265
 
        return os.path.join(self.config['urls']['root'], path)
266
 
 
267
339
    def get_session(self):
268
340
        """Returns a mod_python Session object for this request.
269
341
        Note that this is dependent on mod_python and may need to change
270
 
        interface if porting away from mod_python.
271
 
 
272
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
273
 
                   it! If you don't, all other requests will block!
274
 
        """
 
342
        interface if porting away from mod_python."""
275
343
        # Cache the session object and set the timeout to 24 hours.
276
344
        if not hasattr(self, 'session'):
277
 
            self.session = PotentiallySecureFileSession(
278
 
                self.apache_req, timeout = 60 * 60 * 24)
 
345
            self.session = mod_python.Session.FileSession(self.apache_req,
 
346
                                               timeout = 60 * 60 * 24)
279
347
        return self.session
280
348
 
281
349
    def get_fieldstorage(self):
296
364
            self.got_common_vars = True
297
365
        return self.apache_req.subprocess_env
298
366
 
299
 
    @property
300
 
    def store(self):
301
 
        # Open a database connection and transaction, keep it around for users
302
 
        # of the Request object to use.
303
 
        if self._store is None:
304
 
            self._store = ivle.database.get_store(self.config)
305
 
        return self._store
306
 
 
307
 
    @property
308
 
    def user(self):
309
 
        # Get and cache the request user, or None if it's not valid.
310
 
        # This is a property so that we don't create a store unless
311
 
        # some code actually requests the user.
 
367
    @staticmethod
 
368
    def get_http_codename(code):
 
369
        """Given a HTTP error code int, returns a (name, description)
 
370
        pair, suitable for displaying to the user.
 
371
        May return (None,None) if code is unknown.
 
372
        Only lists common 4xx and 5xx codes (since this is just used
 
373
        to display throw_error error messages).
 
374
        """
312
375
        try:
313
 
            return self._user
314
 
        except AttributeError:
315
 
            if self.publicmode:
316
 
                self._user = None
317
 
            else:
318
 
                temp_user = ivle.webapp.security.get_user_details(self)
319
 
                if temp_user and temp_user.valid:
320
 
                    self._user = temp_user
321
 
                else:
322
 
                    self._user = None
323
 
            return self._user
 
376
            return http_codenames[code]
 
377
        except KeyError:
 
378
            return None, None
324
379
 
 
380
# Human strings for HTTP response codes
 
381
http_codenames = {
 
382
    Request.HTTP_BAD_REQUEST:
 
383
        ("Bad Request",
 
384
        "Your browser sent a request IVLE did not understand."),
 
385
    Request.HTTP_UNAUTHORIZED:
 
386
        ("Unauthorized",
 
387
        "You are not allowed to view this part of IVLE."),
 
388
    Request.HTTP_FORBIDDEN:
 
389
        ("Forbidden",
 
390
        "You are not allowed to view this part of IVLE."),
 
391
    Request.HTTP_NOT_FOUND:
 
392
        ("Not Found",
 
393
        "The application or file you requested does not exist."),
 
394
    Request.HTTP_METHOD_NOT_ALLOWED:
 
395
        ("Method Not Allowed",
 
396
        "Your browser is interacting with IVLE in the wrong way."
 
397
        "This is probably a bug in IVLE. "
 
398
        "Please report it to the administrators."),
 
399
    Request.HTTP_INTERNAL_SERVER_ERROR:
 
400
        ("Internal Server Error",
 
401
        "An unknown error occured in IVLE."),
 
402
    Request.HTTP_NOT_IMPLEMENTED:
 
403
        ("Not Implemented",
 
404
        "The application or file you requested has not been implemented "
 
405
        "in IVLE."),
 
406
    Request.HTTP_SERVICE_UNAVAILABLE:
 
407
        ("Service Unavailable",
 
408
        "IVLE is currently experiencing technical difficulties. "
 
409
        "Please try again later."),
 
410
}