root / snf-django-lib / snf_django / lib / api / __init__.py @ 4d244f4a
History | View | Annotate | Download (9.7 kB)
1 |
# Copyright 2012, 2013 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# interpreted as representing official policies, either expressed
|
32 |
# or implied, of GRNET S.A.
|
33 |
|
34 |
from functools import wraps |
35 |
from traceback import format_exc |
36 |
from time import time |
37 |
from logging import getLogger |
38 |
from wsgiref.handlers import format_date_time |
39 |
|
40 |
from django.http import HttpResponse |
41 |
from django.utils import cache |
42 |
from django.utils import simplejson as json |
43 |
from django.template.loader import render_to_string |
44 |
from django.views.decorators import csrf |
45 |
|
46 |
from astakosclient import AstakosClient |
47 |
from astakosclient.errors import AstakosClientException |
48 |
from django.conf import settings |
49 |
from snf_django.lib.api import faults |
50 |
|
51 |
import itertools |
52 |
|
53 |
log = getLogger(__name__) |
54 |
|
55 |
|
56 |
def get_token(request): |
57 |
"""Get the Authentication Token of a request."""
|
58 |
token = request.GET.get("X-Auth-Token", None) |
59 |
if not token: |
60 |
token = request.META.get("HTTP_X_AUTH_TOKEN", None) |
61 |
return token
|
62 |
|
63 |
|
64 |
def api_method(http_method=None, token_required=True, user_required=True, |
65 |
logger=None, format_allowed=True, astakos_url=None, |
66 |
serializations=None, strict_serlization=False): |
67 |
"""Decorator function for views that implement an API method."""
|
68 |
if not logger: |
69 |
logger = log |
70 |
|
71 |
serializations = serializations or ['json', 'xml'] |
72 |
|
73 |
def decorator(func): |
74 |
@wraps(func)
|
75 |
def wrapper(request, *args, **kwargs): |
76 |
try:
|
77 |
# Get the requested serialization format
|
78 |
serialization = get_serialization( |
79 |
request, format_allowed, 'json')
|
80 |
|
81 |
# If guessed serialization is not supported, fallback to
|
82 |
# the default serialization or return an API error in case
|
83 |
# strict serialization flag is set.
|
84 |
if not serialization in serializations: |
85 |
if strict_serlization:
|
86 |
raise faults.BadRequest(("%s serialization not " |
87 |
"supported") % serialization)
|
88 |
serialization = serializations[0]
|
89 |
request.serialization = serialization |
90 |
|
91 |
# Check HTTP method
|
92 |
if http_method and request.method != http_method: |
93 |
raise faults.BadRequest("Method not allowed") |
94 |
|
95 |
# Get authentication token
|
96 |
request.x_auth_token = None
|
97 |
if token_required or user_required: |
98 |
token = get_token(request) |
99 |
if not token: |
100 |
msg = "Access denied. No authentication token"
|
101 |
raise faults.Unauthorized(msg)
|
102 |
request.x_auth_token = token |
103 |
|
104 |
# Authenticate
|
105 |
if user_required:
|
106 |
assert(token_required), "Can not get user without token" |
107 |
astakos = astakos_url or settings.ASTAKOS_BASE_URL
|
108 |
astakos = AstakosClient(astakos, |
109 |
use_pool=True,
|
110 |
logger=logger) |
111 |
user_info = astakos.get_user_info(token) |
112 |
request.user_uniq = user_info["uuid"]
|
113 |
request.user = user_info |
114 |
|
115 |
# Get the response object
|
116 |
response = func(request, *args, **kwargs) |
117 |
|
118 |
# Fill in response variables
|
119 |
update_response_headers(request, response) |
120 |
return response
|
121 |
except faults.Fault, fault:
|
122 |
if fault.code >= 500: |
123 |
logger.exception("API ERROR")
|
124 |
return render_fault(request, fault)
|
125 |
except AstakosClientException as err: |
126 |
fault = faults.Fault(message=err.message, |
127 |
details=err.details, |
128 |
code=err.status) |
129 |
if fault.code >= 500: |
130 |
logger.exception("Astakos ERROR")
|
131 |
return render_fault(request, fault)
|
132 |
except:
|
133 |
logger.exception("Unexpected ERROR")
|
134 |
fault = faults.InternalServerError("Unexpected error")
|
135 |
return render_fault(request, fault)
|
136 |
return csrf.csrf_exempt(wrapper)
|
137 |
return decorator
|
138 |
|
139 |
|
140 |
def get_serialization(request, format_allowed=True, default_serialization="json"): |
141 |
"""Return the serialization format requested.
|
142 |
|
143 |
Valid formats are 'json' and 'xml' and 'text'
|
144 |
"""
|
145 |
|
146 |
if not format_allowed: |
147 |
return "text" |
148 |
|
149 |
# Try to get serialization from 'format' parameter
|
150 |
_format = request.GET.get("format")
|
151 |
if _format:
|
152 |
if _format == "json": |
153 |
return "json" |
154 |
elif _format == "xml": |
155 |
return "xml" |
156 |
|
157 |
# Try to get serialization from path
|
158 |
path = request.path |
159 |
if path.endswith(".json"): |
160 |
return "json" |
161 |
elif path.endswith(".xml"): |
162 |
return "xml" |
163 |
|
164 |
for item in request.META.get("HTTP_ACCEPT", "").split(","): |
165 |
accept, sep, rest = item.strip().partition(";")
|
166 |
if accept == "application/json": |
167 |
return "json" |
168 |
elif accept == "application/xml": |
169 |
return "xml" |
170 |
|
171 |
return default_serialization
|
172 |
|
173 |
|
174 |
def update_response_headers(request, response): |
175 |
if not getattr(response, "override_serialization", False): |
176 |
serialization = request.serialization |
177 |
if serialization == "xml": |
178 |
response["Content-Type"] = "application/xml; charset=UTF-8" |
179 |
elif serialization == "json": |
180 |
response["Content-Type"] = "application/json; charset=UTF-8" |
181 |
elif serialization == "text": |
182 |
response["Content-Type"] = "text/plain; charset=UTF-8" |
183 |
else:
|
184 |
raise ValueError("Unknown serialization format '%s'" % |
185 |
serialization) |
186 |
|
187 |
if settings.DEBUG or getattr(settings, "TEST", False): |
188 |
response["Date"] = format_date_time(time())
|
189 |
|
190 |
if not response.has_header("Content-Length"): |
191 |
if response._is_string:
|
192 |
response["Content-Length"] = len(response.content) |
193 |
else:
|
194 |
# save response content from been consumed if it is an iterator
|
195 |
response._container, data = itertools.tee(response._container) |
196 |
response["Content-Length"] = len(str(data)) |
197 |
|
198 |
cache.add_never_cache_headers(response) |
199 |
# Fix Vary and Cache-Control Headers. Issue: #3448
|
200 |
cache.patch_vary_headers(response, ('X-Auth-Token',))
|
201 |
cache.patch_cache_control(response, no_cache=True, no_store=True, |
202 |
must_revalidate=True)
|
203 |
|
204 |
|
205 |
def render_fault(request, fault): |
206 |
"""Render an API fault to an HTTP response."""
|
207 |
# If running in debug mode add exception information to fault details
|
208 |
if settings.DEBUG or getattr(settings, "TEST", False): |
209 |
fault.details = format_exc() |
210 |
|
211 |
try:
|
212 |
serialization = request.serialization |
213 |
except AttributeError: |
214 |
request.serialization = "json"
|
215 |
serialization = "json"
|
216 |
|
217 |
# Serialize the fault data to xml or json
|
218 |
if serialization == "xml": |
219 |
data = render_to_string("fault.xml", {"fault": fault}) |
220 |
else:
|
221 |
d = {fault.name: {"code": fault.code,
|
222 |
"message": fault.message,
|
223 |
"details": fault.details}}
|
224 |
data = json.dumps(d) |
225 |
|
226 |
response = HttpResponse(data, status=fault.code) |
227 |
update_response_headers(request, response) |
228 |
return response
|
229 |
|
230 |
|
231 |
@api_method(token_required=False, user_required=False) |
232 |
def api_endpoint_not_found(request): |
233 |
raise faults.BadRequest("API endpoint not found") |
234 |
|
235 |
|
236 |
@api_method(token_required=False, user_required=False) |
237 |
def api_method_not_allowed(request): |
238 |
raise faults.BadRequest('Method not allowed') |
239 |
|
240 |
|
241 |
def allow_jsonp(key='callback'): |
242 |
"""
|
243 |
Wrapper to enable jsonp responses.
|
244 |
"""
|
245 |
def wrapper(func): |
246 |
def view_wrapper(request, *args, **kwargs): |
247 |
response = func(request, *args, **kwargs) |
248 |
if 'content-type' in response._headers and \ |
249 |
response._headers['content-type'][1] == 'application/json': |
250 |
callback_name = request.GET.get(key, None)
|
251 |
if callback_name:
|
252 |
response.content = "%s(%s)" % (callback_name,
|
253 |
response.content) |
254 |
response._headers['content-type'] = ('Content-Type', |
255 |
'text/javascript')
|
256 |
return response
|
257 |
return view_wrapper
|
258 |
return wrapper
|