← 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: Matt Giuca
  • Date: 2010-02-25 04:15:09 UTC
  • Revision ID: matt.giuca@gmail.com-20100225041509-nqz59xjznxjwhi0e
https://launchpad.net/bugs/527543
Project set page: If the page has solo projects, does not show the groups or new group button, instead showing a short message that this is a solo set. This fixes Launchpad bug #527543.

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
 
        for key in kwargs:
37
 
            setattr(self, key, kwargs[key])
38
 
 
39
38
    def render(self, req):
40
39
        raise NotImplementedError()
41
40
 
49
48
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
50
49
                      if hasattr(self, m)] + ['POST'])
51
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
 
59
            self.get_permissions(req.user, req.config)):
 
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()
 
69
 
52
70
    def render(self, req):
53
71
        if req.method not in self._allowed_methods:
54
72
            raise MethodNotAllowed(allowed=self._allowed_methods)
55
73
 
56
74
        if req.method == 'GET':
 
75
            self.authorize_method(req, self.GET)
57
76
            outjson = self.GET(req)
58
77
        # Since PATCH isn't yet an official HTTP method, we allow users to
59
78
        # turn a PUT into a PATCH by supplying a special header.
60
79
        elif req.method == 'PATCH' or (req.method == 'PUT' and
61
80
              'X-IVLE-Patch-Semantics' in req.headers_in and
62
81
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
 
82
            self.authorize_method(req, self.PATCH)
63
83
            try:
64
84
                input = cjson.decode(req.read())
65
85
            except cjson.DecodeError:
66
86
                raise BadRequest('Invalid JSON data')
67
87
            outjson = self.PATCH(req, input)
68
88
        elif req.method == 'PUT':
 
89
            self.authorize_method(req, self.PUT)
69
90
            try:
70
91
                input = cjson.decode(req.read())
71
92
            except cjson.DecodeError:
74
95
        # POST implies named operation.
75
96
        elif req.method == 'POST':
76
97
            # TODO: Check Content-Type and implement multipart/form-data.
77
 
            opargs = dict(cgi.parse_qsl(req.read()))
 
98
            data = req.read()
 
99
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
78
100
            try:
79
101
                opname = opargs['ivle.op']
80
102
                del opargs['ivle.op']
90
112
               not op._rest_api_callable:
91
113
                raise BadRequest('Invalid named operation.')
92
114
 
 
115
            self.authorize_method(req, op)
 
116
 
93
117
            # Find any missing arguments, except for the first two (self, req)
94
118
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
95
119
            args = args[2:]
116
140
            outjson = op(req, **opargs)
117
141
 
118
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):
119
147
        if outjson is not None:
120
148
            req.write(cjson.encode(outjson))
121
149
            req.write("\n")
122
150
 
123
 
def named_operation(meth):
 
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
class named_operation(object):
124
179
    '''Declare a function to be accessible to HTTP users via the REST API.
125
180
    '''
126
 
    meth._rest_api_callable = True
127
 
    return meth
128
 
 
 
181
    def __init__(self, permission):
 
182
        self.permission = permission
 
183
 
 
184
    def __call__(self, func):
 
185
        func._rest_api_callable = True
 
186
        func._rest_api_permission = self.permission
 
187
        return func
 
188
 
 
189
class require_permission(object):
 
190
    '''Declare the permission required for use of a method via the REST API.
 
191
    '''
 
192
    def __init__(self, permission):
 
193
        self.permission = permission
 
194
 
 
195
    def __call__(self, func):
 
196
        func._rest_api_permission = self.permission
 
197
        return func