← 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: 2009-02-24 05:59:10 UTC
  • mto: This revision was merged to the branch mainline in revision 1119.
  • Revision ID: matt.giuca@gmail.com-20090224055910-gevty3r7urdsq4zw
File browser: Re-styled the path area, now has a yellow 3D-looking gradient
    thing.
    Added image-source/filepathbar-bg.svg, and corresponding png.
    Changed filesystem/browser/media/browser.css to the new style.
    (Note: This breaks the two bars below it; that's OK, we're about to
    restyle them too).
Removed redundant span from filesystem/browser/template.html.

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
28
import ivle.conf
 
29
from ivle.config import Config
27
30
from ivle.webapp.base.views import BaseView
28
 
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
 
31
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
29
32
from ivle.webapp.errors import NotFound, Forbidden
30
33
 
31
34
def media_url(req, plugin, path):
32
35
    '''Generates a URL to a media file.
33
 
    
 
36
 
34
37
    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.'''
 
38
    or a plugin object, in which case its name is looked up.
 
39
 
 
40
    If a version is specified in the IVLE configuration, a versioned URL will
 
41
    be generated.
 
42
    '''
36
43
    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):
 
44
        plugin = req.config.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):
42
54
    '''A view for media files.
43
55
 
44
56
    This serves static files from directories registered by plugins.
53
65
        self.path = path
54
66
 
55
67
    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)
 
68
        raise NotImplementedError()
68
69
 
69
70
    def render(self, req):
70
71
        # If it begins with ".." or separator, it's illegal. Die.
87
88
        req.content_type = type
88
89
        req.sendfile(filename)
89
90
 
90
 
class Plugin(ViewPlugin):
 
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)
 
142
 
 
143
class Plugin(ViewPlugin, PublicViewPlugin):
91
144
    urls = [
 
145
        ('+media/+:version/:ns/*path', VersionedMediaFileView),
92
146
        ('+media/:ns/*path', MediaFileView),
93
147
    ]
 
148
 
 
149
    public_urls = urls