← 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: 2010-07-03 08:22:02 UTC
  • Revision ID: grantw@unimelb.edu.au-20100703082202-al9jfotdvaz3rlil
In the file browser, avoid generating a breadcrumb for a final empty path segment created by a trailing slash.

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, Nick Chadwick
 
19
 
 
20
import os
 
21
import cgi
 
22
import urlparse
 
23
import inspect
 
24
 
 
25
import cjson
 
26
import genshi.template
 
27
 
 
28
from ivle.webapp.base.views import BaseView
 
29
from ivle.webapp.base.xhtml import GenshiLoaderMixin
 
30
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
 
31
 
 
32
class RESTView(BaseView):
 
33
    """
 
34
    A view which provides a RESTful interface. The content type is
 
35
    unspecified (see JSONRESTView for a specific content type).
 
36
    """
 
37
    content_type = "application/octet-stream"
 
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
 
60
            self.get_permissions(req.user, req.config)):
 
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
        self.write_json(req, outjson)
 
145
 
 
146
    #This is a separate function to allow additional data to be passed through
 
147
    def write_json(self, req, outjson):
 
148
        if outjson is not None:
 
149
            req.write(cjson.encode(outjson))
 
150
            req.write("\n")
 
151
 
 
152
 
 
153
class XHTMLRESTView(GenshiLoaderMixin, JSONRESTView):
 
154
    """A special type of RESTView which takes enhances the standard JSON
 
155
    with genshi XHTML functions.
 
156
    
 
157
    XHTMLRESTViews should have a template, which is rendered using their
 
158
    context. This is returned in the JSON as 'html'"""
 
159
    template = None
 
160
    ctx = genshi.template.Context()
 
161
 
 
162
    def render_fragment(self):
 
163
        if self.template is None:
 
164
            raise NotImplementedError()
 
165
 
 
166
        rest_template = os.path.join(os.path.dirname(
 
167
                inspect.getmodule(self).__file__), self.template)
 
168
        tmpl = self._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):
 
179
    '''Declare a function to be accessible to HTTP users via the REST API.
 
180
    '''
 
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