Synnefo » Pithos

==============

.. automodule:: pithos.lib.client

0.5 (July 19, 2011)        Object update from another object's data.

\                          List other accounts that share objects with a user.

GET        Authentication (for compatibility with the OOS API) or list allowed accounts

If an ``X-Auth-Token`` is already present, the operation will be interpreted as a request to list other accounts that share objects to the user.

======================  =========================

Request Parameter Name  Value

======================  =========================

limit                   The amount of results requested (default is 10000)

marker                  Return containers with name lexicographically after marker

format                  Optional extended reply type (can be ``json`` or ``xml``)

======================  =========================

The reply is a list of account names.

If a ``format=xml`` or ``format=json`` argument is given, extended information on the containers will be returned, serialized in the chosen format.

For each account, the information will include the following (names will be in lower case and with hyphens replaced with underscores):

===========================  ============================

Name                         Description

===========================  ============================

name                         The name of the account

last_modified                The last container modification date (regardless of ``until``)

===========================  ============================

Example ``format=json`` reply:

::

  [{"name": "user", "last_modified": "2011-07-19T10:48:16"}, ...]

Example ``format=xml`` reply:

::

  <?xml version="1.0" encoding="UTF-8"?>

  <accounts>

    <account>

      <name>user</name>

      <last_modified>2011-07-19T10:48:16</last_modified>

    </account>

    <account>...</account>

  </accounts>

===========================  =====================

Return Code                  Description

===========================  =====================

200 (OK)                     The request succeeded

204 (No Content)             The account has no containers (only for non-extended replies)

===========================  =====================

Will use a ``200`` return code if the reply is of type json/xml.

Cross-user requests are not allowed to use ``until`` and only include the account modification date in the reply.

Cross-user requests are not allowed to use ``until`` and only include the account/container modification dates in the reply.

Cross-user requests are not allowed to use ``until`` and only include the container modification date in the reply.

Cross-user requests are not allowed to use ``until`` and include the following limited set of headers in the reply:

===========================  ===============================

Reply Header Name            Value

===========================  ===============================

X-Container-Block-Size       The block size used by the storage backend

X-Container-Block-Hash       The hash algorithm used for block identifiers in object hashmaps

X-Container-Object-Meta      A list with all meta keys used by allowed objects (**TBD**)

Last-Modified                The last container modification date

===========================  ===============================

A user may ``GET`` another account or container. The result will include a limited reply, containing only the allowed containers or objects respectively. A top-level request with an authentication token, will return a list of allowed accounts, so the user can easily find out which other users share objects.

Objects that are marked as public, via the ``X-Object-Public`` meta, are also available at the corresponding URI returned for ``HEAD`` or ``GET``. Requests for public objects do not need to include an ``X-Auth-Token``. Pithos will ignore request parameters and only include the following headers in the reply (all ``X-Object-*`` meta is hidden):

Public objects are not included and do not influence cross-user listings. They are, however, readable by all users.

* Sharing/publishing with ``X-Object-Sharing``, ``X-Object-Public`` at the object level. Cross-user operations are allowed - controlled by sharing directives. Permissions may include groups defined with ``X-Account-Group-*`` at the account level. These apply to the object - not its versions.

        if request.user:

            return account_list(request)

@api_method('GET', format_allowed=True)

