← 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: Matt Giuca
  • Date: 2010-07-20 12:16:51 UTC
  • mto: This revision was merged to the branch mainline in revision 1818.
  • Revision ID: matt.giuca@gmail.com-20100720121651-rgeeztj6jn1tsrou
Submit page: No longer disables the radio button for closed projects.
Displays them in red rather than grey (grey implies disabled, red implies caution).
Added notice that the deadline has passed, but submission can still be done with a penalty.

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
30
28
from ivle.webapp.base.views import BaseView
31
29
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
32
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'])}
33
38
 
34
39
def media_url(req, plugin, path):
35
40
    '''Generates a URL to a media file.
43
48
    if not isinstance(plugin, basestring):
44
49
        plugin = req.config.reverse_plugins[plugin]
45
50
 
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):
 
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
64
61
        self.ns = ns
65
62
        self.path = path
66
63
 
67
 
    def _make_filename(self, req):
68
 
        raise NotImplementedError()
 
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
69
100
 
70
101
    def render(self, req):
71
102
        # If it begins with ".." or separator, it's illegal. Die.
72
 
        if self.path.startswith("..") or self.path.startswith('/'):
 
103
        if self.context.path.startswith("..") or \
 
104
           self.context.path.startswith('/'):
73
105
            raise Forbidden()
74
106
 
75
 
        filename = self._make_filename(req)
 
107
        filename = self.get_filename(req)
 
108
        if filename is None:
 
109
            raise NotFound()
76
110
 
77
111
        # Find an appropriate MIME type.
78
112
        (type, _) = mimetypes.guess_type(filename)
85
119
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
86
120
            raise Forbidden()
87
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
 
88
129
        req.content_type = type
89
130
        req.sendfile(filename)
90
131
 
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.config.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)
 
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)
142
161
 
143
162
class Plugin(ViewPlugin, PublicViewPlugin):
144
 
    urls = [
145
 
        ('+media/+:version/:ns/*path', VersionedMediaFileView),
146
 
        ('+media/:ns/*path', MediaFileView),
147
 
    ]
148
 
 
149
 
    public_urls = urls
 
163
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
 
164
    views = [(MediaFile, '+index', MediaFileView)]
 
165
    public_forward_routes = forward_routes
 
166
    public_views = views