← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/media.py

Remove the setup.configure import from setup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/media.py
25
25
import mimetypes
26
26
import email.utils
27
27
 
 
28
import ivle.conf
 
29
from ivle.config import Config
28
30
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
 
31
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
30
32
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
33
 
39
34
def media_url(req, plugin, path):
40
35
    '''Generates a URL to a media file.
46
41
    be generated.
47
42
    '''
48
43
    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
 
44
        plugin = req.reverse_plugins[plugin]
 
45
 
 
46
    config = Config()
 
47
 
 
48
    media_path = os.path.join('+media', '+' + config['media']['version']) if \
 
49
                              config['media']['version'] else '+media'
 
50
 
 
51
    return os.path.join(ivle.conf.root_dir, media_path, plugin, path)
 
52
 
 
53
class BaseMediaFileView(BaseView):
 
54
    '''A view for media files.
 
55
 
 
56
    This serves static files from directories registered by plugins.
 
57
 
 
58
    Plugins wishing to export media should declare a 'media' attribute,
 
59
    pointing to the directory to serve (relative to the module's directory).
 
60
    The contents of that directory will then be available under
 
61
    /+media/python.path.to.module.
 
62
    '''
 
63
    def __init__(self, req, ns, path):
61
64
        self.ns = ns
62
65
        self.path = path
63
66
 
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
 
67
    def _make_filename(self, req):
 
68
        raise NotImplementedError()
99
69
 
100
70
    def render(self, req):
101
71
        # If it begins with ".." or separator, it's illegal. Die.
102
 
        if self.context.path.startswith("..") or \
103
 
           self.context.path.startswith('/'):
 
72
        if self.path.startswith("..") or self.path.startswith('/'):
104
73
            raise Forbidden()
105
74
 
106
 
        filename = self.get_filename(req)
107
 
        if filename is None:
108
 
            raise NotFound()
 
75
        filename = self._make_filename(req)
109
76
 
110
77
        # Find an appropriate MIME type.
111
78
        (type, _) = mimetypes.guess_type(filename)
118
85
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
119
86
            raise Forbidden()
120
87
 
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
 
 
128
88
        req.content_type = type
129
89
        req.sendfile(filename)
130
90
 
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
 
91
 
 
92
class MediaFileView(BaseMediaFileView):
 
93
    '''A view for media files.
 
94
 
 
95
    This serves static files from directories registered by plugins.
 
96
 
 
97
    Plugins wishing to export media should declare a 'media' attribute,
 
98
    pointing to the directory to serve (relative to the module's directory).
 
99
    The contents of that directory will then be available under
 
100
    /+media/python.path.to.module.
 
101
    '''
 
102
    permission = None
 
103
 
 
104
    def _make_filename(self, req):
 
105
        try:
 
106
            plugin = req.plugins[self.ns]
 
107
        except KeyError:
 
108
            raise NotFound()
 
109
 
 
110
        if not issubclass(plugin, MediaPlugin):
 
111
            raise NotFound()
 
112
 
 
113
        mediadir = plugin.media
 
114
        plugindir = os.path.dirname(inspect.getmodule(plugin).__file__)
 
115
 
 
116
        return os.path.join(plugindir, mediadir, self.path)
 
117
 
 
118
    def get_permissions(self, user):
 
119
        return set()
 
120
 
 
121
class VersionedMediaFileView(MediaFileView):
 
122
    '''A view for versioned media files, with aggressive caching.
 
123
 
 
124
    This serves static media files with a version string, and requests that
 
125
    browsers cache them for a long time.
 
126
    '''
 
127
 
 
128
    def __init__(self, req, ns, path, version):
 
129
        super(VersionedMediaFileView, self).__init__(req, ns, path)
 
130
        self.version = version
 
131
 
 
132
    def _make_filename(self, req):
 
133
        if self.version != Config()['media']['version']:
 
134
            raise NotFound()
 
135
 
 
136
        # Don't expire for a year.
 
137
        req.headers_out['Expires'] = email.utils.formatdate(
 
138
                                    timeval=time.time() + (60*60*24*365),
 
139
                                    localtime=False,
 
140
                                    usegmt=True)
 
141
        return super(VersionedMediaFileView, self)._make_filename(req)
 
142
 
 
143
class Plugin(ViewPlugin):
 
144
    urls = [
 
145
        ('+media/+:version/:ns/*path', VersionedMediaFileView),
 
146
        ('+media/:ns/*path', MediaFileView),
 
147
    ]