1 # Copyright 2011 GRNET S.A. All rights reserved.
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
7 # 1. Redistributions of source code must retain the above
8 # copyright notice, this list of conditions and the following
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.
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.
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.
39 from django.http import HttpResponse
40 from django.template.loader import render_to_string
41 from django.utils import simplejson as json
42 from django.utils.http import parse_etags
44 from pithos.api.faults import (Fault, NotModified, BadRequest, Unauthorized, ItemNotFound, Conflict,
45 LengthRequired, PreconditionFailed, RangeNotSatisfiable, UnprocessableEntity)
46 from pithos.api.util import (format_meta_key, printable_meta_dict, get_account_meta,
47 put_account_meta, get_container_meta, put_container_meta, get_object_meta, put_object_meta,
48 validate_modification_preconditions, validate_matching_preconditions, copy_or_move_object,
49 get_content_length, get_range, get_content_range, raw_input_socket, socket_read_iterator,
50 ObjectWrapper, api_method)
51 from pithos.backends import backend
54 logger = logging.getLogger(__name__)
57 def top_demux(request):
58 if request.method == 'GET':
59 return authenticate(request)
61 return method_not_allowed(request)
63 def account_demux(request, v_account):
64 if request.method == 'HEAD':
65 return account_meta(request, v_account)
66 elif request.method == 'GET':
67 return container_list(request, v_account)
68 elif request.method == 'POST':
69 return account_update(request, v_account)
71 return method_not_allowed(request)
73 def container_demux(request, v_account, v_container):
74 if request.method == 'HEAD':
75 return container_meta(request, v_account, v_container)
76 elif request.method == 'GET':
77 return object_list(request, v_account, v_container)
78 elif request.method == 'PUT':
79 return container_create(request, v_account, v_container)
80 elif request.method == 'POST':
81 return container_update(request, v_account, v_container)
82 elif request.method == 'DELETE':
83 return container_delete(request, v_account, v_container)
85 return method_not_allowed(request)
87 def object_demux(request, v_account, v_container, v_object):
88 if request.method == 'HEAD':
89 return object_meta(request, v_account, v_container, v_object)
90 elif request.method == 'GET':
91 return object_read(request, v_account, v_container, v_object)
92 elif request.method == 'PUT':
93 return object_write(request, v_account, v_container, v_object)
94 elif request.method == 'COPY':
95 return object_copy(request, v_account, v_container, v_object)
96 elif request.method == 'MOVE':
97 return object_move(request, v_account, v_container, v_object)
98 elif request.method == 'POST':
99 return object_update(request, v_account, v_container, v_object)
100 elif request.method == 'DELETE':
101 return object_delete(request, v_account, v_container, v_object)
103 return method_not_allowed(request)
106 def authenticate(request):
107 # Normal Response Codes: 204
108 # Error Response Codes: serviceUnavailable (503),
109 # unauthorized (401),
112 x_auth_user = request.META.get('HTTP_X_AUTH_USER')
113 x_auth_key = request.META.get('HTTP_X_AUTH_KEY')
114 if not x_auth_user or not x_auth_key:
115 raise BadRequest('Missing X-Auth-User or X-Auth-Key header')
117 response = HttpResponse(status=204)
118 response['X-Auth-Token'] = '0000'
119 response['X-Storage-Url'] = os.path.join(request.build_absolute_uri(), 'demo')
123 def account_meta(request, v_account):
124 # Normal Response Codes: 204
125 # Error Response Codes: serviceUnavailable (503),
126 # unauthorized (401),
129 meta = backend.get_account_meta(request.user)
131 response = HttpResponse(status=204)
132 put_account_meta(response, meta)
136 def account_update(request, v_account):
137 # Normal Response Codes: 202
138 # Error Response Codes: serviceUnavailable (503),
139 # unauthorized (401),
142 meta = get_account_meta(request)
143 backend.update_account_meta(request.user, meta, replace=True)
144 return HttpResponse(status=202)
146 @api_method('GET', format_allowed=True)
147 def container_list(request, v_account):
148 # Normal Response Codes: 200, 204
149 # Error Response Codes: serviceUnavailable (503),
150 # itemNotFound (404),
151 # unauthorized (401),
154 meta = backend.get_account_meta(request.user)
156 validate_modification_preconditions(request, meta)
158 response = HttpResponse()
159 put_account_meta(response, meta)
161 marker = request.GET.get('marker')
162 limit = request.GET.get('limit')
172 containers = backend.list_containers(request.user, marker, limit)
176 if request.serialization == 'text':
177 if len(containers) == 0:
178 # The cloudfiles python bindings expect 200 if json/xml.
179 response.status_code = 204
181 response.status_code = 200
182 response.content = '\n'.join(containers) + '\n'
188 meta = backend.get_container_meta(request.user, x)
191 container_meta.append(printable_meta_dict(meta))
192 if request.serialization == 'xml':
193 data = render_to_string('containers.xml', {'account': request.user, 'containers': container_meta})
194 elif request.serialization == 'json':
195 data = json.dumps(container_meta)
196 response.status_code = 200
197 response.content = data
201 def container_meta(request, v_account, v_container):
202 # Normal Response Codes: 204
203 # Error Response Codes: serviceUnavailable (503),
204 # itemNotFound (404),
205 # unauthorized (401),
209 meta = backend.get_container_meta(request.user, v_container)
210 meta['object_meta'] = backend.list_object_meta(request.user, v_container)
212 raise ItemNotFound('Container does not exist')
214 response = HttpResponse(status=204)
215 put_container_meta(response, meta)
219 def container_create(request, v_account, v_container):
220 # Normal Response Codes: 201, 202
221 # Error Response Codes: serviceUnavailable (503),
222 # itemNotFound (404),
223 # unauthorized (401),
226 meta = get_container_meta(request)
229 backend.put_container(request.user, v_container)
235 backend.update_container_meta(request.user, v_container, meta, replace=True)
237 return HttpResponse(status=ret)
240 def container_update(request, v_account, v_container):
241 # Normal Response Codes: 202
242 # Error Response Codes: serviceUnavailable (503),
243 # itemNotFound (404),
244 # unauthorized (401),
247 meta = get_container_meta(request)
249 backend.update_container_meta(request.user, v_container, meta, replace=True)
251 raise ItemNotFound('Container does not exist')
252 return HttpResponse(status=202)
254 @api_method('DELETE')
255 def container_delete(request, v_account, v_container):
256 # Normal Response Codes: 204
257 # Error Response Codes: serviceUnavailable (503),
259 # itemNotFound (404),
260 # unauthorized (401),
264 backend.delete_container(request.user, v_container)
266 raise ItemNotFound('Container does not exist')
268 raise Conflict('Container is not empty')
269 return HttpResponse(status=204)
271 @api_method('GET', format_allowed=True)
272 def object_list(request, v_account, v_container):
273 # Normal Response Codes: 200, 204
274 # Error Response Codes: serviceUnavailable (503),
275 # itemNotFound (404),
276 # unauthorized (401),
280 meta = backend.get_container_meta(request.user, v_container)
281 meta['object_meta'] = backend.list_object_meta(request.user, v_container)
283 raise ItemNotFound('Container does not exist')
285 validate_modification_preconditions(request, meta)
287 response = HttpResponse()
288 put_container_meta(response, meta)
290 path = request.GET.get('path')
291 prefix = request.GET.get('prefix')
292 delimiter = request.GET.get('delimiter')
294 # Path overrides prefix and delimiter.
302 if prefix and delimiter:
303 prefix = prefix + delimiter
306 prefix = prefix.lstrip('/')
308 marker = request.GET.get('marker')
309 limit = request.GET.get('limit')
318 keys = request.GET.get('meta')
320 keys = keys.split(',')
321 keys = [format_meta_key('X-Object-Meta-' + x.strip()) for x in keys if x.strip() != '']
326 objects = backend.list_objects(request.user, v_container, prefix, delimiter, marker, limit, virtual, keys)
328 raise ItemNotFound('Container does not exist')
330 if request.serialization == 'text':
331 if len(objects) == 0:
332 # The cloudfiles python bindings expect 200 if json/xml.
333 response.status_code = 204
335 response.status_code = 200
336 response.content = '\n'.join(objects) + '\n'
342 meta = backend.get_object_meta(request.user, v_container, x)
344 # Virtual objects/directories.
345 if virtual and delimiter and x.endswith(delimiter):
346 object_meta.append({'subdir': x})
348 object_meta.append(printable_meta_dict(meta))
349 if request.serialization == 'xml':
350 data = render_to_string('objects.xml', {'container': v_container, 'objects': object_meta})
351 elif request.serialization == 'json':
352 data = json.dumps(object_meta)
353 response.status_code = 200
354 response.content = data
358 def object_meta(request, v_account, v_container, v_object):
359 # Normal Response Codes: 204
360 # Error Response Codes: serviceUnavailable (503),
361 # itemNotFound (404),
362 # unauthorized (401),
366 meta = backend.get_object_meta(request.user, v_container, v_object)
368 raise ItemNotFound('Object does not exist')
370 response = HttpResponse(status=204)
371 put_object_meta(response, meta)
374 @api_method('GET', format_allowed=True)
375 def object_read(request, v_account, v_container, v_object):
376 # Normal Response Codes: 200, 206
377 # Error Response Codes: serviceUnavailable (503),
378 # rangeNotSatisfiable (416),
379 # preconditionFailed (412),
380 # itemNotFound (404),
381 # unauthorized (401),
386 meta = backend.get_object_meta(request.user, v_container, v_object)
388 raise ItemNotFound('Object does not exist')
390 # Evaluate conditions.
391 validate_modification_preconditions(request, meta)
393 validate_matching_preconditions(request, meta)
395 response = HttpResponse(status=304)
396 response['ETag'] = meta['hash']
400 # TODO: Also check for IndexError.
401 size, hashmap = backend.get_object_hashmap(request.user, v_container, v_object)
403 raise ItemNotFound('Object does not exist')
405 # Reply with the hashmap.
406 if request.serialization != 'text':
407 if request.serialization == 'xml':
408 data = render_to_string('hashes.xml', {'object': v_object, 'bytes': size, 'hashes': hashmap})
409 elif request.serialization == 'json':
410 data = json.dumps({'bytes': size, 'hashes': hashmap})
412 response = HttpResponse(data, status=200)
413 put_object_meta(response, meta)
414 response['Content-Length'] = len(data)
418 ranges = get_range(request, size)
423 check = [True for offset, length in ranges if
424 length <= 0 or length > size or
425 offset < 0 or offset >= size or
426 offset + length > size]
428 raise RangeNotSatisfiable('Requested range exceeds object limits')
431 if ret == 206 and len(ranges) > 1:
432 boundary = uuid.uuid4().hex
435 wrapper = ObjectWrapper(request.user, v_container, v_object, ranges, size, hashmap, boundary)
436 response = HttpResponse(wrapper, status=ret)
437 put_object_meta(response, meta)
440 offset, length = ranges[0]
441 response['Content-Length'] = length # Update with the correct length.
442 response['Content-Range'] = 'bytes %d-%d/%d' % (offset, offset + length - 1, size)
444 del(response['Content-Length'])
445 response['Content-Type'] = 'multipart/byteranges; boundary=%s' % (boundary,)
449 def object_write(request, v_account, v_container, v_object):
450 # Normal Response Codes: 201
451 # Error Response Codes: serviceUnavailable (503),
452 # unprocessableEntity (422),
453 # lengthRequired (411),
454 # itemNotFound (404),
455 # unauthorized (401),
458 copy_from = request.META.get('HTTP_X_COPY_FROM')
459 move_from = request.META.get('HTTP_X_MOVE_FROM')
460 if copy_from or move_from:
461 # TODO: Why is this required? Copy this ammount?
462 content_length = get_content_length(request)
465 copy_or_move_object(request, move_from, (v_container, v_object), move=True)
467 copy_or_move_object(request, copy_from, (v_container, v_object), move=False)
468 return HttpResponse(status=201)
470 meta = get_object_meta(request)
472 if request.META.get('HTTP_TRANSFER_ENCODING') != 'chunked':
473 content_length = get_content_length(request)
474 # Should be BadRequest, but API says otherwise.
475 if 'Content-Type' not in meta:
476 raise LengthRequired('Missing Content-Type header')
479 if content_length == 0:
481 backend.update_object_hashmap(request.user, v_container, v_object, 0, [])
483 raise ItemNotFound('Container does not exist')
487 sock = raw_input_socket(request)
488 for data in socket_read_iterator(sock, content_length, backend.block_size):
489 # TODO: Raise 408 (Request Timeout) if this takes too long.
490 # TODO: Raise 499 (Client Disconnect) if a length is defined and we stop before getting this much data.
492 hashmap.append(backend.put_block(data))
495 meta['hash'] = md5.hexdigest().lower()
496 etag = request.META.get('HTTP_ETAG')
497 if etag and parse_etags(etag)[0].lower() != meta['hash']:
498 raise UnprocessableEntity('Object ETag does not match')
501 backend.update_object_hashmap(request.user, v_container, v_object, size, hashmap)
503 raise ItemNotFound('Container does not exist')
505 backend.update_object_meta(request.user, v_container, v_object, meta, replace=True)
507 raise ItemNotFound('Object does not exist')
509 response = HttpResponse(status=201)
510 response['ETag'] = meta['hash']
514 def object_copy(request, v_account, v_container, v_object):
515 # Normal Response Codes: 201
516 # Error Response Codes: serviceUnavailable (503),
517 # itemNotFound (404),
518 # unauthorized (401),
521 dest_path = request.META.get('HTTP_DESTINATION')
523 raise BadRequest('Missing Destination header')
524 copy_or_move_object(request, (v_container, v_object), dest_path, move=False)
525 return HttpResponse(status=201)
528 def object_move(request, v_account, v_container, v_object):
529 # Normal Response Codes: 201
530 # Error Response Codes: serviceUnavailable (503),
531 # itemNotFound (404),
532 # unauthorized (401),
535 dest_path = request.META.get('HTTP_DESTINATION')
537 raise BadRequest('Missing Destination header')
538 copy_or_move_object(request, (v_container, v_object), dest_path, move=True)
539 return HttpResponse(status=201)
542 def object_update(request, v_account, v_container, v_object):
543 # Normal Response Codes: 202, 204
544 # Error Response Codes: serviceUnavailable (503),
545 # itemNotFound (404),
546 # unauthorized (401),
549 meta = get_object_meta(request)
550 content_type = meta.get('Content-Type')
552 del(meta['Content-Type']) # Do not allow changing the Content-Type.
555 prev_meta = backend.get_object_meta(request.user, v_container, v_object)
557 raise ItemNotFound('Object does not exist')
559 # Handle metadata changes.
561 # Keep previous values of 'Content-Type' and 'hash'.
562 for k in ('Content-Type', 'hash'):
564 meta[k] = prev_meta[k]
566 backend.update_object_meta(request.user, v_container, v_object, meta, replace=True)
568 raise ItemNotFound('Object does not exist')
570 # A Content-Type or Content-Range header may indicate data updates.
571 if content_type and content_type.startswith('multipart/byteranges'):
572 # TODO: Support multiple update ranges.
573 return HttpResponse(status=202)
574 # Single range update. Range must be in Content-Range.
575 # Based on: http://code.google.com/p/gears/wiki/ContentRangePostProposal
576 # (with the addition that '*' is allowed for the range - will append).
577 if content_type and content_type != 'application/octet-stream':
578 return HttpResponse(status=202)
579 content_range = request.META.get('HTTP_CONTENT_RANGE')
580 if not content_range:
581 return HttpResponse(status=202)
582 ranges = get_content_range(request)
584 return HttpResponse(status=202)
585 # Require either a Content-Length, or 'chunked' Transfer-Encoding.
587 if request.META.get('HTTP_TRANSFER_ENCODING') != 'chunked':
588 content_length = get_content_length(request)
591 # TODO: Also check for IndexError.
592 size, hashmap = backend.get_object_hashmap(request.user, v_container, v_object)
594 raise ItemNotFound('Object does not exist')
596 offset, length, total = ranges
600 length = content_length # Nevermind the error.
601 elif length != content_length:
602 raise BadRequest('Content length does not match range length')
603 if total is not None and (total != size or offset >= size or (length > 0 and offset + length >= size)):
604 raise RangeNotSatisfiable('Supplied range will change provided object limits')
606 sock = raw_input_socket(request)
608 for d in socket_read_iterator(sock, length, backend.block_size):
609 # TODO: Raise 408 (Request Timeout) if this takes too long.
610 # TODO: Raise 499 (Client Disconnect) if a length is defined and we stop before getting this much data.
612 bi = int(offset / backend.block_size)
613 bo = offset % backend.block_size
614 bl = min(len(data), backend.block_size - bo)
616 h = backend.update_block(hashmap[bi], data[:bl], bo)
617 if bi < len(hashmap):
623 bi = int(offset / backend.block_size)
625 h = backend.update_block(hashmap[bi], data)
626 if bi < len(hashmap):
634 backend.update_object_hashmap(request.user, v_container, v_object, size, hashmap)
636 raise ItemNotFound('Container does not exist')
639 # TODO: Decide on the new ETag to use here.
642 md5.update(str(hashmap))
643 meta['hash'] = md5.hexdigest().lower()
645 backend.update_object_meta(request.user, v_container, v_object, meta)
647 raise ItemNotFound('Object does not exist')
649 response = HttpResponse(status=204)
650 response['ETag'] = meta['hash']
653 @api_method('DELETE')
654 def object_delete(request, v_account, v_container, v_object):
655 # Normal Response Codes: 204
656 # Error Response Codes: serviceUnavailable (503),
657 # itemNotFound (404),
658 # unauthorized (401),
662 backend.delete_object(request.user, v_container, v_object)
664 raise ItemNotFound('Object does not exist')
665 return HttpResponse(status=204)
668 def method_not_allowed(request):
669 raise BadRequest('Method not allowed')