← 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: 2007-12-20 05:25:03 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:103
Fix to Makefile.

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