← 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: stevenbird
  • Date: 2008-02-20 00:43:13 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:519
Fixed bug in test framework.  Code given in the <include> section was
not being executed for the tests on code strings.

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