1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Module: dispatch.html
22
# Provides functions for writing the dispatch-generated HTML header and footer
23
# content (the common parts of the HTML pages shared across the entire site).
24
# Does not include the login page. See login.py.
31
from common import util
33
def write_html_head(req):
34
"""Writes the HTML header, given a request object.
36
req: An IVLE request object. Reads attributes such as title. Also used to
39
# Write the XHTML opening and head element
40
# Note the inline JavaScript, which provides the client with constants
41
# derived from the server configuration.
43
titlepart = req.title + ' - '
46
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
47
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
48
<html xmlns="http://www.w3.org/1999/xhtml">
51
<meta http-equiv="Content-Type" content="%s; charset=utf-8" />
52
""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
53
# Write inline JavaScript which gives the client code access to certain
54
# server-side variables.
56
username = repr(req.username)
59
req.write(""" <script type="text/javascript">
63
""" % (repr(conf.root_dir), username))
64
iconurl = get_icon_url(req.app)
66
req.write(""" <link rel="shortcut icon" href="%s" />
67
""" % cgi.escape(iconurl))
68
req.write(""" <link rel="stylesheet" type="text/css" href="%s" />
69
""" % cgi.escape(util.make_path('media/common/ivle.css')))
71
# Write any app-specific style and script links
72
for style in req.styles:
73
req.write(' <link rel="stylesheet" type="text/css" href="%s" />\n'
74
% cgi.escape(util.make_path(style)))
75
for script in req.scripts:
76
req.write(' <script type="text/javascript" src="%s" />\n'
77
% cgi.escape(util.make_path(script)))
79
req.write("</head>\n\n")
81
# Open the body element and write a bunch of stuff there (the header)
85
<h2>Informatics Virtual Learning Environment</h2>
89
req.write(' <p class="userhello">Welcome, <span '
90
'class="username">%s</span> |\n'
91
' <a href="%s">Help</a> |\n'
92
' <a href="%s">Logout</a>\n'
94
(cgi.escape(req.username),
95
cgi.escape(get_help_url(req)),
96
cgi.escape(util.make_path('logout'))))
98
req.write(' <p class="userhello">Not logged in.</p>')
100
# If the "debuginfo" app is installed, display a warning to the admin to
101
# make sure it is removed in production.
102
if "debuginfo" in conf.apps.app_url:
103
req.write(" <p><small>Warning: debuginfo is enabled. Remove this "
104
"app from conf.apps.app_url when placed into production."
108
# Only print app tabs if logged in
109
print_apps_list(req, req.app)
110
req.write('</div>\n<div id="ivlebody">\n')
112
def write_html_foot(req):
113
"""Writes the HTML footer, given a request object.
115
req: An IVLE request object. Written to.
117
req.write("</div>\n</body>\n</html>\n")
119
def get_help_url(req):
120
"""Gets the help URL most relevant to this page, to place as the
121
"help" link at the top of the page."""
122
if req.app == 'help':
123
# We're already in help. Link to the exact current page
124
# instead of the generic help page.
126
if conf.apps.app_url[req.app].hashelp:
127
help_path = os.path.join('help', req.app)
130
return util.make_path(help_path)
132
def get_icon_url(appurl, small=False):
133
"""Given an app's url name, gets the URL of the icon image for this app,
134
relative to the site root. Returns None if the app has no icon."""
135
if appurl is None: return None
136
app = conf.apps.app_url[appurl]
138
icon_dir = conf.apps.app_icon_dir_small
140
icon_dir = conf.apps.app_icon_dir
141
if app.icon is None: return None
142
return util.make_path(os.path.join(icon_dir, app.icon))
144
def print_apps_list(file, thisapp):
145
"""Prints all app tabs, as a UL. Prints a list item for each app that has
148
file: Object with a "write" method - ie. the request object.
151
file.write(' <ul id="apptabs">\n')
153
for urlname in conf.apps.apps_in_tabs:
154
app = conf.apps.app_url[urlname]
155
if urlname == thisapp:
156
li_attr = ' class="thisapp"'
159
file.write(' <li%s>' % li_attr)
161
file.write('<img src="%s" alt="" /> '
162
% cgi.escape(get_icon_url(urlname)))
163
file.write('<a href="%s">%s</a></li>\n'
164
% (cgi.escape(util.make_path(urlname)), cgi.escape(app.name)))
166
file.write(' </ul>\n')
added
removed
www/dispatch/html.py