def account_list(request):

    # Normal Response Codes: 200, 204

    # Error Response Codes: serviceUnavailable (503),

    #                       badRequest (400)

    response = HttpResponse()

    marker = request.GET.get('marker')

    limit = get_int_parameter(request.GET.get('limit'))

    if not limit:

        limit = 10000

    accounts = backend.list_accounts(request.user, marker, limit)

    if request.serialization == 'text':

        if len(accounts) == 0:

            # The cloudfiles python bindings expect 200 if json/xml.

            response.status_code = 204

            return response

        response.status_code = 200

        response.content = '\n'.join(accounts) + '\n'

        return response

    account_meta = []

    for x in accounts:

        try:

            meta = backend.get_account_meta(request.user, x)

            groups = backend.get_account_groups(request.user, x)

        except NotAllowedError:

            raise Unauthorized('Access denied')

        else:

            for k, v in groups.iteritems():

                meta['X-Container-Group-' + k] = ','.join(v)

            account_meta.append(printable_header_dict(meta))

    if request.serialization == 'xml':

        data = render_to_string('accounts.xml', {'accounts': account_meta})

    elif request.serialization  == 'json':

        data = json.dumps(account_meta)

    response.status_code = 200

    response.content = data

    return response

    limit = get_int_parameter(request.GET.get('limit'))

    if not limit:

        limit = 10000

        response.content = '\n'.join(containers) + '\n'

        try:

            meta = backend.get_container_meta(request.user, v_account, x, until)

            policy = backend.get_container_policy(request.user, v_account, x)

        except NotAllowedError:

            raise Unauthorized('Access denied')

        except NameError:

            pass

        else:

            for k, v in policy.iteritems():

                meta['X-Container-Policy-' + k] = v

            container_meta.append(printable_header_dict(meta))

    limit = get_int_parameter(request.GET.get('limit'))

    if not limit:

        limit = 10000

    if 'count' in meta:

        response['X-Account-Container-Count'] = meta['count']

    if 'bytes' in meta:

        response['X-Account-Bytes-Used'] = meta['bytes']

    if 'count' in meta:

        response['X-Container-Object-Count'] = meta['count']

    if 'bytes' in meta:

        response['X-Container-Bytes-Used'] = meta['bytes']

    def list_accounts(self, user, marker=None, limit=10000):

        """Return a list of accounts the user can access.

        Parameters:

            'marker': Start list from the next item after 'marker'

            'limit': Number of containers to return

        """

        return []

        """Return a list of container names existing under an account.

    def list_accounts(self, user, marker=None, limit=10000):

        """Return a list of accounts the user can access."""

        allowed = self._allowed_accounts(user)

        start, limit = self._list_limits(allowed, marker, limit)

        return allowed[start:start + limit]

    @backend_method

            if until or account not in self._allowed_accounts(user):

                raise NotAllowedError

        if user != account:

            meta = {'name': account}

        else:

            meta = self._get_metadata(account, version_id)

            meta.update({'name': account, 'count': count, 'bytes': bytes})

            if until is not None:

                meta.update({'until_timestamp': tstamp})

            if account not in self._allowed_accounts(user):

                raise NotAllowedError

            return {}

            if until or account not in self._allowed_accounts(user):

            allowed = self._allowed_containers(user, account)

            start, limit = self._list_limits(allowed, marker, limit)

            return allowed[start:start + limit]

        return [x[0] for x in self._list_objects(account, '', '/', marker, limit, False, [], until)]

            if until or container not in self._allowed_containers(user, account):

                raise NotAllowedError

        if user != account:

            meta = {'name': container, 'modified': modified}

        else:

            meta = self._get_metadata(path, version_id)

            meta.update({'name': container, 'count': count, 'bytes': bytes, 'modified': modified})

            if until is not None:

                meta.update({'until_timestamp': tstamp})

            if container not in self._allowed_containers(user, account):

                raise NotAllowedError

            return {}

        allowed = []

            if until:

                raise NotAllowedError

            allowed = self._allowed_paths(user, os.path.join(account, container))

            if not allowed:

                raise NotAllowedError

        return self._list_objects(path, prefix, delimiter, marker, limit, virtual, keys, until, allowed)

        allowed = []

            if until:

                raise NotAllowedError

            allowed = self._allowed_paths(user, os.path.join(account, container))

            if not allowed:

                raise NotAllowedError

        param = (path + '/%',)

        if allowed:

            for x in allowed:

                sql += ' and o.name like ?'

                param += (x,)

        c = self.con.execute(sql, param)

    def _list_limits(self, listing, marker, limit):

        start = 0

        if marker:

            try:

                start = listing.index(marker) + 1

            except ValueError:

                pass

        if not limit or limit > 10000:

            limit = 10000

        return start, limit

    def _list_objects(self, path, prefix='', delimiter=None, marker=None, limit=10000, virtual=True, keys=[], until=None, allowed=[]):

                        m.version_id = o.version_id and m.key in (%s)'''

            if allowed:

                for x in allowed:

                    sql += ' and o.name like ?'

                    param += (x,)

            sql += ' order by o.name'

            sql = 'select name, version_id from (%s) where name like ?'

            if allowed:

                for x in allowed:

                    sql += ' and name like ?'

                    param += (x,)

            sql += ' order by name'

        start, limit = self._list_limits([x[0] for x in objects], marker, limit)