← 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: 2009-07-30 08:50:35 UTC
  • mfrom: (1297 ivle)
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090730085035-np5s9ghrgymmya8b
Merge from trunk.

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 BasePlugin
29
 
from ivle.webapp.errors import NotFound
 
29
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
 
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
 
    '''Generates a URL to a media file.'''
33
 
    return os.path.join(ivle.conf.root_dir, '+media',
34
 
                        req.reverse_plugins[plugin], path)
35
 
 
36
 
class MediaFileView(BaseView):
37
 
    '''A view for media files.
38
 
 
39
 
    This serves static files from directories registered by plugins.
40
 
 
41
 
    Plugins wishing to export media should declare a 'media' attribute,
42
 
    pointing to the directory to serve (relative to the module's directory).
43
 
    The contents of that directory will then be available under
44
 
    /+media/python.path.to.module.
 
40
    '''Generates a URL to a media file.
 
41
 
 
42
    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.
45
47
    '''
46
 
    def __init__(self, req, ns, path):
 
48
    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
47
61
        self.ns = ns
48
62
        self.path = path
49
63
 
50
 
    def _make_filename(self, req):
51
 
        try:
52
 
            plugin = req.plugins[self.ns]
53
 
        except KeyError:
54
 
            raise NotFound()
55
 
 
56
 
        try:
 
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
 
57
91
            mediadir = plugin.media
58
 
        except AttributeError:
59
 
            raise NotFound()
60
 
 
61
 
        plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
62
 
 
63
 
        return os.path.join(plugindir, mediadir, self.path)
 
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
64
98
 
65
99
    def render(self, req):
66
100
        # If it begins with ".." or separator, it's illegal. Die.
67
 
        if self.path.startswith("..") or self.path.startswith('/'):
 
101
        if self.context.path.startswith("..") or \
 
102
           self.context.path.startswith('/'):
68
103
            raise Forbidden()
69
104
 
70
 
        filename = self._make_filename(req)
 
105
        filename = self.context.filename
 
106
        if filename is None:
 
107
            raise NotFound()
71
108
 
72
109
        # Find an appropriate MIME type.
73
110
        (type, _) = mimetypes.guess_type(filename)
80
117
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
81
118
            raise Forbidden()
82
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
 
83
127
        req.content_type = type
84
128
        req.sendfile(filename)
85
129
 
86
 
class Plugin(BasePlugin):
87
 
    urls = [
88
 
        ('+media/:ns/*path', MediaFileView),
89
 
    ]
 
130
    def get_permissions(self, user):
 
131
        return set()
 
132
 
 
133
def root_to_media(root, *segments):
 
134
    if segments[0].startswith('+'):
 
135
        if segments[0] == '+external':
 
136
            external = True
 
137
            version = None
 
138
            path = segments[1:]
 
139
        else:
 
140
            version = segments[0][1:]
 
141
            if segments[1] == '+external':
 
142
                external = True
 
143
                path = segments[2:]
 
144
            else:
 
145
                external = False
 
146
                path = segments[1:]
 
147
    else:
 
148
        external = False
 
149
        version = None
 
150
        path = segments
 
151
 
 
152
    if version is not None and version != root.config['media']['version']:
 
153
        return None
 
154
 
 
155
    ns = path[0]
 
156
    path = os.path.normpath(os.path.join(*path[1:]))
 
157
 
 
158
    return MediaFile(root, external, version, ns, path)
 
159
 
 
160
class Plugin(ViewPlugin, PublicViewPlugin):
 
161
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
 
162
    views = [(MediaFile, '+index', MediaFileView)]