← 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

  • Committer: William Grant
  • Date: 2010-02-25 05:47:27 UTC
  • Revision ID: grantw@unimelb.edu.au-20100225054727-fhxksrxj5vhrf5dm
Share one TemplateLoader between every instance of every view, so we cache EVERYTHING.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/xhtml.py
28
28
from ivle.webapp.base.views import BaseView
29
29
from ivle.webapp.base.plugins import ViewPlugin, OverlayPlugin
30
30
from ivle.webapp.errors import HTTPError, Unauthorized
31
 
import ivle.conf
32
 
import ivle.util
33
 
 
34
 
class XHTMLView(BaseView):
 
31
from ivle.webapp.publisher import NoPath
 
32
from ivle.webapp.breadcrumbs import Breadcrumber
 
33
 
 
34
 
 
35
class GenshiLoaderMixin(object):
 
36
    """Mixin for classes which need to render Genshi templates.
 
37
 
 
38
    A TemplateLoader is shared between all instances, so templates are
 
39
    cached across multiple instances and therefore also requests.
 
40
    """
 
41
    _loader = None
 
42
 
 
43
    def __init__(self, *args, **kwargs):
 
44
        super(GenshiLoaderMixin, self).__init__(*args, **kwargs)
 
45
 
 
46
        # We use a single loader for all views, so we can cache the
 
47
        # parsed templates. auto_reload is convenient and has a minimal
 
48
        # performance penalty, so we'll leave it on.
 
49
        if GenshiLoaderMixin._loader is None:
 
50
            GenshiLoaderMixin._loader = genshi.template.TemplateLoader(
 
51
                ".", auto_reload=True,
 
52
                max_cache_size=100)
 
53
 
 
54
 
 
55
class XHTMLView(GenshiLoaderMixin, BaseView):
35
56
    """
36
57
    A view which provides a base class for views which need to return XHTML
37
58
    It is expected that apps which use this view will be written using Genshi
39
60
    """
40
61
 
41
62
    template = 'template.html'
42
 
    plugin_scripts = {}
43
 
    plugin_styles = {}
44
63
    allow_overlays = True
45
 
    overlay_blacklist = []
46
 
 
47
 
    def __init__(self, req, **kwargs):
48
 
        for key in kwargs:
49
 
            setattr(self, key, kwargs[key])
 
64
    breadcrumb_text = None
 
65
 
 
66
    def __init__(self, *args, **kwargs):
 
67
        super(XHTMLView, self).__init__(*args, **kwargs)
 
68
 
 
69
        self.overlay_blacklist = []
 
70
 
 
71
        self.plugin_scripts = {}
 
72
        self.plugin_styles = {}
 
73
        self.scripts_init = []
 
74
 
 
75
        self.extra_breadcrumbs = []
 
76
        self.overlay_blacklist = []
 
77
 
 
78
    def get_context_ancestry(self, req):
 
79
        return req.publisher.get_ancestors(self.context)
 
80
 
 
81
    def filter(self, stream, ctx):
 
82
        return stream
50
83
 
51
84
    def render(self, req):
52
85
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
59
92
        # view.
60
93
        app_template = os.path.join(os.path.dirname(
61
94
                        inspect.getmodule(self).__file__), self.template) 
62
 
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
63
 
        tmpl = loader.load(app_template)
64
 
        app = tmpl.generate(viewctx)
 
95
        tmpl = self._loader.load(app_template)
 
96
        app = self.filter(tmpl.generate(viewctx), viewctx)
65
97
 
 
98
        view_scripts = []
66
99
        for plugin in self.plugin_scripts:
67
100
            for path in self.plugin_scripts[plugin]:
68
 
                req.scripts.append(media_url(req, plugin, path))
 
101
                view_scripts.append(media_url(req, plugin, path))
69
102
 
 
103
        view_styles = []
70
104
        for plugin in self.plugin_styles:
71
105
            for path in self.plugin_styles[plugin]:
