← 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-15 01:12:46 UTC
  • Revision ID: grantw@unimelb.edu.au-20100215011246-2kxz9ro0gnrvqueo
Document how to tag releases in bzr.

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
 
import ivle.conf
32
 
import ivle.util
 
31
from ivle.webapp.publisher import NoPath
 
32
from ivle.webapp.breadcrumbs import Breadcrumber
33
33
 
34
34
class XHTMLView(BaseView):
35
35
    """
39
39
    """
40
40
 
41
41
    template = 'template.html'
42
 
    plugin_scripts = {}
43
 
    plugin_styles = {}
44
42
    allow_overlays = True
45
 
    overlay_blacklist = []
46
 
 
47
 
    def __init__(self, req, **kwargs):
48
 
        for key in kwargs:
49
 
            setattr(self, key, kwargs[key])
 
43
    breadcrumb_text = None
 
44
 
 
45
    def __init__(self, *args, **kwargs):
 
46
        super(XHTMLView, self).__init__(*args, **kwargs)
 
47
 
 
48
        self.overlay_blacklist = []
 
49
 
 
50
        self.plugin_scripts = {}
 
51
        self.plugin_styles = {}
 
52
        self.scripts_init = []
 
53
 
 
54
        self.extra_breadcrumbs = []
 
55
        self.overlay_blacklist = []
 
56
 
 
57
    def get_context_ancestry(self, req):
 
58
        return req.publisher.get_ancestors(self.context)
 
59
 
 
60
    def filter(self, stream, ctx):
 
61
        return stream
50
62
 
51
63
    def render(self, req):
52
64
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
61
73
                        inspect.getmodule(self).__file__), self.template) 
62
74
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
63
75
        tmpl = loader.load(app_template)
64
 
        app = tmpl.generate(viewctx)
 
76
        app = self.filter(tmpl.generate(viewctx), viewctx)
65
77
 
 
78
        view_scripts = []
66
79
        for plugin in self.plugin_scripts:
67
80
            for path in self.plugin_scripts[plugin]:
68
 
                req.scripts.append(media_url(req, plugin, path))
 
81
                view_scripts.append(media_url(req, plugin, path))
69
82
 
 
83
        view_styles = []
70
84
        for plugin in self.plugin_styles:
71
85
            for path in self.plugin_styles[plugin]:
72
 
                req.styles.append(media_url(req, plugin, path))
 
86
                view_styles.append(media_url(req, plugin, path))
73
87
 
74
88
        # Global template
75
89
        ctx = genshi.template.Context()
76
 
        # XXX: Leave this here!! (Before req.styles is read)
77
 
        ctx['overlays'] = self.render_overlays(req) if req.user else []
 
90
 
 
91
        overlay_bits = self.render_overlays(req) if req.user else [[]]*4
 
92
        ctx['overlays'] = overlay_bits[0]
78
93
 
79
94
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
80
 
        ctx['styles'] += req.styles
 
95
        ctx['styles'] += view_styles
 
96
        ctx['styles'] += overlay_bits[1]
81
97
 
82
98
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
83
 
                           ('util.js', 'json2.js', 'md5.js', 'jquery.js')]
84
 
        ctx['scripts'] += req.scripts
 
99
                           ('util.js', 'json2.js', 'md5.js')]
 
100
        ctx['scripts'].append(media_url(req, '+external/jquery', 'jquery.js'))
 
101
        ctx['scripts'] += view_scripts
 
102
        ctx['scripts'] += overlay_bits[2]
85
103
 
86
 
        ctx['scripts_init'] = req.scripts_init
 
104
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
87
105
        ctx['app_template'] = app
88
106
        ctx['title_img'] = media_url(req, CorePlugin,
89
 
                                     "images/chrome/title.png")
 
107
                                     "images/chrome/root-breadcrumb.png")
 
108
        try:
 
109
            ancestry = self.get_context_ancestry(req)
 
110
        except NoPath:
 
111
            ancestry = []
 
112
 
 
113
        crumber = Breadcrumber(req)
 
114
 
 
115
        ctx['breadcrumbs'] = []
 
116
        for ancestor in ancestry:
 
117
            crumb = crumber.crumb(ancestor)
 
118
            if crumb is None:
 
119
                continue
 
120
 
 
121
            if hasattr(crumb, 'extra_breadcrumbs_before'):
 
122
                ctx['breadcrumbs'].extend(crumb.extra_breadcrumbs_before)
 
123
            ctx['breadcrumbs'].append(crumb)
 
124
            if hasattr(crumb, 'extra_breadcrumbs_after'):
 
125
                ctx['breadcrumbs'].extend(crumb.extra_breadcrumbs_after)
 
126
 
 
127
        # If the view has specified text for a breadcrumb, add one.
 
128
        if self.breadcrumb_text:
 
129
            ctx['breadcrumbs'].append(ViewBreadcrumb(req, self))
 
130
 
 
131
        # Allow the view to add its own fake breadcrumbs.
 
