← 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: David Coles
  • Date: 2010-02-26 10:44:48 UTC
  • Revision ID: coles.david@gmail.com-20100226104448-4d1r3qco3shgn1gk
Tags: 1.0rc2
https://launchpad.net/bugs/528211
console: Make sure HOME is set correctly (not always the same as CWD). Also use ivle.interpret.execute_raw rather than duplicating trapoline calling code in ivle.chat

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 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
    def authorize(self, req):
 
98
        return True
68
99
 
69
100
    def render(self, req):
70
101
        # If it begins with ".." or separator, it's illegal. Die.
71
 
        if self.path.startswith("..") or self.path.startswith('/'):
 
102
        if self.context.path.startswith("..") or \
 
103
           self.context.path.startswith('/'):
72
104
            raise Forbidden()
73
105
 
74
 
        filename = self._make_filename(req)
 
106
        filename = self.get_filename(req)
 
107
        if filename is None:
 
108
            raise NotFound()
75
109
 
76
110
        # Find an appropriate MIME type.
77
111
        (type, _) = mimetypes.guess_type(filename)
84
118
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
85
119
            raise Forbidden()
86
120
 
 
121
        if self.context.version is not None:
 
122
            req.headers_out['Expires'] = email.utils.formatdate(
 
123
                                timeval=time.time() + (60*60*24*365),
 
124
                                localtime=False,
 
125
                                usegmt=True)
 
126
 
 
127
 
87
128
        req.content_type = type
88
129
        req.sendfile(filename)
89
130
 
90
 
class Plugin(ViewPlugin):
91
 
    urls = [
92
 
        ('+media/:ns/*path', MediaFileView),
93
 
    ]
 
131
    def get_filename(self, req):
 
132
        return self.context.filename
 
133
 
 
134
def root_to_media(root, *segments):
 
135
    if segments[0].startswith('+'):
 
136
        if segments[0] == '+external':
 
137
            external = True
 
138
            version = None
 
139
            path = segments[1:]
 
140
        else:
 
141
            version = segments[0][1:]
 
142
            if segments[1] == '+external':
 
143
                external = True
 
144
                path = segments[2:]
 
145
            else:
 
146
                external = False
 
147
                path = segments[1:]
 
148
    else:
 
149
        external = False
 
150
        version = None
 
151
        path = segments
 
152
 
 
153
    if version is not None and version != root.config['media']['version']:
 
154
        return None
 
155
 
 
156
    ns = path[0]
 
157
    path = os.path.normpath(os.path.join(*path[1:]))
 
158
 
 
159
    return MediaFile(root, external, version, ns, path)
 
160
 
 
161
class Plugin(ViewPlugin, PublicViewPlugin):
 
162
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
 
163
    views = [(MediaFile, '+index', MediaFileView)]
 
164
    public_forward_routes = forward_routes
 
165
    public_views = views