72
 
                req.styles.append(media_url(req, plugin, path))
 
106
                view_styles.append(media_url(req, plugin, path))
73
107
 
74
108
        # Global template
75
109
        ctx = genshi.template.Context()
76
 
        # XXX: Leave this here!! (Before req.styles is read)
77
 
        ctx['overlays'] = self.render_overlays(req) if req.user else []
 
110
 
 
111
        overlay_bits = self.render_overlays(req) if req.user else [[]]*4
 
112
        ctx['overlays'] = overlay_bits[0]
78
113
 
79
114
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
80
 
        ctx['styles'] += req.styles
 
115
        ctx['styles'] += view_styles
 
116
        ctx['styles'] += overlay_bits[1]
81
117
 
82
118
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
83
119
                           ('util.js', 'json2.js', 'md5.js')]
84
 
        ctx['scripts'] += req.scripts
 
120
        ctx['scripts'].append(media_url(req, '+external/jquery', 'jquery.js'))
 
121
        ctx['scripts'] += view_scripts
 
122
        ctx['scripts'] += overlay_bits[2]
85
123
 
86
 
        ctx['scripts_init'] = req.scripts_init
 
124
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
87
125
        ctx['app_template'] = app
 
126
        ctx['title_img'] = media_url(req, CorePlugin,
 
127
                                     "images/chrome/root-breadcrumb.png")
 
128
        try:
 
129
            ancestry = self.get_context_ancestry(req)
 
130
        except NoPath:
 
131
            ancestry = []
 
132
 
 
133
        crumber = Breadcrumber(req)
 
134
 
 
135
        ctx['breadcrumbs'] = []
 
136
        if not req.publicmode:
 
137
            for ancestor in ancestry:
 
138
                crumb = crumber.crumb(ancestor)
 
139
                if crumb is None:
 
140
                    continue
 
141
 
 
142
                if hasattr(crumb, 'extra_breadcrumbs_before'):
 
143
                    ctx['breadcrumbs'].extend(crumb.extra_breadcrumbs_before)
 
144
                ctx['breadcrumbs'].append(crumb)
 
145
                if hasattr(crumb, 'extra_breadcrumbs_after'):
 
146
                    ctx['breadcrumbs'].extend(crumb.extra_breadcrumbs_after)
 
147
 
 
148
            # If the view has specified text for a breadcrumb, add one.
 
149
            if self.breadcrumb_text:
 
150
                ctx['breadcrumbs'].append(ViewBreadcrumb(req, self))
 
151
 
 
152
            # Allow the view to add its own fake breadcrumbs.
 
153
            ctx['breadcrumbs'].extend(self.extra_breadcrumbs)
 
154
 
88
155
        self.populate_headings(req, ctx)
89
 
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
 
156
        tmpl = self._loader.load(os.path.join(os.path.dirname(__file__), 
90
157
                                                        'ivle-headings.html'))
91
158
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
92
159
        
95
162
 
96
163
    def populate_headings(self, req, ctx):
97
164
        ctx['favicon'] = None
98
 
        ctx['root_dir'] = ivle.conf.root_dir
99
 
        ctx['public_host'] = ivle.conf.public_host
 
165
        ctx['root_dir'] = req.config['urls']['root']
 
166
        ctx['public_host'] = req.config['urls']['public_host']
 
167
        ctx['svn_base'] = req.config['urls']['svn_addr']
100
168
        ctx['write_javascript_settings'] = req.write_javascript_settings
101
169
        if req.user:
102
170
            ctx['login'] = req.user.login
115
183
                continue
116
184
 
117
185
            for tab in plugin.tabs:
118
 
                # tab is a tuple: name, title, desc, icon, path
 
186
                # tab is a tuple: name, title, desc, icon, path, weight, admin
 
187
                # (Admin is optional, defaults to false)
119
188
                new_app = {}
120
 
                new_app['this_app'] = hasattr(self, 'appname') \
121
 
                                      and tab[0] == self.appname
 
