← 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-20 04:52:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1826.
  • Revision ID: grantw@unimelb.edu.au-20100720045231-8ia3uk8nao8zdq1i
Replace cjson with json, or simplejson if json is not available (Python <2.6)

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
26
 
from ivle.webapp.errors import BadRequest, MethodNotAllowed
 
34
from ivle.webapp.base.xhtml import GenshiLoaderMixin
 
35
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
27
36
 
28
37
class RESTView(BaseView):
29
38
    """
32
41
    """
33
42
    content_type = "application/octet-stream"
34
43
 
35
 
    def __init__(self, req, *args, **kwargs):
36
 
        pass
37
 
 
38
44
    def render(self, req):
39
 
        if req.method == 'GET':
40
 
            outstr = self.GET(req)
41
 
        # XXX PATCH hack
42
 
        if req.method == 'PUT':
43
 
            outstr = self.PATCH(req, req.read())
44
 
        req.content_type = self.content_type
45
 
        req.write(outstr)
 
45
        raise NotImplementedError()
46
46
 
47
47
class JSONRESTView(RESTView):
48
48
    """
54
54
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
55
55
                      if hasattr(self, m)] + ['POST'])
56
56
 
 
57
    def authorize(self, req):
 
58
        return True # Real authz performed in render().
 
59
 
 
60
    def authorize_method(self, req, op):
 
61
        if not hasattr(op, '_rest_api_permission'):
 
62
            raise Unauthorized()
 
63
 
 
64
        if (op._rest_api_permission not in
 
65
            self.get_permissions(req.user, req.config)):
 
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()
 
75
 
57
76
    def render(self, req):
58
77
        if req.method not in self._allowed_methods:
59
78
            raise MethodNotAllowed(allowed=self._allowed_methods)
60
79
 
61
80
        if req.method == 'GET':
62
 
            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)
63
89
        # Since PATCH isn't yet an official HTTP method, we allow users to
64
90
        # turn a PUT into a PATCH by supplying a special header.
65
91
        elif req.method == 'PATCH' or (req.method == 'PUT' and
66
92
              'X-IVLE-Patch-Semantics' in req.headers_in and
67
93
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
68
 
            outjson = self.PATCH(req, cjson.decode(req.read()))
 
94
            self.authorize_method(req, self.PATCH)
 
95
            try:
 
96
                input = json.loads(req.read())
 
97
            except ValueError:
 
98
                raise BadRequest('Invalid JSON data')
 
99
            outjson = self.PATCH(req, input)
69
100
        elif req.method == 'PUT':
70
 
            outjson = self.PUT(req, cjson.decode(req.read()))
 
101
            self.authorize_method(req, self.PUT)
 
102
            try:
 
103
                input = json.loads(req.read())
 
104
            except ValueError:
 
105
                raise BadRequest('Invalid JSON data')
 
106
            outjson = self.PUT(req, input)
71
107
        # POST implies named operation.
72
108
        elif req.method == 'POST':
73
109
            # TODO: Check Content-Type and implement multipart/form-data.
74
 
            opargs = dict(cgi.parse_qsl(req.read()))
75
 
            try:
76
 
                opname = opargs['ivle.op']
77
 
                del opargs['ivle.op']
78
 
            except KeyError:
79
 
                raise BadRequest('No named operation specified.')
80
 
 
81
 
            try:
82
 
                op = getattr(self, opname)
83
 
            except AttributeError:
84
 
                raise BadRequest('Invalid named operation.')
85
 
 
86
 
            if not hasattr(op, '_rest_api_callable') or \
87
 
               not op._rest_api_callable:
88
 
                raise BadRequest('Invalid named operation.')
89
 
 
90
 
            # Find any missing arguments, except for the first two (self, req)
91
 
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
92
 
            args = args[2:]
93
 
 
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):],
97
 
            # we are OK.
98
 
            unspec = set(args) - set(opargs.keys())
99
 
            if unspec and not defaults:
100
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
101
 
 
102
 
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
103
 
 
104
 
            if unspec:
105
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
106
 
 
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))
112
 
 
113
 
            outjson = op(req, **opargs)
114
 
        else:
115
 
            raise AssertionError('Unknown method somehow got through.')
 
110
            data = req.read()
 
111
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
112
            outjson = self._named_operation(req, opargs)
116
113
 
117
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):
118
119
        if outjson is not None:
119
 
            req.write(cjson.encode(outjson))
 
120
            req.write(json.dumps(outjson))
120
121
            req.write("\n")
121
122
 
122
 
def named_operation(meth):
 
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):
123
196
    '''Declare a function to be accessible to HTTP users via the REST API.
124
197
    '''
125
 
    meth._rest_api_callable = True
126
 
    return meth
127
 
 
 
198
    def __init__(self, write_operation, permission):
 
199
        self.write_operation = write_operation
 
200
        self.permission = permission
 
201
 
 
202
    def __call__(self, func):
 
203
        func._rest_api_callable = True
 
204
        func._rest_api_write_operation = self.write_operation
 
205
        func._rest_api_permission = self.permission
 
206
        return func
 
207
 
 
208
write_operation = functools.partial(_named_operation, True)
 
209
read_operation = functools.partial(_named_operation, False)
 
210
 
 
211
class require_permission(object):
 
212
    '''Declare the permission required for use of a method via the REST API.
 
213
    '''
 
214
    def __init__(self, permission):
 
215
        self.permission = permission
 
216
 
 
217
    def __call__(self, func):
 
218
        func._rest_api_permission = self.permission
 
219
        return func