New public objects implementation.
[pithos] / pithos / api / util.py
index 9ec9862..342242e 100644 (file)
@@ -41,10 +41,12 @@ from django.conf import settings
 from django.http import HttpResponse
 from django.utils.http import http_date, parse_etags
 
-from pithos.api.compat import parse_http_date_safe
-from pithos.api.faults import (Fault, NotModified, BadRequest, ItemNotFound, LengthRequired,
-                                PreconditionFailed, RangeNotSatisfiable, ServiceUnavailable)
+from pithos.api.compat import parse_http_date_safe, parse_http_date
+from pithos.api.faults import (Fault, NotModified, BadRequest, Unauthorized, ItemNotFound,
+                                LengthRequired, PreconditionFailed, RangeNotSatisfiable,
+                                ServiceUnavailable)
 from pithos.backends import backend
+from pithos.backends.base import NotAllowedError
 
 import datetime
 import logging
@@ -56,7 +58,7 @@ import uuid
 logger = logging.getLogger(__name__)
 
 
-def printable_meta_dict(d):
+def printable_header_dict(d):
     """Format a meta dictionary for printing out json/xml.
     
     Convert all keys to lower case and replace dashes to underscores.
@@ -68,26 +70,31 @@ def printable_meta_dict(d):
         del(d['modified'])
     return dict([(k.lower().replace('-', '_'), v) for k, v in d.iteritems()])
 
-def format_meta_key(k):
+def format_header_key(k):
     """Convert underscores to dashes and capitalize intra-dash strings."""
     
     return '-'.join([x.capitalize() for x in k.replace('_', '-').split('-')])
 
-def get_meta_prefix(request, prefix):
-    """Get all prefix-* request headers in a dict. Reformat keys with format_meta_key()."""
+def get_header_prefix(request, prefix):
+    """Get all prefix-* request headers in a dict. Reformat keys with format_header_key()."""
     
     prefix = 'HTTP_' + prefix.upper().replace('-', '_')
-    return dict([(format_meta_key(k[5:]), v) for k, v in request.META.iteritems() if k.startswith(prefix)])
-
-def get_account_meta(request):
-    """Get metadata from an account request."""
-    
-    meta = get_meta_prefix(request, 'X-Account-Meta-')    
-    return meta
-
-def put_account_meta(response, meta):
-    """Put metadata in an account response."""
-    
+    # TODO: Document or remove '~' replacing.
+    return dict([(format_header_key(k[5:]), v.replace('~', '')) for k, v in request.META.iteritems() if k.startswith(prefix) and len(k) > len(prefix)])
+
+def get_account_headers(request):
+    meta = get_header_prefix(request, 'X-Account-Meta-')
+    groups = {}
+    for k, v in get_header_prefix(request, 'X-Account-Group-').iteritems():
+        n = k[16:].lower()
+        if '-' in n or '_' in n:
+            raise BadRequest('Bad characters in group name')
+        groups[n] = v.replace(' ', '').split(',')
+        if '' in groups[n]:
+            groups[n].remove('')
+    return meta, groups
+
+def put_account_headers(response, meta, groups):
     response['X-Account-Container-Count'] = meta['count']
     response['X-Account-Bytes-Used'] = meta['bytes']
     if 'modified' in meta:
@@ -96,16 +103,15 @@ def put_account_meta(response, meta):
         response[k.encode('utf-8')] = meta[k].encode('utf-8')
     if 'until_timestamp' in meta:
         response['X-Account-Until-Timestamp'] = http_date(int(meta['until_timestamp']))
+    for k, v in groups.iteritems():
+        response[format_header_key('X-Account-Group-' + k).encode('utf-8')] = (','.join(v)).encode('utf-8')
 
-def get_container_meta(request):
-    """Get metadata from a container request."""
-    
-    meta = get_meta_prefix(request, 'X-Container-Meta-')
-    return meta
+def get_container_headers(request):
+    meta = get_header_prefix(request, 'X-Container-Meta-')
+    policy = dict([(k[19:].lower(), v.replace(' ', '')) for k, v in get_header_prefix(request, 'X-Container-Policy-').iteritems()])
+    return meta, policy
 
-def put_container_meta(response, meta):
-    """Put metadata in a container response."""
-    
+def put_container_headers(response, meta, policy):
     response['X-Container-Object-Count'] = meta['count']
     response['X-Container-Bytes-Used'] = meta['bytes']
     response['Last-Modified'] = http_date(int(meta['modified']))
@@ -116,11 +122,11 @@ def put_container_meta(response, meta):
     response['X-Container-Block-Hash'] = backend.hash_algorithm
     if 'until_timestamp' in meta:
         response['X-Container-Until-Timestamp'] = http_date(int(meta['until_timestamp']))
+    for k, v in policy.iteritems():
+        response[format_header_key('X-Container-Policy-' + k).encode('utf-8')] = v.encode('utf-8')
 
-def get_object_meta(request):
-    """Get metadata from an object request."""
-    
-    meta = get_meta_prefix(request, 'X-Object-Meta-')
+def get_object_headers(request):
+    meta = get_header_prefix(request, 'X-Object-Meta-')
     if request.META.get('CONTENT_TYPE'):
         meta['Content-Type'] = request.META['CONTENT_TYPE']
     if request.META.get('HTTP_CONTENT_ENCODING'):
@@ -129,24 +135,20 @@ def get_object_meta(request):
         meta['Content-Disposition'] = request.META['HTTP_CONTENT_DISPOSITION']
     if request.META.get('HTTP_X_OBJECT_MANIFEST'):
         meta['X-Object-Manifest'] = request.META['HTTP_X_OBJECT_MANIFEST']
-    if request.META.get('HTTP_X_OBJECT_PUBLIC'):
-        meta['X-Object-Public'] = request.META['HTTP_X_OBJECT_PUBLIC']
-    return meta
+    return meta, get_sharing(request), get_public(request)
 
-def put_object_meta(response, meta, public=False):
-    """Put metadata in an object response."""
-    
+def put_object_headers(response, meta, restricted=False):
     response['ETag'] = meta['hash']
     response['Content-Length'] = meta['bytes']
     response['Content-Type'] = meta.get('Content-Type', 'application/octet-stream')
     response['Last-Modified'] = http_date(int(meta['modified']))
-    if not public:
+    if not restricted:
+        response['X-Object-Modified-By'] = meta['modified_by']
         response['X-Object-Version'] = meta['version']
-        response['X-Object-Version-Timestamp'] = meta['version_timestamp']
-        response['X-Object-Size'] = meta['bytes']
+        response['X-Object-Version-Timestamp'] = http_date(int(meta['version_timestamp']))
         for k in [x for x in meta.keys() if x.startswith('X-Object-Meta-')]:
             response[k.encode('utf-8')] = meta[k].encode('utf-8')
-        for k in ('Content-Encoding', 'Content-Disposition', 'X-Object-Manifest', 'X-Object-Public'):
+        for k in ('Content-Encoding', 'Content-Disposition', 'X-Object-Manifest', 'X-Object-Sharing', 'X-Object-Shared-By', 'X-Object-Public'):
             if k in meta:
                 response[k] = meta[k]
     else:
@@ -175,6 +177,28 @@ def update_manifest_meta(request, v_account, meta):
         md5.update(hash)
         meta['hash'] = md5.hexdigest().lower()
 
+def update_sharing_meta(permissions, v_account, v_container, v_object, meta):
+    if permissions is None:
+        return
+    perm_path, perms = permissions
+    if len(perms) == 0:
+        return
+    ret = []
+    r = ','.join(perms.get('read', []))
+    if r:
+        ret.append('read=' + r)
+    w = ','.join(perms.get('write', []))
+    if w:
+        ret.append('write=' + w)
+    meta['X-Object-Sharing'] = '; '.join(ret)
+    if '/'.join((v_account, v_container, v_object)) != perm_path:
+        meta['X-Object-Shared-By'] = perm_path
+
+def update_public_meta(public, meta):
+    if not public:
+        return
+    meta['X-Object-Public'] = public
+
 def validate_modification_preconditions(request, meta):
     """Check that the modified timestamp conforms with the preconditions set."""
     
@@ -221,26 +245,28 @@ def split_container_object_string(s):
 def copy_or_move_object(request, v_account, src_container, src_name, dest_container, dest_name, move=False):
     """Copy or move an object."""
     
-    meta = get_object_meta(request)
-    # Keep previous values of 'Content-Type' (if a new one is absent) and 'hash'.
-    try:
-        src_meta = backend.get_object_meta(request.user, v_account, src_container, src_name)
-    except NameError:
-        raise ItemNotFound('Container or object does not exist')
-    if 'Content-Type' in meta and 'Content-Type' in src_meta:
-        del(src_meta['Content-Type'])
-    for k in ('Content-Type', 'hash'):
-        if k in src_meta:
-            meta[k] = src_meta[k]
-    
-    src_version = request.META.get('HTTP_X_SOURCE_VERSION')
+    meta, permissions, public = get_object_headers(request)
+    src_version = request.META.get('HTTP_X_SOURCE_VERSION')    
     try:
         if move:
-            backend.move_object(request.user, v_account, src_container, src_name, dest_container, dest_name, meta, True, src_version)
+            backend.move_object(request.user, v_account, src_container, src_name, dest_container, dest_name, meta, False, permissions)
         else:
-            backend.copy_object(request.user, v_account, src_container, src_name, dest_container, dest_name, meta, True, src_version)
-    except NameError:
+            backend.copy_object(request.user, v_account, src_container, src_name, dest_container, dest_name, meta, False, permissions, src_version)
+    except NotAllowedError:
+        raise Unauthorized('Access denied')
+    except NameError, IndexError:
         raise ItemNotFound('Container or object does not exist')
+    except ValueError:
+        raise BadRequest('Invalid sharing header')
+    except AttributeError:
+        raise Conflict('Sharing already set above or below this path in the hierarchy')
+    if public is not None:
+        try:
+            backend.update_object_public(request.user, v_account, v_container, v_object, public)
+        except NotAllowedError:
+            raise Unauthorized('Access denied')
+        except NameError:
+            raise ItemNotFound('Object does not exist')
 
 def get_int_parameter(request, name):
     p = request.GET.get(name)
@@ -342,6 +368,58 @@ def get_content_range(request):
         length = upto - offset + 1
     return (offset, length, total)
 
+def get_sharing(request):
+    """Parse an X-Object-Sharing header from the request.
+    
+    Raises BadRequest on error.
+    """
+    
+    permissions = request.META.get('HTTP_X_OBJECT_SHARING')
+    if permissions is None:
+        return None
+    
+    ret = {}
+    permissions = permissions.replace(' ', '')
+    if permissions == '':
+        return ret
+    for perm in (x for x in permissions.split(';')):
+        if perm.startswith('read='):
+            ret['read'] = [v.replace(' ','').lower() for v in perm[5:].split(',')]
+            if '' in ret['read']:
+                ret['read'].remove('')
+            if '*' in ret['read']:
+                ret['read'] = ['*']
+            if len(ret['read']) == 0:
+                raise BadRequest('Bad X-Object-Sharing header value')
+        elif perm.startswith('write='):
+            ret['write'] = [v.replace(' ','').lower() for v in perm[6:].split(',')]
+            if '' in ret['write']:
+                ret['write'].remove('')
+            if '*' in ret['write']:
+                ret['write'] = ['*']
+            if len(ret['write']) == 0:
+                raise BadRequest('Bad X-Object-Sharing header value')
+        else:
+            raise BadRequest('Bad X-Object-Sharing header value')
+    return ret
+
+def get_public(request):
+    """Parse an X-Object-Public header from the request.
+    
+    Raises BadRequest on error.
+    """
+    
+    public = request.META.get('HTTP_X_OBJECT_PUBLIC')
+    if public is None:
+        return None
+    
+    public = public.replace(' ', '').lower()
+    if public == 'true':
+        return True
+    elif public == 'false' or public == '':
+        return False
+    raise BadRequest('Bad X-Object-Public header value')
+
 def raw_input_socket(request):
     """Return the socket for reading the rest of the request."""
     
@@ -508,8 +586,21 @@ def object_data_response(request, sizes, hashmaps, meta, public=False):
                     offset < 0 or offset >= size or
                     offset + length > size]
         if len(check) > 0:
-            raise RangeNotSatisfiable('Requested range exceeds object limits')        
+            raise RangeNotSatisfiable('Requested range exceeds object limits')
         ret = 206
+        if_range = request.META.get('HTTP_IF_RANGE', '')
+        if if_range and if_range.startswith('If-Range:'):
+            if_range = if_range.split('If-Range:')[1]
+            try:
+                # modification time has passed instead
+                last_modified = parse_http_date(if_range)
+                if last_modified != meta['modified']:
+                    ranges = [(0, size)]
+                    ret = 200
+            except ValueError:
+                if if_range != meta['hash']:
+                    ranges = [(0, size)]
+                    ret = 200
     
     if ret == 206 and len(ranges) > 1:
         boundary = uuid.uuid4().hex
@@ -517,7 +608,7 @@ def object_data_response(request, sizes, hashmaps, meta, public=False):
         boundary = ''
     wrapper = ObjectWrapper(ranges, sizes, hashmaps, boundary)
     response = HttpResponse(wrapper, status=ret)
-    put_object_meta(response, meta, public)
+    put_object_headers(response, meta, public)
     if ret == 206:
         if len(ranges) == 1:
             offset, length = ranges[0]
@@ -528,6 +619,18 @@ def object_data_response(request, sizes, hashmaps, meta, public=False):
             response['Content-Type'] = 'multipart/byteranges; boundary=%s' % (boundary,)
     return response
 
+def put_object_block(hashmap, data, offset):
+    """Put one block of data at the given offset."""
+    
+    bi = int(offset / backend.block_size)
+    bo = offset % backend.block_size
+    bl = min(len(data), backend.block_size - bo)
+    if bi < len(hashmap):
+        hashmap[bi] = backend.update_block(hashmap[bi], data[:bl], bo)
+    else:
+        hashmap.append(backend.put_block(('\x00' * bo) + data[:bl]))
+    return bl # Return ammount of data written.
+
 def hashmap_hash(hashmap):
     """Produce the root hash, treating the hashmap as a Merkle-like tree."""
     
@@ -612,8 +715,6 @@ def api_method(http_method=None, format_allowed=False):
                 
                 # Fill in custom request variables.
                 request.serialization = request_serialization(request, format_allowed)
-                # TODO: Authenticate.
-                request.user = "test"
                 
                 response = func(request, *args, **kwargs)
                 update_response_headers(request, response)