← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

Port www/apps/logout to new framework (in ivle.webapp.security).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
33
33
    # This needs to be importable from outside Apache.
34
34
    pass
35
35
 
36
 
import os.path
37
 
 
38
36
import ivle.util
 
37
import ivle.conf
39
38
import ivle.database
40
 
from ivle.webapp.base.plugins import CookiePlugin
41
 
import ivle.webapp.security
 
39
import plugins.console # XXX: Relies on www/ being in the Python path.
42
40
 
43
41
class Request:
44
42
    """An IVLE request object. This is presented to the IVLE apps as a way of
80
78
        location (write)
81
79
            String. Response "Location" header value. Used with HTTP redirect
82
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.
83
114
    """
84
115
 
85
116
    # Special code for an OK response.
89
120
 
90
121
    # HTTP status codes
91
122
 
 
123
    HTTP_CONTINUE                     = 100
 
124
    HTTP_SWITCHING_PROTOCOLS          = 101
 
125
    HTTP_PROCESSING                   = 102
92
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
93
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
94
144
    HTTP_FORBIDDEN                    = 403
95
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
96
162
    HTTP_INTERNAL_SERVER_ERROR        = 500
97
 
 
98
 
    _store = None
99
 
 
100
 
    def __init__(self, req, config):
101
 
        """Create an IVLE request from a mod_python one.
102
 
 
103
 
        @param req: A mod_python request.
104
 
        @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.
105
180
        """
106
181
 
107
182
        # Methods are mostly wrappers around the Apache request object
108
183
        self.apache_req = req
109
 
        self.config = config
 
184
        self.func_write_html_head = write_html_head
110
185
        self.headers_written = False
111
186
 
112
187
        # Determine if the browser used the public host name to make the
113
188
        # request (in which case we are in "public mode")
114
 
        if req.hostname == config['urls']['public_host']:
 
189
        if req.hostname == ivle.conf.public_host:
115
190
            self.publicmode = True
116
191
        else:
117
192
            self.publicmode = False
121
196
        self.uri = req.uri
122
197
        # Split the given path into the app (top-level dir) and sub-path
123
198
        # (after first stripping away the root directory)
124
 
        (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
125
202
        self.hostname = req.hostname
126
203
        self.headers_in = req.headers_in
127
204
        self.headers_out = req.headers_out
128
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
 
129
210
        # Default values for the output members
130
211
        self.status = Request.HTTP_OK
131
212
        self.content_type = None        # Use Apache's default
132
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
133
219
        # In some cases we don't want the template JS (such as the username
134
220
        # and public FQDN) in the output HTML. In that case, set this to 0.
135
221
        self.write_javascript_settings = True
136
222
        self.got_common_vars = False
137
223
 
138
224
    def __del__(self):
139
 
        self.cleanup()
140
 
 
141
 
    def cleanup(self):
142
 
        """Cleanup."""
143
 
        if self._store is not None:
144
 
            self._store.close()
145
 
            self._store = None
146
 
 
147
 
    def commit(self):
148
 
        """Cleanup."""
149
 
        if self._store is not None:
150
 
            self._store.commit()
 
225
        """Cleanup."""
 
226
        self.store.close()
151
227
 
152
228
    def __writeheaders(self):
153
229
        """Writes out the HTTP and HTML headers before any real data is
154
230
        written."""
155
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)
156
243
 
157
244
        # Prepare the HTTP and HTML headers before the first write is made
158
245
        if self.content_type != None:
160
247
        self.apache_req.status = self.status
161
248
        if self.location != None:
162
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)
163
253
 
164
254
    def ensure_headers_written(self):
165
255
        """Writes out the HTTP and HTML headers if they haven't already been
185
275
    def logout(self):
186
276
        """Log out the current user by destroying the session state.
187
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
        
188
281
        if hasattr(self, 'session'):
189
282
            self.session.invalidate()
190
283
            self.session.delete()
191
284
            # Invalidates all IVLE cookies
192
285
            all_cookies = mod_python.Cookie.get_cookies(self)
193
 
 
194
 
            # Create cookies for plugins that might request them.
195
 
            for plugin in self.config.plugin_index[CookiePlugin]:
196
 
                for cookie in plugin.cookies:
197
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
198
 
                                                    expires=1, path='/'))
199
 
        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('')) 
200
290
 
201
291
 
202
292
    def flush(self):
217
307
        else:
218
308
            return self.apache_req.read(len)
219
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
 
220
320
    def throw_redirect(self, location):
221
321
        """Writes out an HTTP redirect to the specified URL. Raises an
222
322
        exception which is caught by the dispatch or web server, so any
236
336
        else:
237
337
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
238
338
 
239
 
    def make_path(self, path):
240
 
        """Prepend the IVLE URL prefix to the given path.
241
 
 
242
 
        This is used when generating URLs to send to the client.
243
 
 
244
 
        This method is DEPRECATED. We no longer support use of a prefix.
245
 
        """
246
 
        return os.path.join(self.config['urls']['root'], path)
247
 
 
248
339
    def get_session(self):
249
340
        """Returns a mod_python Session object for this request.
250
341
        Note that this is dependent on mod_python and may need to change
251
 
        interface if porting away from mod_python.
252
 
 
253
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
254
 
                   it! If you don't, all other requests will block!
255
 
        """
 
342
        interface if porting away from mod_python."""
256
343
        # Cache the session object and set the timeout to 24 hours.
257
344
        if not hasattr(self, 'session'):
258
345
            self.session = mod_python.Session.FileSession(self.apache_req,
277
364
            self.got_common_vars = True
278
365
        return self.apache_req.subprocess_env
279
366
 
280
 
    @property
281
 
    def store(self):
282
 
        # Open a database connection and transaction, keep it around for users
283
 
        # of the Request object to use.
284
 
        if self._store is None:
285
 
            self._store = ivle.database.get_store(self.config)
286
 
        return self._store
287
 
 
288
 
    @property
289
 
    def user(self):
290
 
        # Get and cache the request user, or None if it's not valid.
291
 
        # This is a property so that we don't create a store unless
292
 
        # 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
        """
293
375
        try:
294
 
            return self._user
295
 
        except AttributeError:
296
 
            if self.publicmode:
297
 
                self._user = None
298
 
            else:
299
 
                temp_user = ivle.webapp.security.get_user_details(self)
300
 
                if temp_user and temp_user.valid:
301
 
                    self._user = temp_user
302
 
                else:
303
 
                    self._user = None
304
 
            return self._user
 
376
            return http_codenames[code]
 
377
        except KeyError:
 
378
            return None, None
305
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
}