← 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: drtomc
  • Date: 2008-02-01 04:13:23 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:369
Add stuff on installing and configuring pound.

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