Module code

Source code for oio.common.fullpath

# Copyright (C) 2018 OpenIO SAS, as part of OpenIO SDS
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3.0 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library.

from urllib import quote, unquote, quote_plus, unquote_plus


def encode_fullpath(account, container, path, version, content_id):
    for k, v in locals().items():
        if not v:
            raise ValueError("Can't encode fullpath: missing %s" % k)
    if isinstance(account, unicode):
        account = account.encode('utf-8')
    if isinstance(container, unicode):
        container = container.encode('utf-8')
    if isinstance(path, unicode):
        path = path.encode('utf-8')
    return '{0}/{1}/{2}/{3}/{4}'.format(quote(account, ''),
                                        quote(container, ''),
                                        quote(path, ''),
                                        quote(str(version), ''),
                                        quote(content_id, ''))


def decode_fullpath(fullpath):
    """
    Decode a "fullpath" string, extract its 5 parts.

    :raises: ValueError if the string has invalid format.
    :returns: account, container, path, version and content ID.
    """
    fp = fullpath.split('/')
    if len(fp) != 5:
        raise ValueError("fullpath: invalid format")
    decoded = list()
    for part in fp:
        decoded.append(unquote(part))
    return tuple(decoded)


def encode_old_fullpath(account, container, path, version):
    if not account or not container or not path or not version:
        raise ValueError("Can't encode old fullpath")
    return '{0}/{1}/{2}/{3}'.format(quote_plus(account, ''),
                                    quote_plus(container, ''),
                                    quote_plus(path, ''),
                                    quote_plus(str(version), ''))


def decode_old_fullpath(fullpath):
    fp = fullpath.split('/')
    if len(fp) != 4:
        raise ValueError("old fullpath: Wrong format")
    decoded = list()
    for part in fp:
        decoded.append(unquote_plus(part))
    return tuple(decoded)