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
33
import plugins.console
35
def write_html_head(req):
36
"""Writes the HTML header, given a request object.
38
req: An IVLE request object. Reads attributes such as title. Also used to
41
# Let the console plugin insert its own styles and scripts if an app
43
if req.app is not None and (req.app in conf.apps.app_url and
44
conf.apps.app_url[req.app].useconsole):
45
plugins.console.insert_scripts_styles(req.scripts, req.styles, \
48
# Write the XHTML opening and head element
49
# Note the inline JavaScript, which provides the client with constants
50
# derived from the server configuration.
52
titlepart = req.title + ' - '
55
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
56
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
57
<html xmlns="http://www.w3.org/1999/xhtml">
60
<meta http-equiv="Content-Type" content="%s; charset=utf-8" />
61
""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
62
# Write inline JavaScript which gives the client code access to certain
63
# server-side variables.
65
username = repr(req.user.login)
68
req.write(""" <script type="text/javascript">
73
""" % (repr(conf.root_dir), repr(conf.public_host), username))
74
iconurl = get_icon_url(req.app, small=True)
76
req.write(""" <link rel="shortcut icon" href="%s" />
77
""" % cgi.escape(iconurl))
78
req.write(""" <link rel="stylesheet" type="text/css" href="%s" />
79
""" % cgi.escape(util.make_path('media/common/ivle.css')))
81
# Write any app-specific style and script links
82
for style in req.styles:
83
req.write(' <link rel="stylesheet" type="text/css" href="%s" />\n'
84
% cgi.escape(util.make_path(style)))
85
for script in req.scripts:
86
req.write(' <script type="text/javascript" src="%s"></script>\n'
87
% cgi.escape(util.make_path(script)))
88
req.write(' <script type="text/javascript">\n /* Init Functions */\n')
89
for init in req.scripts_init:
90
req.write(' window.addEventListener("load", %s, false);\n'%init)
91
req.write(' </script>\n')
93
req.write("</head>\n\n")
95
# Open the body element and write a bunch of stuff there (the header)
97
<div id="ivleheader"></div>
98
<div id="ivleheader_text">
100
<h2>Informatics Virtual Learning Environment</h2>
104
# Get the user's nickname from the request session
105
nickname = req.user.nick
106
req.write(' <p class="userhello"><span id="usernick">%s</span> '
107
'(<span class="username">%s</span>) |\n'
108
' <a href="%s">Settings</a> |\n'
109
' <a href="%s">Help</a> |\n'
110
' <a href="%s">Sign out</a>\n'
112
(cgi.escape(nickname), cgi.escape(req.user.login),
113
cgi.escape(util.make_path('settings')),
114
cgi.escape(get_help_url(req)),
115
cgi.escape(util.make_path('logout'))))
117
req.write(' <p class="userhello">Not logged in.</p>')
119
# ivleheader_tabs is a separate div, so it can be positioned absolutely
120
req.write('</div>\n<div id="ivleheader_tabs">\n')
122
# If the "debuginfo" app is installed, display a warning to the admin to
123
# make sure it is removed in production.
124
if "debuginfo" in conf.apps.app_url:
125
req.write(" <p><small>Warning: debuginfo is enabled. Set "
126
"enable_debuginfo = False in lib/conf/apps.py, when placing IVLE "
127
"into production.</small></p>\n")
129
# If req has a "no_agreement" attribute, then it is because the user has
130
# not signed the agreement; therefore we are displaying the TOS page.
131
# Do not show apps (see dispatch.login).
132
if req.user and not req.user.state == 'no_agreement':
133
# Only print app tabs if logged in
134
print_apps_list(req, req.app)
135
req.write('</div>\n<div id="ivlebody">\n')
137
def write_html_foot(req):
138
"""Writes the HTML footer, given a request object.
140
req: An IVLE request object. Written to.
143
# Write the console html if the app requests it
144
if req.app is not None and (req.app in conf.apps.app_url and
145
conf.apps.app_url[req.app].useconsole):
146
plugins.console.present(req, windowpane=True)
148
req.write("</div>\n</body>\n</html>\n")
150
def get_help_url(req):
151
"""Gets the help URL most relevant to this page, to place as the
152
"help" link at the top of the page."""
153
reqapp = req.app if hasattr(req, 'app') else None
155
# We're already in help. Link to the exact current page
156
# instead of the generic help page.
158
if reqapp is not None and conf.apps.app_url[reqapp].hashelp:
159
help_path = os.path.join('help', reqapp)
162
return util.make_path(help_path)
164
def get_icon_url(appurl, small=False):
165
"""Given an app's url name, gets the URL of the icon image for this app,
166
relative to the site root. Returns None if the app has no icon."""
167
if appurl is None: return None
169
app = conf.apps.app_url[appurl]
171
# Due to navigating to a bad app
174
icon_dir = conf.apps.app_icon_dir_small
176
icon_dir = conf.apps.app_icon_dir
177
if app.icon is None: return None
178
return util.make_path(os.path.join(icon_dir, app.icon))
180
def print_apps_list(file, thisapp):
181
"""Prints all app tabs, as a UL. Prints a list item for each app that has
184
file: Object with a "write" method - ie. the request object.
187
file.write(' <ul id="apptabs">\n')
189
for urlname in conf.apps.apps_in_tabs:
190
app = conf.apps.app_url[urlname]
191
if urlname == thisapp:
192
li_attr = ' class="thisapp"'
195
file.write(' <li%s>' % li_attr)
197
file.write('<img src="%s" alt="" /> '
198
% urllib.quote(get_icon_url(urlname)))
199
file.write('<a href="%s" title="%s">%s</a></li>\n'
200
% (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
201
cgi.escape(app.name)))
203
file.write(' </ul>\n')
added
removed
www/dispatch/html.py
