← 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: 2009-06-29 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: grantw@unimelb.edu.au-20090629015555-49xxv0piiieunx8e
Add docs on configuring Apache.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/rest.py
17
17
 
18
18
# Author: Matt Giuca, Will Grant, Nick Chadwick
19
19
 
 
20
import os
20
21
import cgi
21
 
import functools
 
22
import urlparse
22
23
import inspect
23
 
import os
24
 
import urlparse
25
24
 
26
25
import cjson
27
26
import genshi.template
28
27
 
29
28
from ivle.webapp.base.views import BaseView
30
 
from ivle.webapp.base.xhtml import GenshiLoaderMixin
31
29
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
32
30
 
33
31
class RESTView(BaseView):
37
35
    """
38
36
    content_type = "application/octet-stream"
39
37
 
 
38
    def __init__(self, req, *args, **kwargs):
 
39
        for key in kwargs:
 
40
            setattr(self, key, kwargs[key])
 
41
 
40
42
    def render(self, req):
41
43
        raise NotImplementedError()
42
44
 
57
59
        if not hasattr(op, '_rest_api_permission'):
58
60
            raise Unauthorized()
59
61
 
60
 
        if (op._rest_api_permission not in
61
 
            self.get_permissions(req.user, req.config)):
 
62
        if op._rest_api_permission not in self.get_permissions(req.user):
62
63
            raise Unauthorized()
63
64
    
64
65
    def convert_bool(self, value):
74
75
            raise MethodNotAllowed(allowed=self._allowed_methods)
75
76
 
76
77
        if req.method == 'GET':
77
 
            qargs = dict(cgi.parse_qsl(
78
 
                urlparse.urlparse(req.unparsed_uri).query,
79
 
                keep_blank_values=1))
80
 
            if 'ivle.op' in qargs:
81
 
                outjson = self._named_operation(req, qargs, readonly=True)
82
 
            else:
83
 
                self.authorize_method(req, self.GET)
84
 
                outjson = self.GET(req)
 
78
            self.authorize_method(req, self.GET)
 
79
            outjson = self.GET(req)
85
80
        # Since PATCH isn't yet an official HTTP method, we allow users to
86
81
        # turn a PUT into a PATCH by supplying a special header.
87
82
        elif req.method == 'PATCH' or (req.method == 'PUT' and
105
100
            # TODO: Check Content-Type and implement multipart/form-data.
106
101
            data = req.read()
107
102
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
108
 
            outjson = self._named_operation(req, opargs)
 
103
            try:
 
104
                opname = opargs['ivle.op']
 
105
                del opargs['ivle.op']
 
106
            except KeyError:
 
107
                raise BadRequest('No named operation specified.')
 
108
 
 
109
            try:
 
110
                op = getattr(self, opname)
 
111
            except AttributeError:
 
112
                raise BadRequest('Invalid named operation.')
 
113
 
 
114
            if not hasattr(op, '_rest_api_callable') or \
 
115
               not op._rest_api_callable:
 
116
                raise BadRequest('Invalid named operation.')
 
117
 
 
118
            self.authorize_method(req, op)
 
119
 
 
120
            # Find any missing arguments, except for the first two (self, req)
 
121
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
 
122
            args = args[2:]
 
123
 
 
124
            # To find missing arguments, we eliminate the provided arguments
 
125
            # from the set of remaining function signature arguments. If the
 
126
            # remaining signature arguments are in the args[-len(defaults):],
 
127
            # we are OK.
 
128
            unspec = set(args) - set(opargs.keys())
 
129
            if unspec and not defaults:
 
130
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
131
 
 
132
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
 
133
 
 
134
            if unspec:
 
135
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
136
 
 
137
            # We have extra arguments if the are no match args in the function
 
138
            # signature, AND there is no **.
 
139
            extra = set(opargs.keys()) - set(args)
 
140
            if extra and not varkw:
 
141
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
 
142
 
 
143
            outjson = op(req, **opargs)
109
144
 
110
145
        req.content_type = self.content_type
111
146
        self.write_json(req, outjson)
116
151
            req.write(cjson.encode(outjson))
117
152
            req.write("\n")
118
153
 
119
 
    def _named_operation(self, req, opargs, readonly=False):
120
 
        try:
121
 
            opname = opargs['ivle.op']
122
 
            del opargs['ivle.op']
123
 
        except KeyError:
124
 
            raise BadRequest('No named operation specified.')
125
 
 
126
 
        try:
127
 
            op = getattr(self, opname)
128
 
        except AttributeError:
129
 
            raise BadRequest('Invalid named operation.')
130
 
 
131
 
        if not hasattr(op, '_rest_api_callable') or \
132
 
           not op._rest_api_callable:
133
 
            raise BadRequest('Invalid named operation.')
134
 
 
135
 
        if readonly and op._rest_api_write_operation:
136
 
            raise BadRequest('POST required for write operation.')
137
 
 
138
 
        self.authorize_method(req, op)
139
 
 
140
 
        # Find any missing arguments, except for the first two (self, req)
141
 
        (args, vaargs, varkw, defaults) = inspect.getargspec(op)
142
 
        args = args[2:]
143
 
 
144
 
        # To find missing arguments, we eliminate the provided arguments
145
 
        # from the set of remaining function signature arguments. If the
146
 
        # remaining signature arguments are in the args[-len(defaults):],
147
 
        # we are OK.
148
 
        unspec = set(args) - set(opargs.keys())
149
 
        if unspec and not defaults:
150
 
            raise BadRequest('Missing arguments: ' + ', '.join(unspec))
151
 
 
152
 
        unspec = [k for k in unspec if k not in args[-len(defaults):]]
153
 
 
154
 
        if unspec:
155
 
            raise BadRequest('Missing arguments: ' + ', '.join(unspec))
156
 
 
157
 
        # We have extra arguments if the are no match args in the function
158
 
        # signature, AND there is no **.
159
 
        extra = set(opargs.keys()) - set(args)
160
 
        if extra and not varkw:
161
 
            raise BadRequest('Extra arguments: ' + ', '.join(extra))
162
 
 
163
 
        return op(req, **opargs)
164
 
 
165
 
 
166
 
class XHTMLRESTView(GenshiLoaderMixin, JSONRESTView):
 
154
 
 
155
class XHTMLRESTView(JSONRESTView):
167
156
    """A special type of RESTView which takes enhances the standard JSON
