← 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

Created a new view for IVLE, allowing lecturers and tutors to 
administrate projects.

At the moment, this new view can add projectsets, and add projects.
It can also view the details of a project.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/rest.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: Matt Giuca, Will Grant
 
19
 
 
20
import cgi
 
21
import urlparse
 
22
import inspect
 
23
 
 
24
import cjson
 
25
import genshi.template
 
26
 
 
27
from ivle.webapp.base.views import BaseView
 
28
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
 
29
 
 
30
class RESTView(BaseView):
 
31
    """
 
32
    A view which provides a RESTful interface. The content type is
 
33
    unspecified (see JSONRESTView for a specific content type).
 
34
    """
 
35
    content_type = "application/octet-stream"
 
36
 
 
37
    def __init__(self, req, *args, **kwargs):
 
38
        for key in kwargs:
 
39
            setattr(self, key, kwargs[key])
 
40
 
 
41
    def render(self, req):
 
42
        raise NotImplementedError()
 
43
 
 
44
class JSONRESTView(RESTView):
 
45
    """
 
46
    A special case of RESTView which deals entirely in JSON.
 
47
    """
 
48
    content_type = "application/json"
 
49
 
 
50
    _allowed_methods = property(
 
51
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
 
52
                      if hasattr(self, m)] + ['POST'])
 
53
 
 
54
    def authorize(self, req):
 
55
        return True # Real authz performed in render().
 
56
 
 
57
    def authorize_method(self, req, op):
 
58
        if not hasattr(op, '_rest_api_permission'):
 
59
            raise Unauthorized()
 
60
 
 
61
        if op._rest_api_permission not in self.get_permissions(req.user):
 
62
            raise Unauthorized()
 
63
    
 
64
    def convert_bool(self, value):
 
65
        if value in ('True', 'true', True):
 
66
            return True
 
67
        elif value in ('False', 'false', False):
 
68
            return False
 
69
        else:
 
70
            raise BadRequest()
 
71
 
 
72
    def render(self, req):
 
73
        if req.method not in self._allowed_methods:
 
74
            raise MethodNotAllowed(allowed=self._allowed_methods)
 
75
 
 
76
        if req.method == 'GET':
 
77
            self.authorize_method(req, self.GET)
 
78
            outjson = self.GET(req)
 
79
        # Since PATCH isn't yet an official HTTP method, we allow users to
 
80
        # turn a PUT into a PATCH by supplying a special header.
 
81
        elif req.method == 'PATCH' or (req.method == 'PUT' and
 
82
              'X-IVLE-Patch-Semantics' in req.headers_in and
 
83
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
 
84
            self.authorize_method(req, self.PATCH)
 
85
            try:
 
86
                input = cjson.decode(req.read())
 
87
            except cjson.DecodeError:
 
88
                raise BadRequest('Invalid JSON data')
 
89
            outjson = self.PATCH(req, input)
 
90
        elif req.method == 'PUT':
 
91
            self.authorize_method(req, self.PUT)
 
92
            try:
 
93
                input = cjson.decode(req.read())
 
94
            except cjson.DecodeError:
 
95
                raise BadRequest('Invalid JSON data')
 
96
            outjson = self.PUT(req, input)
 
97
        # POST implies named operation.
 
98
        elif req.method == 'POST':
 
99
            # TODO: Check Content-Type and implement multipart/form-data.
 
100
            data = req.read()
 
101
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
102
            try:
 
103
                opname = opargs['ivle.op']
 
104
                del opargs['ivle.op']
 
105
            except KeyError:
 
106
                raise BadRequest('No named operation specified.')
 
107
 
 
108
            try:
 
109
                op = getattr(self, opname)
 
110
            except AttributeError:
 
111
                raise BadRequest('Invalid named operation.')
 
112
 
 
113
            if not hasattr(op, '_rest_api_callable') or \
 
114
               not op._rest_api_callable:
 
115
                raise BadRequest('Invalid named operation.')
 
116
 
 
117
            self.authorize_method(req, op)
 
118
 
 
119
            # Find any missing arguments, except for the first two (self, req)
 
120
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
 
121
            args = args[2:]
 
122
 
 
123
            # To find missing arguments, we eliminate the provided arguments
 
124
            # from the set of remaining function signature arguments. If the
 
125
            # remaining signature arguments are in the args[-len(defaults):],
 
126
            # we are OK.
 
127
            unspec = set(args) - set(opargs.keys())
 
128
            if unspec and not defaults:
 
129
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
130
 
 
131
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
 
132
 
 
133
            if unspec:
 
134
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
135
 
 
136
            # We have extra arguments if the are no match args in the function
 
137
            # signature, AND there is no **.
 
138
            extra = set(opargs.keys()) - set(args)
 
139
            if extra and not varkw:
 
140
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
 
141
 
 
142
            outjson = op(req, **opargs)
 
143
 
 
144
        req.content_type = self.content_type
 
145
        self.write_json(req, outjson)
 
146
 
 
147
    #This is a separate function to allow additional data to be passed through
 
148
    def write_json(self, req, outjson):
 
149
        if outjson is not None:
 
150
            req.write(cjson.encode(outjson))
 
151
            req.write("\n")
 
152
 
 
153
 
 
154
class XHTMLRESTView(JSONRESTView):
 
155
    """A special type of RESTView which takes enhances the standard JSON
 
156
    with genshi XHTML functions.
 
157
    
 
158
    XHTMLRESTViews should have a template, which is rendered using their
 
159
    context. This is returned in the JSON as 'html'"""
 
160
    template = None
 
161
    ctx = genshi.template.Context()
 
162
 
 
163
    def __init__(self, req, *args, **kwargs):
 
164
        for key in kwargs:
 
165
            setattr(self, key, kwargs[key])
 
166
    
 
167
    def render_fragment(self):
 
168
        if self.template is None:
 
169
            raise NotImplementedError()
 
170
 
 
171
        return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
 
172
    
 
173
    # This renders the template and adds it to the json
 
174
    def write_json(self, req, outjson):
 
175
        outjson["html"] = self.render_fragment()
 
176
        req.write(cjson.encode(outjson))
 
177
        req.write("\n")
 
178
 
 
179
class named_operation(object):
 
180
    '''Declare a function to be accessible to HTTP users via the REST API.
 
181
    '''
 
182
    def __init__(self, permission):
 
183
        self.permission = permission
 
184
 
 
185
    def __call__(self, func):
 
186
        func._rest_api_callable = True
 
187
        func._rest_api_permission = self.permission
 
188
        return func
 
189
 
 
190
class require_permission(object):
 
191
    '''Declare the permission required for use of a method via the REST API.
 
192
    '''
 
193
    def __init__(self, permission):
 
194
        self.permission = permission
 
195
 
 
196
    def __call__(self, func):
 
197
        func._rest_api_permission = self.permission
 
198
        return func