← 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-02-23 23:47:02 UTC
  • mfrom: (1099.1.211 new-dispatch)
  • Revision ID: grantw@unimelb.edu.au-20090223234702-db4b1llly46ignwo
Merge from lp:~ivle-dev/ivle/new-dispatch.

Pretty much everything changes. Reread the setup docs. Backup your databases.
Every file is now in a different installed location, the configuration system
is rewritten, the dispatch system is rewritten, URLs are different, the
database is different, worksheets and exercises are no longer on the
filesystem, we use a templating engine, jail service protocols are rewritten,
we don't repeat ourselves, we have authorization rewritten, phpBB is gone,
and probably lots of other things that I cannot remember.

This is certainly the biggest commit I have ever made, and hopefully
the largest I ever will.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/media.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: William Grant
 
19
 
 
20
'''Media file support for the framework.'''
 
21
 
 
22
import os
 
23
import time
 
24
import inspect
 
25
import mimetypes
 
26
import email.utils
 
27
 
 
28
import ivle.conf
 
29
from ivle.config import Config
 
30
from ivle.webapp.base.views import BaseView
 
31
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
 
32
from ivle.webapp.errors import NotFound, Forbidden
 
33
 
 
34
def media_url(req, plugin, path):
 
35
    '''Generates a URL to a media file.
 
36
 
 
37
    Plugin can be a string, in which case it is put into the path literally,
 
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
    '''
 
43
    if not isinstance(plugin, basestring):
 
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):
 
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):
 
64
        self.ns = ns
 
65
        self.path = path
 
66
 
 
67
    def _make_filename(self, req):
 
68
        raise NotImplementedError()
 
69
 
 
70
    def render(self, req):
 
71
        # If it begins with ".." or separator, it's illegal. Die.
 
72
        if self.path.startswith("..") or self.path.startswith('/'):
 
73
            raise Forbidden()
 
74
 
 
75
        filename = self._make_filename(req)
 
76
 
 
77
        # Find an appropriate MIME type.
 
78
        (type, _) = mimetypes.guess_type(filename)
 
79
        if type is None:
 
80
            type = 'application/octet-stream'
 
81
 
 
82
        # Get out if it is unreadable or a directory.
 
83
        if not os.access(filename, os.F_OK):
 
84
            raise NotFound()
 
85
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
 
86
            raise Forbidden()
 
87
 
 
88
        req.content_type = type
 
89
        req.sendfile(filename)
 
90
 
 
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):
 
144
    urls = [
 
145
        ('+media/+:version/:ns/*path', VersionedMediaFileView),
 
146
        ('+media/:ns/*path', MediaFileView),
 
147
    ]
 
148
 
 
149
    public_urls = urls