← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/webapp/base/rest.py

  • Committer: William Grant
  • Date: 2009-05-26 02:10:08 UTC
  • Revision ID: grantw@unimelb.edu.au-20090526021008-hnka598yacu5w6da
Always set isdir = False in the file browser template filling.

Previously we used os.path.isdir outside the jail, which was terribly
unreliable and prone to crashing. We should do it properly once we can get
server-side access to the jails.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/rest.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-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: Matt Giuca, Will Grant, Nick Chadwick
 
19
 
 
20
import os
 
21
import cgi
 
22
import urlparse
 
23
import inspect
 
24
 
 
25
import cjson
 
26
import genshi.template
 
27
 
 
28
from ivle.webapp.base.views import BaseView
 
29
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
 
30
 
 
31
class RESTView(BaseView):
 
32
    """
 
33
    A view which provides a RESTful interface. The content type is
 
34
    unspecified (see JSONRESTView for a specific content type).
 
35
    """
 
36
    content_type = "application/octet-stream"
 
37
 
 
38
    def __init__(self, req, *args, **kwargs):
 
39
        for key in kwargs:
 
40
            setattr(self, key, kwargs[key])
 
41
 
 
42
    def render(self, req):
 
43
        raise NotImplementedError()
 
44
 
 
45
class JSONRESTView(RESTView):
 
46
    """
 
47
    A special case of RESTView which deals entirely in JSON.
 
48
    """
 
49
    content_type = "application/json"
 
50
 
 
51
    _allowed_methods = property(
 
52
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
 
53
                      if hasattr(self, m)] + ['POST'])
 
54
 
 
55
    def authorize(self, req):
 
56
        return True # Real authz performed in render().
 
57
 
 
58
    def authorize_method(self, req, op):
 
59
        if not hasattr(op, '_rest_api_permission'):
 
60
            raise Unauthorized()
 
61
 
 
62
        if op._rest_api_permission not in self.get_permissions(req.user):
 
63
            raise Unauthorized()
 
64
    
 
65
    def convert_bool(self, value):
 
66
        if value in ('True', 'true', True):
 
67
            return True
 
68
        elif value in ('False', 'false', False):
 
69
            return False
 
70
        else:
 
71
            raise BadRequest()
 
72
 
 
73
    def render(self, req):
 
74
        if req.method not in self._allowed_methods:
 
75
            raise MethodNotAllowed(allowed=self._allowed_methods)
 
76
 
 
77
        if req.method == 'GET':
 
78
            self.authorize_method(req, self.GET)
 
79
            outjson = self.GET(req)
 
80
        # Since PATCH isn't yet an official HTTP method, we allow users to
 
81
        # turn a PUT into a PATCH by supplying a special header.
 
82
        elif req.method == 'PATCH' or (req.method == 'PUT' and
 
83
              'X-IVLE-Patch-Semantics' in req.headers_in and
 
84
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
 
85
            self.authorize_method(req, self.PATCH)
 
86
            try:
 
87
                input = cjson.decode(req.read())
 
88
            except cjson.DecodeError:
 
89
                raise BadRequest('Invalid JSON data')
 
90
            outjson = self.PATCH(req, input)
 
91
        elif req.method == 'PUT':
 
92
            self.authorize_method(req, self.PUT)
 
93
            try:
 
94
                input = cjson.decode(req.read())
 
95
            except cjson.DecodeError:
 
96
                raise BadRequest('Invalid JSON data')
 
97
            outjson = self.PUT(req, input)
 
98
        # POST implies named operation.
 
99
        elif req.method == 'POST':
 
100
            # TODO: Check Content-Type and implement multipart/form-data.
 
101
            data = req.read()
 
102
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
103
            try:
 
104
                opname = opargs['ivle.op']
 
105
                del opargs['ivle.op']
 
106
            except KeyError:
 
107
                raise BadRequest('No named operation specified.')
 
108
 
 
109
            try:
 
110
                op = getattr(self, opname)
 
111
            except AttributeError:
 
112
                raise BadRequest('Invalid named operation.')
 
113
 
 
114
            if not hasattr(op, '_rest_api_callable') or \
 
115
               not op._rest_api_callable:
 
116
                raise BadRequest('Invalid named operation.')
 
117
 
 
118
            self.authorize_method(req, op)
 
119
 
 
120
            # Find any missing arguments, except for the first two (self, req)
 
121
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
 
122
            args = args[2:]
 
123
 
 
124
            # To find missing arguments, we eliminate the provided arguments
 
125
            # from the set of remaining function signature arguments. If the
 
126
            # remaining signature arguments are in the args[-len(defaults):],
 
127
            # we are OK.
 
128
            unspec = set(args) - set(opargs.keys())
 
129
            if unspec and not defaults:
 
130
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
131
 
 
132
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
 
133
 
 
134
            if unspec:
 
135
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
136
 
 
137
            # We have extra arguments if the are no match args in the function
 
138
            # signature, AND there is no **.
 
139
            extra = set(opargs.keys()) - set(args)
 
140
            if extra and not varkw:
 
141
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
 
142
 
 
143
            outjson = op(req, **opargs)
 
144
 
 
145
        req.content_type = self.content_type
 
146
        self.write_json(req, outjson)
 
147
 
 
148
    #This is a separate function to allow additional data to be passed through
 
149
    def write_json(self, req, outjson):
 
150
        if outjson is not None:
 
151
            req.write(cjson.encode(outjson))
 
152
            req.write("\n")
 
153
 
 
154
 
 
155
class XHTMLRESTView(JSONRESTView):
 
156
    """A special type of RESTView which takes enhances the standard JSON
 
157
    with genshi XHTML functions.
 
158
    
 
159
    XHTMLRESTViews should have a template, which is rendered using their
 
160
    context. This is returned in the JSON as 'html'"""
 
161
    template = None
 
162
    ctx = genshi.template.Context()
 
163
 
 
164
    def __init__(self, req, *args, **kwargs):
 
165
        for key in kwargs:
 
166
            setattr(self, key, kwargs[key])
 
167
    
 
168
    def render_fragment(self):
 
169
        if self.template is None:
 
170
            raise NotImplementedError()
 
171
 
 
172
        rest_template = os.path.join(os.path.dirname(
 
173
                inspect.getmodule(self).__file__), self.template)
 
174
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
175
        tmpl = loader.load(rest_template)
 
176
 
 
177
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
 
178
    
 
179
    # This renders the template and adds it to the json
 
180
    def write_json(self, req, outjson):
 
181
        outjson["html"] = self.render_fragment()
 
182
        req.write(cjson.encode(outjson))
 
183
        req.write("\n")
 
184
 
 
185
class named_operation(object):
 
186
    '''Declare a function to be accessible to HTTP users via the REST API.
 
187
    '''
 
188
    def __init__(self, permission):
 
189
        self.permission = permission
 
190
 
 
191
    def __call__(self, func):
 
192
        func._rest_api_callable = True
 
193
        func._rest_api_permission = self.permission
 
194
        return func
 
195
 
 
196
class require_permission(object):
 
197
    '''Declare the permission required for use of a method via the REST API.
 
198
    '''
 
199
    def __init__(self, permission):
 
200
        self.permission = permission
 
201
 
 
202
    def __call__(self, func):
 
203
        func._rest_api_permission = self.permission
 
204
        return func