36
41
# Write the XHTML opening and head element
42
# Note the inline JavaScript, which provides the client with constants
43
# derived from the server configuration.
37
44
if req.title != None:
38
titlepart = ' - ' + req.title
45
titlepart = req.title + ' - '
41
48
req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
42
49
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
43
50
<html xmlns="http://www.w3.org/1999/xhtml">
46
53
<meta http-equiv="Content-Type" content="%s; charset=utf-8" />
47
<link rel="stylesheet" type="text/css" href="%s" />
48
""" % (titlepart, req.content_type, util.make_path('media/common/ivle.css')))
54
""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
55
# Write inline JavaScript which gives the client code access to certain
56
# server-side variables.
58
username = repr(req.user.login)
61
req.write(""" <script type="text/javascript">
66
""" % (repr(conf.root_dir), repr(conf.public_host), username))
67
iconurl = get_icon_url(req.app, small=True)
69
req.write(""" <link rel="shortcut icon" href="%s" />
70
""" % cgi.escape(iconurl))
71
req.write(""" <link rel="stylesheet" type="text/css" href="%s" />
72
""" % cgi.escape(util.make_path('media/common/ivle.css')))
50
74
# Write any app-specific style and script links
51
75
for style in req.styles:
52
76
req.write(' <link rel="stylesheet" type="text/css" href="%s" />\n'
53
% util.make_path(style))
77
% cgi.escape(util.make_path(style)))
54
78
for script in req.scripts:
55
req.write(' <script type="text/javascript" src="%s" />\n'
56
% util.make_path(script))
79
req.write(' <script type="text/javascript" src="%s"></script>\n'
80
% cgi.escape(util.make_path(script)))
81
req.write(' <script type="text/javascript">\n /* Init Functions */\n')
82
for init in req.scripts_init:
83
req.write(' window.addEventListener("load", %s, false);\n'%init)
84
req.write(' </script>\n')
58
86
req.write("</head>\n\n")
60
88
# Open the body element and write a bunch of stuff there (the header)
61
89
req.write("""<body>
62
<h1>IVLE - Informatics Virtual Learning Environment</h1>
90
<div id="ivleheader"></div>
91
<div id="ivleheader_text">
93
<h2>Informatics Virtual Learning Environment</h2>
66
req.write("""<p>Hello, %s. <a href="%s">Logout</a></p>\n""" %
67
(req.username, util.make_path('logout')))
97
req.write(' <p class="userhello">Running in public mode.</p>')
99
# Get the user's nickname from the request session
100
nickname = req.user.nick
101
req.write(' <p class="userhello"><span id="usernick">%s</span> '
102
'(<span class="username">%s</span>) |\n'
103
' <a href="%s">Settings</a> |\n'
104
' <a href="%s">Help</a> |\n'
105
' <a href="%s">Sign out</a>\n'
107
(cgi.escape(nickname), cgi.escape(req.user.login),
108
cgi.escape(util.make_path('settings')),
109
cgi.escape(get_help_url(req)),
110
cgi.escape(util.make_path('logout'))))
69
req.write("<p>Not logged in.</p>")
112
req.write(' <p class="userhello">Not logged in.</p>')
114
# ivleheader_tabs is a separate div, so it can be positioned absolutely
115
req.write('</div>\n<div id="ivleheader_tabs">\n')
71
117
# If the "debuginfo" app is installed, display a warning to the admin to
72
118
# make sure it is removed in production.
73
119
if "debuginfo" in conf.apps.app_url:
74
req.write("<p>Warning: debuginfo is enabled. Remove this app from "
75
"conf.apps.app_url when placed into production.</p>\n")
120
req.write(" <p><small>Warning: debuginfo is enabled. Set "
121
"enable_debuginfo = False in lib/conf/apps.py, when placing IVLE "
122
"into production.</small></p>\n")
124
# If req has a "no_agreement" attribute, then it is because the user has
125
# not signed the agreement; therefore we are displaying the TOS page.
126
# Do not show apps (see dispatch.login).
127
if req.user and not req.user.state == 'no_agreement':
128
# Only print app tabs if logged in
129
print_apps_list(req, req.app)
130
req.write('</div>\n<div id="ivlebody">\n')
79
132
def write_html_foot(req):
80
133
"""Writes the HTML footer, given a request object.
82
135
req: An IVLE request object. Written to.
84
req.write("</body>\n</html>\n")
86
def print_apps_list(file):
137
req.write("</div>\n</body>\n</html>\n")
139
def get_help_url(req):
140
"""Gets the help URL most relevant to this page, to place as the
141
"help" link at the top of the page."""
142
reqapp = req.app if hasattr(req, 'app') else None
144
# We're already in help. Link to the exact current page
145
# instead of the generic help page.
147
if reqapp is not None and reqapp in conf.apps.app_url and \
148
conf.apps.app_url[reqapp].hashelp:
149
help_path = os.path.join('help', reqapp)
152
return util.make_path(help_path)
154
def get_icon_url(appurl, small=False):
155
"""Given an app's url name, gets the URL of the icon image for this app,
156
relative to the site root. Returns None if the app has no icon."""
157
if appurl is None: return None
159
app = conf.apps.app_url[appurl]
161
# Due to navigating to a bad app
164
icon_dir = conf.apps.app_icon_dir_small
166
icon_dir = conf.apps.app_icon_dir
167
if app.icon is None: return None
168
return util.make_path(os.path.join(icon_dir, app.icon))
170
def print_apps_list(file, thisapp):
87
171
"""Prints all app tabs, as a UL. Prints a list item for each app that has
90
174
file: Object with a "write" method - ie. the request object.
93
file.write('<ul class="apptabs">\n')
177
file.write(' <ul id="apptabs">\n')
95
179
for urlname in conf.apps.apps_in_tabs:
96
180
app = conf.apps.app_url[urlname]
97
file.write(' <li><a href="%s">%s</a></li>\n'
98
% (util.make_path(urlname), app.name))
181
if urlname == thisapp:
182
li_attr = ' class="thisapp"'
185
file.write(' <li%s>' % li_attr)
187
file.write('<img src="%s" alt="" /> '
188
% urllib.quote(get_icon_url(urlname)))
189
file.write('<a href="%s" title="%s">%s</a></li>\n'
190
% (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
191
cgi.escape(app.name)))
100
file.write('</ul>\n')
193
file.write(' </ul>\n')