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