← 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: Matt Giuca
  • Date: 2009-02-25 02:17:36 UTC
  • mfrom: (1109)
  • mto: This revision was merged to the branch mainline in revision 1119.
  • Revision ID: matt.giuca@gmail.com-20090225021736-fnnpc7stnemede00
Merged from trunk.

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
import ivle.conf
 
32
import ivle.util
 
33
 
 
34
class XHTMLView(BaseView):
56
35
    """
57
36
    A view which provides a base class for views which need to return XHTML
58
37
    It is expected that apps which use this view will be written using Genshi
60
39
    """
61
40
 
62
41
    template = 'template.html'
 
42
    plugin_scripts = {}
 
43
    plugin_styles = {}
63
44
    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)
80
 
 
81
 
    def filter(self, stream, ctx):
82
 
        return stream
 
45
    overlay_blacklist = []
 
46
 
 
47
    def __init__(self, req, **kwargs):
 
48
        for key in kwargs:
 
49
            setattr(self, key, kwargs[key])
83
50
 
84
51
    def render(self, req):
85
52
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
92
59
        # view.
93
60
        app_template = os.path.join(os.path.dirname(
94
61
                        inspect.getmodule(self).__file__), self.template) 
95
 
        tmpl = self._loader.load(app_template)
96
 
        app = self.filter(tmpl.generate(viewctx), viewctx)
 
62
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
63
        tmpl = loader.load(app_template)
 
64
        app = tmpl.generate(viewctx)
97
65
 
98
 
        view_scripts = []
99
66
        for plugin in self.plugin_scripts:
100
67
            for path in self.plugin_scripts[plugin]:
101
 
                view_scripts.append(media_url(req, plugin, path))
 
68
                req.scripts.append(media_url(req, plugin, path))
102
69
 
103
 
        view_styles = []
104
70
        for plugin in self.plugin_styles:
105
71
            for path in self.plugin_styles[plugin]:
106
 
                view_styles.append(media_url(req, plugin, path))
 
72
                req.styles.append(media_url(req, plugin, path))
107
73
 
108
74
        # Global template
109
75
        ctx = genshi.template.Context()
110
 
 
111
 
        overlay_bits = self.render_overlays(req) if req.user else [[]]*4
112
 
        ctx['overlays'] = overlay_bits[0]
 
76
        # XXX: Leave this here!! (Before req.styles is read)
 
77
        ctx['overlays'] = self.render_overlays(req) if req.user else []
113
78
 
114
79
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
115
 
        ctx['styles'] += view_styles
116
 
        ctx['styles'] += overlay_bits[1]
 
80
        ctx['styles'] += req.styles
117
81
 
118
82
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
119
83
                           ('util.js', 'json2.js', 'md5.js')]
120
 
        ctx['scripts'].append(media_url(req, '+external/jquery', 'jquery.js'))
121
 
        ctx['scripts'] += view_scripts
122
 
        ctx['scripts'] += overlay_bits[2]
 
84
        ctx['scripts'] += req.scripts
123
85
 
124
 
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
 
86
        ctx['scripts_init'] = req.scripts_init
125
87
        ctx['app_template'] = app
126
88
        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
 
 
 
89
                                     "images/chrome/title.png")
155
90
        self.populate_headings(req, ctx)
156
 
        tmpl = self._loader.load(os.path.join(os.path.dirname(__file__), 
 
91
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
157
92
                                                        'ivle-headings.html'))
158
93
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
159
94
        
162
97
 
163
98
    def populate_headings(self, req, ctx):
164
99
        ctx['favicon'] = None
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
        ctx['root_dir'] = ivle.conf.root_dir
 
101
        ctx['public_host'] = ivle.conf.public_host
168
102
        ctx['write_javascript_settings'] = req.write_javascript_settings
169
103
        if req.user:
170
104
            ctx['login'] = req.user.login
183
117
                continue
184
118
 
185
119
            for tab in plugin.tabs:
186
 
                # tab is a tuple: name, title, desc, icon, path, weight, admin
187
 
                # (Admin is optional, defaults to false)
 
120
                # tab is a tuple: name, title, desc, icon, path
188
121
                new_app = {}
189
 
                new_app['this_app'] = hasattr(self, 'tab') \
190
 
                                      and tab[0] == self.tab
 
122
                new_app['this_app'] = hasattr(self, 'appname') \
 
123
                                      and tab[0] == self.appname
191
124
 
192
125
                # Icon name
193
126
                if tab[3] is not None:
198
131
                        ctx['favicon'] = icon_url
199
132
                else:
200
133
                    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
 
                new_app['path'] = req.make_path(tab[4])
 
134
                new_app['path'] = ivle.util.make_path(tab[4])
208
135
                new_app['desc'] = tab[2]
209
136
                new_app['name'] = tab[1]
210
137
                new_app['weight'] = tab[5]
219
146
        scripts_init.
220
147
        """
221
148
        overlays = []
222
 
        styles = []
223
 
        scripts = []
224
 
        scripts_init = []
225
149
        if not self.allow_overlays:
226
 
            return (overlays, styles, scripts, scripts_init)
 
150
            return overlays
227
151
 
228
152
        for plugin in req.config.plugin_index[OverlayPlugin]:
229
153
            for overclass in plugin.overlays:
233
157
                #TODO: Re-factor this to look nicer
234
158
                for mplugin in overlay.plugin_scripts:
235
159
                    for path in overlay.plugin_scripts[mplugin]:
236
 
                        scripts.append(media_url(req, mplugin, path))
 
160
                        req.scripts.append(media_url(req, mplugin, path))
237
161
 
238
162
                for mplugin in overlay.plugin_styles:
239
163
                    for path in overlay.plugin_styles[mplugin]:
240
 
                        styles.append(media_url(req, mplugin, path))
 
164
                        req.styles.append(media_url(req, mplugin, path))
241
165
 
242
 
                scripts_init += overlay.plugin_scripts_init
 
166
                req.scripts_init += overlay.plugin_scripts_init
243
167
 
244
168
                overlays.append(overlay.render(req))
245
 
        return (overlays, styles, scripts, scripts_init)
 
169
        return overlays
246
170
 
247
171
    @classmethod
248
172
    def get_error_view(cls, e):
255
179
class XHTMLErrorView(XHTMLView):
256
180
    template = 'xhtmlerror.html'
257
181
 
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
    def __init__(self, req, exception):
 
183
        self.context = exception
264
184
 
265
185
    def populate(self, req, ctx):
266
 
        ctx['req'] = req
267
186
        ctx['exception'] = self.context
268
 
        req.headers_out['X-IVLE-Error'] = self.context.message
269
187
 
270
188
class XHTMLUnauthorizedView(XHTMLErrorView):
271
189
    template = 'xhtmlunauthorized.html'
272
190
 
273
 
    def __init__(self, req, exception, lastobj):
274
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
 
191
    def __init__(self, req, exception):
 
192
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
275
193
 
276
 
        if not req.publicmode and req.user is None:
 
194
        if req.user is None:
277
195
            # Not logged in. Redirect to login page.
278
196
            if req.uri == '/':
279
197
                query_string = ''
282
200
            req.throw_redirect('/+login' + query_string)
283
201
 
284
202
        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