← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/webapp/media.py

Added overlay system and console overlay. Note that the console overlay
is no longer special cased, allowing multiple overlays per page.

This commit breaks the original console tab.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/media.py
20
20
'''Media file support for the framework.'''
21
21
 
22
22
import os
23
 
import time
24
23
import inspect
25
24
import mimetypes
26
 
import email.utils
27
25
 
28
26
import ivle.conf
29
 
from ivle.config import Config
30
27
from ivle.webapp.base.views import BaseView
31
 
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
32
 
from ivle.webapp.errors import NotFound, Forbidden
 
28
from ivle.webapp.base.plugins import ViewPlugin
 
29
from ivle.webapp.errors import NotFound
33
30
 
34
31
def media_url(req, plugin, path):
35
32
    '''Generates a URL to a media file.
36
 
 
 
33
    
37
34
    Plugin can be a string, in which case it is put into the path literally,
38
 
    or a plugin object, in which case its name is looked up.
39
 
 
40
 
    If a version is specified in the IVLE configuration, a versioned URL will
41
 
    be generated.
42
 
    '''
 
35
    or a plugin object, in which case its name is looked up.'''
43
36
    if not isinstance(plugin, basestring):
44
 
        plugin = req.config.reverse_plugins[plugin]
45
 
 
46
 
    config = Config()
47
 
 
48
 
    media_path = os.path.join('+media', '+' + config['media']['version']) if \
49
 
                              config['media']['version'] else '+media'
50
 
 
51
 
    return os.path.join(ivle.conf.root_dir, media_path, plugin, path)
52
 
 
53
 
class BaseMediaFileView(BaseView):
 
37
        plugin = req.reverse_plugins[plugin]
 
38
        
 
39
    return os.path.join(ivle.conf.root_dir, '+media', plugin, path)
 
40
 
 
41
class MediaFileView(BaseView):
54
42
    '''A view for media files.
55
43
 
56
44
    This serves static files from directories registered by plugins.
65
53
        self.path = path
66
54
 
67
55
    def _make_filename(self, req):
68
 
        raise NotImplementedError()
 
56
        try:
 
57
            plugin = req.plugins[self.ns]
 
58
        except KeyError:
 
59
            raise NotFound()
 
60
 
 
61
        try:
 
62
            mediadir = plugin.media
 
63
        except AttributeError:
 
64
            raise NotFound()
 
65
 
 
66
        plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
 
67
 
 
68
        return os.path.join(plugindir, mediadir, self.path)
69
69
 
70
70
    def render(self, req):
71
71
        # If it begins with ".." or separator, it's illegal. Die.
88
88
        req.content_type = type
89
89
        req.sendfile(filename)
90
90
 
91
 
 
92
 
class MediaFileView(BaseMediaFileView):
93
 
    '''A view for media files.
94
 
 
95
 
    This serves static files from directories registered by plugins.
96
 
 
97
 
    Plugins wishing to export media should declare a 'media' attribute,
98
 
    pointing to the directory to serve (relative to the module's directory).
99
 
    The contents of that directory will then be available under
100
 
    /+media/python.path.to.module.
101
 
    '''
102
 
    permission = None
103
 
 
104
 
    def _make_filename(self, req):
105
 
        try:
106
 
            plugin = req.config.plugins[self.ns]
107
 
        except KeyError:
108
 
            raise NotFound()
109
 
 
110
 
        if not issubclass(plugin, MediaPlugin):
111
 
            raise NotFound()
112
 
 
113
 
        mediadir = plugin.media
114
 
        plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
115
 
 
116
 
        return os.path.join(plugindir, mediadir, self.path)
117
 
 
118
 
    def get_permissions(self, user):
119
 
        return set()
120
 
 
121
 
class VersionedMediaFileView(MediaFileView):
122
 
    '''A view for versioned media files, with aggressive caching.
123
 
 
124
 
    This serves static media files with a version string, and requests that
125
 
    browsers cache them for a long time.
126
 
    '''
127
 
 
128
 
    def __init__(self, req, ns, path, version):
129
 
        super(VersionedMediaFileView, self).__init__(req, ns, path)
130
 
        self.version = version
131
 
 
132
 
    def _make_filename(self, req):
133
 
        if self.version != Config()['media']['version']:
134
 
            raise NotFound()
135
 
 
136
 
        # Don't expire for a year.
137
 
        req.headers_out['Expires'] = email.utils.formatdate(
138
 
                                    timeval=time.time() + (60*60*24*365),
139
 
                                    localtime=False,
140
 
                                    usegmt=True)
141
 
        return super(VersionedMediaFileView, self)._make_filename(req)
142
 
 
143
 
 
144
 
# This maps a media namespace to an external dependency directory (in this
145
 
# case specified by the configuration option media/externals/jquery) and a
146
 
# list of permitted subpaths.
147
 
EXTERNAL_MEDIA_MAP = {'jquery': ('jquery', ['jquery.js'])}
148
 
 
149
 
class ExternalMediaFileView(BaseMediaFileView):
150
 
    '''A view for media files from external dependencies.
151
 
 
152
 
    This serves specific static files from external dependencies as defined in
153
 
    the IVLE configuration.
154
 
    '''
155
 
    permission = None
156
 
 
157
 
    def _make_filename(self, req):
158
 
        try:
159
 
            extern = EXTERNAL_MEDIA_MAP[self.ns]
160
 
        except KeyError:
161
 
            raise NotFound()
162
 
 
163
 
        # Unless it's a whitelisted path, we don't want to hear about it.
164
 
        if self.path not in extern[1]:
165
 
            raise NotFound()
166
 
 
167
 
        # Grab the admin-configured path for this particular external dep.
168
 
        config = Config()
169
 
        externdir = config['media']['externals'][extern[0]]
170
 
 
171
 
        assert isinstance(externdir, basestring)
172
 
 
173
 
        return os.path.join(externdir, self.path)
174
 
 
175
 
    def get_permissions(self, user):
176
 
        return set()
177
 
 
178
 
class ExternalVersionedMediaFileView(ExternalMediaFileView):
179
 
    '''A view for versioned media files from external dependencies, with
180
 
    aggressive caching.
181
 
 
182
 
    This serves specific static media files from external dependencies with a
183
 
    version string, and requests that browsers cache them for a long time.
184
 
    '''
185
 
 
186
 
    def __init__(self, req, ns, path, version):
187
 
        super(ExternalVersionedMediaFileView, self).__init__(req, ns, path)
188
 
        self.version = version
189
 
 
190
 
    def _make_filename(self, req):
191
 
        if self.version != Config()['media']['version']:
192
 
            raise NotFound()
193
 
 
194
 
        # Don't expire for a year.
195
 
        req.headers_out['Expires'] = email.utils.formatdate(
196
 
                                    timeval=time.time() + (60*60*24*365),
197
 
                                    localtime=False,
198
 
                                    usegmt=True)
199
 
        return super(ExternalVersionedMediaFileView, self)._make_filename(req)
200
 
 
201
 
 
202
 
class Plugin(ViewPlugin, PublicViewPlugin):
 
91
class Plugin(ViewPlugin):
203
92
    urls = [
204
 
        ('+media/+:version/+external/:ns/*path', ExternalVersionedMediaFileView),
205
 
        ('+media/+external/:ns/*path', ExternalMediaFileView),
206
 
        ('+media/+:version/:ns/*path', VersionedMediaFileView),
207
93
        ('+media/:ns/*path', MediaFileView),
208
94
    ]
209
 
 
210
 
    public_urls = urls