← 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

Error views are now retrieved from a class method of the view, not the plugin
registry. They also now discriminate based on exception type.

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, Nick Chadwick
 
18
# Author: Matt Giuca, Will Grant
19
19
 
20
 
import os
21
20
import cgi
22
 
import urlparse
23
21
import inspect
24
22
 
25
23
import cjson
26
 
import genshi.template
27
24
 
28
25
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
 
26
from ivle.webapp.errors import BadRequest, MethodNotAllowed
30
27
 
31
28
class RESTView(BaseView):
32
29
    """
52
49
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
53
50
                      if hasattr(self, m)] + ['POST'])
54
51
 
55
 
    def authorize(self, req):
56
 
        return True # Real authz performed in render().
57
 
 
58
 
    def authorize_method(self, req, op):
59
 
        if not hasattr(op, '_rest_api_permission'):
60
 
            raise Unauthorized()
61
 
 
62
 
        if op._rest_api_permission not in self.get_permissions(req.user):
63
 
            raise Unauthorized()
64
 
    
65
 
    def convert_bool(self, value):
66
 
        if value in ('True', 'true', True):
67
 
            return True
68
 
        elif value in ('False', 'false', False):
69
 
            return False
70
 
        else:
71
 
            raise BadRequest()
72
 
 
73
52
    def render(self, req):
74
53
        if req.method not in self._allowed_methods:
75
54
            raise MethodNotAllowed(allowed=self._allowed_methods)
76
55
 
77
56
        if req.method == 'GET':
78
 
            self.authorize_method(req, self.GET)
79
57
            outjson = self.GET(req)
80
58
        # Since PATCH isn't yet an official HTTP method, we allow users to
81
59
        # turn a PUT into a PATCH by supplying a special header.
82
60
        elif req.method == 'PATCH' or (req.method == 'PUT' and
83
61
              'X-IVLE-Patch-Semantics' in req.headers_in and
84
62
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
85
 
            self.authorize_method(req, self.PATCH)
86
63
            try:
87
64
                input = cjson.decode(req.read())
88
65
            except cjson.DecodeError:
89
66
                raise BadRequest('Invalid JSON data')
90
67
            outjson = self.PATCH(req, input)
91
68
        elif req.method == 'PUT':
92
 
            self.authorize_method(req, self.PUT)
93
69
            try:
94
70
                input = cjson.decode(req.read())
95
71
            except cjson.DecodeError:
98
74
        # POST implies named operation.
99
75
        elif req.method == 'POST':
100
76
            # TODO: Check Content-Type and implement multipart/form-data.
101
 
            data = req.read()
102
 
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
77
            opargs = dict(cgi.parse_qsl(req.read()))
103
78
            try:
104
79
                opname = opargs['ivle.op']
105
80
                del opargs['ivle.op']
115
90
               not op._rest_api_callable:
116
91
                raise BadRequest('Invalid named operation.')
117
92
 
118
 
            self.authorize_method(req, op)
119
 
 
120
93
            # Find any missing arguments, except for the first two (self, req)
121
94
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
122
95
            args = args[2:]
143
116
            outjson = op(req, **opargs)
144
117
 
145
118
        req.content_type = self.content_type
146
 
        self.write_json(req, outjson)
147
 
 
148
 
    #This is a separate function to allow additional data to be passed through
149
 
    def write_json(self, req, outjson):
150
119
        if outjson is not None:
151
120
            req.write(cjson.encode(outjson))
152
121
            req.write("\n")
153
122
 
154
 
 
155
 
class XHTMLRESTView(JSONRESTView):
156
 
    """A special type of RESTView which takes enhances the standard JSON
157
 
    with genshi XHTML functions.
158
 
    
159
 
    XHTMLRESTViews should have a template, which is rendered using their
160
 
    context. This is returned in the JSON as 'html'"""
161
 
    template = None
162
 
    ctx = genshi.template.Context()
163
 
 
164
 
    def __init__(self, req, *args, **kwargs):
165
 
        for key in kwargs:
166
 
            setattr(self, key, kwargs[key])
167
 
    
168
 
    def render_fragment(self):
169
 
        if self.template is None:
170
 
            raise NotImplementedError()
171
 
 
172
 
        rest_template = os.path.join(os.path.dirname(
173
 
                inspect.getmodule(self).__file__), self.template)
174
 
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
175
 
        tmpl = loader.load(rest_template)
176
 
 
177
 
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
178
 
    
179
 
    # This renders the template and adds it to the json
180
 
    def write_json(self, req, outjson):
181
 
        outjson["html"] = self.render_fragment()
182
 
        req.write(cjson.encode(outjson))
183
 
        req.write("\n")
184
 
 
185
 
class named_operation(object):
 
123
def named_operation(meth):
186
124
    '''Declare a function to be accessible to HTTP users via the REST API.
187
125
    '''
188
 
    def __init__(self, permission):
189
 
        self.permission = permission
190
 
 
191
 
    def __call__(self, func):
192
 
        func._rest_api_callable = True
193
 
        func._rest_api_permission = self.permission
194
 
        return func
195
 
 
196
 
class require_permission(object):
197
 
    '''Declare the permission required for use of a method via the REST API.
198
 
    '''
199
 
    def __init__(self, permission):
200
 
        self.permission = permission
201
 
 
202
 
    def __call__(self, func):
203
 
        func._rest_api_permission = self.permission
204
 
        return func
 
126
    meth._rest_api_callable = True
 
127
    return meth
 
128