# Copyright (C) 2013 Red Hat, Inc., Flavio Percoco <fpercoco@redhat.com>
# Copyright (C) 2012 Rackspace US, Inc.,
#                    Justin Shepherd <jshepher@rackspace.com>
# Copyright (C) 2009 Red Hat, Inc., Joey Boggs <jboggs@redhat.com>
# Copyright (C) 2017 Red Hat, Inc., Martin Schuppert <mschuppert@redhat.com>

# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

import os
from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin


class OpenStackGlance(Plugin):

    short_desc = 'OpenStack Glance'
    plugin_name = "openstack_glance"
    profiles = ('openstack', 'openstack_controller')
    containers = ('glance_api',)

    var_puppet_gen = "/var/lib/config-data/puppet-generated/glance_api"
    service_name = "openstack-glance-api.service"

    def setup(self):
        if self.get_option("all_logs"):
            self.add_copy_spec([
                "/var/log/glance/",
            ])
        else:
            self.add_copy_spec([
                "/var/log/glance/*.log",
            ])

        self.add_copy_spec([
            "/etc/glance/",
            self.var_puppet_gen + "/etc/glance/",
            self.var_puppet_gen + "/etc/my.cnf.d/tripleo.cnf"
        ])

        # collect commands output only if the openstack-glance-api service
        # is running
        in_container = self.container_exists('glance_api')

        if self.is_service_running(self.service_name) or in_container:
            glance_config = ""
            # if containerized we need to pass the config to the cont.
            if in_container:
                glance_config = "--config-dir " + self.var_puppet_gen + \
                                "/etc/glance/"

            self.add_cmd_output(
                "glance-manage " + glance_config + " db_version",
                suggest_filename="glance_db_version"
            )

            vars_all = [p in os.environ for p in [
                        'OS_USERNAME', 'OS_PASSWORD']]

            vars_any = [p in os.environ for p in [
                        'OS_TENANT_NAME', 'OS_PROJECT_NAME']]

            if not (all(vars_all) and any(vars_any)):
                self.soslog.warning("Not all environment variables set. "
                                    "Source the environment file for the user "
                                    "intended to connect to the OpenStack "
                                    "environment.")
            else:
                res = self.collect_cmd_output(
                    "openstack image list --long"
                )

                if res['status'] == 0:
                    glance_images = res['output']
                    for image in glance_images.splitlines()[3:-1]:
                        image = image.split()[1]
                        cmd = f"openstack image show {image}"
                        self.add_cmd_output(cmd)

        self.add_file_tags({
            "/etc/glance/glance-api.conf": "glance_api_conf",
            "/etc/glance/glance-cache.conf": "glance_cache_conf",
            "/etc/glance/glance-registry.conf": "glance_registry_conf",
            "/var/log/glance/api.log": "glance_api_log"
        })

    def apply_regex_sub(self, regexp, subst):
        """ Apply regex substitution """
        self.do_path_regex_sub("/etc/glance/*", regexp, subst)
        self.do_path_regex_sub(
            self.var_puppet_gen + "/etc/glance/*",
            regexp, subst
        )

    def postproc(self):
        protect_keys = [
            "admin_password", "password", "qpid_password", "rabbit_password",
            "s3_store_secret_key", "ssl_key_password",
            "vmware_server_password", "transport_url",
            "memcache_secret_key"
        ]
        connection_keys = ["connection"]

        self.apply_regex_sub(
            fr"(^\s*({'|'.join(protect_keys)})\s*=\s*)(.*)",
            r"\1*********"
        )

        join_con_keys = "|".join(connection_keys)

        self.apply_regex_sub(
            fr"(^\s*({join_con_keys})\s*=\s*(.*)://(\w*):)(.*)(@(.*))",
            r"\1*********\6"
        )


class DebianGlance(OpenStackGlance, DebianPlugin, UbuntuPlugin):

    packages = (
        'glance',
        'glance-api',
        'glance-client',
        'glance-common',
        'glance-registry',
        'python-glance',
        'python3-glance',
    )
    service_name = 'apache2.service'


class RedHatGlance(OpenStackGlance, RedHatPlugin):

    packages = ('openstack-selinux',)

# vim: set et ts=4 sw=4 :
