← 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: stevenbird
  • Date: 2007-12-05 22:41:05 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:7
GPL license

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
 
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.base.plugins import PublicViewPlugin, ViewPlugin, MediaPlugin
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'])}
38
 
 
39
 
def media_url(req, plugin, path):
40
 
    '''Generates a URL to a media file.
41
 
 
42
 
    Plugin can be a string, in which case it is put into the path literally,
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
 
    '''
48
 
    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
61
 
        self.ns = ns
62
 
        self.path = path
63
 
 
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
100
 
 
101
 
    def render(self, req):
102
 
        # If it begins with ".." or separator, it's illegal. Die.
103
 
        if self.context.path.startswith("..") or \
104
 
           self.context.path.startswith('/'):
105
 
            raise Forbidden()
106
 
 
107
 
        filename = self.get_filename(req)
108
 
        if filename is None:
109
 
            raise NotFound()
110
 
 
111
 
        # Find an appropriate MIME type.
112
 
        (type, _) = mimetypes.guess_type(filename)
113
 
        if type is None:
114
 
            type = 'application/octet-stream'
115
 
 
116
 
        # Get out if it is unreadable or a directory.
117
 
        if not os.access(filename, os.F_OK):
118
 
            raise NotFound()
119
 
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
120
 
            raise Forbidden()
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
 
 
129
 
        req.content_type = type
130
 
        req.sendfile(filename)
131
 
 
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)
161
 
 
162
 
class Plugin(ViewPlugin, PublicViewPlugin):
163
 
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
164
 
    views = [(MediaFile, '+index', MediaFileView)]
165
 
    public_forward_routes = forward_routes
166
 
    public_views = views