← 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 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: grantw@unimelb.edu.au-20090629015555-49xxv0piiieunx8e
Add docs on configuring Apache.

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
 
    # Note the inline JavaScript, which provides the client with constants
38
 
    # derived from the server configuration.
39
 
    if req.title != None:
40
 
        titlepart = ' - ' + req.title
41
 
    else:
42
 
        titlepart = ''
43
 
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
44
 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
45
 
<html xmlns="http://www.w3.org/1999/xhtml">
46
 
<head>
47
 
  <title>IVLE%s</title>
48
 
  <meta http-equiv="Content-Type" content="%s; charset=utf-8" />
49
 
  <script type="text/javascript">
50
 
    root_dir = "%s";
51
 
  </script>
52
 
  <link rel="stylesheet" type="text/css" href="%s" />
53
 
""" % (titlepart, req.content_type,
54
 
        repr(conf.root_dir)[1:-1],
55
 
        util.make_path('media/common/ivle.css')))
56
 
 
57
 
    # Write any app-specific style and script links
58
 
    for style in req.styles:
59
 
        req.write('  <link rel="stylesheet" type="text/css" href="%s" />\n'
60
 
            % util.make_path(style))
61
 
    for script in req.scripts:
62
 
        req.write('  <script type="text/javascript" src="%s" />\n'
63
 
            % util.make_path(script))
64
 
 
65
 
    req.write("</head>\n\n")
66
 
 
67
 
    # Open the body element and write a bunch of stuff there (the header)
68
 
    req.write("""<body>
69
 
<h1>IVLE - Informatics Virtual Learning Environment</h1>
70
 
""")
71
 
 
72
 
    if req.username:
73
 
        req.write("""<p>Hello, %s. <a href="%s">Logout</a></p>\n""" %
74
 
            (req.username, util.make_path('logout')))
75
 
    else:
76
 
        req.write("<p>Not logged in.</p>")
77
 
 
78
 
    # If the "debuginfo" app is installed, display a warning to the admin to
79
 
    # make sure it is removed in production.
80
 
    if "debuginfo" in conf.apps.app_url:
81
 
        req.write("<p>Warning: debuginfo is enabled. Remove this app from "
82
 
            "conf.apps.app_url when placed into production.</p>\n")
83
 
 
84
 
    print_apps_list(req)
85
 
 
86
 
def write_html_foot(req):
87
 
    """Writes the HTML footer, given a request object.
88
 
 
89
 
    req: An IVLE request object. Written to.
90
 
    """
91
 
    req.write("</body>\n</html>\n")
92
 
 
93
 
def print_apps_list(file):
94
 
    """Prints all app tabs, as a UL. Prints a list item for each app that has
95
 
    a tab.
96
 
 
97
 
    file: Object with a "write" method - ie. the request object.
98
 
    Reads from: conf
99
 
    """
100
 
    file.write('<ul class="apptabs">\n')
101
 
 
102
 
    for urlname in conf.apps.apps_in_tabs:
103
 
        app = conf.apps.app_url[urlname]
104
 
        file.write('  <li><a href="%s">%s</a></li>\n'
105
 
            % (util.make_path(urlname), app.name))
106
 
 
107
 
    file.write('</ul>\n')