73
78
raise MethodNotAllowed(allowed=self._allowed_methods)
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,
84
if 'ivle.op' in qargs:
85
outjson = self._named_operation(req, qargs, readonly=True)
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)
85
input = cjson.decode(req.read())
86
except cjson.DecodeError:
96
input = json.loads(req.read())
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)
92
input = cjson.decode(req.read())
93
except cjson.DecodeError:
103
input = json.loads(req.read())
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.
100
111
opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
102
opname = opargs['ivle.op']
103
del opargs['ivle.op']
105
raise BadRequest('No named operation specified.')
108
op = getattr(self, opname)
109
except AttributeError:
110
raise BadRequest('Invalid named operation.')
112
if not hasattr(op, '_rest_api_callable') or \
113
not op._rest_api_callable:
114
raise BadRequest('Invalid named operation.')
116
self.authorize_method(req, op)
118
# Find any missing arguments, except for the first two (self, req)
119
(args, vaargs, varkw, defaults) = inspect.getargspec(op)
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):],
126
unspec = set(args) - set(opargs.keys())
127
if unspec and not defaults:
128
raise BadRequest('Missing arguments: ' + ', '.join(unspec))
130
unspec = [k for k in unspec if k not in args[-len(defaults):]]
133
raise BadRequest('Missing arguments: ' + ', '.join(unspec))
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))
141
outjson = op(req, **opargs)
112
outjson = self._named_operation(req, opargs)
143
114
req.content_type = self.content_type
144
115
self.write_json(req, outjson)
146
117
#This is a separate function to allow additional data to be passed through
147
118
def write_json(self, req, outjson):
148
119
if outjson is not None:
149
req.write(cjson.encode(outjson))
120
req.write(json.dumps(outjson))
123
def _named_operation(self, req, opargs, readonly=False):
125
opname = opargs['ivle.op']
126
del opargs['ivle.op']
128
raise BadRequest('No named operation specified.')
131
op = getattr(self, opname)
132
except AttributeError:
133
raise BadRequest('Invalid named operation.')
135
if not hasattr(op, '_rest_api_callable') or \
136
not op._rest_api_callable:
137
raise BadRequest('Invalid named operation.')
139
if readonly and op._rest_api_write_operation:
140
raise BadRequest('POST required for write operation.')
142
self.authorize_method(req, op)
144
# Find any missing arguments, except for the first two (self, req)
145
(args, vaargs, varkw, defaults) = inspect.getargspec(op)
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):],
152
unspec = set(args) - set(opargs.keys())
153
if unspec and not defaults:
154
raise BadRequest('Missing arguments: ' + ', '.join(unspec))
156
unspec = [k for k in unspec if k not in args[-len(defaults):]]
159
raise BadRequest('Missing arguments: ' + ', '.join(unspec))
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))
167
return op(req, **opargs)
153
170
class XHTMLRESTView(GenshiLoaderMixin, JSONRESTView):
154
171
"""A special type of RESTView which takes enhances the standard JSON
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))
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.
181
def __init__(self, permission):
198
def __init__(self, write_operation, permission):
199
self.write_operation = write_operation
182
200
self.permission = permission
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
208
write_operation = functools.partial(_named_operation, True)
209
read_operation = functools.partial(_named_operation, False)
189
211
class require_permission(object):
190
212
'''Declare the permission required for use of a method via the REST API.
added
removed
ivle/webapp/base/rest.py
