## Copyright (C) 2012-2013  Daniel Pavel
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License along
## with this program; if not, write to the Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

import argparse
import logging
import sys

from importlib import import_module
from traceback import extract_tb
from traceback import format_exc

from logitech_receiver import base
from logitech_receiver import device
from logitech_receiver import receiver

from solaar import NAME

logger = logging.getLogger(__name__)


def _create_parser():
    parser = argparse.ArgumentParser(
        prog=NAME.lower(),
        add_help=False,
        epilog=f"For details on individual actions, run `{NAME.lower()} <action> --help`.",
    )
    subparsers = parser.add_subparsers(title="actions", help="command-line action to perform")

    sp = subparsers.add_parser("show", description="Show information about device or all devices.")
    sp.add_argument(
        "device",
        nargs="?",
        default="all",
        help="device to show information about; may be a device number (1..6), a serial number, "
        'a substring of a device\'s name, or "all" (the default)',
    )
    sp.set_defaults(action="show")

    sp = subparsers.add_parser("probe", description="Probe a receiver (debugging use only).")
    sp.add_argument(
        "receiver", nargs="?", help="select receiver by name substring or serial number when more than one is present"
    )
    sp.set_defaults(action="probe")

    sp = subparsers.add_parser(
        "profiles",
        description="Print or load YAML dump of profiles.",
        epilog="Only works on active devices.",
    )
    sp.add_argument(
        "device",
        help="device to read or load profiles; may be a device number (1..6), a serial number, "
        "or a substring of a device's name",
    )
    sp.add_argument("profiles", nargs="?", help="file containing YAML dump of profiles to load")
    sp.set_defaults(action="profiles")

    sp = subparsers.add_parser(
        "config",
        description="Print or load device-specific settings.  Only some settings can be loaded.  "
        "Loading complex settings uses the same syntax as in ~/.config/solaar/config.yaml",
        epilog="Please note that configuration only works on active devices.",
    )
    sp.add_argument(
        "device",
        help="device to configure; may be a device number (1..6), a serial number, or a substring of a device's name",
    )
    sp.add_argument("setting", nargs="?", help="device-specific setting; leave empty to list available settings")
    sp.add_argument("value_key", nargs="?", help="new value for the setting or key for keyed settings")
    sp.add_argument("extra_subkey", nargs="?", help="value for keyed or subkey for subkeyed settings")
    sp.add_argument("extra2", nargs="?", help="value for subkeyed settings")
    sp.set_defaults(action="config")

    sp = subparsers.add_parser(
        "pair",
        description="Pair a new device with a receiver.  The device has to be compatible with the receiver.",
        epilog="The Logitech Unifying Receiver supports up to 6 paired devices at the same time.",
    )
    sp.add_argument(
        "receiver", nargs="?", help="select receiver by name substring or serial number when more than one is present"
    )
    sp.set_defaults(action="pair")

    sp = subparsers.add_parser("unpair", description="Unpair a device from its receiver.  Not all receivers allow unpairing.")
    sp.add_argument(
        "device",
        nargs="?",
        help="device to unpair; may be a device number (1..6), a serial number, "
        "or a substring of a device's name.  Omit when using --slot.",
    )
    sp.add_argument(
        "--receiver",
        help="select receiver by name substring or serial number when more than one is present; "
        "required with --slot if multiple receivers are attached.",
    )
    sp.add_argument(
        "--slot",
        type=int,
        help="force-unpair a specific slot number directly, even if Solaar has no cached device there "
        "or the device is currently reachable.  Lightspeed receivers only.  The slot contents are "
        "printed before the write so you can confirm what is about to be cleared.",
    )
    sp.add_argument(
        "--dry-run",
        action="store_true",
        help="with --slot, run all safety checks but do not issue the unpair register write. "
        "Use to verify the active-device guard before committing to a real write.",
    )
    sp.set_defaults(action="unpair")

    return parser, subparsers.choices


_cli_parser, actions = _create_parser()
print_help = _cli_parser.print_help


def _receivers(dev_path=None):
    for dev_info in base.receivers():
        if dev_path is not None and dev_path != dev_info.path:
            continue
        try:
            r = receiver.create_receiver(base, dev_info)
            logger.debug("[%s] => %s", dev_info.path, r)
            if r:
                yield r
        except Exception as e:
            logger.exception("opening " + str(dev_info))
            sys.exit(f"{NAME.lower()}: error: {str(e)}")


def _receivers_and_devices(dev_path=None):
    for dev_info in base.receivers_and_devices():
        if dev_path is not None and dev_path != dev_info.path:
            continue
        try:
            if dev_info.isDevice:
                if getattr(dev_info, "centurion", False):
                    d = device.create_centurion_receiver(base, dev_info)
                    if d is not None:
                        d.notify_devices()
                    else:
                        d = device.create_device(base, dev_info)
                else:
                    d = device.create_device(base, dev_info)
            else:
                d = receiver.create_receiver(base, dev_info)

            logger.debug("[%s] => %s", dev_info.path, d)
            if d is not None:
                yield d
        except Exception as e:
            logger.exception("opening " + str(dev_info))
            sys.exit(f"{NAME.lower()}: error: {str(e)}")


def _find_receiver(receivers, name):
    assert receivers
    assert name

    for r in receivers:
        if name in r.name.lower() or (r.serial is not None and name == r.serial.lower()):
            return r


def _find_device(receivers, name):
    assert receivers
    assert name

    number = None
    if len(name) == 1:
        try:
            number = int(name)
        except Exception:
            pass
        else:
            assert not (number < 0)
            if number > 6:
                number = None

    for r in receivers:
        if not r.isDevice:  # look for nth device of receiver
            if number:
                dev = r[number]
                if dev:
                    yield dev
            count = r.count()
        else:  # wired device, make a device list from it
            r.ping()
            r = [r]
            count = 1

        for dev in r:
            if (
                name == dev.serial.lower()
                or name == dev.codename.lower()
                or name == str(dev.kind).lower()
                or name in dev.name.lower()
            ):
                yield dev
            count -= 1
            if not count:
                break


def run(cli_args=None, hidraw_path=None):
    if cli_args:
        action = cli_args[0]
        args = _cli_parser.parse_args(cli_args)
    else:
        args = _cli_parser.parse_args()
        # Python 3 has an undocumented 'feature' that breaks parsing empty args
        # http://bugs.python.org/issue16308
        if "cmd" not in args:
            _cli_parser.print_usage(sys.stderr)
            sys.stderr.write(f"{NAME.lower()}: error: too few arguments\n")
            sys.exit(2)
        action = args.action
    assert action in actions

    try:
        if action == "show" or action == "probe" or action == "config" or action == "profiles":
            c = list(_receivers_and_devices(hidraw_path))
        else:
            c = list(_receivers(hidraw_path))
        if not c:
            raise Exception(
                'No supported device found. Use "lsusb" and "bluetoothctl devices Connected" to list connected devices.'
            )
        m = import_module("." + action, package=__name__)
        m.run(c, args, _find_receiver, _find_device)
    except AssertionError:
        tb_last = extract_tb(sys.exc_info()[2])[-1]
        sys.exit(f"{NAME.lower()}: assertion failed: {tb_last[0]} line {int(tb_last[1])}")
    except Exception:
        sys.exit(f"{NAME.lower()}: error: {format_exc()}")
