← 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

Quick port of fileservice to the new framework. It's still very much old-style,
though.

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
 
import urlparse
23
21
import inspect
24
22
 
25
23
import cjson
26
 
import genshi.template
27
24
 
28
25
from ivle.webapp.base.views import BaseView
29
 
from ivle.webapp.base.xhtml import GenshiLoaderMixin
30
26
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
31
27
 
32
28
class RESTView(BaseView):
36
32
    """
37
33
    content_type = "application/octet-stream"
38
34
 
 
35
    def __init__(self, req, *args, **kwargs):
 
36
        for key in kwargs:
 
37
            setattr(self, key, kwargs[key])
 
38
 
39
39
    def render(self, req):
40
40
        raise NotImplementedError()
41
41
 
56
56
        if not hasattr(op, '_rest_api_permission'):
57
57
            raise Unauthorized()
58
58
 
59
 
        if (op._rest_api_permission not in
60
 
            self.get_permissions(req.user, req.config)):
 
59
        if op._rest_api_permission not in self.get_permissions(req.user):
61
60
            raise Unauthorized()
62
 
    
63
 
    def convert_bool(self, value):
64
 
        if value in ('True', 'true', True):
65
 
            return True
66
 
        elif value in ('False', 'false', False):
67
 
            return False
68
 
        else:
69
 
            raise BadRequest()
70
61
 
71
62
    def render(self, req):
72
63
        if req.method not in self._allowed_methods:
96
87
        # POST implies named operation.
97
88
        elif req.method == 'POST':
98
89
            # TODO: Check Content-Type and implement multipart/form-data.
99
 
            data = req.read()
100
 
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
90
            opargs = dict(cgi.parse_qsl(req.read()))
101
91
            try:
102
92
                opname = opargs['ivle.op']
103
93
                del opargs['ivle.op']
141
131
            outjson = op(req, **opargs)
142
132
 
143
133
        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):
148
134
        if outjson is not None:
149
135
            req.write(cjson.encode(outjson))
150
136
            req.write("\n")
151
137
 
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
 
 
178
138
class named_operation(object):
179
139
    '''Declare a function to be accessible to HTTP users via the REST API.
180
140
    '''
195
155
    def __call__(self, func):
196
156
        func._rest_api_permission = self.permission
197
157
        return func
 
158