189
                new_app['this_app'] = hasattr(self, 'tab') \
 
190
                                      and tab[0] == self.tab
122
191
 
123
192
                # Icon name
124
193
                if tab[3] is not None:
129
198
                        ctx['favicon'] = icon_url
130
199
                else:
131
200
                    new_app['has_icon'] = False
132
 
                new_app['path'] = ivle.util.make_path(tab[4])
 
201
                # The following check is here, so it is AFTER setting the
 
202
                # icon, but BEFORE actually installing the tab in the menu
 
203
                if len(tab) > 6 and tab[6]:
 
204
                    # Admin-only tab
 
205
                    if not (req.user and req.user.admin):
 
206
                        break
 
207
                new_app['path'] = req.make_path(tab[4])
133
208
                new_app['desc'] = tab[2]
134
209
                new_app['name'] = tab[1]
135
210
                new_app['weight'] = tab[5]
144
219
        scripts_init.
145
220
        """
146
221
        overlays = []
 
222
        styles = []
 
223
        scripts = []
 
224
        scripts_init = []
147
225
        if not self.allow_overlays:
148
 
            return overlays
 
226
            return (overlays, styles, scripts, scripts_init)
149
227
 
150
228
        for plugin in req.config.plugin_index[OverlayPlugin]:
151
229
            for overclass in plugin.overlays:
155
233
                #TODO: Re-factor this to look nicer
156
234
                for mplugin in overlay.plugin_scripts:
157
235
                    for path in overlay.plugin_scripts[mplugin]:
158
 
                        req.scripts.append(media_url(req, mplugin, path))
 
236
                        scripts.append(media_url(req, mplugin, path))
159
237
 
160
238
                for mplugin in overlay.plugin_styles:
161
239
                    for path in overlay.plugin_styles[mplugin]:
162
 
                        req.styles.append(media_url(req, mplugin, path))
 
240
                        styles.append(media_url(req, mplugin, path))
163
241
 
164
 
                req.scripts_init += overlay.plugin_scripts_init
 
242
                scripts_init += overlay.plugin_scripts_init
165
243
 
166
244
                overlays.append(overlay.render(req))
167
 
        return overlays
 
245
        return (overlays, styles, scripts, scripts_init)
168
246
 
169
247
    @classmethod
170
248
    def get_error_view(cls, e):
177
255
class XHTMLErrorView(XHTMLView):
178
256
    template = 'xhtmlerror.html'
179
257
 
180
 
    def __init__(self, req, exception):
181
 
        self.context = exception
 
258
    def __init__(self, req, context, lastobj):
 
259
        super(XHTMLErrorView, self).__init__(req, context)
 
260
        self.lastobj = lastobj
 
261
 
 
262
    def get_context_ancestry(self, req):
 
263
        return req.publisher.get_ancestors(self.lastobj)
182
264
 
183
265
    def populate(self, req, ctx):
 
266
        ctx['req'] = req
184
267
        ctx['exception'] = self.context
 
268
        req.headers_out['X-IVLE-Error'] = self.context.message
185
269
 
186
270
class XHTMLUnauthorizedView(XHTMLErrorView):
187
271
    template = 'xhtmlunauthorized.html'
188
272
 
189
 
    def __init__(self, req, exception):
190
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
273
    def __init__(self, req, exception, lastobj):
 
274
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
191
275
 
192
 
        if req.user is None:
 
276
        if not req.publicmode and req.user is None:
193
277
            # Not logged in. Redirect to login page.
194
278
            if req.uri == '/':
195
279
                query_string = ''
198
282
            req.throw_redirect('/+login' + query_string)
199
283
 
200
284
        req.status = 403
 
285
 
 
286
class ViewBreadcrumb(object):
 
287
    def __init__(self, req, context):
 
288
        self.req = req
 
289
        self.context = context
 
290
 
 
291
    @property
 
292
    def text(self):
 
293
        return self.context.breadcrumb_text