1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# IVLE
# Copyright (C) 2007-2008 The University of Melbourne
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# App: help
# Author: Matt Giuca
# Date: 12/12/2007
# This is an IVLE application.
# A sample / testing application for IVLE.
import os
import copy
from ivle import util
import ivle.conf
import genshi
import genshi.template
# TODO: Nicer 404 errors
def handle(req):
"""Handler for the Help application."""
(appurl, subpath) = util.split_path(req.path)
if appurl is None:
show_help_menu(req)
else:
# app must be valid and have help available
if appurl not in ivle.conf.apps.app_url:
req.throw_error(req.HTTP_NOT_FOUND)
app = ivle.conf.apps.app_url[appurl]
if not app.hashelp:
req.throw_error(req.HTTP_NOT_FOUND)
# subpath must be empty, for now, as there is only one help file per app
if subpath != "":
req.throw_error(req.HTTP_NOT_FOUND)
show_help_app(req, app)
def show_help_menu(req):
"""Show the help menu."""
# Set request attributes
req.content_type = "text/html"
req.write_html_head_foot = True
ctx = genshi.template.Context()
# Write a list of links to all apps with help modules
ctx['apps'] = []
# Tab apps, in order of tabs
for appurl in ivle.conf.apps.apps_in_tabs:
app = ivle.conf.apps.app_url[appurl]
if app.hashelp:
new_app = {}
new_app['appurl'] = os.path.join(util.make_path("help"), appurl)
new_app['name'] = app.name
ctx['apps'].append(new_app)
# Terms of Service
ctx['tos'] = util.make_path("tos")
loader = genshi.template.TemplateLoader(".", auto_reload=True)
tmpl = loader.load(util.make_local_path("apps/help/template.html"))
req.write(tmpl.generate(ctx).render('html')) #'xhtml', doctype='xhtml'))
def show_help_app(req, app):
"""Show help for an application."""
helpfile = os.path.join(util.make_local_path("apps"), app.dir, "help.html")
# Set request attributes
req.content_type = "text/html"
req.write_html_head_foot = True
req.styles = ["media/help/help.css"]
# Start writing data
req.write('<div id="ivle_padding">\n')
req.write("<h1>Help - %s</h1>\n" % app.name)
# Print out the contents of the HTML help file
req.sendfile(helpfile)
req.write('</div>\n')
|