← 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: 2009-07-05 07:54:29 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090705075429-qyh9midyp0v73gnv
Add export details for the breadcrumb chevron SVG.

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
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):
 
31
from ivle.webapp.routing import NoPath
 
32
 
 
33
class XHTMLView(BaseView):
56
34
    """
57
35
    A view which provides a base class for views which need to return XHTML
58
36
    It is expected that apps which use this view will be written using Genshi
60
38
    """
61
39
 
62
40
    template = 'template.html'
 
41
 
 
42
    plugin_scripts = {}
 
43
    plugin_styles = {}
 
44
    scripts_init = []
 
45
 
63
46
    allow_overlays = True
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)
 
47
    overlay_blacklist = []
80
48
 
81
49
    def filter(self, stream, ctx):
82
50
        return stream
92
60
        # view.
93
61
        app_template = os.path.join(os.path.dirname(
94
62
                        inspect.getmodule(self).__file__), self.template) 
95
 
        tmpl = self._loader.load(app_template)
 
63
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
64
        tmpl = loader.load(app_template)
96
65
        app = self.filter(tmpl.generate(viewctx), viewctx)
97
66
 
98
67
        view_scripts = []
126
95
        ctx['title_img'] = media_url(req, CorePlugin,
127
96
                                     "images/chrome/root-breadcrumb.png")
128
97
        try:
129
 
            ancestry = self.get_context_ancestry(req)
 
98
            ctx['ancestry'] = req.router.get_ancestors(self.context)
130
99
        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
            ctx['ancestry'] = []
 
101
        ctx['breadcrumb_text'] = lambda x: x # TODO: Do it properly.
 
102
        ctx['url'] = req.router.generate
155
103
        self.populate_headings(req, ctx)
156
 
        tmpl = self._loader.load(os.path.join(os.path.dirname(__file__), 
 
104
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
157
105
                                                        'ivle-headings.html'))
158
106
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
159
107
        
183
131
                continue
184
132
 
185
133
            for tab in plugin.tabs:
186
 
                # tab is a tuple: name, title, desc, icon, path, weight, admin
187
 
                # (Admin is optional, defaults to false)
 
134
                # tab is a tuple: name, title, desc, icon, path
188
135
                new_app = {}
189
136
                new_app['this_app'] = hasattr(self, 'tab') \
190
137
                                      and tab[0] == self.tab
198
145
                        ctx['favicon'] = icon_url
199
146
                else:
200
147
                    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
207
148
                new_app['path'] = req.make_path(tab[4])
208
149
                new_app['desc'] = tab[2]
209
150
                new_app['name'] = tab[1]
255
196
class XHTMLErrorView(XHTMLView):
256
197
    template = 'xhtmlerror.html'
257
198
 
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)
264
 
 
265
199
    def populate(self, req, ctx):
266
200
        ctx['req'] = req
267
201
        ctx['exception'] = self.context
268
 
        req.headers_out['X-IVLE-Error'] = self.context.message
269
202
 
270
203
class XHTMLUnauthorizedView(XHTMLErrorView):
271
204
    template = 'xhtmlunauthorized.html'
272
205
 
273
 
    def __init__(self, req, exception, lastobj):
274
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
 
206
    def __init__(self, req, exception):
 
207
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
275
208
 
276
 
        if not req.publicmode and req.user is None:
 
209
        if req.user is None:
277
210
            # Not logged in. Redirect to login page.
278
211
            if req.uri == '/':
279
212
                query_string = ''
282
215
            req.throw_redirect('/+login' + query_string)
283
216
 
284
217
        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