← 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: David Coles
  • Date: 2009-12-02 19:13:26 UTC
  • mto: This revision was merged to the branch mainline in revision 1333.
  • Revision ID: coles.david@gmail.com-20091202191326-qwm5jdbeuqd10owz
Allow sending of cwd along with chat in case console needs to be reset

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
 
 
32
class XHTMLView(BaseView):
 
33
    """
 
34
    A view which provides a base class for views which need to return XHTML
 
35
    It is expected that apps which use this view will be written using Genshi
 
36
    templates.
 
37
    """
 
38
 
 
39
    template = 'template.html'
 
40
 
 
41
    plugin_scripts = {}
 
42
    plugin_styles = {}
 
43
    scripts_init = []
 
44
 
 
45
    allow_overlays = True
 
46
    overlay_blacklist = []
 
47
 
 
48
    def __init__(self, req, **kwargs):
 
49
        for key in kwargs:
 
50
            setattr(self, key, kwargs[key])
 
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/title.png")
 
100
        self.populate_headings(req, ctx)
 
101
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
 
102
                                                        'ivle-headings.html'))
 
103
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
 
104
        
 
105
    def populate(self, req, ctx):
 
106
        raise NotImplementedError()
 
107
 
 
108
    def populate_headings(self, req, ctx):
 
109
        ctx['favicon'] = None
 
110
        ctx['root_dir'] = req.config['urls']['root']
 
111
        ctx['public_host'] = req.config['urls']['public_host']
 
112
        ctx['svn_base'] = req.config['urls']['svn_addr']
 
113
        ctx['write_javascript_settings'] = req.write_javascript_settings
 
114
        if req.user:
 
115
            ctx['login'] = req.user.login
 
116
            ctx['logged_in'] = True
 
117
            ctx['nick'] = req.user.nick
 
118
        else:
 
119
            ctx['login'] = None
 
120
            ctx['logged_in'] = False
 
121
        ctx['publicmode'] = req.publicmode
 
122
        if hasattr(self, 'help'):
 
123
            ctx['help_path'] = self.help
 
124
        if hasattr(self, 'tab'):
 
125
            ctx['tab'] = self.tab
 
126
 
 
127
        ctx['apps_in_tabs'] = []
 
128
        for plugin in req.config.plugin_index[ViewPlugin]:
 
129
            if not hasattr(plugin, 'tabs'):
 
130
                continue
 
131
 
 
132
            for tab in plugin.tabs:
 
133
                # tab is a tuple: name, title, desc, icon, path
 
134
                new_app = {}
 
135
                new_app['this_app'] = hasattr(self, 'tab') \
 
136
                                      and tab[0] == self.tab
 
137
 
 
138
                # Icon name
 
139
                if tab[3] is not None:
 
140
                    new_app['has_icon'] = True
 
141
                    icon_url = media_url(req, plugin, tab[3])
 
142
                    new_app['icon_url'] = icon_url
 
143
                    if new_app['this_app']:
 
144
                        ctx['favicon'] = icon_url
 
145
                else:
 
146
                    new_app['has_icon'] = False
 
147
                new_app['path'] = req.make_path(tab[4])
 
148
                new_app['desc'] = tab[2]
 
149
                new_app['name'] = tab[1]
 
150
                new_app['weight'] = tab[5]
 
151
                ctx['apps_in_tabs'].append(new_app)
 
152
 
 
153
        ctx['apps_in_tabs'].sort(key=lambda tab: tab['weight'])
 
154
 
 
155
    def render_overlays(self, req):
 
156
        """Generate XML streams for the overlays.
 
157
        
 
158
        Returns a list of streams. Populates the scripts, styles, and 
 
159
        scripts_init.
 
160
        """
 
161
        overlays = []
 
162
        styles = []
 
163
        scripts = []
 
164
        scripts_init = []
 
165
        if not self.allow_overlays:
 
166
            return (overlays, styles, scripts, scripts_init)
 
167
 
 
168
        for plugin in req.config.plugin_index[OverlayPlugin]:
 
169
            for overclass in plugin.overlays:
 
170
                if overclass in self.overlay_blacklist:
 
171
                    continue
 
172
                overlay = overclass(req)
 
173
                #TODO: Re-factor this to look nicer
 
174
                for mplugin in overlay.plugin_scripts:
 
175
                    for path in overlay.plugin_scripts[mplugin]:
 
176
                        scripts.append(media_url(req, mplugin, path))
 
177
 
 
178
                for mplugin in overlay.plugin_styles:
 
179
                    for path in overlay.plugin_styles[mplugin]:
 
180
                        styles.append(media_url(req, mplugin, path))
 
181
 
 
182
                scripts_init += overlay.plugin_scripts_init
 
183
 
 
184
                overlays.append(overlay.render(req))
 
185
        return (overlays, styles, scripts, scripts_init)
 
186
 
 
187
    @classmethod
 
188
    def get_error_view(cls, e):
 
189
        view_map = {HTTPError:    XHTMLErrorView,
 
190
                    Unauthorized: XHTMLUnauthorizedView}
 
191
        for exccls in inspect.getmro(type(e)):
 
192
            if exccls in view_map:
 
193
                return view_map[exccls]
 
194
 
 
195
class XHTMLErrorView(XHTMLView):
 
196
    template = 'xhtmlerror.html'
 
197
 
 
198
    def __init__(self, req, exception):
 
199
        self.context = exception
 
200
 
 
201
    def populate(self, req, ctx):
 
202
        ctx['exception'] = self.context
 
203
 
 
204
class XHTMLUnauthorizedView(XHTMLErrorView):
 
205
    template = 'xhtmlunauthorized.html'
 
206
 
 
207
    def __init__(self, req, exception):
 
208
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
 
209
 
 
210
        if req.user is None:
 
211
            # Not logged in. Redirect to login page.
 
212
            if req.uri == '/':
 
213
                query_string = ''
 
214
            else:
 
215
                query_string = '?url=' + urllib.quote(req.uri, safe="/~")
 
216
            req.throw_redirect('/+login' + query_string)
 
217
 
 
218
        req.status = 403