1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2009 The University of Melbourne
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.
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.
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
18
# Author: William Grant
20
'''Media file support for the framework.'''
29
from ivle.config import Config
30
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
34
def media_url(req, plugin, path):
35
'''Generates a URL to a media file.
37
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.
40
If a version is specified in the IVLE configuration, a versioned URL will
43
if not isinstance(plugin, basestring):
44
plugin = req.config.reverse_plugins[plugin]
48
media_path = os.path.join('+media', '+' + config['media']['version']) if \
49
config['media']['version'] else '+media'
51
return os.path.join(ivle.conf.root_dir, media_path, plugin, path)
53
class BaseMediaFileView(BaseView):
54
'''A view for media files.
56
This serves static files from directories registered by plugins.
58
Plugins wishing to export media should declare a 'media' attribute,
59
pointing to the directory to serve (relative to the module's directory).
60
The contents of that directory will then be available under
61
/+media/python.path.to.module.
63
def __init__(self, req, ns, path):
67
def _make_filename(self, req):
68
raise NotImplementedError()
70
def render(self, req):
71
# If it begins with ".." or separator, it's illegal. Die.
72
if self.path.startswith("..") or self.path.startswith('/'):
75
filename = self._make_filename(req)
77
# Find an appropriate MIME type.
78
(type, _) = mimetypes.guess_type(filename)
80
type = 'application/octet-stream'
82
# Get out if it is unreadable or a directory.
83
if not os.access(filename, os.F_OK):
85
if not os.access(filename, os.R_OK) or os.path.isdir(filename):
88
req.content_type = type
89
req.sendfile(filename)
92
class MediaFileView(BaseMediaFileView):
93
'''A view for media files.
95
This serves static files from directories registered by plugins.
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.
104
def _make_filename(self, req):
106
plugin = req.config.plugins[self.ns]
110
if not issubclass(plugin, MediaPlugin):
113
mediadir = plugin.media
114
plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
116
return os.path.join(plugindir, mediadir, self.path)
118
def get_permissions(self, user):
121
class VersionedMediaFileView(MediaFileView):
122
'''A view for versioned media files, with aggressive caching.
124
This serves static media files with a version string, and requests that
125
browsers cache them for a long time.
128
def __init__(self, req, ns, path, version):
129
super(VersionedMediaFileView, self).__init__(req, ns, path)
130
self.version = version
132
def _make_filename(self, req):
133
if self.version != Config()['media']['version']:
136
# Don't expire for a year.
137
req.headers_out['Expires'] = email.utils.formatdate(
138
timeval=time.time() + (60*60*24*365),
141
return super(VersionedMediaFileView, self)._make_filename(req)
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'])}
149
class ExternalMediaFileView(BaseMediaFileView):
150
'''A view for media files from external dependencies.
152
This serves specific static files from external dependencies as defined in
153
the IVLE configuration.
157
def _make_filename(self, req):
159
extern = EXTERNAL_MEDIA_MAP[self.ns]
163
# Unless it's a whitelisted path, we don't want to hear about it.
164
if self.path not in extern[1]:
167
# Grab the admin-configured path for this particular external dep.
169
externdir = config['media']['externals'][extern[0]]
171
assert isinstance(externdir, basestring)
173
return os.path.join(externdir, self.path)
175
def get_permissions(self, user):
178
class ExternalVersionedMediaFileView(ExternalMediaFileView):
179
'''A view for versioned media files from external dependencies, with
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.
186
def __init__(self, req, ns, path, version):
187
super(ExternalVersionedMediaFileView, self).__init__(req, ns, path)
188
self.version = version
190
def _make_filename(self, req):
191
if self.version != Config()['media']['version']:
194
# Don't expire for a year.
195
req.headers_out['Expires'] = email.utils.formatdate(
196
timeval=time.time() + (60*60*24*365),
199
return super(ExternalVersionedMediaFileView, self)._make_filename(req)
202
class Plugin(ViewPlugin, PublicViewPlugin):
204
('+media/+:version/+external/:ns/*path', ExternalVersionedMediaFileView),
205
('+media/+external/:ns/*path', ExternalMediaFileView),
206
('+media/+:version/:ns/*path', VersionedMediaFileView),
207
('+media/:ns/*path', MediaFileView),
added
removed
ivle/webapp/media.py
