#!/usr/bin/python
#
# Entropy Server QA executable hook.
# This file doesn't strictly need to be a shell script, but just an executable
# file (r-xr-xr-x) and (mandatory) owned by root:root.
# Please rename this file by stripping the .example part
#
# It is used by Entropy Server QA routines to perform package metadata
# validation.
# Metadata is exported as environmental variables and stdin.
#
# Metadata from environment:
# REPOSITORY_ID = repository identifier
# PKG_ID = package identifier
# PKG_ATOM = package atom
# PKG_NAME = package name
# PKG_VERSION = package version
# PKG_TAG = package version tag
# PKG_DESCRIPTION = package description
# PKG_CATEGORY = package category
# PKG_CHOST = package CHOST
# PKG_CFLAGS = package CFLAGS
# PKG_CXXFLAGS = package CXXFLAGS
# PKG_HOMEPAGE = package homepage
# PKG_LICENSE = package license
# PKG_BRANCH = package license
# PKG_DOWNLOAD = package relative download URL
# PKG_KEYWORDS = package keywords, space separated
# PKG_MD5 = package file md5 hash
# PKG_SLOT = package slot
# PKG_ETPAPI = package Entropy API
# PKG_DATE = package creation date (in unix time)
# PKG_SIZE = package size, in bytes
# PKG_REVISION = package entropy revision
# PKG_DEPS = list (\n separated) of package dependencies and conflicts

# Metadata on stdin (more can be added in the future, so it's advisable
# to ignore entries well formed but with unknown prefix):
# PKG_NEEDED_LIB:
#	SONAME required by package (one per line), including ELF class,
#	so each line will look like this:
#     PKG_NEEDED_LIB|<soname>|<elfclass>
# PKG_PROVIDED_LIB:
#	SONAME provided by package (one per line), note: elf class
#	and path are also provided, so each line will look like this:
#     PKG_PROVIDED_LIB|<soname>|<path of soname>|<elfclass>
#
# The executable must return 0 for success, 1 for warning, 2 for critical error

import sys
sys.path.insert(0, "/usr/lib/entropy/lib")
import os
import entropy.dep

def write_attention_msg(msg):
    sys.stderr.write("\nATTENTION ATTENTION ATTENTION\n")
    sys.stderr.write(msg + "\n")
    sys.stderr.write("ATTENTION ATTENTION ATTENTION\n\n")

def write_warning_msg(msg):
    sys.stderr.write("\nWARNING WARNING WARNING\n")
    sys.stderr.write(msg + "\n")
    sys.stderr.write("\nWARNING WARNING WARNING\n")

def check_unwanted_deps():
    """
    Check against forbidden dependencies, those we consider meta packages,
    placeholders just to keep Gentoo compatibility, which, if listed as dep in,
    would cause the whole world to be pulled in.
    """
    pkg_deps = os.getenv("PKG_DEPS", "")
    pkg_deps = pkg_deps.split()
    if not pkg_deps:
        return 0

    pkg_atom = os.getenv("PKG_ATOM")
    pkg_keywords = os.getenv("PKG_KEYWORDS")

    # You can only declare key or key:slot
    unwanted_deps = ["app-admin/packagekit", "app-text/poppler",
        "kde-base/kde-l10n", "kde-apps/kde4-l10n", "net-dns/avahi",
        "net-p2p/transmission", "app-crypt/pinentry", "dev-python/pygobject:3",
        "x11-misc/lightdm"]
    warning_deps = ["media-libs/jpeg",
        "dev-lang/gnat-gcc", "dev-lang/gcc", "x11-drivers/nvidia-drivers"]
    func_rc = 0

    pkg_deps_map = dict(
        (entropy.dep.dep_getkey(x), (entropy.dep.dep_getslot(x), x)) \
            for x in pkg_deps if not x.startswith("!"))

    pkg_deps_map = {}
    for pkg_dep in pkg_deps:
        if pkg_dep.startswith("!"):
            continue
        key = entropy.dep.dep_getkey(pkg_dep)
        obj = pkg_deps_map.setdefault(key, [])
        val = entropy.dep.dep_getslot(pkg_dep), pkg_dep
        obj.append(val)

    for unwanted_dep in unwanted_deps:
        unwanted_slot = entropy.dep.dep_getslot(unwanted_dep)
        if unwanted_slot:
            unwanted_dep = entropy.dep.remove_slot(unwanted_dep)

        dep_data_list = pkg_deps_map.get(unwanted_dep)
        if dep_data_list is None:
            continue

        for dep_data in dep_data_list:
            dep_slot, dep = dep_data

            if not unwanted_slot:
                unwanted_slot = dep_slot

            if dep_slot == unwanted_slot:
                write_attention_msg(
                    "%s contains forbidden dependency against %s" % (
                        pkg_atom, dep))
                func_rc = 2

    for warning_dep in warning_deps:

        warning_slot = entropy.dep.dep_getslot(warning_dep)
        if warning_slot:
            warning_dep = entropy.dep.remove_slot(warning_dep)

        dep_data_list = pkg_deps_map.get(warning_dep)
        if dep_data_list is None:
            continue

        for dep_data in dep_data_list:
            dep_slot, dep = dep_data

            if not warning_slot:
                unwanted_slot = dep_slot

            if dep_slot == warning_slot:
                write_attention_msg(
                    "%s contains a weirdo dependency against %s" % (
                        pkg_atom, dep))
                if func_rc == 0:
                    func_rc = 1

    if pkg_keywords is not None:
        keywords = pkg_keywords.split()
        if not keywords or ("**" in keywords and len(keywords) == 1):
            write_attention_msg("%s is masked by default, keywords: %s" % (
                pkg_atom, pkg_keywords))
            if func_rc == 0:
                func_rc = 1

    return func_rc

