← 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-25 06:20:32 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:313
test/test_framework: Updated examples, a bit of better descriptions, sample
    partial solutions, etc.

Added all sample subject material.
This has been copied from test/test_framework and modified slightly.
There is now a subject "sample" with 2 worksheets. The 1st worksheet has 3
exercises. These work in IVLE by default.

setup.py: Added code to install subjects into the designated directory. This
means that installing IVLE will result in the sample subjects being
immediately available.

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
34
37
    write to."""
35
38
 
36
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.
37
42
    if req.title != None:
38
 
        titlepart = ' - ' + req.title
 
43
        titlepart = req.title + ' - '
39
44
    else:
40
45
        titlepart = ''
41
46
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
42
47
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
43
48
<html xmlns="http://www.w3.org/1999/xhtml">
44
49
<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))
 
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")
51
80
 
52
81
    # Open the body element and write a bunch of stuff there (the header)
53
82
    req.write("""<body>
54
 
<h1>IVLE - Informatics Virtual Learning Environment</h1>
 
83
<div id="ivleheader">
 
84
  <h1>IVLE</h1>
 
85
  <h2>Informatics Virtual Learning Environment</h2>
55
86
""")
56
87
 
57
88
    if req.username:
58
 
        req.write("""<p>Hello, %s. <a href="%s">Logout</a></p>\n""" %
59
 
            (req.username, util.make_path('logout')))
 
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'))))
60
97
    else:
61
 
        req.write("<p>Not logged in.</p>")
 
98
        req.write('  <p class="userhello">Not logged in.</p>')
62
99
 
63
100
    # If the "debuginfo" app is installed, display a warning to the admin to
64
101
    # make sure it is removed in production.
65
102
    if "debuginfo" in conf.apps.app_url:
66
 
        req.write("<p>Warning: debuginfo is enabled. Remove this app from "
67
 
            "conf.apps.app_url when placed into production.</p>")
 
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")
68
106
 
69
 
    print_apps_list(req)
 
107
    if req.username:
 
108
        # Only print app tabs if logged in
 
109
        print_apps_list(req, req.app)
 
110
    req.write('</div>\n<div id="ivlebody">\n')
70
111
 
71
112
def write_html_foot(req):
72
113
    """Writes the HTML footer, given a request object.
73
114
 
74
115
    req: An IVLE request object. Written to.
75
116
    """
76
 
    req.write("</body>\n</html>\n")
77
 
 
78
 
def print_apps_list(file):
 
117
    req.write("</div>\n</body>\n</html>\n")
 
118
 
 
119
def get_help_url(req):
 
120
    """Gets the help URL most relevant to this page, to place as the
 
121
    "help" link at the top of the page."""
 
122
    if req.app == 'help':
 
123
        # We're already in help. Link to the exact current page
 
124
        # instead of the generic help page.
 
125
        return req.uri
 
126
    if conf.apps.app_url[req.app].hashelp:
 
127
        help_path = os.path.join('help', req.app)
 
128
    else:
 
129
        help_path = 'help'
 
130
    return util.make_path(help_path)
 
131
 
 
132
def get_icon_url(appurl, small=False):
 
133
    """Given an app's url name, gets the URL of the icon image for this app,
 
134
    relative to the site root. Returns None if the app has no icon."""
 
135
    if appurl is None: return None
 
136
    app = conf.apps.app_url[appurl]
 
137
    if small:
 
138
        icon_dir = conf.apps.app_icon_dir_small
 
139
    else:
 
140
        icon_dir = conf.apps.app_icon_dir
 
141
    if app.icon is None: return None
 
142
    return util.make_path(os.path.join(icon_dir, app.icon))
 
143
 
 
144
def print_apps_list(file, thisapp):
79
145
    """Prints all app tabs, as a UL. Prints a list item for each app that has
80
146
    a tab.
81
147
 
82
148
    file: Object with a "write" method - ie. the request object.
83
149
    Reads from: conf
84
150
    """
85
 
    file.write('<ul class="apptabs">\n')
 
151
    file.write('  <ul id="apptabs">\n')
86
152
 
87
153
    for urlname in conf.apps.apps_in_tabs:
88
154
        app = conf.apps.app_url[urlname]
89
 
        file.write('  <li><a href="%s">%s</a></li>\n'
90
 
            % (util.make_path(app.dir), app.name))
 
155
        if urlname == thisapp:
 
156
            li_attr = ' class="thisapp"'
 
157
        else:
 
158
            li_attr = ''
 
159
        file.write('    <li%s>' % li_attr)
 
160
        if app.icon:
 
161
            file.write('<img src="%s" alt="" /> '
 
162
                % cgi.escape(get_icon_url(urlname)))
 
163
        file.write('<a href="%s">%s</a></li>\n'
 
164
            % (cgi.escape(util.make_path(urlname)), cgi.escape(app.name)))
91
165
 
92
 
    file.write('</ul>\n')
 
166
    file.write('  </ul>\n')