← 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-18 00:31:46 UTC
  • mto: (1092.1.63 setup-stuff)
  • mto: This revision was merged to the branch mainline in revision 1100.
  • Revision ID: grantw@unimelb.edu.au-20090218003146-jictayp2dg05ec1d
Remove phpBB3 installation code and instructions.

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