← 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-23 08:55:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1674.
  • Revision ID: grantw@unimelb.edu.au-20100223085542-r8xw14bxxoraza51
Permit underscores in all names.

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
27
29
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
33
35
    """
34
36
    content_type = "application/octet-stream"
35
37
 
36
 
    def __init__(self, req, *args, **kwargs):
37
 
        for key in kwargs:
38
 
            setattr(self, key, kwargs[key])
39
 
 
40
38
    def render(self, req):
41
39
        raise NotImplementedError()
42
40
 
57
55
        if not hasattr(op, '_rest_api_permission'):
58
56
            raise Unauthorized()
59
57
 
60
 
        if op._rest_api_permission not in self.get_permissions(req.user):
 
58
        if (op._rest_api_permission not in
 
59
            self.get_permissions(req.user, req.config)):
61
60
            raise Unauthorized()
62
61
    
63
62
    def convert_bool(self, value):
141
140
            outjson = op(req, **opargs)
142
141
 
143
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):
144
147
        if outjson is not None:
145
148
            req.write(cjson.encode(outjson))
146
149
            req.write("\n")
147
150
 
 
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
 
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