← 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-02-24 11:44:41 UTC
  • mto: This revision was merged to the branch mainline in revision 1698.
  • Revision ID: grantw@unimelb.edu.au-20100224114441-2q7005y80g1s26im
Add DB patch for mark showing, and worksheet cutoff and publishing.

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