# vim: tabstop=4 shiftwidth=4 softtabstop=4

#    Copyright (C) 2012 Yahoo! Inc. All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.


from devstack import log as logging
from devstack import packager as pack
from devstack import shell as sh

LOG = logging.getLogger("devstack.packaging.apt")

# Base apt commands
APT_GET = ['apt-get']
APT_PURGE = ["purge", "-y"]
APT_REMOVE = ["remove", "-y"]
APT_INSTALL = ["install", "-y"]
APT_AUTOREMOVE = ['autoremove', '-y']

# Should we use remove or purge?
APT_DO_REMOVE = APT_PURGE

# Make sure its non-interactive
# http://awaseconfigurations.wordpress.com/tag/debian_frontend/
ENV_ADDITIONS = {'DEBIAN_FRONTEND': 'noninteractive'}

# Apt separates its pkg names and versions with a equal sign
VERSION_TEMPL = "%s=%s"


class AptPackager(pack.Packager):
    def __init__(self, distro, keep_packages):
        pack.Packager.__init__(self, distro, keep_packages)
        self.auto_remove = True

    def _format_pkg_name(self, name, version):
        if version:
            return VERSION_TEMPL % (name, version)
        else:
            return name

    def _execute_apt(self, cmd, **kargs):
        full_cmd = APT_GET + cmd
        return sh.execute(*full_cmd, run_as_root=True,
            check_exit_code=True,
            env_overrides=ENV_ADDITIONS,
            **kargs)

    def _remove_batch(self, pkgs):
        cmds = []
        which_removed = []
        for info in pkgs:
            name = info['name']
            removable = info.get('removable', True)
            if not removable:
                continue
            if self._remove_special(name, info):
                which_removed.append(name)
                continue
            pkg_full = self._format_pkg_name(name, info.get("version"))
            if pkg_full:
                cmds.append(pkg_full)
                which_removed.append(name)
        if cmds:
            cmd = APT_DO_REMOVE + cmds
            self._execute_apt(cmd)
        if which_removed and self.auto_remove:
            cmd = APT_AUTOREMOVE
            self._execute_apt(cmd)
        return which_removed

    def install(self, pkg):
        name = pkg['name']
        if self._install_special(name, pkg):
            return
        else:
            pkg_full = self._format_pkg_name(name, pkg.get("version"))
            if pkg_full:
                cmd = APT_INSTALL + [pkg_full]
                self._execute_apt(cmd)

    def _remove_special(self, name, info):
        return False

    def _install_special(self, name, info):
        return False