← 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: mattgiuca
  • Date: 2008-01-12 15:35:53 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:201
Added "test" directory.
Added make_date_test.py, a short script I wrote to test the date format
algorithm committed in the previous revision.

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', 'jquery.js')]
84
 
        ctx['scripts'] += req.scripts
85
 
 
86
 
        ctx['scripts_init'] = req.scripts_init
87
 
        ctx['app_template'] = app
88
 
        ctx['title_img'] = media_url(req, CorePlugin,
89
 
                                     "images/chrome/title.png")
90
 
        self.populate_headings(req, ctx)
91
 
        tmpl = loader.load(os.path.join(os.path.dirname(__file__), 
92
 
                                                        'ivle-headings.html'))
93
 
        req.write(tmpl.generate(ctx).render('xhtml', doctype='xhtml'))
94
 
        
95
 
    def populate(self, req, ctx):
96
 
        raise NotImplementedError()
97
 
 
98
 
    def populate_headings(self, req, ctx):
99
 
        ctx['favicon'] = None
100
 
        ctx['root_dir'] = ivle.conf.root_dir
101
 
        ctx['public_host'] = ivle.conf.public_host
102
 
        ctx['write_javascript_settings'] = req.write_javascript_settings
103
 
        if req.user:
104
 
            ctx['login'] = req.user.login
105
 
            ctx['logged_in'] = True
106
 
            ctx['nick'] = req.user.nick
107
 
        else:
108
 
            ctx['login'] = None
109
 
            ctx['logged_in'] = False
110
 
        ctx['publicmode'] = req.publicmode
111
 
        if hasattr(self, 'help'):
112
 
            ctx['help_path'] = self.help
113
 
 
114
 
        ctx['apps_in_tabs'] = []
115
 
        for plugin in req.config.plugin_index[ViewPlugin]:
116
 
            if not hasattr(plugin, 'tabs'):
117
 
                continue
118
 
 
119
 
            for tab in plugin.tabs:
120
 
                # tab is a tuple: name, title, desc, icon, path
121
 
                new_app = {}
122
 
                new_app['this_app'] = hasattr(self, 'tab') \
123
 
                                      and tab[0] == self.tab
124
 
 
125
 
                # Icon name
126
 
                if tab[3] is not None:
127
 
                    new_app['has_icon'] = True
128
 
                    icon_url = media_url(req, plugin, tab[3])
129
 
                    new_app['icon_url'] = icon_url
130
 
                    if new_app['this_app']:
131
 
                        ctx['favicon'] = icon_url
132
 
                else:
133
 
                    new_app['has_icon'] = False
134
 
                new_app['path'] = ivle.util.make_path(tab[4])
135
 
                new_app['desc'] = tab[2]
136
 
                new_app['name'] = tab[1]
137
 
                new_app['weight'] = tab[5]
138
 
                ctx['apps_in_tabs'].append(new_app)
139
 
 
140
 
        ctx['apps_in_tabs'].sort(key=lambda tab: tab['weight'])
141
 
 
142
 
    def render_overlays(self, req):
143
 
        """Generate XML streams for the overlays.
144
 
        
145
 
        Returns a list of streams. Populates the scripts, styles, and 
146
 
        scripts_init.
147
 
        """
148
 
        overlays = []
149
 
        if not self.allow_overlays:
150
 
            return overlays
151
 
 
152
 
        for plugin in req.config.plugin_index[OverlayPlugin]:
153
 
            for overclass in plugin.overlays:
154
 
                if overclass in self.overlay_blacklist:
155
 
                    continue
156
 
                overlay = overclass(req)
157
 
                #TODO: Re-factor this to look nicer
158
 
                for mplugin in overlay.plugin_scripts:
159
 
                    for path in overlay.plugin_scripts[mplugin]:
160
 
                        req.scripts.append(media_url(req, mplugin, path))
161
 
 
162
 
                for mplugin in overlay.plugin_styles:
163
 
                    for path in overlay.plugin_styles[mplugin]:
164
 
                        req.styles.append(media_url(req, mplugin, path))
165
 
 
166
 
                req.scripts_init += overlay.plugin_scripts_init
167
 
 
168
 
                overlays.append(overlay.render(req))
169
 
        return overlays
170
 
 
171
 
    @classmethod
172
 
    def get_error_view(cls, e):
173
 
        view_map = {HTTPError:    XHTMLErrorView,
174
 
                    Unauthorized: XHTMLUnauthorizedView}
175
 
        for exccls in inspect.getmro(type(e)):
176
 
            if exccls in view_map:
177
 
                return view_map[exccls]
178
 
 
179
 
class XHTMLErrorView(XHTMLView):
180
 
    template = 'xhtmlerror.html'
181
 
 
182
 
    def __init__(self, req, exception):
183
 
        self.context = exception
184
 
 
185
 
    def populate(self, req, ctx):
186
 
        ctx['exception'] = self.context
187
 
 
188
 
class XHTMLUnauthorizedView(XHTMLErrorView):
189
 
    template = 'xhtmlunauthorized.html'
190
 
 
191
 
    def __init__(self, req, exception):
192
 
        super(XHTMLUnauthorizedView, self).__init__(req, exception)
193
 
 
194
 
        if req.user is None:
195
 
            # Not logged in. Redirect to login page.
196
 
            if req.uri == '/':
197
 
                query_string = ''
198
 
            else:
199
 
                query_string = '?url=' + urllib.quote(req.uri, safe="/~")
200
 
            req.throw_redirect('/+login' + query_string)
201
 
 
202
 
        req.status = 403