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