← 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

Move ivle.webapp.groups' media to the new framework.

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