132
        ctx['breadcrumbs'].extend(self.extra_breadcrumbs)
 
133
 
90
134
        self.populate_headings(req, ctx)
91
135
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
92
136
                                                        'ivle-headings.html'))
97
141
 
98
142
    def populate_headings(self, req, ctx):
99
143
        ctx['favicon'] = None
100
 
        ctx['root_dir'] = ivle.conf.root_dir
101
 
        ctx['public_host'] = ivle.conf.public_host
 
144
        ctx['root_dir'] = req.config['urls']['root']
 
145
        ctx['public_host'] = req.config['urls']['public_host']
 
146
        ctx['svn_base'] = req.config['urls']['svn_addr']
102
147
        ctx['write_javascript_settings'] = req.write_javascript_settings
103
148
        if req.user:
104
149
            ctx['login'] = req.user.login
117
162
                continue
118
163
 
119
164
            for tab in plugin.tabs:
120
 
                # tab is a tuple: name, title, desc, icon, path
 
165
                # tab is a tuple: name, title, desc, icon, path, weight, admin
 
166
                # (Admin is optional, defaults to false)
121
167
                new_app = {}
122
168
                new_app['this_app'] = hasattr(self, 'tab') \
123
169
                                      and tab[0] == self.tab
131
177
                        ctx['favicon'] = icon_url
132
178
                else:
133
179
                    new_app['has_icon'] = False
134
 
                new_app['path'] = ivle.util.make_path(tab[4])
 
180
                # The following check is here, so it is AFTER setting the
 
181
                # icon, but BEFORE actually installing the tab in the menu
 
182
                if len(tab) > 6 and tab[6]:
 
183
                    # Admin-only tab
 
184
                    if not (req.user and req.user.admin):
 
185
                        break
 
186
                new_app['path'] = req.make_path(tab[4])
135
187
                new_app['desc'] = tab[2]
136
188
                new_app['name'] = tab[1]
137
189
                new_app['weight'] = tab[5]
146
198
        scripts_init.
147
199
        """
148
200
        overlays = []
 
201
        styles = []
 
202
        scripts = []
 
203
        scripts_init = []
149
204
        if not self.allow_overlays:
150
 
            return overlays
 
205
            return (overlays, styles, scripts, scripts_init)
151
206
 
152
207
        for plugin in req.config.plugin_index[OverlayPlugin]:
153
208
            for overclass in plugin.overlays:
157
212
                #TODO: Re-factor this to look nicer
158
213
                for mplugin in overlay.plugin_scripts:
159
214
                    for path in overlay.plugin_scripts[mplugin]:
160
 
                        req.scripts.append(media_url(req, mplugin, path))
 
215
                        scripts.append(media_url(req, mplugin, path))
161
216
 
162
217
                for mplugin in overlay.plugin_styles:
163
218
                    for path in overlay.plugin_styles[mplugin]:
164
 
                        req.styles.append(media_url(req, mplugin, path))
 
219
                        styles.append(media_url(req, mplugin, path))
165
220
 
166
 
                req.scripts_init += overlay.plugin_scripts_init
 
221
                scripts_init += overlay.plugin_scripts_init
167
222
 
168
223
                overlays.append(overlay.render(req))
169
 
        return overlays
 
224
        return (overlays, styles, scripts, scripts_init)
170
225
 
171
226
    @classmethod
172
227
    def get_error_view(cls, e):
179
234
class XHTMLErrorView(XHTMLView):
180
235
    template = 'xhtmlerror.html'
181
236
 
182
 
    def __init__(self, req, exception):
183
 
        self.context = exception
 
237
    def __init__(self, req, context, lastobj):
 
238
        super(XHTMLErrorView, self).__init__(req, context)
 
239
        self.lastobj = lastobj
 
240
 
 
241
    def get_context_ancestry(self, req):
 
242
        return req.publisher.get_ancestors(self.lastobj)
184
243
 
185
244
    def populate(self, req, ctx):
 
245
        ctx['req'] = req
186
246
        ctx['exception'] = self.context
187
247
 
188
248
class XHTMLUnauthorizedView(XHTMLErrorView):
189
249
    template = 'xhtmlunauthorized.html'
190
250
 
191
 
    def __init__(self, req, exception):
192
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
251
    def __init__(self, req, exception, lastobj):
 
252
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
193
253
 
194
 
        if req.user is None:
 
254
        if not req.publicmode and req.user is None:
195
255
            # Not logged in. Redirect to login page.
196
256
            if req.uri == '/':
197
257
                query_string = ''
200
260
            req.throw_redirect('/+login' + query_string)
201
261
 
202
262
        req.status = 403
 
263
 
 
264
class ViewBreadcrumb(object):
 
265
    def __init__(self, req, context):
 
266
        self.req = req
 
267
        self.context = context
 
268
 
 
269
    @property
 
270
    def text(self):
 
271
        return self.context.breadcrumb_text