← 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 the remaining images to the new framework, in the new ivle.webapp.core
plugin.

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