← 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: me at id
  • Date: 2009-01-15 03:02:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1090.
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:branches%2Fstorm:1150
ivle.makeuser.make_jail: Just take an ivle.database.User, rather than some
    attributes.

services/usrmgt-server: Give make_jail a User.

bin/ivle-remakeuser: Rewrite to use ivle.database.User.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
25
25
object.
26
26
"""
27
27
 
28
 
try:
29
 
    import mod_python.Session
30
 
    import mod_python.Cookie
31
 
    import mod_python.util
32
 
except ImportError:
33
 
    # This needs to be importable from outside Apache.
34
 
    pass
 
28
import mod_python
 
29
from mod_python import (util, Session, Cookie)
35
30
 
36
31
import ivle.util
 
32
import ivle.conf
37
33
import ivle.database
38
 
from ivle.webapp.base.plugins import CookiePlugin
 
34
import plugins.console # XXX: Relies on www/ being in the Python path.
39
35
 
40
36
class Request:
41
37
    """An IVLE request object. This is presented to the IVLE apps as a way of
77
73
        location (write)
78
74
            String. Response "Location" header value. Used with HTTP redirect
79
75
            responses.
 
76
        title (write)
 
77
            String. HTML page title. Used if write_html_head_foot is True, in
 
78
            the HTML title element text.
80
79
        styles (write)
81
80
            List of strings. Write a list of URLs to CSS files here, and they
82
81
            will be incorporated as <link rel="stylesheet" type="text/css">
95
94
            in the head, if write_html_head_foot is True.
96
95
            This is the propper way to specify functions that need to run at 
97
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.
98
109
    """
99
110
 
100
111
    # Special code for an OK response.
153
164
    HTTP_INSUFFICIENT_STORAGE         = 507
154
165
    HTTP_NOT_EXTENDED                 = 510
155
166
 
156
 
    def __init__(self, req, config):
157
 
        """Create an IVLE request from a mod_python one.
 
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.
158
171
 
159
 
        @param req: A mod_python request.
160
 
        @param config: An IVLE configuration.
 
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.
161
175
        """
162
176
 
163
177
        # Methods are mostly wrappers around the Apache request object
164
178
        self.apache_req = req
165
 
        self.config = config
 
179
        self.func_write_html_head = write_html_head
166
180
        self.headers_written = False
167
181
 
168
182
        # Determine if the browser used the public host name to make the
169
183
        # request (in which case we are in "public mode")
170
 
        if req.hostname == config['urls']['public_host']:
 
184
        if req.hostname == ivle.conf.public_host:
171
185
            self.publicmode = True
172
186
        else:
173
187
            self.publicmode = False
186
200
 
187
201
        # Open a database connection and transaction, keep it around for users
188
202
        # of the Request object to use
189
 
        self.store = ivle.database.get_store(config)
 
203
        self.store = ivle.database.get_store()
190
204
 
191
205
        # Default values for the output members
192
206
        self.status = Request.HTTP_OK
193
207
        self.content_type = None        # Use Apache's default
194
208
        self.location = None
 
209
        self.title = None     # Will be set by dispatch before passing to app
195
210
        self.styles = []
196
211
        self.scripts = []
197
212
        self.scripts_init = []
 
213
        self.write_html_head_foot = False
198
214
        # In some cases we don't want the template JS (such as the username
199
215
        # and public FQDN) in the output HTML. In that case, set this to 0.
200
216
        self.write_javascript_settings = True
208
224
        """Writes out the HTTP and HTML headers before any real data is
209
225
        written."""
210
226
        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)
211
238
 
212
239
        # Prepare the HTTP and HTML headers before the first write is made
213
240
        if self.content_type != None:
215
242
        self.apache_req.status = self.status
216
243
        if self.location != None:
217
244
            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)
218
248
 
219
249
    def ensure_headers_written(self):
220
250
        """Writes out the HTTP and HTML headers if they haven't already been
237
267
            # This includes binary strings.
238
268
            self.apache_req.write(string, flush)
239
269
 
240
 
    def logout(self):
241
 
        """Log out the current user by destroying the session state.
242
 
        Then redirect to the top-level IVLE page."""
243
 
        if hasattr(self, 'session'):
244
 
            self.session.invalidate()
245
 
            self.session.delete()
246
 
            # Invalidates all IVLE cookies
247
 
            all_cookies = mod_python.Cookie.get_cookies(self)
248
 
 
249
 
            # Create cookies for plugins that might request them.
250
 
            for plugin in self.config.plugin_index[CookiePlugin]:
251
 
                for cookie in plugin.cookies:
252
 
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
253
 
                                                    expires=1, path='/'))
254
 
        self.throw_redirect(ivle.util.make_path('')) 
255
 
 
256
 
 
257
270
    def flush(self):
258
271
        """Flushes the output buffer."""
259
272
        self.apache_req.flush()
272
285
        else:
273
286
            return self.apache_req.read(len)
274
287
 
 
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
 
275
298
    def throw_redirect(self, location):
276
299
        """Writes out an HTTP redirect to the specified URL. Raises an
277
300
        exception which is caught by the dispatch or web server, so any
287
310
    def add_cookie(self, cookie, value=None, **attributes):
288
311
        """Inserts a cookie into this request object's headers."""
289
312
        if value is None:
290
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie)
 
313
            Cookie.add_cookie(self.apache_req, cookie)
291
314
        else:
292
 
            mod_python.Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
 
315
            Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
293
316
 
294
317
    def get_session(self):
295
318
        """Returns a mod_python Session object for this request.
296
319
        Note that this is dependent on mod_python and may need to change
297
 
        interface if porting away from mod_python.
298
 
 
299
 
        IMPORTANT: Call unlock() on the session as soon as you are done with
300
 
                   it! If you don't, all other requests will block!
301
 
        """
 
320
        interface if porting away from mod_python."""
302
321
        # Cache the session object and set the timeout to 24 hours.
303
322
        if not hasattr(self, 'session'):
304
 
            self.session = mod_python.Session.FileSession(self.apache_req,
 
323
            self.session = Session.FileSession(self.apache_req,
305
324
                                               timeout = 60 * 60 * 24)
306
325
        return self.session
307
326
 
311
330
        interface if porting away from mod_python."""
312
331
        # Cache the fieldstorage object
313
332
        if not hasattr(self, 'fields'):
314
 
            self.fields = mod_python.util.FieldStorage(self.apache_req)
 
333
            self.fields = util.FieldStorage(self.apache_req)
315
334
        return self.fields
316
335
 
317
336
    def get_cgi_environ(self):