← 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-10 21:47:53 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:169
Added global common css file (media/common/ivle.css).
dispatch.request: Added 2 new attributes: scripts and styles, which let apps
    specify arbitrary numbers of custom CSS and JavaScript files.
dispatch.html: Added media/common/ivle.css to the HTML header.
               Prints out all request custom CSS and JS files in the header.
apps.dummy: Test use of scripts and styles.

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