← 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: Matt Giuca
  • Date: 2009-05-12 15:21:57 UTC
  • mto: This revision was merged to the branch mainline in revision 1247.
  • Revision ID: matt.giuca@gmail.com-20090512152157-ueya8fkemrjbo9ju
ivle.util: Backported os.path.relpath from Python2.6 (required).
ivle-fetchsubmissions: Use ivle.util.relpath not os.path.relpath (not
    available pre 2.6).

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.errors import BadRequest, MethodNotAllowed, Unauthorized
27
30
 
28
31
class RESTView(BaseView):
29
32
    """
33
36
    content_type = "application/octet-stream"
34
37
 
35
38
    def __init__(self, req, *args, **kwargs):
36
 
        pass
 
39
        for key in kwargs:
 
40
            setattr(self, key, kwargs[key])
37
41
 
38
42
    def render(self, req):
39
 
        if req.method == 'GET':
40
 
            outstr = self.GET(req)
41
 
        # XXX PATCH hack
42
 
        if req.method == 'PUT':
43
 
            outstr = self.PATCH(req, req.read())
44
 
        req.content_type = self.content_type
45
 
        req.write(outstr)
 
43
        raise NotImplementedError()
46
44
 
47
45
class JSONRESTView(RESTView):
48
46
    """
54
52
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
55
53
                      if hasattr(self, m)] + ['POST'])
56
54
 
 
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
 
57
73
    def render(self, req):
58
74
        if req.method not in self._allowed_methods:
59
75
            raise MethodNotAllowed(allowed=self._allowed_methods)
60
76
 
61
77
        if req.method == 'GET':
 
78
            self.authorize_method(req, self.GET)
62
79
            outjson = self.GET(req)
63
80
        # Since PATCH isn't yet an official HTTP method, we allow users to
64
81
        # turn a PUT into a PATCH by supplying a special header.
65
82
        elif req.method == 'PATCH' or (req.method == 'PUT' and
66
83
              'X-IVLE-Patch-Semantics' in req.headers_in and
67
84
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
68
 
            outjson = self.PATCH(req, cjson.decode(req.read()))
 
85
            self.authorize_method(req, self.PATCH)
 
86
            try:
 
87
                input = cjson.decode(req.read())
 
88
            except cjson.DecodeError:
 
89
                raise BadRequest('Invalid JSON data')
 
90
            outjson = self.PATCH(req, input)
69
91
        elif req.method == 'PUT':
70
 
            outjson = self.PUT(req, cjson.decode(req.read()))
 
92
            self.authorize_method(req, self.PUT)
 
93
            try:
 
94
                input = cjson.decode(req.read())
 
95
            except cjson.DecodeError:
 
96
                raise BadRequest('Invalid JSON data')
 
97
            outjson = self.PUT(req, input)
71
98
        # POST implies named operation.
72
99
        elif req.method == 'POST':
73
100
            # TODO: Check Content-Type and implement multipart/form-data.
74
 
            opargs = dict(cgi.parse_qsl(req.read()))
 
101
            data = req.read()
 
102
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
75
103
            try:
76
104
                opname = opargs['ivle.op']
77
105
                del opargs['ivle.op']
87
115
               not op._rest_api_callable:
88
116
                raise BadRequest('Invalid named operation.')
89
117
 
 
118
            self.authorize_method(req, op)
 
119
 
90
120
            # Find any missing arguments, except for the first two (self, req)
91
121
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
92
122
            args = args[2:]
97
127
            # we are OK.
98
128
            unspec = set(args) - set(opargs.keys())
99
129
            if unspec and not defaults:
100
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
 
130
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
101
131
 
102
132
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
103
133
 
104
134
            if unspec:
105
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
 
135
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
106
136
 
107
137
            # We have extra arguments if the are no match args in the function
108
138
            # signature, AND there is no **.
111
141
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
112
142
 
113
143
            outjson = op(req, **opargs)
114
 
        else:
115
 
            raise AssertionError('Unknown method somehow got through.')
116
144
 
117
145
        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):
118
150
        if outjson is not None:
119
151
            req.write(cjson.encode(outjson))
120
152
            req.write("\n")
121
153
 
122
 
def named_operation(meth):
 
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
186
    '''Declare a function to be accessible to HTTP users via the REST API.
124
187
    '''
125
 
    meth._rest_api_callable = True
126
 
    return meth
127
 
 
 
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