← 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: David Coles
  • Date: 2009-08-02 08:57:44 UTC
  • mto: (1294.2.119 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: coles.david@gmail.com-20090802085744-ig0mr5fcm29ngibv
Show drop down icon for breadcrumbs with a sub-menu.

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
 
from ivle.webapp.errors import BadRequest, MethodNotAllowed
 
29
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
27
30
 
28
31
class RESTView(BaseView):
29
32
    """
32
35
    """
33
36
    content_type = "application/octet-stream"
34
37
 
35
 
    def __init__(self, req, *args, **kwargs):
36
 
        pass
37
 
 
38
38
    def render(self, req):
39
 
        if req.method == 'GET':
40
 
            outstr = self.GET(req)
41
 
        # XXX PATCH hack
42
 
        if req.method == 'PUT':
43
 
            outstr = self.PATCH(req, req.read())
44
 
        req.content_type = self.content_type
45
 
        req.write(outstr)
 
39
        raise NotImplementedError()
46
40
 
47
41
class JSONRESTView(RESTView):
48
42
    """
54
48
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
55
49
                      if hasattr(self, m)] + ['POST'])
56
50
 
 
51
    def authorize(self, req):
 
52
        return True # Real authz performed in render().
 
53
 
 
54
    def authorize_method(self, req, op):
 
55
        if not hasattr(op, '_rest_api_permission'):
 
56
            raise Unauthorized()
 
57
 
 
58
        if op._rest_api_permission not in self.get_permissions(req.user):
 
59
            raise Unauthorized()
 
60
    
 
61
    def convert_bool(self, value):
 
62
        if value in ('True', 'true', True):
 
63
            return True
 
64
        elif value in ('False', 'false', False):
 
65
            return False
 
66
        else:
 
67
            raise BadRequest()
 
68
 
57
69
    def render(self, req):
58
70
        if req.method not in self._allowed_methods:
59
71
            raise MethodNotAllowed(allowed=self._allowed_methods)
60
72
 
61
73
        if req.method == 'GET':
 
74
            self.authorize_method(req, self.GET)
62
75
            outjson = self.GET(req)
63
76
        # Since PATCH isn't yet an official HTTP method, we allow users to
64
77
        # turn a PUT into a PATCH by supplying a special header.
65
78
        elif req.method == 'PATCH' or (req.method == 'PUT' and
66
79
              'X-IVLE-Patch-Semantics' in req.headers_in and
67
80
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
68
 
            outjson = self.PATCH(req, cjson.decode(req.read()))
 
81
            self.authorize_method(req, self.PATCH)
 
82
            try:
 
83
                input = cjson.decode(req.read())
 
84
            except cjson.DecodeError:
 
85
                raise BadRequest('Invalid JSON data')
 
86
            outjson = self.PATCH(req, input)
69
87
        elif req.method == 'PUT':
70
 
            outjson = self.PUT(req, cjson.decode(req.read()))
 
88
            self.authorize_method(req, self.PUT)
 
89
            try:
 
90
                input = cjson.decode(req.read())
 
91
            except cjson.DecodeError:
 
92
                raise BadRequest('Invalid JSON data')
 
93
            outjson = self.PUT(req, input)
71
94
        # POST implies named operation.
72
95
        elif req.method == 'POST':
73
96
            # TODO: Check Content-Type and implement multipart/form-data.
74
 
            opargs = dict(cgi.parse_qsl(req.read()))
 
97
            data = req.read()
 
98
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
75
99
            try:
76
100
                opname = opargs['ivle.op']
77
101
                del opargs['ivle.op']
87
111
               not op._rest_api_callable:
88
112
                raise BadRequest('Invalid named operation.')
89
113
 
 
114
            self.authorize_method(req, op)
 
115
 
90
116
            # Find any missing arguments, except for the first two (self, req)
91
117
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
92
118
            args = args[2:]
97
123
            # we are OK.
98
124
            unspec = set(args) - set(opargs.keys())
99
125
            if unspec and not defaults:
100
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
 
126
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
101
127
 
102
128
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
103
129
 
104
130
            if unspec:
105
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
 
131
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
106
132
 
107
133
            # We have extra arguments if the are no match args in the function
108
134
            # signature, AND there is no **.
111
137
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
112
138
 
113
139
            outjson = op(req, **opargs)
114
 
        else:
115
 
            raise AssertionError('Unknown method somehow got through.')
116
140
 
117
141
        req.content_type = self.content_type
 
142
        self.write_json(req, outjson)
 
143
 
 
144
    #This is a separate function to allow additional data to be passed through
 
145
    def write_json(self, req, outjson):
118
146
        if outjson is not None:
119
147
            req.write(cjson.encode(outjson))
120
148
            req.write("\n")
121
149
 
122
 
def named_operation(meth):
 
150
 
 
151
class XHTMLRESTView(JSONRESTView):
 
152
    """A special type of RESTView which takes enhances the standard JSON
 
153
    with genshi XHTML functions.
 
154
    
 
155
    XHTMLRESTViews should have a template, which is rendered using their
 
156
    context. This is returned in the JSON as 'html'"""
 
157
    template = None
 
158
    ctx = genshi.template.Context()
 
159
 
 
160
    def render_fragment(self):
 
161
        if self.template is None:
 
162
            raise NotImplementedError()
 
163
 
 
164
        rest_template = os.path.join(os.path.dirname(
 
165
                inspect.getmodule(self).__file__), self.template)
 
166
        loader = genshi.template.TemplateLoader(".", auto_reload=True)
 
167
        tmpl = loader.load(rest_template)
 
168
 
 
169
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
 
170
    
 
171
    # This renders the template and adds it to the json
 
172
    def write_json(self, req, outjson):
 
173
        outjson["html"] = self.render_fragment()
 
174
        req.write(cjson.encode(outjson))
 
175
        req.write("\n")
 
176
 
 
177
class named_operation(object):
123
178
    '''Declare a function to be accessible to HTTP users via the REST API.
124
179
    '''
125
 
    meth._rest_api_callable = True
126
 
    return meth
127
 
 
 
180
    def __init__(self, permission):
 
181
        self.permission = permission
 
182
 
 
183
    def __call__(self, func):
 
184
        func._rest_api_callable = True
 
185
        func._rest_api_permission = self.permission
 
186
        return func
 
187
 
 
188
class require_permission(object):
 
189
    '''Declare the permission required for use of a method via the REST API.
 
190
    '''
 
191
    def __init__(self, permission):
 
192
        self.permission = permission
 
193
 
 
194
    def __call__(self, func):
 
195
        func._rest_api_permission = self.permission
 
196
        return func