← 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-30 11:52:23 UTC
  • Revision ID: grantw@unimelb.edu.au-20100730115223-bcyxqpefhp514ra8
Tags: 1.0.2
Release 1.0.2.

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
22
 
 
23
 
import cjson
 
23
import os
 
24
import urlparse
 
25
 
 
26
try:
 
27
    import json
 
28
except ImportError:
 
29
    import simplejson as json
 
30
 
 
31
import genshi.template
24
32
 
25
33
from ivle.webapp.base.views import BaseView
 
34
from ivle.webapp.base.xhtml import GenshiLoaderMixin
26
35
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
27
36
 
28
37
class RESTView(BaseView):
32
41
    """
33
42
    content_type = "application/octet-stream"
34
43
 
35
 
    def __init__(self, req, *args, **kwargs):
36
 
        for key in kwargs:
37
 
            setattr(self, key, kwargs[key])
38
 
 
39
44
    def render(self, req):
40
45
        raise NotImplementedError()
41
46
 
56
61
        if not hasattr(op, '_rest_api_permission'):
57
62
            raise Unauthorized()
58
63
 
59
 
        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)):
60
66
            raise Unauthorized()
 
67
    
 
68
    def convert_bool(self, value):
 
69
        if value in ('True', 'true', True):
 
70
            return True
 
71
        elif value in ('False', 'false', False):
 
72
            return False
 
73
        else:
 
74
            raise BadRequest()
61
75
 
62
76
    def render(self, req):
63
77
        if req.method not in self._allowed_methods:
64
78
            raise MethodNotAllowed(allowed=self._allowed_methods)
65
79
 
66
80
        if req.method == 'GET':
67
 
            self.authorize_method(req, self.GET)
68
 
            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)
69
89
        # Since PATCH isn't yet an official HTTP method, we allow users to
70
90
        # turn a PUT into a PATCH by supplying a special header.
71
91
        elif req.method == 'PATCH' or (req.method == 'PUT' and
73
93
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
74
94
            self.authorize_method(req, self.PATCH)
75
95
            try:
76
 
                input = cjson.decode(req.read())
77
 
            except cjson.DecodeError:
 
96
                input = json.loads(req.read())
 
97
            except ValueError:
78
98
                raise BadRequest('Invalid JSON data')
79
99
            outjson = self.PATCH(req, input)
80
100
        elif req.method == 'PUT':
81
101
            self.authorize_method(req, self.PUT)
82
102
            try:
83
 
                input = cjson.decode(req.read())
84
 
            except cjson.DecodeError:
 
103
                input = json.loads(req.read())
 
104
            except ValueError:
85
105
                raise BadRequest('Invalid JSON data')
86
106
            outjson = self.PUT(req, input)
87
107
        # POST implies named operation.
88
108
        elif req.method == 'POST':
89
109
            # 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)
 
110
            data = req.read()
 
111
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
112
            outjson = self._named_operation(req, opargs)
132
113
 
133
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):
134
119
        if outjson is not None:
135
 
            req.write(cjson.encode(outjson))
 
120
            req.write(json.dumps(outjson))
136
121
            req.write("\n")
137
122
 
138
 
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):
139
196
    '''Declare a function to be accessible to HTTP users via the REST API.
140
197
    '''
141
 
    def __init__(self, permission):
 
198
    def __init__(self, write_operation, permission):
 
199
        self.write_operation = write_operation
142
200
        self.permission = permission
143
201
 
144
202
    def __call__(self, func):
145
203
        func._rest_api_callable = True
 
204
        func._rest_api_write_operation = self.write_operation
146
205
        func._rest_api_permission = self.permission
147
206
        return func
148
207
 
 
208
write_operation = functools.partial(_named_operation, True)
 
209
read_operation = functools.partial(_named_operation, False)
 
210
 
149
211
class require_permission(object):
150
212
    '''Declare the permission required for use of a method via the REST API.
151
213
    '''
155
217
    def __call__(self, func):
156
218
        func._rest_api_permission = self.permission
157
219
        return func
158