#!/usr/bin/env python3
#
# Copyright (c) 2015 Jon Turney
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#

#
# mksetupini
#
# Make a setup.ini file from a collection of tarfiles and .hint files
# (this is intended to be a replacement for genini)
#

import argparse
import logging
import os
import sys

from . import common_constants
from . import hint
from . import package

try:
    import spelling
except ImportError:
    pass


#
#
#
def do_main(args):
    # build package list
    packages, error = package.read_packages(args.rel_area, args.arch)

    if error and not args.ignore_errors:
        logging.error("errors reading package set, not writing setup.ini")
        return 1

    # spellcheck text hints
    if args.spell:
        if spelling:
            spelling.spellcheck_hints(args, packages)
        else:
            logging.error("spell-checking support not available")

    # validate the package set
    if not package.validate_packages(args, packages):
        logging.error("package set has errors, not writing setup.ini")
        return 1

    # write setup.ini
    package.write_setup_ini(args, packages, args.arch)

    if args.stats:
        stats(packages)

    return 0


#
#
#

def stats(packages):
    # make a histogram of categories
    histogram = {}

    for c in hint.categories:
        histogram[c.lower()] = 0

    for p in packages.values():
        if 'category' in p.hints:
            for c in p.hints['category'].split():
                histogram.setdefault(c.lower(), 0)
                histogram[c.lower()] += 1

    for c in sorted(histogram, key=histogram.get, reverse=True):
        print('%16s: %4d' % (c, histogram[c]))


#
# argparse helpers for an option which can take a comma separated list of
# choices, or can be repeated (e.g.: --option a --option b,c ->
# option:[a,b,c])
#

class flatten_append(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        curr = getattr(namespace, self.dest, self.default)
        curr.extend(values)
        setattr(namespace, self.dest, curr)


class choiceList(object):
    def __init__(self, choices):
        self.choices = choices

    def __call__(self, csv):
        args = csv.split(',')
        remainder = sorted(set(args) - set(self.choices))
        if remainder:
            msg = "invalid choices: %r (choose from %r)" % (remainder, self.choices)
            raise argparse.ArgumentTypeError(msg)
        return args

    def help(self):
        return '{%s}' % (','.join(self.choices))


#
#
#
def main():
    pkglist_default = common_constants.PKGMAINT
    relarea_default = common_constants.FTP

    disable_check_choices = choiceList(['missing-curr', 'missing-depended-package', 'missing-obsoleted-package', 'missing-required-package', 'curr-most-recent', 'missing-build-depended-package'])

    parser = argparse.ArgumentParser(description='Make setup.ini')
    parser.add_argument('--arch', action='store', required=True, choices=common_constants.ARCHES + common_constants.ARCHIVED_ARCHES)
    parser.add_argument('--disable-check', action=flatten_append, help='checks to disable', type=disable_check_choices, default=[], metavar=disable_check_choices.help())
    parser.add_argument('--inifile', '-u', action='store', help='output filename', required=True)
    parser.add_argument('--ignore-errors', action='store_true', help='ignore errors')
    parser.add_argument('--okmissing', action='append', help=argparse.SUPPRESS, choices=['curr', 'depended-package', 'obsoleted-package', 'required-package'])
    parser.add_argument('--pkglist', action='store', nargs='?', metavar='FILE', help="package maintainer list (default: " + pkglist_default + ")", const=pkglist_default)
    parser.add_argument('--release', action='store', help='value for setup-release key', default='')
    parser.add_argument('--releasearea', action='store', metavar='DIR', help="release directory (default: " + relarea_default + ")", default=relarea_default, dest='rel_area')
    parser.add_argument('--spell', action='store_true', help='spellcheck text hints')
    parser.add_argument('--stats', action='store_true', help='show additional package statistics')
    parser.add_argument('--setup-version', action='store', metavar='VERSION', help='value for setup-version key')
    parser.add_argument('-v', '--verbose', action='count', dest='verbose', help='verbose output')
    (args) = parser.parse_args()

    if args.verbose:
        logging.getLogger().setLevel(logging.INFO)

    logging.basicConfig(format=os.path.basename(sys.argv[0]) + ': %(message)s')

    # The option name 'okmissing' was inherited from genini.  The more general
    # option 'disable-check' is intended to supersede that, eventually.
    #
    # For the moment '--okmissing=foo' is silently transformed into it's
    # equivalent '--disable-check=missing-foo'
    if args.okmissing:
        for m in args.okmissing:
            print("Warning: --okmissing={0} is obsolete, use --disable-check=missing-{0} instead".format(m), file=sys.stderr)
            args.disable_check.append('missing-' + m)

    # disabling either of these checks, implies both of these are disabled
    # (since depends: is generated from requires:, and vice versa, if not
    # present)
    implied = ['missing-depended-package', 'missing-required-package']
    for p in implied:
        if p in args.disable_check:
            for c in implied:
                if c not in args.disable_check:
                    args.disable_check.append(c)

    return do_main(args)


#
#
#

if __name__ == "__main__":
    sys.exit(main())
