15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Author: Matt Giuca, Will Grant, Nick Chadwick
18
# Author: Matt Giuca, Will Grant
26
import genshi.template
28
26
from ivle.webapp.base.views import BaseView
29
from ivle.webapp.base.xhtml import GenshiLoaderMixin
30
27
from ivle.webapp.errors import BadRequest, MethodNotAllowed, Unauthorized
32
29
class RESTView(BaseView):
37
34
content_type = "application/octet-stream"
36
def __init__(self, req, *args, **kwargs):
38
setattr(self, key, kwargs[key])
39
40
def render(self, req):
40
41
raise NotImplementedError()
56
57
if not hasattr(op, '_rest_api_permission'):
57
58
raise Unauthorized()
59
if (op._rest_api_permission not in
60
self.get_permissions(req.user, req.config)):
60
if op._rest_api_permission not in self.get_permissions(req.user):
61
61
raise Unauthorized()
63
63
def convert_bool(self, value):
141
141
outjson = op(req, **opargs)
143
143
req.content_type = self.content_type
144
self.write_json(req, outjson)
146
#This is a separate function to allow additional data to be passed through
147
def write_json(self, req, outjson):
148
144
if outjson is not None:
149
145
req.write(cjson.encode(outjson))
153
class XHTMLRESTView(GenshiLoaderMixin, JSONRESTView):
154
"""A special type of RESTView which takes enhances the standard JSON
155
with genshi XHTML functions.
157
XHTMLRESTViews should have a template, which is rendered using their
158
context. This is returned in the JSON as 'html'"""
160
ctx = genshi.template.Context()
162
def render_fragment(self):
163
if self.template is None:
164
raise NotImplementedError()
166
rest_template = os.path.join(os.path.dirname(
167
inspect.getmodule(self).__file__), self.template)
168
tmpl = self._loader.load(rest_template)
170
return tmpl.generate(self.ctx).render('xhtml', doctype='xhtml')
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))
178
148
class named_operation(object):
179
149
'''Declare a function to be accessible to HTTP users via the REST API.