← 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: 2009-03-03 07:22:17 UTC
  • Revision ID: grantw@unimelb.edu.au-20090303072217-rmlsjtjd6uzknied
Show a link to +enrolments/+new on /subjects to appropriately-privileged
people.

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
22
23
 
23
24
import genshi.template
24
25
 
 
26
from ivle.webapp.media import media_url
 
27
from ivle.webapp.core import Plugin as CorePlugin
25
28
from ivle.webapp.base.views import BaseView
 
29
from ivle.webapp.base.plugins import ViewPlugin, OverlayPlugin
 
30
from ivle.webapp.errors import HTTPError, Unauthorized
26
31
import ivle.conf
27
32
import ivle.util
28
33
 
32
37
    It is expected that apps which use this view will be written using Genshi
33
38
    templates.
34
39
    """
 
40
 
 
41
    template = 'template.html'
 
42
    plugin_scripts = {}
 
43
    plugin_styles = {}
 
44
    allow_overlays = True
 
45
    overlay_blacklist = []
 
46
 
35
47
    def __init__(self, req, **kwargs):
36
48
        for key in kwargs:
37
 
          setattr(self, key, kwargs[key])
 
49
            setattr(self, key, kwargs[key])
 
50
 
 
51
    def filter(self, stream, ctx):
 
52
        return stream
38
53
 
39
54
    def render(self, req):
40
55
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
47
62
        # view.
48
63
        app_template = os.path.join(os.path.dirname(
49
64
                        inspect.getmodule(self).__file__), self.template) 
50
 
        req.write_html_head_foot = False
51
65
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
52
66
        tmpl = loader.load(app_template)
53
 
        app = tmpl.generate(viewctx)
 
67
        app = self.filter(tmpl.generate(viewctx), viewctx)
 
68
 
 
69
        for plugin in self.plugin_scripts:
 
70
            for path in self.plugin_scripts[plugin]:
 
71
                req.scripts.append(media_url(req, plugin, path))
 
72
 
 
73
        for plugin in self.plugin_styles:
 
74
            for path in self.plugin_styles[plugin]:
 
75
                req.styles.append(media_url(req, plugin, path))
54
76
 
55
77
        # Global template
56
78
        ctx = genshi.template.Context()
57
 
        ctx['app_styles'] = req.styles
58
 
        ctx['scripts'] = req.scripts
 
79
        # XXX: Leave this here!! (Before req.styles is read)
 
80
        ctx['overlays'] = self.render_overlays(req) if req.user else []
 
81
 
 
82
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
 
83
        ctx['styles'] += req.styles
 
84
 
 
85
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
 
86
                           ('util.js', 'json2.js', 'md5.js')]
 
87
        ctx['scripts'] += req.scripts
 
88
 
59
89
        ctx['scripts_init'] = req.scripts_init
60
90
        ctx['app_template'] = app
 
91
        ctx['title_img'] = media_url(req, CorePlugin,
 
92
                                     "images/chrome/title.png")
61
93
        self.populate_headings(req, ctx)
62
94
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
63
95
                                                        'ivle-headings.html'))
64
96
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
 
97
        
 
98
    def populate(self, req, ctx):
 
99
        raise NotImplementedError()
65
100
 
66
101
    def populate_headings(self, req, ctx):
67
102
        ctx['favicon'] = None
74
109
            ctx['nick'] = req.user.nick
75
110
        else:
76
111
            ctx['login'] = None
 
112
            ctx['logged_in'] = False
77
113
        ctx['publicmode'] = req.publicmode
 
114
        if hasattr(self, 'help'):
 
115
            ctx['help_path'] = self.help
 
116
 
78
117
        ctx['apps_in_tabs'] = []
79
 
        for urlname in ivle.conf.apps.apps_in_tabs:
80
 
            new_app = {}
81
 
            app = ivle.conf.apps.app_url[urlname]
82
 
            new_app['this_app'] = hasattr(self, 'appname') \
83
 
                                  and urlname == self.appname
84
 
            if app.icon:
85
 
                new_app['has_icon'] = True
86
 
                icon_dir = ivle.conf.apps.app_icon_dir
87
 
                icon_url = ivle.util.make_path(os.path.join(icon_dir, app.icon))
88
 
                new_app['icon_url'] = icon_url
89
 
                if new_app['this_app']:
90
 
                    ctx['favicon'] = icon_url
 
118
        for plugin in req.config.plugin_index[ViewPlugin]:
 
119
            if not hasattr(plugin, 'tabs'):
 
120
                continue
 
121
 
 
122
            for tab in plugin.tabs:
 
123
                # tab is a tuple: name, title, desc, icon, path
 
124
                new_app = {}
 
125
                new_app['this_app'] = hasattr(self, 'tab') \
 
126
                                      and tab[0] == self.tab
 
127
 
 
128
                # Icon name
 
129
                if tab[3] is not None:
 
130
                    new_app['has_icon'] = True
 
131
                    icon_url = media_url(req, plugin, tab[3])
 
132
                    new_app['icon_url'] = icon_url
 
133
                    if new_app['this_app']:
 
134
                        ctx['favicon'] = icon_url
 
135
                else:
 
136
                    new_app['has_icon'] = False
 
137
                new_app['path'] = ivle.util.make_path(tab[4])
 
138
                new_app['desc'] = tab[2]
 
139
                new_app['name'] = tab[1]
 
140
                new_app['weight'] = tab[5]
 
141
                ctx['apps_in_tabs'].append(new_app)
 
142
 
 
143
        ctx['apps_in_tabs'].sort(key=lambda tab: tab['weight'])
 
144
 
 
145
    def render_overlays(self, req):
 
146
        """Generate XML streams for the overlays.
 
