36
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.
37
42
if req.title != None:
38
titlepart = ' - ' + req.title
43
titlepart = req.title + ' - '
41
46
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
42
47
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
43
48
<html xmlns="http://www.w3.org/1999/xhtml">
46
<meta http-equiv="Content-Type"
47
content="%s; charset=utf-8" />
50
""" % (titlepart, req.content_type))
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")
52
81
# Open the body element and write a bunch of stuff there (the header)
53
82
req.write("""<body>
54
<h1>IVLE - Informatics Virtual Learning Environment</h1>
83
<div id="ivleheader"></div>
84
<div id="ivleheader_text">
86
<h2>Informatics Virtual Learning Environment</h2>
90
# Get the user's nickname from the request session
91
nickname = req.get_session()['nick']
92
req.write(' <p class="userhello">%s (<span '
93
'class="username">%s</span>) |\n'
94
' <a href="%s">Help</a> |\n'
95
' <a href="%s">Logout</a>\n'
97
(cgi.escape(nickname), cgi.escape(req.username),
98
cgi.escape(get_help_url(req)),
99
cgi.escape(util.make_path('logout'))))
101
req.write(' <p class="userhello">Not logged in.</p>')
57
103
# If the "debuginfo" app is installed, display a warning to the admin to
58
104
# make sure it is removed in production.
59
105
if "debuginfo" in conf.apps.app_url:
60
req.write("<p>Warning: debuginfo is enabled. Remove this app from "
61
"conf.apps.app_url when placed into production.</p>")
106
req.write(" <p><small>Warning: debuginfo is enabled. Remove this "
107
"app from conf.apps.app_url when placed into production."
109
# ivleheader_tabs is a separate div, so it can be positioned absolutely
110
req.write('</div>\n<div id="ivleheader_tabs">\n')
113
# Only print app tabs if logged in
114
print_apps_list(req, req.app)
115
req.write('</div>\n<div id="ivlebody">\n')
65
117
def write_html_foot(req):
66
118
"""Writes the HTML footer, given a request object.
68
120
req: An IVLE request object. Written to.
70
req.write("</body>\n</html>\n")
72
def print_apps_list(file):
122
req.write("</div>\n</body>\n</html>\n")
124
def get_help_url(req):
125
"""Gets the help URL most relevant to this page, to place as the
126
"help" link at the top of the page."""
127
if req.app == 'help':
128
# We're already in help. Link to the exact current page
129
# instead of the generic help page.
131
if conf.apps.app_url[req.app].hashelp:
132
help_path = os.path.join('help', req.app)
135
return util.make_path(help_path)
137
def get_icon_url(appurl, small=False):
138
"""Given an app's url name, gets the URL of the icon image for this app,
139
relative to the site root. Returns None if the app has no icon."""
140
if appurl is None: return None
141
app = conf.apps.app_url[appurl]
143
icon_dir = conf.apps.app_icon_dir_small
145
icon_dir = conf.apps.app_icon_dir
146
if app.icon is None: return None
147
return util.make_path(os.path.join(icon_dir, app.icon))
149
def print_apps_list(file, thisapp):
73
150
"""Prints all app tabs, as a UL. Prints a list item for each app that has
76
153
file: Object with a "write" method - ie. the request object.
79
file.write('<ul class="apptabs">\n')
156
file.write(' <ul id="apptabs">\n')
81
158
for urlname in conf.apps.apps_in_tabs:
82
159
app = conf.apps.app_url[urlname]
83
file.write(' <li><a href="%s">%s</a></li>\n'
84
% (util.make_path(app.dir), app.name))
160
if urlname == thisapp:
161
li_attr = ' class="thisapp"'
164
file.write(' <li%s>' % li_attr)
166
file.write('<img src="%s" alt="" /> '
167
% cgi.escape(get_icon_url(urlname)))
168
file.write('<a href="%s">%s</a></li>\n'
169
% (cgi.escape(util.make_path(urlname)), cgi.escape(app.name)))
171
file.write(' </ul>\n')