← 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 03:18:21 UTC
  • Revision ID: grantw@unimelb.edu.au-20100225031821-mi9a2tm5679fht4d
Shuffle things around so that req.user and req.store only construct when actually retrieved, and ensure they're not retrieved for media files. Saves 50ms of DB connection time per request.

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
from ivle.webapp.publisher import NoPath
 
32
from ivle.webapp.breadcrumbs import Breadcrumber
31
33
 
32
34
class XHTMLView(BaseView):
33
35
    """
37
39
    """
38
40
 
39
41
    template = 'template.html'
40
 
 
41
 
    plugin_scripts = {}
42
 
    plugin_styles = {}
43
 
    scripts_init = []
44
 
 
45
42
    allow_overlays = True
46
 
    overlay_blacklist = []
47
 
 
48
 
    def __init__(self, req, **kwargs):
49
 
        for key in kwargs:
50
 
            setattr(self, key, kwargs[key])
 
43
    breadcrumb_text = None
 
44
    _loader = None
 
45
 
 
46
    def __init__(self, *args, **kwargs):
 
47
        super(XHTMLView, self).__init__(*args, **kwargs)
 
48
 
 
49
        # We use a single loader for all views, so we can cache the
 
50
        # parsed templates. auto_reload is convenient and has a minimal
 
51
        # performance penalty, so we'll leave it on.
 
52
        if self.__class__._loader is None:
 
53
            self.__class__._loader = genshi.template.TemplateLoader(
 
54
                ".", auto_reload=True,
 
55
                max_cache_size=100)
 
56
 
 
57
        self.overlay_blacklist = []
 
58
 
 
59
        self.plugin_scripts = {}
 
60
        self.plugin_styles = {}
 
61
        self.scripts_init = []
 
62
 
 
63
        self.extra_breadcrumbs = []
 
64
        self.overlay_blacklist = []
 
65
 
 
66
    def get_context_ancestry(self, req):
 
67
        return req.publisher.get_ancestors(self.context)
51
68
 
52
69
    def filter(self, stream, ctx):
53
70
        return stream
63
80
        # view.
64
81
        app_template = os.path.join(os.path.dirname(
65
82
                        inspect.getmodule(self).__file__), self.template) 
66
 
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
67
 
        tmpl = loader.load(app_template)
 
83
        tmpl = self._loader.load(app_template)
68
84
        app = self.filter(tmpl.generate(viewctx), viewctx)
69
85
 
70
86
        view_scripts = []
96
112
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
97
113
        ctx['app_template'] = app
98
114
        ctx['title_img'] = media_url(req, CorePlugin,
99
 
                                     "images/chrome/title.png")
 
115
                                     "images/chrome/root-breadcrumb.png")
 
116
        try:
 
117
            ancestry = self.get_context_ancestry(req)
 
118
        except NoPath:
 
119
            ancestry = []
 
120
 
 
121
        crumber = Breadcrumber(req)
 
122
 
 
123
        ctx['breadcrumbs'] = []
 
124
        if not req.publicmode:
 
125
            for ancestor in ancestry:
 
126
                crumb = crumber.crumb(ancestor)
 
127
                if crumb is None:
 
128
                    continue
 
129
 
 
130
                if hasattr(crumb, 'extra_breadcrumbs_before'):
 
131
                    ctx['breadcrumbs'].extend(crumb.extra_breadcrumbs_before)
 
132
                ctx['breadcrumbs'].append(crumb)
 
133
                if hasattr(crumb, 'extra_breadcrumbs_after'):
 
134
                    ctx['breadcrumbs'].extend(crumb.extra_breadcrumbs_after)
 
135
 
 
136
            # If the view has specified text for a breadcrumb, add one.
 
137
            if self.breadcrumb_text:
 
138
                ctx['breadcrumbs'].append(ViewBreadcrumb(req, self))
 
139
 
 
140
            # Allow the view to add its own fake breadcrumbs.
 
141
            ctx['breadcrumbs'].extend(self.extra_breadcrumbs)
 
142
 
100
143
        self.populate_headings(req, ctx)
101
 
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
 
144
        tmpl = self._loader.load(os.path.join(os.path.dirname(__file__), 
102
145
                                                        'ivle-headings.html'))
103
146
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
104
147
        
128
171
                continue
129
172
 
130
173
            for tab in plugin.tabs:
131
 
                # tab is a tuple: name, title, desc, icon, path
 
174
                # tab is a tuple: name, title, desc, icon, path, weight, admin
 
175
                # (Admin is optional, defaults to false)
132
176
                new_app = {}
133
177
                new_app['this_app'] = hasattr(self, 'tab') \
134
178
                                      and tab[0] == self.tab
142
186
                        ctx['favicon'] = icon_url
143
187
                else:
144
188
                    new_app['has_icon'] = False
 
189
                # The following check is here, so it is AFTER setting the
 
190
                # icon, but BEFORE actually installing the tab in the menu
 
191
                if len(tab) > 6 and tab[6]:
 
192
                    # Admin-only tab
 
193
                    if not (req.user and req.user.admin):
 
194
                        break
145
195
                new_app['path'] = req.make_path(tab[4])
146
196
                new_app['desc'] = tab[2]
147
197
                new_app['name'] = tab[1]
193
243
class XHTMLErrorView(XHTMLView):
194
244
    template = 'xhtmlerror.html'
195
245
 
196
 
    def __init__(self, req, exception):
197
 
        self.context = exception
 
246
    def __init__(self, req, context, lastobj):
 
247
        super(XHTMLErrorView, self).__init__(req, context)
 
248
        self.lastobj = lastobj
 
249
 
 
250
    def get_context_ancestry(self, req):
 
251
        return req.publisher.get_ancestors(self.lastobj)
198
252
 
199
253
    def populate(self, req, ctx):
 
254
        ctx['req'] = req
200
255
        ctx['exception'] = self.context
 
256
        req.headers_out['X-IVLE-Error'] = self.context.message
201
257
 
202
258
class XHTMLUnauthorizedView(XHTMLErrorView):
203
259
    template = 'xhtmlunauthorized.html'
204
260
 
205
 
    def __init__(self, req, exception):
206
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
261
    def __init__(self, req, exception, lastobj):
 
262
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
207
263
 
208
 
        if req.user is None:
 
264
        if not req.publicmode and req.user is None:
209
265
            # Not logged in. Redirect to login page.
210
266
            if req.uri == '/':
211
267
                query_string = ''
214
270
            req.throw_redirect('/+login' + query_string)
215
271
 
216
272
        req.status = 403
 
273
 
 
274
class ViewBreadcrumb(object):
 
275
    def __init__(self, req, context):
 
276
        self.req = req
 
277
        self.context = context
 
278
 
 
279
    @property
 
280
    def text(self):
 
281
        return self.context.breadcrumb_text