← 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-02-23 23:47:02 UTC
  • mfrom: (1099.1.211 new-dispatch)
  • Revision ID: grantw@unimelb.edu.au-20090223234702-db4b1llly46ignwo
Merge from lp:~ivle-dev/ivle/new-dispatch.

Pretty much everything changes. Reread the setup docs. Backup your databases.
Every file is now in a different installed location, the configuration system
is rewritten, the dispatch system is rewritten, URLs are different, the
database is different, worksheets and exercises are no longer on the
filesystem, we use a templating engine, jail service protocols are rewritten,
we don't repeat ourselves, we have authorization rewritten, phpBB is gone,
and probably lots of other things that I cannot remember.

This is certainly the biggest commit I have ever made, and hopefully
the largest I ever will.

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