42
44
String. The path specified in the URL *not including* the
43
45
application or the IVLE location prefix. eg. a URL of
44
46
"/ivle/files/joe/myfiles" has a path of "joe/myfiles".
46
String. Login name of the user who is currently logged in, or
48
User object. Details of the user who is currently logged in, or
51
String. Hostname the server is running on.
49
53
Table object representing headers sent by the client.
50
54
headers_out (read, can be written to)
51
55
Table object representing headers to be sent to the client.
57
Bool. True if the request came for the "public host" as
58
configured in conf.py. Note that public mode requests do not
59
have an app (app is set to None).
54
62
Int. Response status number. Use one of the status codes defined
73
81
in the head, if write_html_head_foot is True.
74
82
URLs should be relative to the IVLE root; they will be fixed up
75
83
to be site-relative.
85
List of strings. Write a list of JS function names, and they
86
will be added as window.addListener('load', ..., false); calls
87
in the head, if write_html_head_foot is True.
88
This is the propper way to specify functions that need to run at
76
90
write_html_head_foot (write)
77
91
Boolean. If True, dispatch assumes that this is an XHTML page, and
78
92
will immediately write a full HTML head, open the body element,
158
172
self.func_write_html_head = write_html_head
159
173
self.headers_written = False
175
# Determine if the browser used the public host name to make the
176
# request (in which case we are in "public mode")
177
if req.hostname == conf.public_host:
178
self.publicmode = True
180
self.publicmode = False
161
182
# Inherit values for the input members
162
183
self.method = req.method
163
184
self.uri = req.uri
164
185
# Split the given path into the app (top-level dir) and sub-path
165
186
# (after first stripping away the root directory)
166
(self.app, self.path) = (
167
common.util.split_path(common.util.unmake_path(req.uri)))
187
path = common.util.unmake_path(req.uri)
188
(self.app, self.path) = (common.util.split_path(path))
190
self.hostname = req.hostname
169
191
self.headers_in = req.headers_in
170
192
self.headers_out = req.headers_out
176
198
self.title = None # Will be set by dispatch before passing to app
178
200
self.scripts = []
201
self.scripts_init = []
179
202
self.write_html_head_foot = False
203
# In some cases we don't want the template JS (such as the username
204
# and public FQDN) in the output HTML. In that case, set this to 0.
205
self.write_javascript_settings = True
206
self.got_common_vars = False
181
208
def __writeheaders(self):
182
209
"""Writes out the HTTP and HTML headers before any real data is
184
211
self.headers_written = True
213
# app is the App object for the chosen app
215
app = conf.apps.app_url[self.app]
219
# Write any final modifications to header content
220
if app and app.useconsole and self.user:
221
plugins.console.insert_scripts_styles(self.scripts, self.styles, \
185
224
# Prepare the HTTP and HTML headers before the first write is made
186
225
if self.content_type != None:
187
226
self.apache_req.content_type = self.content_type
205
244
if not self.headers_written:
206
245
self.__writeheaders()
207
self.apache_req.write(string, flush)
246
if isinstance(string, unicode):
247
# Encode unicode strings as UTF-8
248
# (Otherwise cannot handle being written to a bytestream)
249
self.apache_req.write(string.encode('utf8'), flush)
251
# 8-bit clean strings just get written directly.
252
# This includes binary strings.
253
self.apache_req.write(string, flush)
210
256
"""Flushes the output buffer."""
220
266
"""Reads at most len bytes directly from the client. (See mod_python
221
267
Request.read)."""
223
self.apache_req.read()
269
return self.apache_req.read()
225
self.apache_req.read(len)
271
return self.apache_req.read(len)
227
def throw_error(self, httpcode):
273
def throw_error(self, httpcode, message=None):
228
274
"""Writes out an HTTP error of the specified code. Raises an exception
229
275
which is caught by the dispatch or web server, so any code following
230
276
this call will not be executed.
232
278
httpcode: An HTTP response status code. Pass a constant from the
235
raise mod_python.apache.SERVER_RETURN, httpcode
281
raise common.util.IVLEError(httpcode, message)
237
283
def throw_redirect(self, location):
238
284
"""Writes out an HTTP redirect to the specified URL. Raises an
245
291
mod_python.util.redirect(self.apache_req, location)
293
def add_cookie(self, cookie, value=None, **attributes):
294
"""Inserts a cookie into this request object's headers."""
296
Cookie.add_cookie(self.apache_req, cookie)
298
Cookie.add_cookie(self.apache_req, cookie, value, **attributes)
247
300
def get_session(self):
248
301
"""Returns a mod_python Session object for this request.
249
302
Note that this is dependent on mod_python and may need to change
250
303
interface if porting away from mod_python."""
251
# Cache the session object
304
# Cache the session object and set the timeout to 24 hours.
252
305
if not hasattr(self, 'session'):
253
self.session = Session.Session(self.apache_req)
306
self.session = Session.FileSession(self.apache_req,
307
timeout = 60 * 60 * 24)
254
308
return self.session
256
310
def get_fieldstorage(self):
261
315
if not hasattr(self, 'fields'):
262
316
self.fields = util.FieldStorage(self.apache_req)
263
317
return self.fields
319
def get_cgi_environ(self):
320
"""Returns the CGI environment emulation for this request. (Calls
321
add_common_vars). The environment is returned as a mapping
322
compatible with os.environ."""
323
if not self.got_common_vars:
324
self.apache_req.add_common_vars()
325
self.got_common_vars = True
326
return self.apache_req.subprocess_env
329
def get_http_codename(code):
330
"""Given a HTTP error code int, returns a (name, description)
331
pair, suitable for displaying to the user.
332
May return (None,None) if code is unknown.
333
Only lists common 4xx and 5xx codes (since this is just used
334
to display throw_error error messages).
337
return http_codenames[code]
341
# Human strings for HTTP response codes
343
Request.HTTP_BAD_REQUEST:
345
"Your browser sent a request IVLE did not understand."),
346
Request.HTTP_UNAUTHORIZED:
348
"You are not allowed to view this part of IVLE."),
349
Request.HTTP_FORBIDDEN:
351
"You are not allowed to view this part of IVLE."),
352
Request.HTTP_NOT_FOUND:
354
"The application or file you requested does not exist."),
355
Request.HTTP_METHOD_NOT_ALLOWED:
356
("Method Not Allowed",
357
"Your browser is interacting with IVLE in the wrong way."
358
"This is probably a bug in IVLE. "
359
"Please report it to the administrators."),
360
Request.HTTP_INTERNAL_SERVER_ERROR:
361
("Internal Server Error",
362
"An unknown error occured in IVLE."),
363
Request.HTTP_NOT_IMPLEMENTED:
365
"The application or file you requested has not been implemented "
367
Request.HTTP_SERVICE_UNAVAILABLE:
368
("Service Unavailable",
369
"IVLE is currently experiencing technical difficulties. "
370
"Please try again later."),