← 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-12 12:37:53 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:195
Configuration: Moved "default_app" setting from conf/conf.py to conf/apps.py.
    Reason: This is not user-configurable, much more relevant to apps.
Updated setup.py so as to not write this variable to conf.py.
setup.py: Also made a bit more robust, can handle an existing conf.py with
    missing variables.

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
26
import os.path
29
27
 
30
28
import conf
41
39
    # Note the inline JavaScript, which provides the client with constants
42
40
    # derived from the server configuration.
43
41
    if req.title != None:
44
 
        titlepart = req.title + ' - '
 
42
        titlepart = ' - ' + req.title
45
43
    else:
46
44
        titlepart = ''
47
45
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
48
46
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
49
47
<html xmlns="http://www.w3.org/1999/xhtml">
50
48
<head>
51
 
  <title>%sIVLE</title>
 
49
  <title>IVLE%s</title>
52
50
  <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;
 
51
  <script type="text/javascript">
 
52
    root_dir = "%s";
63
53
  </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')))
 
54
  <link rel="stylesheet" type="text/css" href="%s" />
 
55
""" % (titlepart, req.content_type,
 
56
        repr(conf.root_dir)[1:-1],
 
57
        util.make_path('media/common/ivle.css')))
71
58
 
72
59
    # Write any app-specific style and script links
73
60
    for style in req.styles:
74
61
        req.write('  <link rel="stylesheet" type="text/css" href="%s" />\n'
75
 
            % cgi.escape(util.make_path(style)))
 
62
            % util.make_path(style))
76
63
    for script in req.scripts:
77
 
        req.write('  <script type="text/javascript" src="%s"></script>\n'
78
 
            % cgi.escape(util.make_path(script)))
 
64
        req.write('  <script type="text/javascript" src="%s" />\n'
 
65
            % util.make_path(script))
79
66
 
80
67
    req.write("</head>\n\n")
81
68
 
82
69
    # Open the body element and write a bunch of stuff there (the header)
83
70
    req.write("""<body>
84
 
<div id="ivleheader"></div>
85
 
<div id="ivleheader_text">
86
 
  <h1>IVLE</h1>
87
 
  <h2>Informatics Virtual Learning Environment</h2>
 
71
<div id="ivleheader">
 
72
  <h1>IVLE - Informatics Virtual Learning Environment</h1>
88
73
""")
89
74
 
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'
 
75
    if req.username:
 
76
        req.write('  <p class="userhello">Welcome, <span '
 
77
            'class="username">%s</span> |\n'
96
78
            '    <a href="%s">Help</a> |\n'
97
 
            '    <a href="%s">Sign out</a>\n'
 
79
            '    <a href="%s">Logout</a>\n'
98
80
            '  </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'))))
 
81
            (req.username, get_help_url(req), util.make_path('logout')))
103
82
    else:
104
83
        req.write('  <p class="userhello">Not logged in.</p>')
105
84
 
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
85
    # If the "debuginfo" app is installed, display a warning to the admin to
110
86
    # make sure it is removed in production.
111
87
    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")
 
88
        req.write("  <p><small>Warning: debuginfo is enabled. Remove this "
 
89
            "app from conf.apps.app_url when placed into production."
 
90
            "</small></p>\n")
115
91
 
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':
 
92
    if req.username:
120
93
        # Only print app tabs if logged in
121
94
        print_apps_list(req, req.app)
122
95
    req.write('</div>\n<div id="ivlebody">\n')
131
104
def get_help_url(req):
132
105
    """Gets the help URL most relevant to this page, to place as the
133
106
    "help" link at the top of the page."""
134
 
    reqapp = req.app if hasattr(req, 'app') else None
135
 
    if reqapp == 'help':
 
107
    if req.app == 'help':
136
108
        # We're already in help. Link to the exact current page
137
109
        # instead of the generic help page.
138
110
        return req.uri
139
 
    if reqapp is not None and conf.apps.app_url[reqapp].hashelp:
140
 
        help_path = os.path.join('help', reqapp)
 
111
    if conf.apps.app_url[req.app].hashelp:
 
112
        help_path = os.path.join('help', req.app)
141
113
    else:
142
114
        help_path = 'help'
143
115
    return util.make_path(help_path)
144
116
 
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
117
def print_apps_list(file, thisapp):
162
118
    """Prints all app tabs, as a UL. Prints a list item for each app that has
163
119
    a tab.
165
121
    file: Object with a "write" method - ie. the request object.
166
122
    Reads from: conf
167
123
    """
168
 
    file.write('  <ul id="apptabs">\n')
 
124
    file.write('  <ul class="apptabs">\n')
169
125
 
170
126
    for urlname in conf.apps.apps_in_tabs:
171
127
        app = conf.apps.app_url[urlname]
173
129
            li_attr = ' class="thisapp"'
174
130
        else:
175
131
            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)))
 
132
        file.write('    <li%s><a href="%s">%s</a></li>\n'
 
133
            % (li_attr, util.make_path(urlname), app.name))
183
134
 
184
135
    file.write('  </ul>\n')