← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/html.py

  • Committer: William Grant
  • Date: 2009-01-22 04:47:42 UTC
  • mfrom: (1080.1.93 storm)
  • Revision ID: grantw@unimelb.edu.au-20090122044742-sa8gnww0ma2bm2rv
Merge Storm branch. ivle.db is dead. Watch out for the schema change.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/html.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
 
17
 
 
18
# Module: dispatch.html
 
19
# Author: Matt Giuca
 
20
# Date: 12/12/2007
 
21
 
 
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.
 
25
 
 
26
import cgi
 
27
import urllib
 
28
import os.path
 
29
 
 
30
import ivle.conf
 
31
import ivle.conf.apps
 
32
from ivle import util
 
33
 
 
34
def write_html_head(req):
 
35
    """Writes the HTML header, given a request object.
 
36
 
 
37
    req: An IVLE request object. Reads attributes such as title. Also used to
 
38
    write to."""
 
39
 
 
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.
 
43
    if req.title != None:
 
44
        titlepart = req.title + ' - '
 
45
    else:
 
46
        titlepart = ''
 
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">
 
50
<head>
 
51
  <title>%sIVLE</title>
 
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.
 
56
    if req.user:
 
57
        username = '"%s"' % req.user.login
 
58
    else:
 
59
        username = "null"
 
60
    if req.write_javascript_settings:
 
61
        req.write("""  <script type="text/javascript">
 
62
    root_dir = "%s";
 
63
    public_host = "%s";
 
64
    username = %s;
 
65
  </script>
 
66
""" % (ivle.conf.root_dir, ivle.conf.public_host, username))
 
67
    iconurl = get_icon_url(req.app, small=True)
 
68
    if iconurl:
 
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')))
 
73
 
 
74
    # Write any app-specific style and script links
 
75
    for style in req.styles:
 
76
        req.write('  <link rel="stylesheet" type="text/css" href="%s" />\n'
 
77
            % cgi.escape(util.make_path(style)))
 
78
    for script in req.scripts:
 
79
        req.write('  <script type="text/javascript" src="%s"></script>\n'
 
80
            % cgi.escape(util.make_path(script)))
 
81
    if len(req.scripts_init) > 0:
 
82
        req.write('  <script type="text/javascript">\n    /* Init Functions */\n')
 
83
        for init in req.scripts_init:
 
84
            req.write('    window.addEventListener("load", %s, false);\n'%init)
 
85
        req.write('  </script>\n')
 
86
 
 
87
    req.write("</head>\n\n")
 
88
 
 
89
    # Open the body element and write a bunch of stuff there (the header)
 
90
    req.write("""<body>
 
91
<div id="ivleheader"></div>
 
92
<div id="ivleheader_text">
 
93
  <h1>IVLE</h1>
 
94
  <h2>Informatics Virtual Learning Environment</h2>
 
95
""")
 
96
 
 
97
    if req.publicmode:
 
98
        req.write('   <p class="userhello">Running in public mode.</p>')
 
99
    elif req.user:
 
100
        # Get the user's nickname from the request session
 
101
        nickname = req.user.nick
 
102
        req.write('  <p class="userhello"><span id="usernick">%s</span> '
 
103
            '(<span class="username">%s</span>) |\n'
 
104
            '    <a href="%s">Settings</a> |\n'
 
105
            '    <a href="%s">Help</a> |\n'
 
106
            '    <a href="%s">Sign out</a>\n'
 
107
            '  </p>\n' %
 
108
            (cgi.escape(nickname), cgi.escape(req.user.login),
 
109
             cgi.escape(util.make_path('settings')),
 
110
             cgi.escape(get_help_url(req)),
 
111
             cgi.escape(util.make_path('logout'))))
 
112
    else:
 
113
        req.write('  <p class="userhello">Not logged in.</p>')
 
114
 
 
115
    # ivleheader_tabs is a separate div, so it can be positioned absolutely
 
116
    req.write('</div>\n<div id="ivleheader_tabs">\n')
 
117
 
 
118
    # If the "debuginfo" app is installed, display a warning to the admin to
 
119
    # make sure it is removed in production.
 
120
    if "debuginfo" in ivle.conf.apps.app_url:
 
121
        req.write("  <p><small>Warning: debuginfo is enabled. Set "
 
122
            "enable_debuginfo = False in ivle/conf/apps.py, when placing IVLE "
 
123
            "into production.</small></p>\n")
 
124
 
 
125
    # If req has a "no_agreement" attribute, then it is because the user has
 
126
    # not signed the agreement; therefore we are displaying the TOS page.
 
127
    # Do not show apps (see dispatch.login).
 
128
    if req.user and not req.user.state == 'no_agreement':
 
129
        # Only print app tabs if logged in
 
130
        print_apps_list(req, req.app)
 
131
    req.write('</div>\n<div id="ivlebody">\n')
 
132
 
 
133
def write_html_foot(req):
 
134
    """Writes the HTML footer, given a request object.
 
135
 
 
136
    req: An IVLE request object. Written to.
 
137
    """
 
138
    req.write("</div>\n</body>\n</html>\n")
 
139
 
 
140
def get_help_url(req):
 
141
    """Gets the help URL most relevant to this page, to place as the
 
142
    "help" link at the top of the page."""
 
143
    reqapp = req.app if hasattr(req, 'app') else None
 
144
    if reqapp == 'help':
 
145
        # We're already in help. Link to the exact current page
 
146
        # instead of the generic help page.
 
147
        return req.uri
 
148
    if reqapp is not None and reqapp in ivle.conf.apps.app_url and \
 
149
        ivle.conf.apps.app_url[reqapp].hashelp:
 
150
        help_path = os.path.join('help', reqapp)
 
151
    else:
 
152
        help_path = 'help'
 
153
    return util.make_path(help_path)
 
154
 
 
155
def get_icon_url(appurl, small=False):
 
156
    """Given an app's url name, gets the URL of the icon image for this app,
 
157
    relative to the site root. Returns None if the app has no icon."""
 
158
    if appurl is None: return None
 
159
    try:
 
160
        app = ivle.conf.apps.app_url[appurl]
 
161
    except KeyError:
 
162
        # Due to navigating to a bad app
 
163
        return None
 
164
    if small:
 
165
        icon_dir = ivle.conf.apps.app_icon_dir_small
 
166
    else:
 
167
        icon_dir = ivle.conf.apps.app_icon_dir
 
168
    if app.icon is None: return None
 
169
    return util.make_path(os.path.join(icon_dir, app.icon))
 
170
 
 
171
def print_apps_list(file, thisapp):
 
172
    """Prints all app tabs, as a UL. Prints a list item for each app that has
 
173
    a tab.
 
174
 
 
175
    file: Object with a "write" method - ie. the request object.
 
176
    Reads from: ivle.conf
 
177
    """
 
178
    file.write('  <ul id="apptabs">\n')
 
179
 
 
180
    for urlname in ivle.conf.apps.apps_in_tabs:
 
181
        app = ivle.conf.apps.app_url[urlname]
 
182
        if urlname == thisapp:
 
183
            li_attr = ' class="thisapp"'
 
184
        else:
 
185
            li_attr = ''
 
186
        file.write('    <li%s>' % li_attr)
 
187
        if app.icon:
 
188
            file.write('<img src="%s" alt="" /> '
 
189
                % urllib.quote(get_icon_url(urlname)))
 
190
        file.write('<a href="%s" title="%s">%s</a></li>\n'
 
191
            % (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
 
192
                cgi.escape(app.name)))
 
193
 
 
194
    file.write('  </ul>\n')