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.
32
from common import util
34
def write_html_head(req):
35
"""Writes the HTML header, given a request object.
37
req: An IVLE request object. Reads attributes such as title. Also used to
40
# Write the XHTML opening and head element
41
# Note the inline JavaScript, which provides the client with constants
42
# derived from the server configuration.
44
titlepart = req.title + ' - '
47
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
48
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
49
<html xmlns="http://www.w3.org/1999/xhtml">
52
<meta http-equiv="Content-Type" content="%s; charset=utf-8" />
53
""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
54
# Write inline JavaScript which gives the client code access to certain
55
# server-side variables.
57
username = repr(req.user.login)
60
req.write(""" <script type="text/javascript">
64
""" % (repr(conf.root_dir), username))
65
iconurl = get_icon_url(req.app, small=True)
67
req.write(""" <link rel="shortcut icon" href="%s" />
68
""" % cgi.escape(iconurl))
69
req.write(""" <link rel="stylesheet" type="text/css" href="%s" />
70
""" % cgi.escape(util.make_path('media/common/ivle.css')))
72
# Write any app-specific style and script links
73
for style in req.styles:
74
req.write(' <link rel="stylesheet" type="text/css" href="%s" />\n'
75
% cgi.escape(util.make_path(style)))
76
for script in req.scripts:
77
req.write(' <script type="text/javascript" src="%s"></script>\n'
78
% cgi.escape(util.make_path(script)))
80
req.write("</head>\n\n")
82
# Open the body element and write a bunch of stuff there (the header)
84
<div id="ivleheader"></div>
85
<div id="ivleheader_text">
87
<h2>Informatics Virtual Learning Environment</h2>
91
# Get the user's nickname from the request session
92
nickname = req.user.nick
93
req.write(' <p class="userhello"><span id="usernick">%s</span> '
94
'(<span class="username">%s</span>) |\n'
95
' <a href="%s">Settings</a> |\n'
96
' <a href="%s">Help</a> |\n'
97
' <a href="%s">Sign out</a>\n'
99
(cgi.escape(nickname), cgi.escape(req.user.login),
100
cgi.escape(util.make_path('settings')),
101
cgi.escape(get_help_url(req)),
102
cgi.escape(util.make_path('logout'))))
104
req.write(' <p class="userhello">Not logged in.</p>')
106
# ivleheader_tabs is a separate div, so it can be positioned absolutely
107
req.write('</div>\n<div id="ivleheader_tabs">\n')
109
# If the "debuginfo" app is installed, display a warning to the admin to
110
# make sure it is removed in production.
111
if "debuginfo" in conf.apps.app_url:
112
req.write(" <p><small>Warning: debuginfo is enabled. Set "
113
"enable_debuginfo = False in lib/conf/apps.py, when placing IVLE "
114
"into production.</small></p>\n")
116
# If req has a "no_agreement" attribute, then it is because the user has
117
# not signed the agreement; therefore we are displaying the TOS page.
118
# Do not show apps (see dispatch.login).
119
if req.user and not req.user.state == 'no_agreement':
120
# Only print app tabs if logged in
121
print_apps_list(req, req.app)
122
req.write('</div>\n<div id="ivlebody">\n')
124
def write_html_foot(req):
125
"""Writes the HTML footer, given a request object.
127
req: An IVLE request object. Written to.
129
req.write("</div>\n</body>\n</html>\n")
131
def get_help_url(req):
132
"""Gets the help URL most relevant to this page, to place as the
133
"help" link at the top of the page."""
134
reqapp = req.app if hasattr(req, 'app') else None
136
# We're already in help. Link to the exact current page
137
# instead of the generic help page.
139
if reqapp is not None and conf.apps.app_url[reqapp].hashelp:
140
help_path = os.path.join('help', reqapp)
143
return util.make_path(help_path)
145
def get_icon_url(appurl, small=False):
146
"""Given an app's url name, gets the URL of the icon image for this app,
147
relative to the site root. Returns None if the app has no icon."""
148
if appurl is None: return None
150
app = conf.apps.app_url[appurl]
152
# Due to navigating to a bad app
155
icon_dir = conf.apps.app_icon_dir_small
157
icon_dir = conf.apps.app_icon_dir
158
if app.icon is None: return None
159
return util.make_path(os.path.join(icon_dir, app.icon))
161
def print_apps_list(file, thisapp):
162
"""Prints all app tabs, as a UL. Prints a list item for each app that has
165
file: Object with a "write" method - ie. the request object.
168
file.write(' <ul id="apptabs">\n')
170
for urlname in conf.apps.apps_in_tabs:
171
app = conf.apps.app_url[urlname]
172
if urlname == thisapp:
173
li_attr = ' class="thisapp"'
176
file.write(' <li%s>' % li_attr)
178
file.write('<img src="%s" alt="" /> '
179
% urllib.quote(get_icon_url(urlname)))
180
file.write('<a href="%s" title="%s">%s</a></li>\n'
181
% (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
182
cgi.escape(app.name)))
184
file.write(' </ul>\n')
added
removed
www/dispatch/html.py
