← 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: 2009-06-29 07:04:22 UTC
  • Revision ID: grantw@unimelb.edu.au-20090629070422-uwg9c7lj4635m6xw
Try to install ivle-adduser, not ivle-makeuser.

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.username:
56
 
        username = repr(req.username)
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)
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" />\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.username:
90
 
        # Get the user's nickname from the request session
91
 
        nickname = req.get_session()['nick']
92
 
        req.write('  <p class="userhello">%s (<span '
93
 
            'class="username">%s</span>) |\n'
94
 
            '    <a href="%s">Help</a> |\n'
95
 
            '    <a href="%s">Logout</a>\n'
96
 
            '  </p>\n' %
97
 
            (cgi.escape(nickname), cgi.escape(req.username),
98
 
             cgi.escape(get_help_url(req)),
99
 
             cgi.escape(util.make_path('logout'))))
100
 
    else:
101
 
        req.write('  <p class="userhello">Not logged in.</p>')
102
 
 
103
 
    # If the "debuginfo" app is installed, display a warning to the admin to
104
 
    # make sure it is removed in production.
105
 
    if "debuginfo" in conf.apps.app_url:
106
 
        req.write("  <p><small>Warning: debuginfo is enabled. Remove this "
107
 
            "app from conf.apps.app_url when placed into production."
108
 
            "</small></p>\n")
109
 
    # ivleheader_tabs is a separate div, so it can be positioned absolutely
110
 
    req.write('</div>\n<div id="ivleheader_tabs">\n')
111
 
 
112
 
    if req.username:
113
 
        # Only print app tabs if logged in
114
 
        print_apps_list(req, req.app)
115
 
    req.write('</div>\n<div id="ivlebody">\n')
116
 
 
117
 
def write_html_foot(req):
118
 
    """Writes the HTML footer, given a request object.
119
 
 
120
 
    req: An IVLE request object. Written to.
121
 
    """
122
 
    req.write("</div>\n</body>\n</html>\n")
123
 
 
124
 
def get_help_url(req):
125
 
    """Gets the help URL most relevant to this page, to place as the
126
 
    "help" link at the top of the page."""
127
 
    if req.app == 'help':
128
 
        # We're already in help. Link to the exact current page
129
 
        # instead of the generic help page.
130
 
        return req.uri
131
 
    if conf.apps.app_url[req.app].hashelp:
132
 
        help_path = os.path.join('help', req.app)
133
 
    else:
134
 
        help_path = 'help'
135
 
    return util.make_path(help_path)
136
 
 
137
 
def get_icon_url(appurl, small=False):
138
 
    """Given an app's url name, gets the URL of the icon image for this app,
139
 
    relative to the site root. Returns None if the app has no icon."""
140
 
    if appurl is None: return None
141
 
    app = conf.apps.app_url[appurl]
142
 
    if small:
143
 
        icon_dir = conf.apps.app_icon_dir_small
144
 
    else:
145
 
        icon_dir = conf.apps.app_icon_dir
146
 
    if app.icon is None: return None
147
 
    return util.make_path(os.path.join(icon_dir, app.icon))
148
 
 
149
 
def print_apps_list(file, thisapp):
150
 
    """Prints all app tabs, as a UL. Prints a list item for each app that has
151
 
    a tab.
152
 
 
153
 
    file: Object with a "write" method - ie. the request object.
154
 
    Reads from: conf
155
 
    """
156
 
    file.write('  <ul id="apptabs">\n')
157
 
 
158
 
    for urlname in conf.apps.apps_in_tabs:
159
 
        app = conf.apps.app_url[urlname]
160
 
        if urlname == thisapp:
161
 
            li_attr = ' class="thisapp"'
162
 
        else:
163
 
            li_attr = ''
164
 
        file.write('    <li%s>' % li_attr)
165
 
        if app.icon:
166
 
            file.write('<img src="%s" alt="" /> '
167
 
                % cgi.escape(get_icon_url(urlname)))
168
 
        file.write('<a href="%s">%s</a></li>\n'
169
 
            % (cgi.escape(util.make_path(urlname)), cgi.escape(app.name)))
170
 
 
171
 
    file.write('  </ul>\n')