← 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-02-25 06:52:09 UTC
  • mto: This revision was merged to the branch mainline in revision 1731.
  • Revision ID: matt.giuca@gmail.com-20100225065209-9vc7j8mlwbcj181e
subject.py: ProjectUniquenessValidator now allows a project to have the same shortname as the one it is replacing (allowing you to edit a project without changing its short name, once edit is implemented).

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 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
 
99
 
 
100
    def render(self, req):
 
101
        # If it begins with ".." or separator, it's illegal. Die.
 
102
        if self.context.path.startswith("..") or \
 
103
           self.context.path.startswith('/'):
 
104
            raise Forbidden()
 
105
 
 
106
        filename = self.get_filename(req)
 
107
        if filename is None:
 
108
            raise NotFound()
 
109
 
 
110
        # Find an appropriate MIME type.
 
111
        (type, _) = mimetypes.guess_type(filename)
 
112
        if type is None:
 
113
            type = 'application/octet-stream'
 
114
 
 
115
        # Get out if it is unreadable or a directory.
 
116
        if not os.access(filename, os.F_OK):
 
117
            raise NotFound()
 
118
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
 
119
            raise Forbidden()
 
120
 
 
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
        req.content_type = type
 
129
        req.sendfile(filename)
 
130
 
 
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