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
32
class XHTMLView(BaseView):
31
from ivle.webapp.publisher import NoPath
32
from ivle.webapp.breadcrumbs import Breadcrumber
35
class GenshiLoaderMixin(object):
36
"""Mixin for classes which need to render Genshi templates.
38
A TemplateLoader is shared between all instances, so templates are
39
cached across multiple instances and therefore also requests.
43
def __init__(self, *args, **kwargs):
44
super(GenshiLoaderMixin, self).__init__(*args, **kwargs)
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,
55
class XHTMLView(GenshiLoaderMixin, BaseView):
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
39
62
template = 'template.html'
42
63
allow_overlays = True
43
overlay_blacklist = []
45
def __init__(self, req, **kwargs):
47
setattr(self, key, kwargs[key])
64
breadcrumb_text = None
66
def __init__(self, *args, **kwargs):
67
super(XHTMLView, self).__init__(*args, **kwargs)
69
self.overlay_blacklist = []
71
self.plugin_scripts = {}
72
self.plugin_styles = {}
73
self.scripts_init = []
75
self.extra_breadcrumbs = []
76
self.overlay_blacklist = []
78
def get_context_ancestry(self, req):
79
return req.publisher.get_ancestors(self.context)
49
81
def filter(self, stream, ctx):
61
93
app_template = os.path.join(os.path.dirname(
62
94
inspect.getmodule(self).__file__), self.template)
63
loader = genshi.template.TemplateLoader(".", auto_reload=True)
64
tmpl = loader.load(app_template)
95
tmpl = self._loader.load(app_template)
65
96
app = self.filter(tmpl.generate(viewctx), viewctx)
67
99
for plugin in self.plugin_scripts:
68
100
for path in self.plugin_scripts[plugin]:
69
req.scripts.append(media_url(req, plugin, path))
101
view_scripts.append(media_url(req, plugin, path))
71
104
for plugin in self.plugin_styles:
72
105
for path in self.plugin_styles[plugin]:
73
req.styles.append(media_url(req, plugin, path))
106
view_styles.append(media_url(req, plugin, path))
76
109
ctx = genshi.template.Context()
77
# XXX: Leave this here!! (Before req.styles is read)
78
ctx['overlays'] = self.render_overlays(req) if req.user else []
111
overlay_bits = self.render_overlays(req) if req.user else [[]]*4
112
ctx['overlays'] = overlay_bits[0]
80
114
ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
81
ctx['styles'] += req.styles
115
ctx['styles'] += view_styles
116
ctx['styles'] += overlay_bits[1]
83
118
ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
84
119
('util.js', 'json2.js', 'md5.js')]
85
120
ctx['scripts'].append(media_url(req, '+external/jquery', 'jquery.js'))
86
ctx['scripts'] += req.scripts
121
ctx['scripts'] += view_scripts
122
ctx['scripts'] += overlay_bits[2]
88
ctx['scripts_init'] = req.scripts_init
124
ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
89
125
ctx['app_template'] = app
90
126
ctx['title_img'] = media_url(req, CorePlugin,
91
"images/chrome/title.png")
127
"images/chrome/root-breadcrumb.png")
129
ancestry = self.get_context_ancestry(req)
133
crumber = Breadcrumber(req)
135
ctx['breadcrumbs'] = []
136
if not req.publicmode:
137
for ancestor in ancestry:
138
crumb = crumber.crumb(ancestor)
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)
148
# If the view has specified text for a breadcrumb, add one.
149
if self.breadcrumb_text:
150
ctx['breadcrumbs'].append(ViewBreadcrumb(req, self))
152
# Allow the view to add its own fake breadcrumbs.
153
ctx['breadcrumbs'].extend(self.extra_breadcrumbs)
92
155
self.populate_headings(req, ctx)
93
tmpl = loader.load(os.path.join(os.path.dirname(__file__),
156
tmpl = self._loader.load(os.path.join(os.path.dirname(__file__),
94
157
'ivle-headings.html'))
95
158
req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
160
233
#TODO: Re-factor this to look nicer
161
234
for mplugin in overlay.plugin_scripts:
162
235
for path in overlay.plugin_scripts[mplugin]:
163
req.scripts.append(media_url(req, mplugin, path))
236
scripts.append(media_url(req, mplugin, path))
165
238
for mplugin in overlay.plugin_styles:
166
239
for path in overlay.plugin_styles[mplugin]:
167
req.styles.append(media_url(req, mplugin, path))
240
styles.append(media_url(req, mplugin, path))
169
req.scripts_init += overlay.plugin_scripts_init
242
scripts_init += overlay.plugin_scripts_init
171
244
overlays.append(overlay.render(req))
245
return (overlays, styles, scripts, scripts_init)
175
248
def get_error_view(cls, e):
182
255
class XHTMLErrorView(XHTMLView):
183
256
template = 'xhtmlerror.html'
185
def __init__(self, req, exception):
186
self.context = exception
258
def __init__(self, req, context, lastobj):
259
super(XHTMLErrorView, self).__init__(req, context)
260
self.lastobj = lastobj
262
def get_context_ancestry(self, req):
263
return req.publisher.get_ancestors(self.lastobj)
188
265
def populate(self, req, ctx):
189
267
ctx['exception'] = self.context
268
req.headers_out['X-IVLE-Error'] = self.context.message
191
270
class XHTMLUnauthorizedView(XHTMLErrorView):
192
271
template = 'xhtmlunauthorized.html'
194
def __init__(self, req, exception):
195
super(XHTMLUnauthorizedView, self).__init__(req, exception)
273
def __init__(self, req, exception, lastobj):
274
super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
276
if not req.publicmode and req.user is None:
198
277
# Not logged in. Redirect to login page.
199
278
if req.uri == '/':
200
279
query_string = ''
added
removed
ivle/webapp/base/xhtml.py
