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