← Back to branch summary

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

« back to all changes in this revision

Viewing changes to www/dispatch/html.py

  • Committer: William Grant
  • Date: 2012-06-28 01:52:02 UTC
  • Revision ID: me@williamgrant.id.au-20120628015202-f6ru7o367gt6nvgz
Hah

Show diffs side-by-side

added added

removed removed

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