← 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-07-05 12:11:48 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090705121148-9z2x7kk92ox2ncqi
Replace the breadcrumb-h1 with proper breadcrumbs throughout the filesystem views.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/xhtml.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: Nick Chadwick
 
19
 
 
20
import inspect
 
21
import os.path
 
22
import urllib
 
23
 
 
24
import genshi.template
 
25
 
 
26
from ivle.webapp.media import media_url
 
27
from ivle.webapp.core import Plugin as CorePlugin
 
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
 
31
from ivle.webapp.routing import NoPath
 
32
from ivle.webapp.breadcrumbs import Breadcrumber
 
33
 
 
34
class XHTMLView(BaseView):
 
35
    """
 
36
    A view which provides a base class for views which need to return XHTML
 
37
    It is expected that apps which use this view will be written using Genshi
 
38
    templates.
 
39
    """
 
40
 
 
41
    template = 'template.html'
 
42
 
 
43
    plugin_scripts = {}
 
44
    plugin_styles = {}
 
45
    scripts_init = []
 
46
 
 
47
    extra_breadcrumbs = []
 
48
 
 
49
    allow_overlays = True
 
50
    overlay_blacklist = []
 
51
 
 
52
    def filter(self, stream, ctx):
 
53
        return stream
 
54
 
 
55
    def render(self, req):
 
56
        req.content_type = 'text/html' # TODO: Detect application/xhtml+xml
 
57
 
 
58
        # View template
 
59
        viewctx = genshi.template.Context()
 
60
        self.populate(req, viewctx)
 
61
 
 
62
        # The template is found in the directory of the module containing the
 
63
        # view.
 
64
        app_template = os.path.join(os.path.dirname(
 
65
                        inspect.getmodule(self).__file__), self.template) 
 
66
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
67
        tmpl = loader.load(app_template)
 
68
        app = self.filter(tmpl.generate(viewctx), viewctx)
 
69
 
 
70
        view_scripts = []
 
71
        for plugin in self.plugin_scripts:
 
72
            for path in self.plugin_scripts[plugin]:
 
73
                view_scripts.append(media_url(req, plugin, path))
 
74
 
 
75
        view_styles = []
 
76
        for plugin in self.plugin_styles:
 
77
            for path in self.plugin_styles[plugin]:
 
78
                view_styles.append(media_url(req, plugin, path))
 
79
 
 
80
        # Global template
 
81
        ctx = genshi.template.Context()
 
82
 
 
83
        overlay_bits = self.render_overlays(req) if req.user else [[]]*4
 
84
        ctx['overlays'] = overlay_bits[0]
 
85
 
 
86
        ctx['styles'] = [media_url(req, CorePlugin, 'ivle.css')]
 
87
        ctx['styles'] += view_styles
 
88
        ctx['styles'] += overlay_bits[1]
 
89
 
 
90
        ctx['scripts'] = [media_url(req, CorePlugin, path) for path in
 
91
                           ('util.js', 'json2.js', 'md5.js')]
 
92
        ctx['scripts'].append(media_url(req, '+external/jquery', 'jquery.js'))
 
93
        ctx['scripts'] += view_scripts
 
94
        ctx['scripts'] += overlay_bits[2]
 
95
 
 
96
        ctx['scripts_init'] = self.scripts_init + overlay_bits[3]
 
97
        ctx['app_template'] = app
 
98
        ctx['title_img'] = media_url(req, CorePlugin,
 
99
                                     "images/chrome/root-breadcrumb.png")
 
100
        try:
 
101
            ctx['ancestry'] = req.router.get_ancestors(self.context)
 
102
        except NoPath:
 
103
            ctx['ancestry'] = []
 
104
 
 
105
        # Allow the view to add its own fake breadcrumbs.
 
106
        ctx['extra_breadcrumbs'] = self.extra_breadcrumbs
 
107
 
 
108
        ctx['crumb'] = Breadcrumber(req).crumb
 
109
        self.populate_headings(req, ctx)
 
110
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
 
111
                                                        'ivle-headings.html'))
 
112
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
 
113
        
 
114
    def populate(self, req, ctx):
 
115
        raise NotImplementedError()
 
116
 
 
117
    def populate_headings(self, req, ctx):
 
118
        ctx['favicon'] = None
 
119
        ctx['root_dir'] = req.config['urls']['root']
 
120
        ctx['public_host'] = req.config['urls']['public_host']
 
121
        ctx['svn_base'] = req.config['urls']['svn_addr']
 
