1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Author: Matt Giuca, Will Grant
25
from ivle.webapp.base.views import BaseView
26
from ivle.webapp.errors import BadRequest, MethodNotAllowed
28
class RESTView(BaseView):
30
A view which provides a RESTful interface. The content type is
31
unspecified (see JSONRESTView for a specific content type).
33
content_type = "application/octet-stream"
35
def __init__(self, req, *args, **kwargs):
38
def render(self, req):
39
if req.method == 'GET':
40
outstr = self.GET(req)
42
if req.method == 'PUT':
43
outstr = self.PATCH(req, req.read())
44
req.content_type = self.content_type
47
class JSONRESTView(RESTView):
49
A special case of RESTView which deals entirely in JSON.
51
content_type = "application/json"
53
_allowed_methods = property(
54
lambda self: [m for m in ('GET', 'PUT', 'PATCH')
55
if hasattr(self, m)] + ['POST'])
57
def render(self, req):
58
if req.method not in self._allowed_methods:
59
raise MethodNotAllowed(allowed=self._allowed_methods)
61
if req.method == 'GET':
62
outjson = self.GET(req)
63
# Since PATCH isn't yet an official HTTP method, we allow users to
64
# turn a PUT into a PATCH by supplying a special header.
65
elif req.method == 'PATCH' or (req.method == 'PUT' and
66
'X-IVLE-Patch-Semantics' in req.headers_in and
67
req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
68
outjson = self.PATCH(req, cjson.decode(req.read()))
69
elif req.method == 'PUT':
70
outjson = self.PUT(req, cjson.decode(req.read()))
71
# POST implies named operation.
72
elif req.method == 'POST':
73
# TODO: Check Content-Type and implement multipart/form-data.
74
opargs = dict(cgi.parse_qsl(req.read()))
76
opname = opargs['ivle.op']
79
raise BadRequest('No named operation specified.')
82
op = getattr(self, opname)
83
except AttributeError:
84
raise BadRequest('Invalid named operation.')
86
if not hasattr(op, '_rest_api_callable') or \
87
not op._rest_api_callable:
88
raise BadRequest('Invalid named operation.')
90
# Find any missing arguments, except for the first two (self, req)
91
(args, vaargs, varkw, defaults) = inspect.getargspec(op)
94
# To find missing arguments, we eliminate the provided arguments
95
# from the set of remaining function signature arguments. If the
96
# remaining signature arguments are in the args[-len(defaults):],
98
unspec = set(args) - set(opargs.keys())
99
if unspec and not defaults:
100
raise BadRequest('Missing arguments: ' + ','.join(unspec))
102
unspec = [k for k in unspec if k not in args[-len(defaults):]]
105
raise BadRequest('Missing arguments: ' + ','.join(unspec))
107
# We have extra arguments if the are no match args in the function
108
# signature, AND there is no **.
109
extra = set(opargs.keys()) - set(args)
110
if extra and not varkw:
111
raise BadRequest('Extra arguments: ' + ', '.join(extra))
113
outjson = op(req, **opargs)
115
raise AssertionError('Unknown method somehow got through.')
117
req.content_type = self.content_type
118
if outjson is not None:
119
req.write(cjson.encode(outjson))
122
def named_operation(meth):
123
'''Declare a function to be accessible to HTTP users via the REST API.
125
meth._rest_api_callable = True
added
removed
ivle/webapp/base/rest.py
