← 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:08:27 UTC
  • Revision ID: grantw@unimelb.edu.au-20100223080827-wklsx122pcw79wi7
https://launchpad.net/bugs/525559
Reject off-site non-GET requests.

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
29
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
32
35
    """
33
36
    content_type = "application/octet-stream"
34
37
 
35
 
    def __init__(self, req, *args, **kwargs):
36
 
        for key in kwargs:
37
 
            setattr(self, key, kwargs[key])
38
 
 
39
38
    def render(self, req):
40
39
        raise NotImplementedError()
41
40
 
56
55
        if not hasattr(op, '_rest_api_permission'):
57
56
            raise Unauthorized()
58
57
 
59
 
        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)):
60
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()
61
69
 
62
70
    def render(self, req):
63
71
        if req.method not in self._allowed_methods:
87
95
        # POST implies named operation.
88
96
        elif req.method == 'POST':
89
97
            # TODO: Check Content-Type and implement multipart/form-data.
90
 
            opargs = dict(cgi.parse_qsl(req.read()))
 
98
            data = req.read()
 
99
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
91
100
            try:
92
101
                opname = opargs['ivle.op']
93
102
                del opargs['ivle.op']
131
140
            outjson = op(req, **opargs)
132
141
 
133
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):
134
147
        if outjson is not None:
135
148
            req.write(cjson.encode(outjson))
136
149
            req.write("\n")
137
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
 
138
178
class named_operation(object):
139
179
    '''Declare a function to be accessible to HTTP users via the REST API.
140
180
    '''
155
195
    def __call__(self, func):
156
196
        func._rest_api_permission = self.permission
157
197
        return func
158