def warn_perl5_bump():
    """
    Warn in case of bumping dev-lang/perl. Developer should not
    forget about running perl-cleaner.
    """
    pkg_key = "%s/%s" % (os.getenv("PKG_CATEGORY", ""),
                         os.getenv("PKG_NAME", ""))
    pkg_version = os.getenv("PKG_VERSION", "")

    if pkg_key == "dev-lang/perl" and pkg_version.startswith("5"):
        perl_dir = "/usr/lib/perl5/vendor_perl"
        try:
            perl_versions = os.listdir(perl_dir)
        except (OSError, IOError):
            perl_versions = []

        if len(perl_versions) > 1:
            write_warning_msg(
                "Adding dev-lang/perl but you forgot to run perl-cleaner?\n"
                "These are the versions detected in %s:\n"
                "%s" % (perl_dir, ", ".join(perl_versions)))
            return 1

    return 0

def warn_portage_bump():
    """
    Wheneger Portage is bumped, its packages.db.critical entry in build.git
    must be raised.
    """
    pkg_key = "%s/%s" % (os.getenv("PKG_CATEGORY", ""),
                         os.getenv("PKG_NAME", ""))

    if pkg_key == "sys-apps/portage":
        write_warning_msg(
            "So you bumped Portage they told me...\n"
            "Have you raised the portage version in packages.db.critical?\n"
            "It is inside build.git.")
        return 1

    return 0

def warn_sip_bump():
    """
    Wheneger Sip is bumped, we need to manually bump the reverse dependencies.
    """
    pkg_key = "%s/%s" % (os.getenv("PKG_CATEGORY", ""),
                         os.getenv("PKG_NAME", ""))

    if pkg_key == "dev-python/sip":
        write_warning_msg(
            "So you bumped Sip they told me...\n"
            "Have you rebuilt its reverse dependencies?\n"
            "# qfile -e /usr/lib/python2.7/site-packages/PyQt4")
        return 1

    return 0

def warn_binutils_bump():
    """
    Whenever binutils is bumped, we should rebuild packages
    linking explicitly to libbfd-<ver>.so :( sigh.
    """
    pkg_key = "%s/%s" % (os.getenv("PKG_CATEGORY", ""),
                         os.getenv("PKG_NAME", ""))

    if pkg_key == "sys-devel/binutils":
        write_warning_msg(
            "So you bumped binutils they told me...\n"
            "Please, no wait... FUCKING CHECK that packages linking to\n"
            "libbfd-<old_ver>.so have been rebuilt. You can use:\n"
            " # eit query required libbfd-*.so\n")
        return 1

    return 0

def warn_haskell_bump():
    """
    Warn in case of bumping dev-lang/ghc. Developer should not
    forget about running haskell-updater.
    """
    pkg_key = "%s/%s" % (os.getenv("PKG_CATEGORY", ""),
                         os.getenv("PKG_NAME", ""))
    pkg_version = os.getenv("PKG_VERSION", "")

    if pkg_key == "dev-lang/ghc":
        write_warning_msg(
            "Bumping dev-lang/ghc !!!\n"
            "Make sure to run 'haskell-updater' !\n")
        return 1

    return 0

if __name__ == "__main__":

    exit_st = 0

    checks = [
        check_unwanted_deps,
        warn_portage_bump,
        warn_perl5_bump,
        warn_haskell_bump,
        warn_binutils_bump,
        warn_sip_bump
        # more tests here
    ]

    for check in checks:
        rc = check()
        if rc > exit_st:
            exit_st = rc

    raise SystemExit(exit_st)
