#!/usr/bin/env python

# Software License Agreement (BSD License)
#
# Copyright (c) 2013, Open Source Robotics Foundation, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above
#    copyright notice, this list of conditions and the following
#    disclaimer in the documentation and/or other materials provided
#    with the distribution.
#  * Neither the name of Open Source Robotics Foundation, Inc. nor
#    the names of its contributors may be used to endorse or promote
#    products derived from this software without specific prior
#    written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

from __future__ import print_function

import argparse
import gzip
import logging
import sys

from rosdistro import logger
from rosdistro.distribution_cache_generator import CacheYamlDumper, generate_distribution_caches

import yaml

logging.basicConfig(level=logging.INFO)


def parse_args(args=sys.argv[1:]):
    parser = argparse.ArgumentParser(
        description='Build the cache for rosdistro distributions.'
    )
    add = parser.add_argument
    add(
        'index',
        help='The path or url of the index.yaml file (must be either a local file or a file:// url)')
    add(
        'dist_names', nargs='*',
        help='The names of the distributions (default: all)')
    add(
        '--debug', action='store_true', default=False,
        help='Output debug messages')
    add(
        '--preclean', action='store_true', default=False,
        help='Build the cache from scratch instead of reusing cached data')
    add(
        '--ignore-local', action='store_true', default=False,
        help='Ignore locally available cache')
    add(
        '--include-source', action='store_true', default=False,
        help='Also include source branch package XMLs in the cache')
    return parser.parse_args(args)


def main():
    args = parse_args()

    if args.debug:
        logger.level = logging.DEBUG

    try:
        caches = generate_distribution_caches(
            args.index, dist_names=args.dist_names, preclean=args.preclean,
            ignore_local=args.ignore_local, include_source=args.include_source, debug=args.debug)
    except RuntimeError as e:
        print(str(e), file=sys.stderr)
        sys.exit(1)

    for dist_name, cache in caches.items():
        if args.dist_names and dist_name not in args.dist_names:
            continue
        # write the cache
        data = yaml.dump(cache.get_data(), Dumper=CacheYamlDumper)

        # On Python 3, we must encode the unicode yaml str prior to writing it,
        # whereas for Python 2, the yaml output is a str which cannot be further
        # encoded (compared with a unicode object).
        if sys.version_info[0] >= 3:
            data = data.encode('utf-8')

        with open('%s-cache.yaml' % dist_name, 'wb') as f:
            print('- write cache file "%s-cache.yaml"' % dist_name)
            f.write(data)
        with gzip.open('%s-cache.yaml.gz' % dist_name, 'wb') as f:
            print('- write compressed cache file "%s-cache.yaml.gz"' % dist_name)
            f.write(data)


if __name__ == '__main__':
    main()
