← 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-14 01:13:50 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:217
Console: Python code generates a minimal document with a DIV and links to
    JavaScript.
    Added console.js. This spawns the server (calling consoleservice) and sets
    up the iframe. Console now working.
Added md5.js to media/common.

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