← 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: 2010-07-30 01:16:11 UTC
  • Revision ID: grantw@unimelb.edu.au-20100730011611-ik9hj6yueeh6gc9h
Set version to 1.0.2rc1.

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(
110
 
                        os.path.join('~' + req.user.login, '+settings'))),
111
 
             cgi.escape(get_help_url(req)),
112
 
             cgi.escape(util.make_path('logout'))))
113
 
    else:
114
 
        req.write('  <p class="userhello">Not logged in.</p>')
115
 
 
116
 
    # ivleheader_tabs is a separate div, so it can be positioned absolutely
117
 
    req.write('</div>\n<div id="ivleheader_tabs">\n')
118
 
 
119
 
    # If the "debuginfo" app is installed, display a warning to the admin to
120
 
    # make sure it is removed in production.
121
 
    if "debuginfo" in ivle.conf.apps.app_url:
122
 
        req.write("  <p><small>Warning: debuginfo is enabled. Set "
123
 
            "enable_debuginfo = False in ivle/conf/apps.py, when placing IVLE "
124
 
            "into production.</small></p>\n")
125
 
 
126
 
    # If req has a "no_agreement" attribute, then it is because the user has
127
 
    # not signed the agreement; therefore we are displaying the TOS page.
128
 
    # Do not show apps (see dispatch.login).
129
 
    if req.user and not req.user.state == 'no_agreement':
130
 
        # Only print app tabs if logged in
131
 
        print_apps_list(req, req.app)
132
 
    req.write('</div>\n<div id="ivlebody">\n')
133
 
 
134
 
def write_html_foot(req):
135
 
    """Writes the HTML footer, given a request object.
136
 
 
137
 
    req: An IVLE request object. Written to.
138
 
    """
139
 
    req.write("</div>\n</body>\n</html>\n")
140
 
 
141
 
def get_help_url(req):
142
 
    """Gets the help URL most relevant to this page, to place as the
143
 
    "help" link at the top of the page."""
144
 
    reqapp = req.app if hasattr(req, 'app') else None
145
 
    if reqapp == 'help':
146
 
        # We're already in help. Link to the exact current page
147
 
        # instead of the generic help page.
148
 
        return req.uri
149
 
    if reqapp is not None and reqapp in ivle.conf.apps.app_url and \
150
 
        ivle.conf.apps.app_url[reqapp].hashelp:
151
 
        help_path = os.path.join('help', reqapp)
152
 
    else:
153
 
        help_path = 'help'
154
 
    return util.make_path(help_path)
155
 
 
156
 
def get_icon_url(appurl, small=False):
157
 
    """Given an app's url name, gets the URL of the icon image for this app,
158
 
    relative to the site root. Returns None if the app has no icon."""
159
 
    if appurl is None: return None
160
 
    try:
161
 
        app = ivle.conf.apps.app_url[appurl]
162
 
    except KeyError:
163
 
        # Due to navigating to a bad app
164
 
        return None
165
 
    if small:
166
 
        icon_dir = ivle.conf.apps.app_icon_dir_small
167
 
    else:
168
 
        icon_dir = ivle.conf.apps.app_icon_dir
169
 
    if app.icon is None: return None
170
 
    return util.make_path(os.path.join(icon_dir, app.icon))
171
 
 
172
 
def print_apps_list(file, thisapp):
173
 
    """Prints all app tabs, as a UL. Prints a list item for each app that has
174
 
    a tab.
175
 
 
176
 
    file: Object with a "write" method - ie. the request object.
177
 
    Reads from: ivle.conf
178
 
    """
179
 
    file.write('  <ul id="apptabs">\n')
180
 
 
181
 
    for urlname in ivle.conf.apps.apps_in_tabs:
182
 
        app = ivle.conf.apps.app_url[urlname]
183
 
        if urlname == thisapp:
184
 
            li_attr = ' class="thisapp"'
185
 
        else:
186
 
            li_attr = ''
187
 
        file.write('    <li%s>' % li_attr)
188
 
        if app.icon:
189
 
            file.write('<img src="%s" alt="" /> '
190
 
                % urllib.quote(get_icon_url(urlname)))
191
 
        file.write('<a href="%s" title="%s">%s</a></li>\n'
192
 
            % (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
193
 
                cgi.escape(app.name)))
194
 
 
195
 
    file.write('  </ul>\n')