← 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

Port the tos app to the new framework, and fix ivle.webapp.help's reference
to it.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/xhtml.py
19
19
 
20
20
import inspect
21
21
import os.path
22
 
import urllib
23
22
 
24
23
import genshi.template
25
24
 
26
25
from ivle.webapp.media import media_url
27
 
from ivle.webapp.core import Plugin as CorePlugin
28
26
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.base.plugins import ViewPlugin, OverlayPlugin
 
27
from ivle.webapp.base.plugins import OverlayPlugin
30
28
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):
 
29
import ivle.conf
 
30
import ivle.util
 
31
 
 
32
class XHTMLView(BaseView):
56
33
    """
57
34
    A view which provides a base class for views which need to return XHTML
58
35
    It is expected that apps which use this view will be written using Genshi
60
37
    """
61
38
 
62
39
    template = 'template.html'
63
 
    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
 
40
    plugin_scripts = {}
 
41
    plugin_styles = {}
 
42
    overlay_blacklist = []
 
43
 
 
44
    def __init__(self, req, **kwargs):
 
45
        for key in kwargs:
 
46
            setattr(self, key, kwargs[key])
83
47
 
84
48
    def render(self, req):
85
49
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
92
56
        # view.
93
57
        app_template = os.path.join(os.path.dirname(
94
58
                        inspect.getmodule(self).__file__), self.template) 
95
 
        tmpl = self._loader.load(app_template)
96
 
        app = self.filter(tmpl.generate(viewctx), viewctx)
 
59
        req.write_html_head_foot = False
 
60
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
61
        tmpl = loader.load(app_template)
 
62
        app = tmpl.generate(viewctx)
97
63
 
98
 
        view_scripts = []
99
64
        for plugin in self.plugin_scripts:
100
65
            for path in self.plugin_scripts[plugin]:
101
 
                view_scripts.append(media_url(req, plugin, path))
 
66
                req.scripts.append(media_url(req, plugin, path))
102
67
 
103
 
        view_styles = []
104
68
        for plugin in self.plugin_styles:
105
69
            for path in self.plugin_styles[plugin]:
106
 
                view_styles.append(media_url(req, plugin, path))
 
70
                req.styles.append(media_url(req, plugin, path))
107
71
 
108
72
        # Global template
109
73
        ctx = genshi.template.Context()
110
 
 
111
 
        overlay_bits = self.render_overlays(req) if req.user else [[]]*4
112
 
        ctx['overlays'] = overlay_bits[0]
113
 
 
114
 
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
115
 
        ctx['styles'] += view_styles
116
 
        ctx['styles'] += overlay_bits[1]