168
157
    with genshi XHTML functions.
169
158
    
172
161
    template = None
173
162
    ctx = genshi.template.Context()
174
163
 
 
164
    def __init__(self, req, *args, **kwargs):
 
165
        for key in kwargs:
 
166
            setattr(self, key, kwargs[key])
 
167
    
175
168
    def render_fragment(self):
176
169
        if self.template is None:
177
170
            raise NotImplementedError()
178
171
 
179
172
        rest_template = os.path.join(os.path.dirname(
180
173
                inspect.getmodule(self).__file__), self.template)
181
 
        tmpl = self._loader.load(rest_template)
 
174
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
175
        tmpl = loader.load(rest_template)
182
176
 
183
177
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
184
178
    
188
182
        req.write(cjson.encode(outjson))
189
183
        req.write("\n")
190
184
 
191
 
class _named_operation(object):
 
185
class named_operation(object):
192
186
    '''Declare a function to be accessible to HTTP users via the REST API.
193
187
    '''
194
 
    def __init__(self, write_operation, permission):
195
 
        self.write_operation = write_operation
 
188
    def __init__(self, permission):
196
189
        self.permission = permission
197
190
 
198
191
    def __call__(self, func):
199
192
        func._rest_api_callable = True
200
 
        func._rest_api_write_operation = self.write_operation
201
193
        func._rest_api_permission = self.permission
202
194
        return func
203
195
 
204
 
write_operation = functools.partial(_named_operation, True)
205
 
read_operation = functools.partial(_named_operation, False)
206
 
 
207
196
class require_permission(object):
208
197
    '''Declare the permission required for use of a method via the REST API.
209
198
    '''