← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/media.py

  • Committer: William Grant
  • Date: 2010-02-11 05:09:56 UTC
  • Revision ID: grantw@unimelb.edu.au-20100211050956-t5i2z6b8iulxteza
Unbreak existing tests.

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
23
24
import inspect
24
25
import mimetypes
 
26
import email.utils
25
27
 
26
 
import ivle.conf
27
28
from ivle.webapp.base.views import BaseView
28
 
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
 
29
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
29
30
from ivle.webapp.errors import NotFound, Forbidden
 
31
from ivle.webapp.publisher import INF
 
32
from ivle.webapp import ApplicationRoot
 
33
 
 
34
# This maps a media namespace to an external dependency directory (in this
 
35
# case specified by the configuration option media/externals/jquery) and a
 
36
# list of permitted subpaths.
 
37
EXTERNAL_MEDIA_MAP = {'jquery': ('jquery', ['jquery.js'])}
30
38
 
31
39
def media_url(req, plugin, path):
32
40
    '''Generates a URL to a media file.
33
 
    
 
41
 
34
42
    Plugin can be a string, in which case it is put into the path literally,
35
 
    or a plugin object, in which case its name is looked up.'''
 
43
    or a plugin object, in which case its name is looked up.
 
44
 
 
45
    If a version is specified in the IVLE configuration, a versioned URL will
 
46
    be generated.
 
47
    '''
36
48
    if not isinstance(plugin, basestring):
37
 
        plugin = req.reverse_plugins[plugin]
38
 
 
39
 
    return os.path.join(ivle.conf.root_dir, '+media', plugin, path)
40
 
 
41
 
class BaseMediaFileView(BaseView):
42
 
    '''A view for media files.
43
 
 
44
 
    This serves static files from directories registered by plugins.
45
 
 
46
 
    Plugins wishing to export media should declare a 'media' attribute,
47
 
    pointing to the directory to serve (relative to the module's directory).
48
 
    The contents of that directory will then be available under
49
 
    /+media/python.path.to.module.
50
 
    '''
51
 
    def __init__(self, req, ns, path):
 
49
        plugin = req.config.reverse_plugins[plugin]
 
50
 
 
51
    media_path = os.path.join('+media', '+' + req.config['media']['version']) \
 
52
                    if req.config['media']['version'] else '+media'
 
53
 
 
54
    return req.make_path(os.path.join(media_path, plugin, path))
 
55
 
 
56
class MediaFile(object):
 
57
    def __init__(self, root, external, version, ns, path):
 
58
        self.root = root
 
59
        self.external = external
 
60
        self.version = version
52
61
        self.ns = ns
53
62
        self.path = path
54
63
 
55
 
    def _make_filename(self, req):
56
 
        raise NotImplementedError()
 
64
    @property
 
65
    def filename(self):
 
66
        if self.external:
 
67
            try:
 
68
                extern = EXTERNAL_MEDIA_MAP[self.ns]
 
69
            except KeyError:
 
70
                return None
 
71
 
 
72
            # Unless it's a whitelisted path, we don't want to hear about it.
 
73
            if self.path not in extern[1]:
 
74
                return None
 
75
 
 
76
            # Grab the admin-configured path for this particular external dep.
 
77
            externdir = self.root.config['media']['externals'][extern[0]]
 
78
 
 
79
            assert isinstance(externdir, basestring)
 
80
 
 
81
            return os.path.join(externdir, self.path)
 
82
        else:
 
83
            try:
 
84
                plugin = self.root.config.plugins[self.ns]
 
85
            except KeyError:
 
86
                return None
 
87
 
 
88
            if not issubclass(plugin, MediaPlugin):
 
89
                return None
 
90
 
 
91
            mediadir = plugin.media
 
92
            plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
 
93
 
 
94
            return os.path.join(plugindir, mediadir, self.path)
 
95
 
 
96
class MediaFileView(BaseView):
 
97
    permission = None
57
98
 
58
99
    def render(self, req):
59
100
        # If it begins with ".." or separator, it's illegal. Die.
60
 
        if self.path.startswith("..") or self.path.startswith('/'):
 
101
        if self.context.path.startswith("..") or \
 
102
           self.context.path.startswith('/'):
61
103
            raise Forbidden()
62
104
 
63
 
        filename = self._make_filename(req)
 
105
        filename = self.get_filename(req)
 
106
        if filename is None:
 
107
            raise NotFound()
64
108
 
65
109
        # Find an appropriate MIME type.
66
110
        (type, _) = mimetypes.guess_type(filename)
73
117
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
74
118
            raise Forbidden()
75
119
 
 
120
        if self.context.version is not None:
 
121
            req.headers_out['Expires'] = email.utils.formatdate(
 
122
                                timeval=time.time() + (60*60*24*365),
 
123
                                localtime=False,
 
124
                                usegmt=True)
 
125
 
 
126
 
76
127
        req.content_type = type
77
128
        req.sendfile(filename)
78
129
 
79
 
 
80
 
class MediaFileView(BaseMediaFileView):
81
 
    '''A view for media files.
82
 
 
83
 
    This serves static files from directories registered by plugins.
84
 
 
85
 
    Plugins wishing to export media should declare a 'media' attribute,
86
 
    pointing to the directory to serve (relative to the module's directory).
87
 
    The contents of that directory will then be available under
88
 
    /+media/python.path.to.module.
89
 
    '''
90
 
    permission = None
91
 
 
92
 
    def _make_filename(self, req):
93
 
        try:
94
 
            plugin = req.plugins[self.ns]
95
 
        except KeyError:
96
 
            raise NotFound()
97
 
 
98
 
        if not issubclass(plugin, MediaPlugin):
99
 
            raise NotFound()
100
 
 
101
 
        mediadir = plugin.media
102
 
        plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
103
 
 
104
 
        return os.path.join(plugindir, mediadir, self.path)
 
130
    def get_filename(self, req):
 
131
        return self.context.filename
105
132
 
106
133
    def get_permissions(self, user):
107
134
        return set()
108
135
 
109
 
class Plugin(ViewPlugin):
110
 
    urls = [
111
 
        ('+media/:ns/*path', MediaFileView),
112
 
    ]
 
136
def root_to_media(root, *segments):
 
137
    if segments[0].startswith('+'):
 
138
        if segments[0] == '+external':
 
139
            external = True
 
140
            version = None
 
141
            path = segments[1:]
 
142
        else:
 
143
            version = segments[0][1:]
 
144
            if segments[1] == '+external':
 
145
                external = True
 
146
                path = segments[2:]
 
147
            else:
 
148
                external = False
 
149
                path = segments[1:]
 
150
    else:
 
151
        external = False
 
152
        version = None
 
153
        path = segments
 
154
 
 
155
    if version is not None and version != root.config['media']['version']:
 
156
        return None
 
157
 
 
158
    ns = path[0]
 
159
    path = os.path.normpath(os.path.join(*path[1:]))
 
160
 
 
161
    return MediaFile(root, external, version, ns, path)
 
162
 
 
163
class Plugin(ViewPlugin, PublicViewPlugin):
 
164
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
 
165
    views = [(MediaFile, '+index', MediaFileView)]
 
166
    public_forward_routes = forward_routes
 
167
    public_views = views