← 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-07-04 11:36:12 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090704113612-x67yyuyjbzjv23yl
Implement default deep views.

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.urls 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
    permission = None
 
98
 
 
99
    def __init__(self, req, context):
 
100
        self.context = context
 
101
 
 
102
    def render(self, req):
 
103
        # If it begins with ".." or separator, it's illegal. Die.
 
104
        if self.context.path.startswith("..") or \
 
105
           self.context.path.startswith('/'):
 
106
            raise Forbidden()
 
107
 
 
108
        filename = self.context.filename
 
109
        if filename is None:
 
110
            raise NotFound()
 
111
 
 
112
        # Find an appropriate MIME type.
 
113
        (type, _) = mimetypes.guess_type(filename)
 
114
        if type is None:
 
115
            type = 'application/octet-stream'
 
116
 
 
117
        # Get out if it is unreadable or a directory.
 
118
        if not os.access(filename, os.F_OK):
 
119
            raise NotFound()
 
120
        if not os.access(filename, os.R_OK) or os.path.isdir(filename):
 
121
            raise Forbidden()
 
122
 
 
123
        if self.context.version is not None:
 
124
            req.headers_out['Expires'] = email.utils.formatdate(
 
125
                                timeval=time.time() + (60*60*24*365),
 
126
                                localtime=False,
 
127
                                usegmt=True)
 
128
 
 
129
 
 
130
        req.content_type = type
 
131
        req.sendfile(filename)
 
132
 
 
133
    def get_permissions(self, user):
 
134
        return set()
 
135
 
 
136
def root_to_media(root, *segments):
 
137
    if segments[0].startswith('+'):
 
138
        if segments[0] == '+external':
 
139
            external = True
 
140
            version = None
 
141
            path = segments[1:]
 
142
        else:
 
143
            version = segments[0][1:]
 
144
            if segments[1] == '+external':
 
145
                external = True
 
146
                path = segments[2:]
 
147
            else:
 
148
                external = False
 
149
                path = segments[1:]
 
150
    else:
 
151
        external = False
 
152
        version = None
 
153
        path = segments
 
154
 
 
155
    if version is not None and version != root.config['media']['version']:
 
156
        raise RoutingError()
 
157
 
 
158
    ns = path[0]
 
159
    path = os.path.normpath(os.path.join(*path[1:]))
 
160
 
 
161
    return MediaFile(root, external, version, ns, path)
 
162
 
 
163
class Plugin(ViewPlugin, PublicViewPlugin):
 
164
    forward_routes = [(ApplicationRoot, '+media', root_to_media, INF)]
 
165
    views = [(MediaFile, '+index', MediaFileView)]