← 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: mattgiuca
  • Date: 2008-01-31 01:44:30 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:345
Global CSS change: ivlebody no longer has 1em of padding (it has none).
This is because most apps were disabling it (and it had to change anyway for
other reasons -- see below).

Hence, all apps which WERE disabling the padding have had that removed, and
just work by default. (console, browser, tutorial)
All apps which WEREN'T disabling the padding (very few) now have to manually
include an extra div. This has been done on all such apps, and has been
heavily documented (both in the CSS file and doc/app_howto). (help, dummy,
debuginfo).

media/common/ivle.css: 
    The real change here (which isn't yet being used) is that ivlebody is now
    positioned absolutely and takes up all the space on the canvas. This is
    to be used for full-page layouts in console and browser.

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