← 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-07-27 10:25:59 UTC
  • Revision ID: grantw@unimelb.edu.au-20100727102559-cvt3fhlaiaknd5bp
https://launchpad.net/bugs/610407
Validate uniqueness of Subject.code at the form layer, so we don't crash due to DB constraints.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/rest.py
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
17
 
18
 
# Author: Matt Giuca, Will Grant
 
18
# Author: Matt Giuca, Will Grant, Nick Chadwick
19
19
 
20
20
import cgi
 
21
import functools
21
22
import inspect
 
23
import os
 
24
import urlparse
22
25
 
23
26
import cjson
 
27
import genshi.template
24
28
 
25
29
from ivle.webapp.base.views import BaseView
 
30
from ivle.webapp.base.xhtml import GenshiLoaderMixin
26
31
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
27
32
 
28
33
class RESTView(BaseView):
32
37
    """
33
38
    content_type = "application/octet-stream"
34
39
 
35
 
    def __init__(self, req, *args, **kwargs):
36
 
        for key in kwargs:
37
 
            setattr(self, key, kwargs[key])
38
 
 
39
40
    def render(self, req):
40
41
        raise NotImplementedError()
41
42
 
56
57
        if not hasattr(op, '_rest_api_permission'):
57
58
            raise Unauthorized()
58
59
 
59
 
        if op._rest_api_permission not in self.get_permissions(req.user):
 
60
        if (op._rest_api_permission not in
 
61
            self.get_permissions(req.user, req.config)):
60
62
            raise Unauthorized()
 
63
    
 
64
    def convert_bool(self, value):
 
65
        if value in ('True', 'true', True):
 
66
            return True
 
67
        elif value in ('False', 'false', False):
 
68
            return False
 
69
        else:
 
70
            raise BadRequest()
61
71
 
62
72
    def render(self, req):
63
73
        if req.method not in self._allowed_methods:
64
74
            raise MethodNotAllowed(allowed=self._allowed_methods)
65
75
 
66
76
        if req.method == 'GET':
67
 
            self.authorize_method(req, self.GET)
68
 
            outjson = self.GET(req)
 
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)
69
85
        # Since PATCH isn't yet an official HTTP method, we allow users to
70
86
        # turn a PUT into a PATCH by supplying a special header.
71
87
        elif req.method == 'PATCH' or (req.method == 'PUT' and
87
103
        # POST implies named operation.
88
104
        elif req.method == 'POST':
89
105
            # TODO: Check Content-Type and implement multipart/form-data.
90
 
            opargs = dict(cgi.parse_qsl(req.read()))
91
 
            try:
92
 
                opname = opargs['ivle.op']
93
 
                del opargs['ivle.op']
94
 
            except KeyError:
95
 
                raise BadRequest('No named operation specified.')
96
 
 
97
 
            try:
98
 
                op = getattr(self, opname)
99
 
            except AttributeError:
100
 
                raise BadRequest('Invalid named operation.')
101
 
 
102
 
            if not hasattr(op, '_rest_api_callable') or \
103
 
               not op._rest_api_callable:
104
 
                raise BadRequest('Invalid named operation.')
105
 
 
106
 
            self.authorize_method(req, op)
107
 
 
108
 
            # Find any missing arguments, except for the first two (self, req)
109
 
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
110
 
            args = args[2:]
111
 
 
112
 
            # To find missing arguments, we eliminate the provided arguments
113
 
            # from the set of remaining function signature arguments. If the
114
 
            # remaining signature arguments are in the args[-len(defaults):],
115
 
            # we are OK.
116
 
            unspec = set(args) - set(opargs.keys())
117
 
            if unspec and not defaults:
118
 
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
119
 
 
120
 
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
121
 
 
122
 
            if unspec:
123
 
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
124
 
 
125
 
            # We have extra arguments if the are no match args in the function
126
 
            # signature, AND there is no **.
127
 
            extra = set(opargs.keys()) - set(args)
128
 
            if extra and not varkw:
129
 
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
130
 
 
131
 
            outjson = op(req, **opargs)
 
106
            data = req.read()
 
107
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
108
            outjson = self._named_operation(req, opargs)
132
109
 
133
110
        req.content_type = self.content_type
 
111
        self.write_json(req, outjson)
 
112
 
 
113
    #This is a separate function to allow additional data to be passed through
 
114
    def write_json(self, req, outjson):
134
115
        if outjson is not None:
135
116
            req.write(cjson.encode(outjson))
136
117
            req.write("\n")
137
118
 
138
 
class named_operation(object):
 
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):
 
167
    """A special type of RESTView which takes enhances the standard JSON
 
168
    with genshi XHTML functions.
 
169
    
 
170
    XHTMLRESTViews should have a template, which is rendered using their
 
171
    context. This is returned in the JSON as 'html'"""
 
172
    template = None
 
173
    ctx = genshi.template.Context()
 
174
 
 
175
    def render_fragment(self):
 
176
        if self.template is None:
 
177
            raise NotImplementedError()
 
178
 
 
179
        rest_template = os.path.join(os.path.dirname(
 
180
                inspect.getmodule(self).__file__), self.template)
 
181
        tmpl = self._loader.load(rest_template)
 
182
 
 
183
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
 
184
    
 
185
    # This renders the template and adds it to the json
 
186
    def write_json(self, req, outjson):
 
187
        outjson["html"] = self.render_fragment()
 
188
        req.write(cjson.encode(outjson))
 
189
        req.write("\n")
 
190
 
 
191
class _named_operation(object):
139
192
    '''Declare a function to be accessible to HTTP users via the REST API.
140
193
    '''
141
 
    def __init__(self, permission):
 
194
    def __init__(self, write_operation, permission):
 
195
        self.write_operation = write_operation
142
196
        self.permission = permission
143
197
 
144
198
    def __call__(self, func):
145
199
        func._rest_api_callable = True
 
200
        func._rest_api_write_operation = self.write_operation
146
201
        func._rest_api_permission = self.permission
147
202
        return func
148
203
 
 
204
write_operation = functools.partial(_named_operation, True)
 
205
read_operation = functools.partial(_named_operation, False)
 
206
 
149
207
class require_permission(object):
150
208
    '''Declare the permission required for use of a method via the REST API.
151
209
    '''
155
213
    def __call__(self, func):
156
214
        func._rest_api_permission = self.permission
157
215
        return func
158