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.
38 from django.http import HttpResponse
39 from django.template.loader import render_to_string
40 from django.utils import simplejson as json
41 from django.utils.http import parse_etags
43 from pithos.api.faults import (Fault, NotModified, BadRequest, Unauthorized, ItemNotFound, Conflict,
44 LengthRequired, PreconditionFailed, RangeNotSatisfiable, UnprocessableEntity)
45 from pithos.api.util import (format_meta_key, printable_meta_dict, get_account_meta,
46 put_account_meta, get_container_meta, put_container_meta, get_object_meta, put_object_meta,
47 update_manifest_meta, validate_modification_preconditions, validate_matching_preconditions,
48 split_container_object_string, copy_or_move_object, get_int_parameter, get_content_length,
49 get_content_range, raw_input_socket, socket_read_iterator, object_data_response,
50 hashmap_hash, 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 == 'POST':
67 return account_update(request, v_account)
68 elif request.method == 'GET':
69 return container_list(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 == 'PUT':
77 return container_create(request, v_account, v_container)
78 elif request.method == 'POST':
79 return container_update(request, v_account, v_container)
80 elif request.method == 'DELETE':
81 return container_delete(request, v_account, v_container)
82 elif request.method == 'GET':
83 return object_list(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')
116 response = HttpResponse(status=204)
117 response['X-Auth-Token'] = '0000'
118 response['X-Storage-Url'] = os.path.join(request.build_absolute_uri(), 'demo')
122 def account_meta(request, v_account):
123 # Normal Response Codes: 204
124 # Error Response Codes: serviceUnavailable (503),
125 # unauthorized (401),
128 until = get_int_parameter(request, 'until')
129 meta = backend.get_account_meta(request.user, v_account, until)
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, v_account, 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 until = get_int_parameter(request, 'until')
155 meta = backend.get_account_meta(request.user, v_account, until)
157 validate_modification_preconditions(request, meta)
159 response = HttpResponse()
160 put_account_meta(response, meta)
162 marker = request.GET.get('marker')
163 limit = request.GET.get('limit')
173 containers = backend.list_containers(request.user, v_account, marker, limit, until)
177 if request.serialization == 'text':
178 if len(containers) == 0:
179 # The cloudfiles python bindings expect 200 if json/xml.
180 response.status_code = 204
182 response.status_code = 200
183 response.content = '\n'.join([x[0] for x in containers]) + '\n'
190 meta = backend.get_container_meta(request.user, v_account, x[0], until)
191 container_meta.append(printable_meta_dict(meta))
194 if request.serialization == 'xml':
195 data = render_to_string('containers.xml', {'account': v_account, 'containers': container_meta})
196 elif request.serialization == 'json':
197 data = json.dumps(container_meta)
198 response.status_code = 200
199 response.content = data
203 def container_meta(request, v_account, v_container):
204 # Normal Response Codes: 204
205 # Error Response Codes: serviceUnavailable (503),
206 # itemNotFound (404),
207 # unauthorized (401),
210 until = get_int_parameter(request, 'until')
212 meta = backend.get_container_meta(request.user, v_account, v_container, until)
213 meta['object_meta'] = backend.list_object_meta(request.user, v_account, v_container, until)
215 raise ItemNotFound('Container does not exist')
217 response = HttpResponse(status=204)
218 put_container_meta(response, meta)
222 def container_create(request, v_account, v_container):
223 # Normal Response Codes: 201, 202
224 # Error Response Codes: serviceUnavailable (503),
225 # itemNotFound (404),
226 # unauthorized (401),
229 meta = get_container_meta(request)
232 backend.put_container(request.user, v_account, v_container)
238 backend.update_container_meta(request.user, v_account, v_container, meta, replace=True)
240 return HttpResponse(status=ret)
243 def container_update(request, v_account, v_container):
244 # Normal Response Codes: 202
245 # Error Response Codes: serviceUnavailable (503),
246 # itemNotFound (404),
247 # unauthorized (401),
250 meta = get_container_meta(request)
252 backend.update_container_meta(request.user, v_account, v_container, meta, replace=True)
254 raise ItemNotFound('Container does not exist')
255 return HttpResponse(status=202)
257 @api_method('DELETE')
258 def container_delete(request, v_account, v_container):
259 # Normal Response Codes: 204
260 # Error Response Codes: serviceUnavailable (503),
262 # itemNotFound (404),
263 # unauthorized (401),
267 backend.delete_container(request.user, v_account, v_container)
269 raise ItemNotFound('Container does not exist')
271 raise Conflict('Container is not empty')
272 return HttpResponse(status=204)
274 @api_method('GET', format_allowed=True)
275 def object_list(request, v_account, v_container):
276 # Normal Response Codes: 200, 204
277 # Error Response Codes: serviceUnavailable (503),
278 # itemNotFound (404),
279 # unauthorized (401),
282 until = get_int_parameter(request, 'until')
284 meta = backend.get_container_meta(request.user, v_account, v_container, until)
285 meta['object_meta'] = backend.list_object_meta(request.user, v_account, v_container, until)
287 raise ItemNotFound('Container does not exist')
289 validate_modification_preconditions(request, meta)
291 response = HttpResponse()
292 put_container_meta(response, meta)
294 path = request.GET.get('path')
295 prefix = request.GET.get('prefix')
296 delimiter = request.GET.get('delimiter')
298 # Path overrides prefix and delimiter.
306 if prefix and delimiter:
307 prefix = prefix + delimiter
310 prefix = prefix.lstrip('/')
312 marker = request.GET.get('marker')
313 limit = request.GET.get('limit')
322 keys = request.GET.get('meta')
324 keys = keys.split(',')
325 keys = [format_meta_key('X-Object-Meta-' + x.strip()) for x in keys if x.strip() != '']
330 objects = backend.list_objects(request.user, v_account, v_container, prefix, delimiter, marker, limit, virtual, keys, until)
332 raise ItemNotFound('Container does not exist')
334 if request.serialization == 'text':
335 if len(objects) == 0:
336 # The cloudfiles python bindings expect 200 if json/xml.
337 response.status_code = 204
339 response.status_code = 200
340 response.content = '\n'.join([x[0] for x in objects]) + '\n'
346 # Virtual objects/directories.
347 object_meta.append({'subdir': x[0]})
350 meta = backend.get_object_meta(request.user, v_account, v_container, x[0], x[1])
351 object_meta.append(printable_meta_dict(meta))
354 if request.serialization == 'xml':
355 data = render_to_string('objects.xml', {'container': v_container, 'objects': object_meta})
356 elif request.serialization == 'json':
357 data = json.dumps(object_meta)
358 response.status_code = 200
359 response.content = data
363 def object_meta(request, v_account, v_container, v_object):
364 # Normal Response Codes: 204
365 # Error Response Codes: serviceUnavailable (503),
366 # itemNotFound (404),
367 # unauthorized (401),
370 version = get_int_parameter(request, 'version')
372 meta = backend.get_object_meta(request.user, v_account, v_container, v_object, version)
374 raise ItemNotFound('Object does not exist')
376 raise ItemNotFound('Version does not exist')
378 update_manifest_meta(request, v_account, meta)
380 response = HttpResponse(status=204)
381 put_object_meta(response, meta)
384 @api_method('GET', format_allowed=True)
385 def object_read(request, v_account, v_container, v_object):
386 # Normal Response Codes: 200, 206
387 # Error Response Codes: serviceUnavailable (503),
388 # rangeNotSatisfiable (416),
389 # preconditionFailed (412),
390 # itemNotFound (404),
391 # unauthorized (401),
395 version = get_int_parameter(request, 'version')
397 version = request.GET.get('version')
399 meta = backend.get_object_meta(request.user, v_account, v_container, v_object, version)
401 raise ItemNotFound('Object does not exist')
403 raise ItemNotFound('Version does not exist')
405 update_manifest_meta(request, v_account, meta)
407 # Evaluate conditions.
408 validate_modification_preconditions(request, meta)
410 validate_matching_preconditions(request, meta)
412 response = HttpResponse(status=304)
413 response['ETag'] = meta['hash']
416 # Reply with the version list.
417 if version == 'list':
418 if request.serialization == 'text':
419 raise BadRequest('No format specified for version list.')
421 d = {'versions': backend.list_versions(request.user, v_account, v_container, v_object)}
422 if request.serialization == 'xml':
423 d['object'] = v_object
424 data = render_to_string('versions.xml', d)
425 elif request.serialization == 'json':
428 response = HttpResponse(data, status=200)
429 put_object_meta(response, meta)
430 response['Content-Length'] = len(data)
435 if 'X-Object-Manifest' in meta:
437 src_container, src_name = split_container_object_string('/' + meta['X-Object-Manifest'])
438 objects = backend.list_objects(request.user, v_account, src_container, prefix=src_name, virtual=False)
440 raise BadRequest('Invalid X-Object-Manifest header')
442 raise ItemNotFound('Container does not exist')
446 s, h = backend.get_object_hashmap(request.user, v_account, src_container, x[0], x[1])
450 raise ItemNotFound('Object does not exist')
452 raise ItemNotFound('Version does not exist')
455 s, h = backend.get_object_hashmap(request.user, v_account, v_container, v_object, version)
459 raise ItemNotFound('Object does not exist')
461 raise ItemNotFound('Version does not exist')
463 # Reply with the hashmap.
464 if request.serialization != 'text':
466 hashmap = sum(hashmaps, [])
467 d = {'block_size': backend.block_size, 'block_hash': backend.hash_algorithm, 'bytes': size, 'hashes': hashmap}
468 if request.serialization == 'xml':
469 d['object'] = v_object
470 data = render_to_string('hashes.xml', d)
471 elif request.serialization == 'json':
474 response = HttpResponse(data, status=200)
475 put_object_meta(response, meta)
476 response['Content-Length'] = len(data)
479 return object_data_response(request, sizes, hashmaps, meta)
482 def object_write(request, v_account, v_container, v_object):
483 # Normal Response Codes: 201
484 # Error Response Codes: serviceUnavailable (503),
485 # unprocessableEntity (422),
486 # lengthRequired (411),
487 # itemNotFound (404),
488 # unauthorized (401),
491 copy_from = request.META.get('HTTP_X_COPY_FROM')
492 move_from = request.META.get('HTTP_X_MOVE_FROM')
493 if copy_from or move_from:
494 # TODO: Why is this required? Copy this ammount?
495 content_length = get_content_length(request)
499 src_container, src_name = split_container_object_string(move_from)
501 raise BadRequest('Invalid X-Move-From header')
502 copy_or_move_object(request, v_account, src_container, src_name, v_container, v_object, move=True)
505 src_container, src_name = split_container_object_string(copy_from)
507 raise BadRequest('Invalid X-Copy-From header')
508 copy_or_move_object(request, v_account, src_container, src_name, v_container, v_object, move=False)
509 return HttpResponse(status=201)
511 meta = get_object_meta(request)
513 if request.META.get('HTTP_TRANSFER_ENCODING') != 'chunked':
514 content_length = get_content_length(request)
515 # Should be BadRequest, but API says otherwise.
516 if 'Content-Type' not in meta:
517 raise LengthRequired('Missing Content-Type header')
522 sock = raw_input_socket(request)
523 for data in socket_read_iterator(sock, content_length, backend.block_size):
524 # TODO: Raise 408 (Request Timeout) if this takes too long.
525 # TODO: Raise 499 (Client Disconnect) if a length is defined and we stop before getting this much data.
527 hashmap.append(backend.put_block(data))
530 meta['hash'] = md5.hexdigest().lower()
531 etag = request.META.get('HTTP_ETAG')
532 if etag and parse_etags(etag)[0].lower() != meta['hash']:
533 raise UnprocessableEntity('Object ETag does not match')
536 backend.update_object_hashmap(request.user, v_account, v_container, v_object, size, hashmap, meta, True)
538 raise ItemNotFound('Container does not exist')
540 response = HttpResponse(status=201)
541 response['ETag'] = meta['hash']
545 def object_copy(request, v_account, v_container, v_object):
546 # Normal Response Codes: 201
547 # Error Response Codes: serviceUnavailable (503),
548 # itemNotFound (404),
549 # unauthorized (401),
552 dest_path = request.META.get('HTTP_DESTINATION')
554 raise BadRequest('Missing Destination header')
556 dest_container, dest_name = split_container_object_string(dest_path)
558 raise BadRequest('Invalid Destination header')
559 copy_or_move_object(request, v_account, v_container, v_object, dest_container, dest_name, move=False)
560 return HttpResponse(status=201)
563 def object_move(request, v_account, v_container, v_object):
564 # Normal Response Codes: 201
565 # Error Response Codes: serviceUnavailable (503),
566 # itemNotFound (404),
567 # unauthorized (401),
570 dest_path = request.META.get('HTTP_DESTINATION')
572 raise BadRequest('Missing Destination header')
574 dest_container, dest_name = split_container_object_string(dest_path)
576 raise BadRequest('Invalid Destination header')
577 copy_or_move_object(request, v_account, v_container, v_object, dest_container, dest_name, move=True)
578 return HttpResponse(status=201)
581 def object_update(request, v_account, v_container, v_object):
582 # Normal Response Codes: 202, 204
583 # Error Response Codes: serviceUnavailable (503),
584 # itemNotFound (404),
585 # unauthorized (401),
588 meta = get_object_meta(request)
589 content_type = meta.get('Content-Type')
591 del(meta['Content-Type']) # Do not allow changing the Content-Type.
594 prev_meta = backend.get_object_meta(request.user, v_account, v_container, v_object)
596 raise ItemNotFound('Object does not exist')
598 # Handle metadata changes.
600 # Keep previous values of 'Content-Type' and 'hash'.
601 for k in ('Content-Type', 'hash'):
603 meta[k] = prev_meta[k]
605 backend.update_object_meta(request.user, v_account, v_container, v_object, meta, replace=True)
607 raise ItemNotFound('Object does not exist')
609 # A Content-Type or Content-Range header may indicate data updates.
610 if content_type and content_type.startswith('multipart/byteranges'):
611 # TODO: Support multiple update ranges.
612 return HttpResponse(status=202)
613 # Single range update. Range must be in Content-Range.
614 # Based on: http://code.google.com/p/gears/wiki/ContentRangePostProposal
615 # (with the addition that '*' is allowed for the range - will append).
616 if content_type and content_type != 'application/octet-stream':
617 return HttpResponse(status=202)
618 content_range = request.META.get('HTTP_CONTENT_RANGE')
619 if not content_range:
620 return HttpResponse(status=202)
621 ranges = get_content_range(request)
623 return HttpResponse(status=202)
624 # Require either a Content-Length, or 'chunked' Transfer-Encoding.
626 if request.META.get('HTTP_TRANSFER_ENCODING') != 'chunked':
627 content_length = get_content_length(request)
630 size, hashmap = backend.get_object_hashmap(request.user, v_account, v_container, v_object)
632 raise ItemNotFound('Object does not exist')
634 offset, length, total = ranges
637 if length is None or content_length == -1:
638 length = content_length # Nevermind the error.
639 elif length != content_length:
640 raise BadRequest('Content length does not match range length')
641 if total is not None and (total != size or offset >= size or (length > 0 and offset + length >= size)):
642 raise RangeNotSatisfiable('Supplied range will change provided object limits')
644 sock = raw_input_socket(request)
646 for d in socket_read_iterator(sock, length, backend.block_size):
647 # TODO: Raise 408 (Request Timeout) if this takes too long.
648 # TODO: Raise 499 (Client Disconnect) if a length is defined and we stop before getting this much data.
650 bi = int(offset / backend.block_size)
651 bo = offset % backend.block_size
652 bl = min(len(data), backend.block_size - bo)
654 h = backend.update_block(hashmap[bi], data[:bl], bo)
655 if bi < len(hashmap):
661 bi = int(offset / backend.block_size)
663 h = backend.update_block(hashmap[bi], data)
664 if bi < len(hashmap):
671 meta = {'hash': hashmap_hash(hashmap)} # Update ETag.
673 backend.update_object_hashmap(request.user, v_account, v_container, v_object, size, hashmap, meta, False)
675 raise ItemNotFound('Container does not exist')
677 response = HttpResponse(status=204)
678 response['ETag'] = meta['hash']
681 @api_method('DELETE')
682 def object_delete(request, v_account, v_container, v_object):
683 # Normal Response Codes: 204
684 # Error Response Codes: serviceUnavailable (503),
685 # itemNotFound (404),
686 # unauthorized (401),
690 backend.delete_object(request.user, v_account, v_container, v_object)
692 raise ItemNotFound('Object does not exist')
693 return HttpResponse(status=204)
696 def method_not_allowed(request):
697 raise BadRequest('Method not allowed')