← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/media.py

Update ivle.rpc.decorators to use new exceptions.

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
 
 
26
import ivle.conf
28
27
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
 
28
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
30
29
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'])}
38
30
 
39
31
def media_url(req, plugin, path):
40
32
    '''Generates a URL to a media file.
41
 
 
 
33
    
42
34
    Plugin can be a string, in which case it is put into the path literally,
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
 
    '''
 
35
    or a plugin object, in which case its name is looked up.'''
48
36
    if not isinstance(plugin, basestring):
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
 
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):
61
52
        self.ns = ns
62
53
        self.path = path
63
54
 
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
 
55
    def _make_filename(self, req):
 
56
        raise NotImplementedError()
100
57
 
101
58
    def render(self, req):
102
59
        # If it begins with ".." or separator, it's illegal. Die.
103
 
        if self.context.path.startswith("..") or \
104
 
           self.context.path.startswith('/'):
 
60
        if self.path.startswith("..") or self.path.startswith('/'):
105
61
            raise Forbidden()
106
62
 
107
 
        filename = self.get_filename(req)
108
 
        if filename is None:
109
 
            raise NotFound()
 
63
        filename = self._make_filename(req)
110
64
 
111
65
        # Find an appropriate MIME type.
112
66
        (type, _) = mimetypes.guess_type(filename)
119
73
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
120
74
            raise Forbidden()
121
75
 
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
 
 
129
76
        req.content_type = type
130
77
        req.sendfile(filename)
131
78
 
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
 
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)
 
105
 
 
106
    def get_permissions(self, user):
 
107
        return set()
 
108
 
 
109
class Plugin(ViewPlugin):
 
110
    urls = [
 
111
        ('+media/:ns/*path', MediaFileView),
 
112
    ]