← 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: 2010-02-11 09:58:53 UTC
  • Revision ID: grantw@unimelb.edu.au-20100211095853-ip0ekc0ky2d6dxyv
'Login' is not a verb.

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