← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/base/xhtml.py

Fixed a small backwards-compatibility issue in the main genshi template.

This template should now function accross genshi versions 4 and 5,
making this compatible with ubuntu hardy packages

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/xhtml.py
1
 
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2009 The University of Melbourne
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
 
 
18
 
# Author: Nick Chadwick
19
 
 
20
 
import inspect
21
 
import os.path
22
 
import urllib
23
 
 
24
 
import genshi.template
25
 
 
26
 
from ivle.webapp.media import media_url
27
 
from ivle.webapp.core import Plugin as CorePlugin
28
 
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.base.plugins import ViewPlugin, OverlayPlugin
30
 
from ivle.webapp.errors import HTTPError, Unauthorized
31
 
import ivle.conf
32
 
import ivle.util
33
 
 
34
 
class XHTMLView(BaseView):
35
 
    """
36
 
    A view which provides a base class for views which need to return XHTML
37
 
    It is expected that apps which use this view will be written using Genshi
38
 
    templates.
39
 
    """
40
 
 
41
 
    template = 'template.html'
42
 
    plugin_scripts = {}
43
 
    plugin_styles = {}
44
 
    overlay_blacklist = []
45
 
 
46
 
    def __init__(self, req, **kwargs):
47
 
        for key in kwargs:
48
 
            setattr(self, key, kwargs[key])
49
 
 
50
 
    def render(self, req):
51
 
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
52
 
 
53
 
        # View template
54
 
        viewctx = genshi.template.Context()
55
 
        self.populate(req, viewctx)
56
 
 
57
 
        # The template is found in the directory of the module containing the
58
 
        # view.
59
 
        app_template = os.path.join(os.path.dirname(
60
 
                        inspect.getmodule(self).__file__), self.template) 
61
 
        req.write_html_head_foot = False
62
 
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
63
 
        tmpl = loader.load(app_template)
64
 
        app = tmpl.generate(viewctx)
65
 
 
66
 
        for plugin in self.plugin_scripts:
67
 
            for path in self.plugin_scripts[plugin]:
68
 
                req.scripts.append(media_url(req, plugin, path))
69
 
 
70
 
        for plugin in self.plugin_styles:
71
 
            for path in self.plugin_styles[plugin]:
72
 
                req.styles.append(media_url(req, plugin, path))
73
 
 
74
 
        # Global template
75
 
        ctx = genshi.template.Context()
76
 
        # XXX: Leave this here!! (Before req.styles is read)
77
 
        ctx['overlays'] = self.render_overlays(req)
78
 
 
79
 
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
80
 
        ctx['styles'] += req.styles
81
 
 
82
 
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
83
 
                           ('util.js', 'json2.js', 'md5.js')]
84
 
        ctx['scripts'] += req.scripts
85
 
 
86
 
        ctx['scripts_init'] = req.scripts_init
87
 
        ctx['app_template'] = app
88
 
        self.populate_headings(req, ctx)
89
 
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
90
 
                                                        'ivle-headings.html'))
91
 
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
92
 
        
93
 
    def populate(self, req, ctx):
94
 
        raise NotImplementedError()
95
 
 
96
 
    def populate_headings(self, req, ctx):
97
 
        ctx['favicon'] = None
98
 
        ctx['root_dir'] = ivle.conf.root_dir
99
 
        ctx['public_host'] = ivle.conf.public_host
100
 
        ctx['write_javascript_settings'] = req.write_javascript_settings
101
 
        if req.user:
102
 
            ctx['login'] = req.user.login
103
 
            ctx['logged_in'] = True
104
 
            ctx['nick'] = req.user.nick
105
 
        else:
106
 
            ctx['login'] = None
107
 
            ctx['logged_in'] = False
108
 
        ctx['publicmode'] = req.publicmode
109
 
        if hasattr(self, 'help'):
110
 
            ctx['help_path'] = self.help
111
 
 
112
 
        ctx['apps_in_tabs'] = []
113
 
        for plugin in req.plugin_index[ViewPlugin]:
114
 
            if not hasattr(plugin, 'tabs'):
115
 
                continue
116
 
 
117
 
            for tab in plugin.tabs:
118
 
                # tab is a tuple: name, title, desc, icon, path
119
 
                new_app = {}
120
 
                new_app['this_app'] = hasattr(self, 'appname') \
121
 
                                      and tab[0] == self.appname
122
 
 
123
 
                # Icon name
124
 
                if tab[3] is not None:
125
 
                    new_app['has_icon'] = True
126
 
                    icon_url = media_url(req, plugin, tab[3])
127
 
                    new_app['icon_url'] = icon_url
128
 
                    if new_app['this_app']:
129
 
                        ctx['favicon'] = icon_url
130
 
                else:
131
 
                    new_app['has_icon'] = False
132
 
                new_app['path'] = ivle.util.make_path(tab[4])
133
 
                new_app['desc'] = tab[2]
134
 
                new_app['name'] = tab[1]
135
 
                new_app['weight'] = tab[5]
136
 
                ctx['apps_in_tabs'].append(new_app)
137
 
 
138
 
        ctx['apps_in_tabs'].sort(key=lambda tab: tab['weight'])
139
 
 
140
 
    def render_overlays(self, req):
141
 
        """Generate XML streams for the overlays.
142
 
        
143
 
        Returns a list of streams. Populates the scripts, styles, and 
144
 
        scripts_init.
145
 
        """
146
 
        overlays = []
147
 
        for plugin in req.plugin_index[OverlayPlugin]:
148
 
            for overclass in plugin.overlays:
149
 
                if overclass in self.overlay_blacklist:
150
 
                    continue
151
 
                overlay = overclass(req)
152
 
                #TODO: Re-factor this to look nicer
153
 
                for mplugin in overlay.plugin_scripts:
154
 
                    for path in overlay.plugin_scripts[mplugin]:
155
 
                        req.scripts.append(media_url(req, mplugin, path))
156
 
 
157
 
                for mplugin in overlay.plugin_styles:
158
 
                    for path in overlay.plugin_styles[mplugin]:
159
 
                        req.styles.append(media_url(req, mplugin, path))
160
 
 
161
 
                req.scripts_init += overlay.plugin_scripts_init
162
 
 
163
 
                overlays.append(overlay.render(req))
164
 
        return overlays
165
 
 
166
 
    @classmethod
167
 
    def get_error_view(cls, e):
168
 
        view_map = {HTTPError:    XHTMLErrorView,
169
 
                    Unauthorized: XHTMLUnauthorizedView}
170
 
        for exccls in inspect.getmro(type(e)):
171
 
            if exccls in view_map:
172
 
                return view_map[exccls]
173
 
 
174
 
class XHTMLErrorView(XHTMLView):
175
 
    template = 'xhtmlerror.html'
176
 
 
177
 
    def __init__(self, req, exception):
178
 
        self.context = exception
179
 
 
180
 
    def populate(self, req, ctx):
181
 
        ctx['exception'] = self.context
182
 
 
183
 
class XHTMLUnauthorizedView(XHTMLErrorView):
184
 
    template = 'xhtmlunauthorized.html'
185
 
 
186
 
    def __init__(self, req, exception):
187
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
188
 
 
189
 
        if req.user is None:
190
 
            # Not logged in. Redirect to login page.
191
 
            req.throw_redirect('/+login?' + 
192
 
                               urllib.urlencode([('url', req.uri)]))
193
 
 
194
 
        req.status = 403