← 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: mattgiuca
  • Date: 2008-01-30 00:40:45 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:330
browser/listing.js: Bugfix - error on multiple files selected when updating
sidebar (causing no actions to appear).

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
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
 
        pass
37
 
 
38
 
    def render(self, req):
39
 
        if req.method == 'GET':
40
 
            outstr = self.GET(req)
41
 
        # XXX PATCH hack
42
 
        if req.method == 'PUT':
43
 
            outstr = self.PATCH(req, req.read())
44
 
        req.content_type = self.content_type
45
 
        req.write(outstr)
46
 
 
47
 
class JSONRESTView(RESTView):
48
 
    """
49
 
    A special case of RESTView which deals entirely in JSON.
50
 
    """
51
 
    content_type = "application/json"
52
 
 
53
 
    _allowed_methods = property(
54
 
        lambda self: [m for m in ('GET', 'PUT', 'PATCH')
55
 
                      if hasattr(self, m)] + ['POST'])
56
 
 
57
 
    def render(self, req):
58
 
        if req.method not in self._allowed_methods:
59
 
            raise MethodNotAllowed(allowed=self._allowed_methods)
60
 
 
61
 
        if req.method == 'GET':
62
 
            outjson = self.GET(req)
63
 
        # Since PATCH isn't yet an official HTTP method, we allow users to
64
 
        # turn a PUT into a PATCH by supplying a special header.
65
 
        elif req.method == 'PATCH' or (req.method == 'PUT' and
66
 
              'X-IVLE-Patch-Semantics' in req.headers_in and
67
 
              req.headers_in['X-IVLE-Patch-Semantics'].lower() == 'yes'):
68
 
            outjson = self.PATCH(req, cjson.decode(req.read()))
69
 
        elif req.method == 'PUT':
70
 
            outjson = self.PUT(req, cjson.decode(req.read()))
71
 
        # POST implies named operation.
72
 
        elif req.method == 'POST':
73
 
            # TODO: Check Content-Type and implement multipart/form-data.
74
 
            opargs = dict(cgi.parse_qsl(req.read()))
75
 
            try:
76
 
                opname = opargs['ivle.op']
77
 
                del opargs['ivle.op']
78
 
            except KeyError:
79
 
                raise BadRequest('No named operation specified.')
80
 
 
81
 
            try:
82
 
                op = getattr(self, opname)
83
 
            except AttributeError:
84
 
                raise BadRequest('Invalid named operation.')
85
 
 
86
 
            if not hasattr(op, '_rest_api_callable') or \
87
 
               not op._rest_api_callable:
88
 
                raise BadRequest('Invalid named operation.')
89
 
 
90
 
            # Find any missing arguments, except for the first two (self, req)
91
 
            (args, vaargs, varkw, defaults) = inspect.getargspec(op)
92
 
            args = args[2:]
93
 
 
94
 
            # To find missing arguments, we eliminate the provided arguments
95
 
            # from the set of remaining function signature arguments. If the
96
 
            # remaining signature arguments are in the args[-len(defaults):],
97
 
            # we are OK.
98
 
            unspec = set(args) - set(opargs.keys())
99
 
            if unspec and not defaults:
100
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
101
 
 
102
 
            unspec = [k for k in unspec if k not in args[-len(defaults):]]
103
 
 
104
 
            if unspec:
105
 
                raise BadRequest('Missing arguments: ' + ','.join(unspec))
106
 
 
107
 
            # We have extra arguments if the are no match args in the function
108
 
            # signature, AND there is no **.
109
 
            extra = set(opargs.keys()) - set(args)
110
 
            if extra and not varkw:
111
 
                raise BadRequest('Extra arguments: ' + ', '.join(extra))
112
 
 
113
 
            outjson = op(req, **opargs)
114
 
        else:
115
 
            raise AssertionError('Unknown method somehow got through.')
116
 
 
117
 
        req.content_type = self.content_type
118
 
        if outjson is not None:
119
 
            req.write(cjson.encode(outjson))
120
 
            req.write("\n")
121
 
 
122
 
def named_operation(meth):
123
 
    '''Declare a function to be accessible to HTTP users via the REST API.
124
 
    '''
125
 
    meth._rest_api_callable = True
126
 
    return meth
127