122
        ctx['write_javascript_settings'] = req.write_javascript_settings
 
123
        if req.user:
 
124
            ctx['login'] = req.user.login
 
125
            ctx['logged_in'] = True
 
126
            ctx['nick'] = req.user.nick
 
127
        else:
 
128
            ctx['login'] = None
 
129
            ctx['logged_in'] = False
 
130
        ctx['publicmode'] = req.publicmode
 
131
        if hasattr(self, 'help'):
 
132
            ctx['help_path'] = self.help
 
133
 
 
134
        ctx['apps_in_tabs'] = []
 
135
        for plugin in req.config.plugin_index[ViewPlugin]:
 
136
            if not hasattr(plugin, 'tabs'):
 
137
                continue
 
138
 
 
139
            for tab in plugin.tabs:
 
140
                # tab is a tuple: name, title, desc, icon, path
 
141
                new_app = {}
 
142
                new_app['this_app'] = hasattr(self, 'tab') \
 
143
                                      and tab[0] == self.tab
 
144
 
 
145
                # Icon name
 
146
                if tab[3] is not None:
 
147
                    new_app['has_icon'] = True
 
148
                    icon_url = media_url(req, plugin, tab[3])
 
149
                    new_app['icon_url'] = icon_url
 
150
                    if new_app['this_app']:
 
151
                        ctx['favicon'] = icon_url
 
152
                else:
 
153
                    new_app['has_icon'] = False
 
154
                new_app['path'] = req.make_path(tab[4])
 
155
                new_app['desc'] = tab[2]
 
156
                new_app['name'] = tab[1]
 
157
                new_app['weight'] = tab[5]
 
158
                ctx['apps_in_tabs'].append(new_app)
 
159
 
 
160
        ctx['apps_in_tabs'].sort(key=lambda tab: tab['weight'])
 
161
 
 
162
    def render_overlays(self, req):
 
163
        """Generate XML streams for the overlays.
 
164
        
 
165
        Returns a list of streams. Populates the scripts, styles, and 
 
166
        scripts_init.
 
167
        """
 
168
        overlays = []
 
169
        styles = []
 
170
        scripts = []
 
171
        scripts_init = []
 
172
        if not self.allow_overlays:
 
173
            return (overlays, styles, scripts, scripts_init)
 
174
 
 
175
        for plugin in req.config.plugin_index[OverlayPlugin]:
 
176
            for overclass in plugin.overlays:
 
177
                if overclass in self.overlay_blacklist:
 
178
                    continue
 
179
                overlay = overclass(req)
 
180
                #TODO: Re-factor this to look nicer
 
181
                for mplugin in overlay.plugin_scripts:
 
182
                    for path in overlay.plugin_scripts[mplugin]:
 
183
                        scripts.append(media_url(req, mplugin, path))
 
184
 
 
185
                for mplugin in overlay.plugin_styles:
 
186
                    for path in overlay.plugin_styles[mplugin]:
 
187
                        styles.append(media_url(req, mplugin, path))
 
188
 
 
189
                scripts_init += overlay.plugin_scripts_init
 
190
 
 
191
                overlays.append(overlay.render(req))
 
192
        return (overlays, styles, scripts, scripts_init)
 
193
 
 
194
    @classmethod
 
195
    def get_error_view(cls, e):
 
196
        view_map = {HTTPError:    XHTMLErrorView,
 
197
                    Unauthorized: XHTMLUnauthorizedView}
 
198
        for exccls in inspect.getmro(type(e)):
 
199
            if exccls in view_map:
 
200
                return view_map[exccls]
 
201
 
 
202
class XHTMLErrorView(XHTMLView):
 
203
    template = 'xhtmlerror.html'
 
204
 
 
205
    def populate(self, req, ctx):
 
206
        ctx['req'] = req
 
207
        ctx['exception'] = self.context
 
208
 
 
209
class XHTMLUnauthorizedView(XHTMLErrorView):
 
210
    template = 'xhtmlunauthorized.html'
 
211
 
 
212
    def __init__(self, req, exception):
 
213
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
214
 
 
215
        if req.user is None:
 
216
            # Not logged in. Redirect to login page.
 
217
            if req.uri == '/':
 
218
                query_string = ''
 
219
            else:
 
220
                query_string = '?url=' + urllib.quote(req.uri, safe="/~")
 
221
            req.throw_redirect('/+login' + query_string)
 
222
 
 
223
        req.status = 403