← 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: 2007-12-20 03:14:17 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:93
New directory hierarchy.
Renamed src to www.
Added console, trampoline (currently empty).

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 conf
 
27
import conf.apps
 
28
from common import util
 
29
 
 
30
def write_html_head(req):
 
31
    """Writes the HTML header, given a request object.
 
32
 
 
33
    req: An IVLE request object. Reads attributes such as title. Also used to
 
34
    write to."""
 
35
 
 
36
    # Write the XHTML opening and head element
 
37
    if req.title != None:
 
38
        titlepart = ' - ' + req.title
 
39
    else:
 
40
        titlepart = ''
 
41
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 
42
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
43
<html xmlns="http://www.w3.org/1999/xhtml">
 
44
<head>
 
45
  <title>IVLE%s</title>
 
46
  <meta http-equiv="Content-Type"
 
47
    content="%s; charset=utf-8" />
 
48
</head>
 
49
 
 
50
""" % (titlepart, req.content_type))
 
51
 
 
52
    # Open the body element and write a bunch of stuff there (the header)
 
53
    req.write("""<body>
 
54
<h1>IVLE - Informatics Virtual Learning Environment</h1>
 
55
""")
 
56
 
 
57
    # If the "debuginfo" app is installed, display a warning to the admin to
 
58
    # make sure it is removed in production.
 
59
    if "debuginfo" in conf.apps.app_url:
 
60
        req.write("<p>Warning: debuginfo is enabled. Remove this app from "
 
61
            "conf.apps.app_url when placed into production.</p>")
 
62
 
 
63
    print_apps_list(req)
 
64
 
 
65
def write_html_foot(req):
 
66
    """Writes the HTML footer, given a request object.
 
67
 
 
68
    req: An IVLE request object. Written to.
 
69
    """
 
70
    req.write("</body>\n</html>\n")
 
71
 
 
72
def print_apps_list(file):
 
73
    """Prints all app tabs, as a UL. Prints a list item for each app that has
 
74
    a tab.
 
75
 
 
76
    file: Object with a "write" method - ie. the request object.
 
77
    Reads from: conf
 
78
    """
 
79
    file.write('<ul class="apptabs">\n')
 
80
 
 
81
    for urlname in conf.apps.apps_in_tabs:
 
82
        app = conf.apps.app_url[urlname]
 
83
        file.write('  <li><a href="%s">%s</a></li>\n'
 
84
            % (util.make_path(app.dir), app.name))
 
85
 
 
86
    file.write('</ul>\n')