← 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: 2009-04-29 04:58:42 UTC
  • Revision ID: grantw@unimelb.edu.au-20090429045842-upijb1ybcbz1zg6u
Kill --nosvnrevno from setup.install - we don't use Subversion now.

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