← 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-26 08:00:58 UTC
  • Revision ID: grantw@unimelb.edu.au-20100226080058-v7477s5xfopuii1r
Update role docs: admins can now create users, and tutors have always been able to admin groups.

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
21
22
import urlparse
22
23
import inspect
23
24
 
24
25
import cjson
 
26
import genshi.template
25
27
 
26
28
from ivle.webapp.base.views import BaseView
 
29
from ivle.webapp.base.xhtml import GenshiLoaderMixin
27
30
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
28
31
 
29
32
class RESTView(BaseView):
33
36
    """
34
37
    content_type = "application/octet-stream"
35
38
 
36
 
    def __init__(self, req, *args, **kwargs):
37
 
        for key in kwargs:
38
 
            setattr(self, key, kwargs[key])
39
 
 
40
39
    def render(self, req):
41
40
        raise NotImplementedError()
42
41
 
57
56
        if not hasattr(op, '_rest_api_permission'):
58
57
            raise Unauthorized()
59
58
 
60
 
        if op._rest_api_permission not in self.get_permissions(req.user):
 
59
        if (op._rest_api_permission not in
 
60
            self.get_permissions(req.user, req.config)):
61
61
            raise Unauthorized()
62
62
    
63
63
    def convert_bool(self, value):
141
141
            outjson = op(req, **opargs)
142
142
 
143
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):
144
148
        if outjson is not None:
145
149
            req.write(cjson.encode(outjson))
146
150
            req.write("\n")
147
151
 
 
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
 
148
178
class named_operation(object):
149
179
    '''Declare a function to be accessible to HTTP users via the REST API.
150
180
    '''
165
195
    def __call__(self, func):
166
196
        func._rest_api_permission = self.permission
167
197
        return func
168