Mini Shell

"""
Swift utility class
===================
Author: Anthony Stanton <anthony.stanton@gmail.com>
"""

import logging
import sys
from errno import EEXIST
from os import makedirs
from os.path import dirname, isdir

import salt.utils.files

# Get logging started
log = logging.getLogger(__name__)

HAS_SWIFT = False
try:
    from swiftclient import client

    HAS_SWIFT = True
except ImportError:
    pass


def check_swift():
    return HAS_SWIFT


def mkdirs(path):
    try:
        makedirs(path)
    except OSError as err:
        if err.errno != EEXIST:
            raise


# we've been playing fast and loose with kwargs, but the swiftclient isn't
# going to accept any old thing
def _sanitize(kwargs):
    variables = (
        "user",
        "key",
        "authurl",
        "retries",
        "preauthurl",
        "preauthtoken",
        "snet",
        "starting_backoff",
        "max_backoff",
        "tenant_name",
        "os_options",
        "auth_version",
        "cacert",
        "insecure",
        "ssl_compression",
    )
    ret = {}
    for var in kwargs:
        if var in variables:
            ret[var] = kwargs[var]

    return ret


class SaltSwift:
    """
    Class for all swiftclient functions
    """

    def __init__(
        self, user, tenant_name, auth_url, password=None, auth_version=2, **kwargs
    ):
        """
        Set up openstack credentials
        """
        if not HAS_SWIFT:
            log.error(
                "Error:: unable to find swiftclient. Try installing it from the"
                " appropriate repository."
            )
            return None

        self.kwargs = kwargs.copy()
        self.kwargs["user"] = user
        self.kwargs["password"] = password
        self.kwargs["tenant_name"] = tenant_name
        self.kwargs["authurl"] = auth_url
        self.kwargs["auth_version"] = auth_version
        if "key" not in self.kwargs:
            self.kwargs["key"] = password

        self.kwargs = _sanitize(self.kwargs)

        self.conn = client.Connection(**self.kwargs)

    def get_account(self):
        """
        List Swift containers
        """
        try:
            listing = self.conn.get_account()
            return listing
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def get_container(self, cont):
        """
        List files in a Swift container
        """
        try:
            listing = self.conn.get_container(cont)
            return listing
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def put_container(self, cont):
        """
        Create a new Swift container
        """
        try:
            self.conn.put_container(cont)
            return True
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def delete_container(self, cont):
        """
        Delete a Swift container
        """
        try:
            self.conn.delete_container(cont)
            return True
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def post_container(self, cont, metadata=None):
        """
        Update container metadata
        """

    def head_container(self, cont):
        """
        Get container metadata
        """

    def get_object(self, cont, obj, local_file=None, return_bin=False):
        """
        Retrieve a file from Swift
        """
        try:
            if local_file is None and return_bin is False:
                return False

            headers, body = self.conn.get_object(cont, obj, resp_chunk_size=65536)

            if return_bin is True:
                fp = sys.stdout
            else:
                dirpath = dirname(local_file)
                if dirpath and not isdir(dirpath):
                    mkdirs(dirpath)
                # pylint: disable=resource-leakage
                fp = salt.utils.files.fopen(local_file, "wb")
                # pylint: enable=resource-leakage

            read_length = 0
            for chunk in body:
                read_length += len(chunk)
                fp.write(chunk)
            fp.close()
            return True

        # ClientException
        # file/dir exceptions
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def put_object(self, cont, obj, local_file):
        """
        Upload a file to Swift
        """
        try:
            with salt.utils.files.fopen(local_file, "rb") as fp_:
                self.conn.put_object(cont, obj, fp_)
            return True
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def delete_object(self, cont, obj):
        """
        Delete a file from Swift
        """
        try:
            self.conn.delete_object(cont, obj)
            return True
        except Exception as exc:  # pylint: disable=broad-except
            log.error("There was an error::")
            if hasattr(exc, "code") and hasattr(exc, "msg"):
                log.error("    Code: %s: %s", exc.code, exc.msg)
            log.error("    Content: \n%s", getattr(exc, "read", lambda: str(exc))())
            return False

    def head_object(self, cont, obj):
        """
        Get object metadata
        """

    def post_object(self, cont, obj, metadata):
        """
        Update object metadata
        """