← 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: 2012-06-28 01:52:02 UTC
  • Revision ID: me@williamgrant.id.au-20120628015202-f6ru7o367gt6nvgz
Hah

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