147
        
 
148
        Returns a list of streams. Populates the scripts, styles, and 
 
149
        scripts_init.
 
150
        """
 
151
        overlays = []
 
152
        if not self.allow_overlays:
 
153
            return overlays
 
154
 
 
155
        for plugin in req.config.plugin_index[OverlayPlugin]:
 
156
            for overclass in plugin.overlays:
 
157
                if overclass in self.overlay_blacklist:
 
158
                    continue
 
159
                overlay = overclass(req)
 
160
                #TODO: Re-factor this to look nicer
 
161
                for mplugin in overlay.plugin_scripts:
 
162
                    for path in overlay.plugin_scripts[mplugin]:
 
163
                        req.scripts.append(media_url(req, mplugin, path))
 
164
 
 
165
                for mplugin in overlay.plugin_styles:
 
166
                    for path in overlay.plugin_styles[mplugin]:
 
167
                        req.styles.append(media_url(req, mplugin, path))
 
168
 
 
169
                req.scripts_init += overlay.plugin_scripts_init
 
170
 
 
171
                overlays.append(overlay.render(req))
 
172
        return overlays
 
173
 
 
174
    @classmethod
 
175
    def get_error_view(cls, e):
 
176
        view_map = {HTTPError:    XHTMLErrorView,
 
177
                    Unauthorized: XHTMLUnauthorizedView}
 
178
        for exccls in inspect.getmro(type(e)):
 
179
            if exccls in view_map:
 
180
                return view_map[exccls]
 
181
 
 
182
class XHTMLErrorView(XHTMLView):
 
183
    template = 'xhtmlerror.html'
 
184
 
 
185
    def __init__(self, req, exception):
 
186
        self.context = exception
 
187
 
 
188
    def populate(self, req, ctx):
 
189
        ctx['exception'] = self.context
 
190
 
 
191
class XHTMLUnauthorizedView(XHTMLErrorView):
 
192
    template = 'xhtmlunauthorized.html'
 
193
 
 
194
    def __init__(self, req, exception):
 
195
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
196
 
 
197
        if req.user is None:
 
198
            # Not logged in. Redirect to login page.
 
199
            if req.uri == '/':
 
200
                query_string = ''
91
201
            else:
92
 
                new_app['has_icon'] = False
93
 
            new_app['path'] = ivle.util.make_path(urlname)
94
 
            new_app['desc'] = app.desc
95
 
            new_app['name'] = app.name
96
 
            ctx['apps_in_tabs'].append(new_app)
 
202
                query_string = '?url=' + urllib.quote(req.uri, safe="/~")
 
203
            req.throw_redirect('/+login' + query_string)
 
204
 
 
205
        req.status = 403