← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/request.py

Remove some dummy help files, and register the only remaining one (browser).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/request.py
34
34
    pass
35
35
 
36
36
import ivle.util
 
37
import ivle.conf
37
38
import ivle.database
38
39
from ivle.webapp.base.plugins import CookiePlugin
39
40
 
77
78
        location (write)
78
79
            String. Response "Location" header value. Used with HTTP redirect
79
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.
80
84
        styles (write)
81
85
            List of strings. Write a list of URLs to CSS files here, and they
82
86
            will be incorporated as <link rel="stylesheet" type="text/css">
95
99
            in the head, if write_html_head_foot is True.
96
100
            This is the propper way to specify functions that need to run at 
97
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.
98
114
    """
99
115
 
100
116
    # Special code for an OK response.
153
169
    HTTP_INSUFFICIENT_STORAGE         = 507
154
170
    HTTP_NOT_EXTENDED                 = 510
155
171
 
156
 
    def __init__(self, req, config):
157
 
        """Create an IVLE request from a mod_python one.
 
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.
158
176
 
159
 
        @param req: A mod_python request.
160
 
        @param config: An IVLE configuration.
 
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.
161
180
        """
162
181
 
163
182
        # Methods are mostly wrappers around the Apache request object
164
183
        self.apache_req = req
165
 
        self.config = config
 
184
        self.func_write_html_head = write_html_head
166
185
        self.headers_written = False
167
186
 
168
187
        # Determine if the browser used the public host name to make the
169
188
        # request (in which case we are in "public mode")
170
 
        if req.hostname == config['urls']['public_host']:
 
189
        if req.hostname == ivle.conf.public_host:
171
190
            self.publicmode = True
172
191
        else:
173
192
            self.publicmode = False
186
205
 
187
206
        # Open a database connection and transaction, keep it around for users
188
207
        # of the Request object to use
189
 
        self.store = ivle.database.get_store(config)
 
208
        self.store = ivle.database.get_store()
190
209
 
191
210
        # Default values for the output members
192
211
        self.status = Request.HTTP_OK
193
212
        self.content_type = None        # Use Apache's default
194
213
        self.location = None
 
214
        self.title = None     # Will be set by dispatch before passing to app
195
215
        self.styles = []
196
216
        self.scripts = []
197
217
        self.scripts_init = []
 
218
        self.write_html_head_foot = False
198
219
        # In some cases we don't want the template JS (such as the username
199
220
        # and public FQDN) in the output HTML. In that case, set this to 0.
200
221
        self.write_javascript_settings = True
208
229
        """Writes out the HTTP and HTML headers before any real data is
209
230
        written."""
210
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
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
247
277
            all_cookies = mod_python.Cookie.get_cookies(self)
248
278
 
249
279
            # Create cookies for plugins that might request them.
250
 
            for plugin in self.config.plugin_index[CookiePlugin]:
 
280
            for plugin in self.plugin_index[CookiePlugin]:
251
281
                for cookie in plugin.cookies:
252
282
                    self.add_cookie(mod_python.Cookie.Cookie(cookie, '',
253
283
                                                    expires=1, path='/'))
272
302
        else:
273
303
            return self.apache_req.read(len)
274
304
 
 
305
    def throw_error(self, httpcode, message=None):
 
306
        """Writes out an HTTP error of the specified code. Raises an exception
 
307
        which is caught by the dispatch or web server, so any code following
 
308
        this call will not be executed.
 
309
 
 
310
        httpcode: An HTTP response status code. Pass a constant from the
 
311
        Request class.
 
312
        """
 
313
        raise ivle.util.IVLEError(httpcode, message)
 
314
 
275
315
    def throw_redirect(self, location):
276
316
        """Writes out an HTTP redirect to the specified URL. Raises an
277
317
        exception which is caught by the dispatch or web server, so any
294
334
    def get_session(self):
295
335
        """Returns a mod_python Session object for this request.
296
336
        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
 
        """
 
337
        interface if porting away from mod_python."""
302
338
        # Cache the session object and set the timeout to 24 hours.
303
339
        if not hasattr(self, 'session'):
304
340
            self.session = mod_python.Session.FileSession(self.apache_req,