← 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-12 15:35:53 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:201
Added "test" directory.
Added make_date_test.py, a short script I wrote to test the date format
algorithm committed in the previous revision.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/html.py
23
23
# content (the common parts of the HTML pages shared across the entire site).
24
24
# Does not include the login page. See login.py.
25
25
 
 
26
import os.path
 
27
 
26
28
import conf
27
29
import conf.apps
28
30
from common import util
34
36
    write to."""
35
37
 
36
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.
37
41
    if req.title != None:
38
 
        titlepart = ' - ' + req.title
 
42
        titlepart = req.title + ' - '
39
43
    else:
40
44
        titlepart = ''
41
45
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
42
46
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
43
47
<html xmlns="http://www.w3.org/1999/xhtml">
44
48
<head>
45
 
  <title>IVLE%s</title>
 
49
  <title>%sIVLE</title>
46
50
  <meta http-equiv="Content-Type" content="%s; charset=utf-8" />
47
 
  <link rel="stylesheet" type="text/css" href="%s" />
48
 
""" % (titlepart, req.content_type, util.make_path('media/common/ivle.css')))
 
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'))
49
69
 
50
70
    # Write any app-specific style and script links
51
71
    for style in req.styles:
59
79
 
60
80
    # Open the body element and write a bunch of stuff there (the header)
61
81
    req.write("""<body>
62
 
<h1>IVLE - Informatics Virtual Learning Environment</h1>
 
82
<div id="ivleheader">
 
83
  <h1>IVLE</h1>
 
84
  <h2>Informatics Virtual Learning Environment</h2>
63
85
""")
64
86
 
65
87
    if req.username:
66
 
        req.write("""<p>Hello, %s. <a href="%s">Logout</a></p>\n""" %
67
 
            (req.username, util.make_path('logout')))
 
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')))
68
94
    else:
69
 
        req.write("<p>Not logged in.</p>")
 
95
        req.write('  <p class="userhello">Not logged in.</p>')
70
96
 
71
97
    # If the "debuginfo" app is installed, display a warning to the admin to
72
98
    # make sure it is removed in production.
73
99
    if "debuginfo" in conf.apps.app_url:
74
 
        req.write("<p>Warning: debuginfo is enabled. Remove this app from "
75
 
            "conf.apps.app_url when placed into production.</p>\n")
 
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")
76
103
 
77
 
    print_apps_list(req)
 
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')
78
108
 
79
109
def write_html_foot(req):
80
110
    """Writes the HTML footer, given a request object.
81
111
 
82
112
    req: An IVLE request object. Written to.
83
113
    """
84
 
    req.write("</body>\n</html>\n")
85
 
 
86
 
def print_apps_list(file):
 
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):
87
142
    """Prints all app tabs, as a UL. Prints a list item for each app that has
88
143
    a tab.
89
144
 
90
145
    file: Object with a "write" method - ie. the request object.
91
146
    Reads from: conf
92
147
    """
93
 
    file.write('<ul class="apptabs">\n')
 
148
    file.write('  <ul class="apptabs">\n')
94
149
 
95
150
    for urlname in conf.apps.apps_in_tabs:
96
151
        app = conf.apps.app_url[urlname]
97
 
        file.write('  <li><a href="%s">%s</a></li>\n'
 
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'
98
160
            % (util.make_path(urlname), app.name))
99
161
 
100
 
    file.write('</ul>\n')
 
162
    file.write('  </ul>\n')