← 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: 2009-02-23 23:47:02 UTC
  • mfrom: (1099.1.211 new-dispatch)
  • Revision ID: grantw@unimelb.edu.au-20090223234702-db4b1llly46ignwo
Merge from lp:~ivle-dev/ivle/new-dispatch.

Pretty much everything changes. Reread the setup docs. Backup your databases.
Every file is now in a different installed location, the configuration system
is rewritten, the dispatch system is rewritten, URLs are different, the
database is different, worksheets and exercises are no longer on the
filesystem, we use a templating engine, jail service protocols are rewritten,
we don't repeat ourselves, we have authorization rewritten, phpBB is gone,
and probably lots of other things that I cannot remember.

This is certainly the biggest commit I have ever made, and hopefully
the largest I ever will.

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
 
 
26
from ivle.webapp.base.views import BaseView
 
27
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
 
28
 
 
29
class RESTView(BaseView):
 
30
    """
 
31
    A view which provides a RESTful interface. The content type is
 
32
    unspecified (see JSONRESTView for a specific content type).
 
33
    """
 
34
    content_type = "application/octet-stream"
 
35
 
 
36
    def __init__(self, req, *args, **kwargs):
 
37
        for key in kwargs:
 
38
            setattr(self, key, kwargs[key])
 
39
 
 
40
    def render(self, req):
 
41
        raise NotImplementedError()
 
42
 
 
43
class JSONRESTView(RESTView):
 
44
    """
 
45
    A special case of RESTView which deals entirely in JSON.
 
46
    """
 
47
    content_type = "application/json"
 
48
 
 
49
    _allowed_methods = property(
 
50
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
 
51
                      if hasattr(self, m)] + ['POST'])
 
52
 
 
53
    def authorize(self, req):
 
54
        return True # Real authz performed in render().
 
55
 
 
56
    def authorize_method(self, req, op):
 
57
        if not hasattr(op, '_rest_api_permission'):
 
58
            raise Unauthorized()
 
59
 
 
60
        if op._rest_api_permission not in self.get_permissions(req.user):
 
61
            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
 
 
71
    def render(self, req):
 
72
        if req.method not in self._allowed_methods:
 
73
            raise MethodNotAllowed(allowed=self._allowed_methods)
 
74
 
 
75
        if req.method == 'GET':
 
76
            self.authorize_method(req, self.GET)
 
77
            outjson = self.GET(req)
 
78
        # Since PATCH isn't yet an official HTTP method, we allow users to
 
79
        # turn a PUT into a PATCH by supplying a special header.
 
80
        elif req.method == 'PATCH' or (req.method == 'PUT' and
 
81
              'X-IVLE-Patch-Semantics' in req.headers_in and
 
82
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
 
83
            self.authorize_method(req, self.PATCH)
 
84
            try:
 
85
                input = cjson.decode(req.read())
 
86
            except cjson.DecodeError:
 
87
                raise BadRequest('Invalid JSON data')
 
88
            outjson = self.PATCH(req, input)
 
89
        elif req.method == 'PUT':
 
90
            self.authorize_method(req, self.PUT)
 
91
            try:
 
92
                input = cjson.decode(req.read())
 
93
            except cjson.DecodeError:
 
94
                raise BadRequest('Invalid JSON data')
 
95
            outjson = self.PUT(req, input)
 
96
        # POST implies named operation.
 
97
        elif req.method == 'POST':
 
98
            # TODO: Check Content-Type and implement multipart/form-data.
 
99
            data = req.read()
 
100
            opargs = dict(cgi.parse_qsl(data, keep_blank_values=1))
 
101
            try:
 
102
                opname = opargs['ivle.op']
 
103
                del opargs['ivle.op']
 
104
            except KeyError:
 
105
                raise BadRequest('No named operation specified.')
 
106
 
 
107
            try:
 
108
                op = getattr(self, opname)
 
109
            except AttributeError:
 
110
                raise BadRequest('Invalid named operation.')
 
111
 
 
112
            if not hasattr(op, '_rest_api_callable') or \
 
113
               not op._rest_api_callable:
 
114
                raise BadRequest('Invalid named operation.')
 
115
 
 
116
            self.authorize_method(req, op)
 
117
 
 
118
            # Find any missing arguments, except for the first two (self, req)
 
119
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
 
120
            args = args[2:]
 
121
 
 
122
            # To find missing arguments, we eliminate the provided arguments
 
123
            # from the set of remaining function signature arguments. If the
 
124
            # remaining signature arguments are in the args[-len(defaults):],
 
125
            # we are OK.
 
126
            unspec = set(args) - set(opargs.keys())
 
127
            if unspec and not defaults:
 
128
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
129
 
 
130
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
 
131
 
 
132
            if unspec:
 
133
                raise BadRequest('Missing arguments: ' + ', '.join(unspec))
 
134
 
 
135
            # We have extra arguments if the are no match args in the function
 
136
            # signature, AND there is no **.
 
137
            extra = set(opargs.keys()) - set(args)
 
138
            if extra and not varkw:
 
139
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
 
140
 
 
141
            outjson = op(req, **opargs)
 
142
 
 
143
        req.content_type = self.content_type
 
144
        if outjson is not None:
 
145
            req.write(cjson.encode(outjson))
 
146
            req.write("\n")
 
147
 
 
148
class named_operation(object):
 
149
    '''Declare a function to be accessible to HTTP users via the REST API.
 
150
    '''
 
151
    def __init__(self, permission):
 
152
        self.permission = permission
 
153
 
 
154
    def __call__(self, func):
 
155
        func._rest_api_callable = True
 
156
        func._rest_api_permission = self.permission
 
157
        return func
 
158
 
 
159
class require_permission(object):
 
160
    '''Declare the permission required for use of a method via the REST API.
 
161
    '''
 
162
    def __init__(self, permission):
 
163
        self.permission = permission
 
164
 
 
165
    def __call__(self, func):
 
166
        func._rest_api_permission = self.permission
 
167
        return func
 
168