← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/media.py

Semesters now have separate URL name, display name and code attributes.

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 MediaFileView(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
 
        try:
57
 
            plugin = req.plugins[self.ns]
58
 
        except KeyError:
59
 
            raise NotFound()
60
 
 
61
 
        if not issubclass(plugin, MediaPlugin):
62
 
            raise NotFound()
63
 
 
64
 
        mediadir = plugin.media
65
 
        plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
66
 
 
67
 
        return os.path.join(plugindir, mediadir, self.path)
 
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 the whitelist is None (not []), we allow all.
 
74
            if extern[1] is not None and self.path not in extern[1]:
 
75
                return None
 
76
 
 
77
            # Grab the admin-configured path for this particular external dep.
 
78
            externdir = self.root.config['media']['externals'][extern[0]]
 
79
 
 
80
            assert isinstance(externdir, basestring)
 
81
 
 
82
            return os.path.join(externdir, self.path)
 
83
        else:
 
84
            try:
 
85
                plugin = self.root.config.plugins[self.ns]
 
86
            except KeyError:
 
87
                return None
 
88
 
 
89
            if not issubclass(plugin, MediaPlugin):
 
90
                return None
 
91
 
 
92
            mediadir = plugin.media
 
93
            plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
 
94
 
 
95
            return os.path.join(plugindir, mediadir, self.path)
 
96
 
 
97
class MediaFileView(BaseView):
 
98
    def authorize(self, req):
 
99
        return True
68
100
 
69
101
    def render(self, req):
70
102
        # If it begins with ".." or separator, it's illegal. Die.
71
 
        if self.path.startswith("..") or self.path.startswith('/'):
 
103
        if self.context.path.startswith("..") or \
 
104
           self.context.path.startswith('/'):
72
105
            raise Forbidden()
73
106
 
74
 
        filename = self._make_filename(req)
 
107
        filename = self.get_filename(req)
 
108
        if filename is None:
 
109
            raise NotFound()
75
110
 
76
111
        # Find an appropriate MIME type.
77
112
        (type, _) = mimetypes.guess_type(filename)
84
119
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
85
120
            raise Forbidden()
86
121
 
 
122
        if self.context.version is not None:
 
123
            req.headers_out['Expires'] = email.utils.formatdate(
 
124
                                timeval=time.time() + (60*60*24*365),
 
125
                                localtime=False,
 
126
                                usegmt=True)
 
127
 
 
128
 
87
129
        req.content_type = type
88
130
        req.sendfile(filename)
89
131
 
90
 
class Plugin(ViewPlugin):
91
 
    urls = [
92
 
        ('+media/:ns/*path', MediaFileView),
93
 
    ]
 
132
    def get_filename(self, req):
 
133
        return self.context.filename
 
134
 
 
135
def root_to_media(root, *segments):
 
136
    if segments[0].startswith('+'):
 
137
        if segments[0] == '+external':
 
138
            external = True
 
139
            version = None
 
140
            path = segments[1:]
 
141
        else:
 
142
            version = segments[0][1:]
 
143
            if segments[1] == '+external':
 
144
                external = True
 
145
                path = segments[2:]
 
146
            else:
 
147
                external = False
 
148
                path = segments[1:]
 
149
    else:
 
150
        external = False
 
151
        version = None
 
152
        path = segments
 
153
 
 
154
    if version is not None and version != root.config['media']['version']:
 
155
        return None
 
156
 
 
157
    ns = path[0]
 
158
    path = os.path.normpath(os.path.join(*path[1:]))
 
159
 
 
160
    return MediaFile(root, external, version, ns, path)
 
161
 
 
162
class Plugin(ViewPlugin, PublicViewPlugin):
 
163
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
 
164
    views = [(MediaFile, '+index', MediaFileView)]
 
165
    public_forward_routes = forward_routes
 
166
    public_views = views