← 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: 2010-02-12 06:29:00 UTC
  • Revision ID: grantw@unimelb.edu.au-20100212062900-jxv2knrpuhyarfiq
https://launchpad.net/bugs/520813
Allow tutors to view project submissions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/rest.py
17
17
 
18
18
# Author: Matt Giuca, Will Grant, Nick Chadwick
19
19
 
 
20
import os
20
21
import cgi
21
 
import functools
 
22
import urlparse
22
23
import inspect
23
 
import os
24
 
import urlparse
25
24
 
26
25
import cjson
27
26
import genshi.template
28
27
 
29
28
from ivle.webapp.base.views import BaseView
30
 
from ivle.webapp.base.xhtml import GenshiLoaderMixin
31
29
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
32
30
 
33
31
class RESTView(BaseView):
74
72
            raise MethodNotAllowed(allowed=self._allowed_methods)
75
73
 
76
74
        if req.method == 'GET':
77
 
            qargs = dict(cgi.parse_qsl(
78
 
                urlparse.urlparse(req.unparsed_uri).query,
79
 
                keep_blank_values=1))
80
 
            if 'ivle.op' in qargs:
81
 
                outjson = self._named_operation(req, qargs, readonly=True)
82
 
            else:
83
 
                self.authorize_method(req, self.GET)
84
 
                outjson = self.GET(req)
 
75
            self.authorize_method(req, self.GET)
 
76
            outjson = self.GET(req)
85
77
        # Since PATCH isn't yet an official HTTP method, we allow users to
86
78
        # turn a PUT into a PATCH by supplying a special header.
87
79
        elif req.method == 'PATCH' or (req.method == 'PUT' and
105
97
            # TODO: Check Content-Type and implement multipart/form-data.
106
98
            data = req.read()
107
99
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
108
 
            outjson = self._named_operation(req, opargs)
 
100
            try:
 
101
                opname = opargs['ivle.op']
 
102
                del opargs['ivle.op']
 
103
            except KeyError:
 
104
                raise BadRequest('No named operation specified.')
 
105
 
 
106
            try:
 
107
                op = getattr(self, opname)
 
108
            except AttributeError:
 
109
                raise BadRequest('Invalid named operation.')
 
110
 
 
111
            if not hasattr(op, '_rest_api_callable') or \
 
112
               not op._rest_api_callable:
 
113
                raise BadRequest('Invalid named operation.')
 
114
 
 
115
            self.authorize_method(req, op)
 
116
 
 
117
            # Find any missing arguments, except for the first two (self, req)
 
118
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
 
119
            args = args[2:]
 
120
 
 
121
            # To find missing arguments, we eliminate the provided arguments
 
122
            # from the set of remaining function signature arguments. If the
 
123
            # remaining signature arguments are in the args[-len(defaults):],
 
124
            # we are OK.
 
125
            unspec = set(args) - set(opargs.keys())
 
126
            if unspec and not defaults:
 
127
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
128
 
 
129
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
 
130
 
 
131
            if unspec:
 
132
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
133
 
 
134
            # We have extra arguments if the are no match args in the function
 
135
            # signature, AND there is no **.
 
136
            extra = set(opargs.keys()) - set(args)
 
137
            if extra and not varkw:
 
138
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
 
139
 
 
140
            outjson = op(req, **opargs)
109
141
 
110
142
        req.content_type = self.content_type
111
143
        self.write_json(req, outjson)
116
148
            req.write(cjson.encode(outjson))
117
149
            req.write("\n")
118
150
 
119
 
    def _named_operation(self, req, opargs, readonly=False):
120
 
        try:
121
 
            opname = opargs['ivle.op']
122
 
            del opargs['ivle.op']
123
 
        except KeyError:
124
 
            raise BadRequest('No named operation specified.')
125
 
 
126
 
        try:
127
 
            op = getattr(self, opname)
128
 
        except AttributeError:
129
 
            raise BadRequest('Invalid named operation.')
130
 
 
131
 
        if not hasattr(op, '_rest_api_callable') or \
132
 
           not op._rest_api_callable:
133
 
            raise BadRequest('Invalid named operation.')
134
 
 
135
 
        if readonly and op._rest_api_write_operation:
136
 
            raise BadRequest('POST required for write operation.')
137
 
 
138
 
        self.authorize_method(req, op)
139
 
 
140
 
        # Find any missing arguments, except for the first two (self, req)
141
 
        (args, vaargs, varkw, defaults) = inspect.getargspec(op)
142
 
        args = args[2:]
143
 
 
144
 
        # To find missing arguments, we eliminate the provided arguments
145
 
        # from the set of remaining function signature arguments. If the
146
 
        # remaining signature arguments are in the args[-len(defaults):],
147
 
        # we are OK.
148
 
        unspec = set(args) - set(opargs.keys())
149
 
        if unspec and not defaults:
150
 
            raise BadRequest('Missing arguments: ' + ', '.join(unspec))
151
 
 
152
 
        unspec = [k for k in unspec if k not in args[-len(defaults):]]
153
 
 
154
 
        if unspec:
155
 
            raise BadRequest('Missing arguments: ' + ', '.join(unspec))
156
 
 
157
 
        # We have extra arguments if the are no match args in the function
158
 
        # signature, AND there is no **.
159
 
        extra = set(opargs.keys()) - set(args)
160
 
        if extra and not varkw:
161
 
            raise BadRequest('Extra arguments: ' + ', '.join(extra))
162
 
 
163
 
        return op(req, **opargs)
164
 
 
165
 
 
166
 
class XHTMLRESTView(GenshiLoaderMixin, JSONRESTView):
 
151
 
 
152
class XHTMLRESTView(JSONRESTView):
167
153
    """A special type of RESTView which takes enhances the standard JSON
168
154
    with genshi XHTML functions.
169
155
    
178
164
 
179
165
        rest_template = os.path.join(os.path.dirname(
180
166
                inspect.getmodule(self).__file__), self.template)
181
 
        tmpl = self._loader.load(rest_template)
 
167
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
168
        tmpl = loader.load(rest_template)
182
169
 
183
170
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
184
171
    
188
175
        req.write(cjson.encode(outjson))
189
176
        req.write("\n")
190
177
 
191
 
class _named_operation(object):
 
178
class named_operation(object):
192
179
    '''Declare a function to be accessible to HTTP users via the REST API.
193
180
    '''
194
 
    def __init__(self, write_operation, permission):
195
 
        self.write_operation = write_operation
 
181
    def __init__(self, permission):
196
182
        self.permission = permission
197
183
 
198
184
    def __call__(self, func):
199
185
        func._rest_api_callable = True
200
 
        func._rest_api_write_operation = self.write_operation
201
186
        func._rest_api_permission = self.permission
202
187
        return func
203
188
 
204
 
write_operation = functools.partial(_named_operation, True)
205
 
read_operation = functools.partial(_named_operation, False)
206
 
 
207
189
class require_permission(object):
208
190
    '''Declare the permission required for use of a method via the REST API.
209
191
    '''