← 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-03-03 04:05:17 UTC
  • Revision ID: grantw@unimelb.edu.au-20100303040517-7grsyhj96ksqzi9e
Remove IVLEError support; only fileservice used it, and the last invocation is GONE.

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