117
 
 
118
 
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
119
 
                           ('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]
123
 
 
124
 
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
 
74
        # XXX: Leave this here!! (Before req.styles is read)
 
75
        ctx['overlays'] = self.render_overlays(req)
 
76
        ctx['app_styles'] = req.styles
 
77
        ctx['scripts'] = req.scripts
 
78
        ctx['scripts_init'] = req.scripts_init
125
79
        ctx['app_template'] = app
126
 
        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
 
 
155
80
        self.populate_headings(req, ctx)
156
 
        tmpl = self._loader.load(os.path.join(os.path.dirname(__file__), 
 
81
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
157
82
                                                        'ivle-headings.html'))
158
83
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
159
84
        
162
87
 
163
88
    def populate_headings(self, req, ctx):
164
89
        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']
 
90
        ctx['root_dir'] = ivle.conf.root_dir
 
91
        ctx['public_host'] = ivle.conf.public_host
168
92
        ctx['write_javascript_settings'] = req.write_javascript_settings
169
93
        if req.user:
170
94
            ctx['login'] = req.user.login
174
98
            ctx['login'] = None
175
99
            ctx['logged_in'] = False
176
100
        ctx['publicmode'] = req.publicmode
 
101
        ctx['apps_in_tabs'] = []
177
102
        if hasattr(self, 'help'):
178
103
            ctx['help_path'] = self.help
179
 
 
180
 
        ctx['apps_in_tabs'] = []
181
 
        for plugin in req.config.plugin_index[ViewPlugin]:
182
 
            if not hasattr(plugin, 'tabs'):
183
 
                continue
184
 
 
185
 
            for tab in plugin.tabs:
186
 
                # tab is a tuple: name, title, desc, icon, path, weight, admin
187
 
                # (Admin is optional, defaults to false)
188
 
                new_app = {}
189
 
                new_app['this_app'] = hasattr(self, 'tab') \
190
 
                                      and tab[0] == self.tab
191
 
 
192
 
                # Icon name
193
 
                if tab[3] is not None:
194
 
                    new_app['has_icon'] = True
195
 
                    icon_url = media_url(req, plugin, tab[3])
196
 
                    new_app['icon_url'] = icon_url
197
 
                    if new_app['this_app']:
198
 
                        ctx['favicon'] = icon_url
199
 
                else:
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
207
 
                new_app['path'] = req.make_path(tab[4])
208
 
                new_app['desc'] = tab[2]
209
 
                new_app['name'] = tab[1]
210
 
                new_app['weight'] = tab[5]
211
 
                ctx['apps_in_tabs'].append(new_app)
212
 
 
213
 
        ctx['apps_in_tabs'].sort(key=lambda tab: tab['weight'])
214
 
 
 
104
        for urlname in ivle.conf.apps.apps_in_tabs:
 
105
            new_app = {}
 
106
            app = ivle.conf.apps.app_url[urlname]
 
107
            new_app['this_app'] = hasattr(self, 'appname') \
 
108
                                  and urlname == self.appname
 
109
            if app.icon:
 
110
                new_app['has_icon'] = True
 
111
                icon_dir = ivle.conf.apps.app_icon_dir
 
112
                icon_url = ivle.util.make_path(os.path.join(icon_dir, app.icon))
 
113
                new_app['icon_url'] = icon_url
 
114
                if new_app['this_app']:
 
115
                    ctx['favicon'] = icon_url
 
116
            else:
 
117
                new_app['has_icon'] = False
 
118
            new_app['path'] = ivle.util.make_path(urlname)
 
119
            new_app['desc'] = app.desc
 
120
            new_app['name'] = app.name
 
121
            ctx['apps_in_tabs'].append(new_app)
 
122
            
215
123
    def render_overlays(self, req):
216
124
        """Generate XML streams for the overlays.
217
125
        
219
127
        scripts_init.
220
128
        """
221
129
        overlays = []
222
 
        styles = []
223
 
        scripts = []
224
 
        scripts_init = []
225
 
        if not self.allow_overlays:
226
 
            return (overlays, styles, scripts, scripts_init)
227
 
 
228
 
        for plugin in req.config.plugin_index[OverlayPlugin]:
 
130
        for plugin in req.plugin_index[OverlayPlugin]:
229
131
            for overclass in plugin.overlays:
230
132
                if overclass in self.overlay_blacklist:
231
133
                    continue
233
135
                #TODO: Re-factor this to look nicer
234
136
                for mplugin in overlay.plugin_scripts:
235
137
                    for path in overlay.plugin_scripts[mplugin]:
236
 
                        scripts.append(media_url(req, mplugin, path))
 
138
                        req.scripts.append(media_url(req, mplugin, path))
237
139
 
238
140
                for mplugin in overlay.plugin_styles:
239
141
                    for path in overlay.plugin_styles[mplugin]:
240
 
                        styles.append(media_url(req, mplugin, path))
 
142
                        req.styles.append(media_url(req, mplugin, path))
241
143
 
242
 
                scripts_init += overlay.plugin_scripts_init
 
144
                req.scripts_init += overlay.plugin_scripts_init
243
145
 
244
146
                overlays.append(overlay.render(req))
245
 
        return (overlays, styles, scripts, scripts_init)
 
147
        return overlays
246
148
 
247
149
    @classmethod
248
150
    def get_error_view(cls, e):
255
157
class XHTMLErrorView(XHTMLView):
256
158
    template = 'xhtmlerror.html'
257
159
 
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)
 
160
    def __init__(self, req, exception):
 
161
        self.context = exception
264
162
 
265
163
    def populate(self, req, ctx):
266
 
        ctx['req'] = req
267
164
        ctx['exception'] = self.context
268
 
        req.headers_out['X-IVLE-Error'] = self.context.message
269
165
 
270
166
class XHTMLUnauthorizedView(XHTMLErrorView):
271
167
    template = 'xhtmlunauthorized.html'
272
168
 
273
 
    def __init__(self, req, exception, lastobj):
274
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
275
 
 
276
 
        if not req.publicmode and req.user is None:
 
169
    def __init__(self, req, exception):
 
170
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
171
        if req.user is None:
277
172
            # Not logged in. Redirect to login page.
278
 
            if req.uri == '/':
279
 
                query_string = ''
280
 
            else:
281
 
                query_string = '?url=' + urllib.quote(req.uri, safe="/~")
282
 
            req.throw_redirect('/+login' + query_string)
 
173
            req.throw_redirect('/') # XXX: Need proper URL.
283
174
 
284
175
        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