~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-11 00:49:06 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:172
util: Added buildurl function.

Show diffs side-by-side

added added

removed removed

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