← 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 07:34:50 UTC
  • Revision ID: grantw@unimelb.edu.au-20100225073450-zcl8ev5hlyhbszeu
Activate the Storm C extensions if possible. Moar speed.

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
 
 
32
 
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):
33
56
    """
34
57
    A view which provides a base class for views which need to return XHTML
35
58
    It is expected that apps which use this view will be written using Genshi
37
60
    """
38
61
 
39
62
    template = 'template.html'
40
 
 
41
 
    plugin_scripts = {}
42
 
    plugin_styles = {}
43
 
    scripts_init = []
44
 
 
45
63
    allow_overlays = True
46
 
    overlay_blacklist = []
47
 
 
48
 
    def __init__(self, req, **kwargs):
49
 
        for key in kwargs:
50
 
            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)
51
80
 
52
81
    def filter(self, stream, ctx):
53
82
        return stream
63
92
        # view.
64
93
        app_template = os.path.join(os.path.dirname(
65
94
                        inspect.getmodule(self).__file__), self.template) 
66
 
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
67
 
        tmpl = loader.load(app_template)
 
95
        tmpl = self._loader.load(app_template)
68
96
        app = self.filter(tmpl.generate(viewctx), viewctx)
69
97
 
70
98
        view_scripts = []
96
124
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
97
125
        ctx['app_template'] = app
98
126
        ctx['title_img'] = media_url(req, CorePlugin,
99
 
                                     "images/chrome/title.png")
 
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
 
100
155
        self.populate_headings(req, ctx)
101
 
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
 
156
        tmpl = self._loader.load(os.path.join(os.path.dirname(__file__), 
102
157
                                                        'ivle-headings.html'))
103
158
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
104
159
        
128
183
                continue
129
184
 
130
185
            for tab in plugin.tabs:
131
 
                # 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)
132
188
                new_app = {}
133
189
                new_app['this_app'] = hasattr(self, 'tab') \
134
190
                                      and tab[0] == self.tab
142
198
                        ctx['favicon'] = icon_url
143
199
                else:
144
200
                    new_app['has_icon'] = False
 
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
145
207
                new_app['path'] = req.make_path(tab[4])
146
208
                new_app['desc'] = tab[2]
147
209
                new_app['name'] = tab[1]
193
255
class XHTMLErrorView(XHTMLView):
194
256
    template = 'xhtmlerror.html'
195
257
 
196
 
    def __init__(self, req, exception):
197
 
        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)
198
264
 
199
265
    def populate(self, req, ctx):
 
266
        ctx['req'] = req
200
267
        ctx['exception'] = self.context
 
268
        req.headers_out['X-IVLE-Error'] = self.context.message
201
269
 
202
270
class XHTMLUnauthorizedView(XHTMLErrorView):
203
271
    template = 'xhtmlunauthorized.html'
204
272
 
205
 
    def __init__(self, req, exception):
206
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
273
    def __init__(self, req, exception, lastobj):
 
274
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
207
275
 
208
 
        if req.user is None:
 
276
        if not req.publicmode and req.user is None:
209
277
            # Not logged in. Redirect to login page.
210
278
            if req.uri == '/':
211
279
                query_string = ''
214
282
            req.throw_redirect('/+login' + query_string)
215
283
 
216
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