← 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: 2010-02-12 05:22:13 UTC
  • Revision ID: matt.giuca@gmail.com-20100212052213-vq4x06ia07xk9d81
docs: Added new manual page, User roles, detailing the exact capabilities of each role.

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
31
33
 
32
34
class XHTMLView(BaseView):
33
35
    """
37
39
    """
38
40
 
39
41
    template = 'template.html'
40
 
    plugin_scripts = {}
41
 
    plugin_styles = {}
42
42
    allow_overlays = True
43
 
    overlay_blacklist = []
44
 
 
45
 
    def __init__(self, req, **kwargs):
46
 
        for key in kwargs:
47
 
            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)
48
59
 
49
60
    def filter(self, stream, ctx):
50
61
        return stream
64
75
        tmpl = loader.load(app_template)
65
76
        app = self.filter(tmpl.generate(viewctx), viewctx)
66
77
 
 
78
        view_scripts = []
67
79
        for plugin in self.plugin_scripts:
68
80
            for path in self.plugin_scripts[plugin]:
69
 
                req.scripts.append(media_url(req, plugin, path))
 
81
                view_scripts.append(media_url(req, plugin, path))
70
82
 
 
83
        view_styles = []
71
84
        for plugin in self.plugin_styles:
72
85
            for path in self.plugin_styles[plugin]:
73
 
                req.styles.append(media_url(req, plugin, path))
 
86
                view_styles.append(media_url(req, plugin, path))
74
87
 
75
88
        # Global template
76
89
        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 []
 
90
 
 
91
        overlay_bits = self.render_overlays(req) if req.user else [[]]*4
 
92
        ctx['overlays'] = overlay_bits[0]
79
93
 
80
94
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
81
 
        ctx['styles'] += req.styles
 
95
        ctx['styles'] += view_styles
 
96
        ctx['styles'] += overlay_bits[1]
82
97
 
83
98
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
84
99
                           ('util.js', 'json2.js', 'md5.js')]
85
100
        ctx['scripts'].append(media_url(req, '+external/jquery', 'jquery.js'))
86
 
        ctx['scripts'] += req.scripts
 
101
        ctx['scripts'] += view_scripts
 
102
        ctx['scripts'] += overlay_bits[2]
87
103
 
88
 
        ctx['scripts_init'] = req.scripts_init
 
104
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
89
105
        ctx['app_template'] = app
90
106
        ctx['title_img'] = media_url(req, CorePlugin,
91
 
                                     "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
 
92
134
        self.populate_headings(req, ctx)
93
135
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
94
136
                                                        'ivle-headings.html'))
120
162
                continue
121
163
 
122
164
            for tab in plugin.tabs:
123
 
                # 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)
124
167
                new_app = {}
125
168
                new_app['this_app'] = hasattr(self, 'tab') \
126
169
                                      and tab[0] == self.tab
134
177
                        ctx['favicon'] = icon_url
135
178
                else:
136
179
                    new_app['has_icon'] = False
 
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
137
186
                new_app['path'] = req.make_path(tab[4])
138
187
                new_app['desc'] = tab[2]
139
188
                new_app['name'] = tab[1]
149
198
        scripts_init.
150
199
        """
151
200
        overlays = []
 
201
        styles = []
 
202
        scripts = []
 
203
        scripts_init = []
152
204
        if not self.allow_overlays:
153
 
            return overlays
 
205
            return (overlays, styles, scripts, scripts_init)
154
206
 
155
207
        for plugin in req.config.plugin_index[OverlayPlugin]:
156
208
            for overclass in plugin.overlays:
160
212
                #TODO: Re-factor this to look nicer
161
213
                for mplugin in overlay.plugin_scripts:
162
214
                    for path in overlay.plugin_scripts[mplugin]:
163
 
                        req.scripts.append(media_url(req, mplugin, path))
 
215
                        scripts.append(media_url(req, mplugin, path))
164
216
 
165
217
                for mplugin in overlay.plugin_styles:
166
218
                    for path in overlay.plugin_styles[mplugin]:
167
 
                        req.styles.append(media_url(req, mplugin, path))
 
219
                        styles.append(media_url(req, mplugin, path))
168
220
 
169
 
                req.scripts_init += overlay.plugin_scripts_init
 
221
                scripts_init += overlay.plugin_scripts_init
170
222
 
171
223
                overlays.append(overlay.render(req))
172
 
        return overlays
 
224
        return (overlays, styles, scripts, scripts_init)
173
225
 
174
226
    @classmethod
175
227
    def get_error_view(cls, e):
182
234
class XHTMLErrorView(XHTMLView):
183
235
    template = 'xhtmlerror.html'
184
236
 
185
 
    def __init__(self, req, exception):
186
 
        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)
187
243
 
188
244
    def populate(self, req, ctx):
 
245
        ctx['req'] = req
189
246
        ctx['exception'] = self.context
190
247
 
191
248
class XHTMLUnauthorizedView(XHTMLErrorView):
192
249
    template = 'xhtmlunauthorized.html'
193
250
 
194
 
    def __init__(self, req, exception):
195
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
251
    def __init__(self, req, exception, lastobj):
 
252
        super(XHTMLUnauthorizedView, self).__init__(req, exception, lastobj)
196
253
 
197
 
        if req.user is None:
 
254
        if not req.publicmode and req.user is None:
198
255
            # Not logged in. Redirect to login page.
199
256
            if req.uri == '/':
200
257
                query_string = ''
203
260
            req.throw_redirect('/+login' + query_string)
204
261
 
205
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