← 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

Add tabs to the new framework. Move the app icons into the apps themselves.

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