← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/dispatch/html.py

  • Committer: matt.giuca
  • Date: 2009-01-19 10:34:45 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1169
Changed svn:ignore on trunk - no longer need to ignore bin or svn directories
    (bin is in repo, svn is gone).
Added .bzrignore, for Bazaar branches of this repository.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/html.py
24
24
# Does not include the login page. See login.py.
25
25
 
26
26
import cgi
 
27
import urllib
27
28
import os.path
28
29
 
 
30
import ivle.conf
 
31
import ivle.conf.apps
29
32
from ivle import util
30
33
 
31
34
def write_html_head(req):
48
51
  <title>%sIVLE</title>
49
52
  <meta http-equiv="Content-Type" content="%s; charset=utf-8" />
50
53
""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
51
 
 
 
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
    if req.write_javascript_settings:
 
61
        req.write("""  <script type="text/javascript">
 
62
    root_dir = %s;
 
63
    public_host = %s;
 
64
    username = %s;
 
65
  </script>
 
66
""" % (repr(ivle.conf.root_dir), repr(ivle.conf.public_host), username))
 
67
    iconurl = get_icon_url(req.app, small=True)
 
68
    if iconurl:
 
69
        req.write("""  <link rel="shortcut icon" href="%s" />
 
70
""" % cgi.escape(iconurl))
52
71
    req.write("""  <link rel="stylesheet" type="text/css" href="%s" />
53
 
""" % cgi.escape(util.make_path('+media/ivle.webapp.core/ivle.css')))
 
72
""" % cgi.escape(util.make_path('media/common/ivle.css')))
 
73
 
 
74
    # Write any app-specific style and script links
 
75
    for style in req.styles:
 
76
        req.write('  <link rel="stylesheet" type="text/css" href="%s" />\n'
 
77
            % cgi.escape(util.make_path(style)))
 
78
    for script in req.scripts:
 
79
        req.write('  <script type="text/javascript" src="%s"></script>\n'
 
80
            % cgi.escape(util.make_path(script)))
 
81
    if len(req.scripts_init) > 0:
 
82
        req.write('  <script type="text/javascript">\n    /* Init Functions */\n')
 
83
        for init in req.scripts_init:
 
84
            req.write('    window.addEventListener("load", %s, false);\n'%init)
 
85
        req.write('  </script>\n')
54
86
 
55
87
    req.write("</head>\n\n")
56
88
 
74
106
            '    <a href="%s">Sign out</a>\n'
75
107
            '  </p>\n' %
76
108
            (cgi.escape(nickname), cgi.escape(req.user.login),
77
 
             cgi.escape(util.make_path(
78
 
                        os.path.join('~' + req.user.login, '+settings'))),
79
 
             cgi.escape(util.make_path('+help')),
80
 
             cgi.escape(util.make_path('+logout'))))
 
109
             cgi.escape(util.make_path('settings')),
 
110
             cgi.escape(get_help_url(req)),
 
111
             cgi.escape(util.make_path('logout'))))
81
112
    else:
82
113
        req.write('  <p class="userhello">Not logged in.</p>')
83
114
 
 
115
    # ivleheader_tabs is a separate div, so it can be positioned absolutely
84
116
    req.write('</div>\n<div id="ivleheader_tabs">\n')
 
117
 
 
118
    # If the "debuginfo" app is installed, display a warning to the admin to
 
119
    # make sure it is removed in production.
 
120
    if "debuginfo" in ivle.conf.apps.app_url:
 
121
        req.write("  <p><small>Warning: debuginfo is enabled. Set "
 
122
            "enable_debuginfo = False in ivle/conf/apps.py, when placing IVLE "
 
123
            "into production.</small></p>\n")
 
124
 
 
125
    # If req has a "no_agreement" attribute, then it is because the user has
 
126
    # not signed the agreement; therefore we are displaying the TOS page.
 
127
    # Do not show apps (see dispatch.login).
 
128
    if req.user and not req.user.state == 'no_agreement':
 
129
        # Only print app tabs if logged in
 
130
        print_apps_list(req, req.app)
85
131
    req.write('</div>\n<div id="ivlebody">\n')
86
132
 
87
133
def write_html_foot(req):
90
136
    req: An IVLE request object. Written to.
91
137
    """
92
138
    req.write("</div>\n</body>\n</html>\n")
 
139
 
 
140
def get_help_url(req):
 
141
    """Gets the help URL most relevant to this page, to place as the
 
142
    "help" link at the top of the page."""
 
143
    reqapp = req.app if hasattr(req, 'app') else None
 
144
    if reqapp == 'help':
 
145
        # We're already in help. Link to the exact current page
 
146
        # instead of the generic help page.
 
147
        return req.uri
 
148
    if reqapp is not None and reqapp in ivle.conf.apps.app_url and \
 
149
        ivle.conf.apps.app_url[reqapp].hashelp:
 
150
        help_path = os.path.join('help', reqapp)
 
151
    else:
 
152
        help_path = 'help'
 
153
    return util.make_path(help_path)
 
154
 
 
155
def get_icon_url(appurl, small=False):
 
156
    """Given an app's url name, gets the URL of the icon image for this app,
 
157
    relative to the site root. Returns None if the app has no icon."""
 
158
    if appurl is None: return None
 
159
    try:
 
160
        app = ivle.conf.apps.app_url[appurl]
 
161
    except KeyError:
 
162
        # Due to navigating to a bad app
 
163
        return None
 
164
    if small:
 
165
        icon_dir = ivle.conf.apps.app_icon_dir_small
 
166
    else:
 
167
        icon_dir = ivle.conf.apps.app_icon_dir
 
168
    if app.icon is None: return None
 
169
    return util.make_path(os.path.join(icon_dir, app.icon))
 
170
 
 
171
def print_apps_list(file, thisapp):
 
172
    """Prints all app tabs, as a UL. Prints a list item for each app that has
 
173
    a tab.
 
174
 
 
175
    file: Object with a "write" method - ie. the request object.
 
176
    Reads from: ivle.conf
 
177
    """
 
178
    file.write('  <ul id="apptabs">\n')
 
179
 
 
180
    for urlname in ivle.conf.apps.apps_in_tabs:
 
181
        app = ivle.conf.apps.app_url[urlname]
 
182
        if urlname == thisapp:
 
183
            li_attr = ' class="thisapp"'
 
184
        else:
 
185
            li_attr = ''
 
186
        file.write('    <li%s>' % li_attr)
 
187
        if app.icon:
 
188
            file.write('<img src="%s" alt="" /> '
 
189
                % urllib.quote(get_icon_url(urlname)))
 
190
        file.write('<a href="%s" title="%s">%s</a></li>\n'
 
191
            % (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
 
192
                cgi.escape(app.name)))
 
193
 
 
194
    file.write('  </ul>\n')