"""Command definitions."""

from __future__ import absolute_import, division, print_function

from abc import ABCMeta, abstractmethod
from builtins import (  # noqa: F401  # pylint: disable=redefined-builtin,unused-import
    bytes,
    dict,
    int,
    range,
    str,
    super,
)
import json
import os
import re
import shlex
import subprocess as sp
import tempfile
from typing import Dict, List, Union

from pygments import highlight  # type: ignore
from pygments.formatters import TerminalFormatter  # type: ignore
from pygments.lexers import BashLexer  # type: ignore

from funky import errors, utils
from funky.utils import log


class Command:
    """Abstract base command class.

    To use a command, the corresponding command class should be used to build a
    command instance.  A command instance is a callable object.

    Args:
        args (iter): The first element is necessarily a funk name. The others
                     elements (if any exist) vary depending on what command is
                     being used.
        color (bool): If True, colorize output (if command produces output).
        global_ (bool): If True, the global database will be used instead of the
                        local database.
        verbose (bool): If True, Show command displays verbose command
                        definition.

    IMPORTANT: The class docstring of a Command subclass is used by argparse to
               generate output for the help command.
    """

    __metaclass__ = ABCMeta

    FUNKY_DB_FILENAME = ".funky"
    GLOBAL_FUNKY_DB_FILENAME = "{}/.funky".format(os.path.expanduser("~"))

    def __init__(
        self,
        args: Union[None, str, List[str]],
        color: bool = False,
        global_: bool = False,
        verbose: bool = False,
    ) -> None:
        if isinstance(args, str):
            args = [args]

        if global_:
            self.ACTIVE_DB_FILENAME = self.GLOBAL_FUNKY_DB_FILENAME
        else:
            self.ACTIVE_DB_FILENAME = self.FUNKY_DB_FILENAME

        if args is None:
            self.funk = None
            self.args = []
        else:
            self.funk = args[0]
            self.args = args[1:]

        self.color = color
        self.verbose = verbose
        self.global_ = global_
        self.funk_dict = self.read_db_file(self.ACTIVE_DB_FILENAME)

        log.logger.vdebug("Existing Funks: {}".format(self.funk_dict))  # type: ignore

    @staticmethod
    def abort() -> None:
        """Print abort message."""
        print()
        log.logger.info("OK. Aborting...")

    def purge_db(self) -> None:
        """Removes the database file."""
        try:
            os.remove(self.ACTIVE_DB_FILENAME)
        except (IOError, OSError):
            pass

    def commit(self) -> None:
        """Saves funk changes to database."""
        if self.funk_dict:
            log.logger.debug(
                "Committing changes to database: %s", self.ACTIVE_DB_FILENAME
            )
            with open(self.ACTIVE_DB_FILENAME, "w") as f:
                json.dump(self.funk_dict, f)
        else:
            log.logger.debug("Removing %s.", self.ACTIVE_DB_FILENAME)
            self.purge_db()

    @staticmethod
    def read_db_file(db_fname: str) -> Dict[str, str]:
        """Reads the provided database file."""
        try:
            with open(db_fname, "r") as f:
                result: Dict[str, str] = json.load(f)
                return result
        except (IOError, OSError):
            return {}

    @abstractmethod
    def __call__(self) -> None:
        """Runs the current command.

        This is where a concrete Command class should implement its
        functionality.
        """
        log.logger.debug("Running %s command.", self.__class__.__name__)


class Show(Command):
    """
    When no action command is specified, the default action is to display
    existing funks. An funk name (FUNK) can optionally be provided as an
    argument to display only FUNK. If FUNK ends in two periods ('..'), it is
    treated as a prefix instead of an exact match: all funks that start with
    FUNK (not including the trailing '..') will be displayed.
    """

    def show(self, funk: str) -> None:
        """Print funk and funk command definition to stdout."""
        cmd_string = self.funk_dict[funk]
        if "\n" in cmd_string:
            show_output = "{0}() {{\n\t{1}\n}}".format(
                funk, cmd_string.replace("\n", "\n\t")
            )
        else:
            show_output = "{0}() {{ {1}; }}".format(funk, cmd_string)

        if self.verbose:
            unalias_out = "unalias {} &> /dev/null\n".format(funk)

            show_output = "".join([unalias_out, show_output])

        if self.color:
            final_output = highlight(
                show_output, BashLexer(), TerminalFormatter()
            ).strip()
        else:
            final_output = show_output

        print(final_output)

    def show_search(self, prefix: str) -> None:
        """Prints all funks that start with @prefix to stdout."""
        log.logger.debug("Running show command for all defined funks.")
        sorted_funks = sorted(
            [funk for funk in self.funk_dict if funk.startswith(prefix)],
            key=lambda x: x.lower(),
        )

        if not sorted_funks:
            raise errors.FunkNotDefinedError(funk=self.funk)

        for funk in sorted_funks:
            if self.verbose:
                print()
            self.show(funk)

    def __call__(self) -> None:
        """See Command.__call__."""
        super().__call__()
        if not self.funk_dict:
            self.purge_db()
            raise errors.FunkNotDefinedError(global_=self.global_)

        if self.funk is None:
            self.show_search(prefix="")
        elif self.funk[-2:] == "..":
            self.show_search(prefix=self.funk[:-2])
        elif self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)
        else:
            self.show(self.funk)


class Rename(Command):
    """Rename an existing funk. OLD funk is renamed to NEW."""

    def __call__(self) -> None:
        """See Command.__call__."""
        super().__call__()
        if self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)

        new_funk = self.args[0]
        if new_funk in self.funk_dict:
            y_or_n = utils.getch(
                '"{}" is already in use. Overwrite? (y/n): '.format(new_funk)
            )
            if y_or_n == "y":
                print()
            else:
                return self.abort()

        self.funk_dict[new_funk] = self.funk_dict[self.funk]
        self.funk_dict.pop(self.funk)

        log.logger.info(
            'Funk "%s" has successfully been renamed to "%s".',
            self.funk,
            new_funk,
        )
        self.commit()


class Edit(Command):
    """Edit an existing funk."""

    NONE_FUNK_ERROR = (
        "Logic Error: Must provide a funk name when using the --edit option."
    )

    def remove_funk(self) -> None:
        """Removes the funk defined at instance creation time."""
        assert self.funk is not None, self.NONE_FUNK_ERROR
        self.funk_dict.pop(self.funk)
        log.logger.info('Removed funk "%s".', self.funk)

    def edit_funk(self, startinsert: bool = False) -> None:
        """Opens up funk definition using temp file in $EDITOR for editing.

        Args:
            startinsert: If vim is your editor, should we start in insert mode?
        """
        tf = tempfile.NamedTemporaryFile(
            prefix="{}.".format(self.funk),
            suffix=".sh",
            dir="/var/tmp",
            mode="w",
            delete=False,
        )
        if self.funk in self.funk_dict:
            tf.write(self.funk_dict[self.funk])
        tf.close()

        editor_cmd_list = self._editor_cmd_list(startinsert)

        editor_cmd_list.append(tf.name)
        try:
            sp.check_call(editor_cmd_list)
        except sp.CalledProcessError as e:
            raise errors.FunkyError(
                "Failed to open editor using: {}".format(editor_cmd_list)
            ) from e

        tf = open(tf.name, "r")
        edited_cmd_string = tf.read()
        tf.close()
        os.unlink(tf.name)

        if edited_cmd_string.strip() == "":
            raise errors.BlankDefinition("Funk definition cannot be blank.")

        log.logger.debug('New Command String: "%s"', edited_cmd_string)
        formatted_cmd_string = self._apply_shortcuts(edited_cmd_string.strip())

        assert self.funk is not None, self.NONE_FUNK_ERROR
        self.funk_dict[self.funk] = formatted_cmd_string

    @staticmethod
    def _editor_cmd_list(startinsert: bool = False) -> List[str]:
        """Generates and returns editor command list."""
        if "EDITOR" in os.environ:
            editor_cmd_list = shlex.split(os.environ["EDITOR"])
            log.logger.debug(
                "Editor command set to $EDITOR: %s", editor_cmd_list
            )
        else:
            editor_cmd_list = ["vim"]
            log.logger.debug(
                "Editor command falling back to default: %s",
                editor_cmd_list,
            )

        if any("vim" in arg for arg in editor_cmd_list) and startinsert:
            editor_cmd_list.append("+startinsert")

        return editor_cmd_list

    @staticmethod
    def _apply_shortcuts(cmd_string: str) -> str:
        """Formats command string for correct execution and display."""
        if cmd_string.startswith("@./"):
            cmd_string = 'cd {}/"$@" || return 1'.format(
                cmd_string.replace("@./", "{}/".format(os.getcwd()))
            )

        double_quoted_conds = [
            cmd_string.startswith('"'),
            cmd_string.endswith('"'),
        ]
        single_quoted_conds = [
            cmd_string.startswith("'"),
            cmd_string.endswith("'"),
        ]
        if all(double_quoted_conds) or all(single_quoted_conds):
            cmd_string = "echo {}".format(cmd_string)

        bad_keys = [r"\$", r"\n", "return", "done", "fi"]
        if re.search("({})".format("|".join(bad_keys)), cmd_string):
            new_cmd_string = cmd_string
        else:
            new_cmd_string = '{} "$@"'.format(cmd_string)

        return new_cmd_string

    def __call__(self) -> None:
        """See Command.__call__."""
        super().__call__()
        if self.funk and self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)

        try:
            self.edit_funk()
            log.logger.info('Edited funk "%s".', self.funk)
        except errors.BlankDefinition as e:
            log.logger.info(str(e))
            self.remove_funk()

        self.commit()


class Remove(Edit):
    """
    Remove an existing funk. Or (if FUNK is not given) remove all funks defined
    in this directory.
    """

    def __call__(self) -> None:
        """See Command.__call__."""
        Command.__call__(self)
        if self.funk and self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)

        if not self.funk_dict:
            raise errors.FunkNotDefinedError(global_=self.global_)

        if self.funk is None:
            log.logger.debug("Prompting to destroy local funk database.")
            prompt = (
                "Remove all local funks defined in this directory? (y/n): "
            )
            y_or_n = utils.getch(prompt)
            if y_or_n == "y":
                self.funk_dict = {}
                print()
                log.logger.info(
                    "Done. The local funk database has been removed."
                )
            else:
                return self.abort()
        else:
            self.remove_funk()

        self.commit()


class Add(Edit):
    """Add a new funk."""

    def __call__(self) -> None:
        """See Command.__call__."""
        Command.__call__(self)
        already_exists = False
        if self.funk in self.funk_dict:
            already_exists = True
            log.logger.info(
                'Funk "%s" is already defined. Running edit command.',
                self.funk,
            )

        try:
            self.edit_funk(startinsert=(not already_exists))
            log.logger.info(
                '%s funk "%s".',
                "Edited" if already_exists else "Added",
                self.funk,
            )
        except errors.BlankDefinition as e:
            raise errors.FunkyError(str(e))

        self.commit()

"""Command definitions."""

from __future__ import absolute_import, division, print_function

from abc import ABCMeta, abstractmethod
from builtins import (  # noqa: F401  # pylint: disable=redefined-builtin,unused-import
    bytes,
    dict,
    int,
    range,
    str,
    super,
)
import json
import os
import re
import shlex
import subprocess as sp
import tempfile
from typing import Dict, List, Union

from pygments import highlight  # type: ignore
from pygments.formatters import TerminalFormatter  # type: ignore
from pygments.lexers import BashLexer  # type: ignore

from funky import errors, utils
from funky.utils import log


class Command:
    """Abstract base command class.

    To use a command, the corresponding command class should be used to build a
    command instance.  A command instance is a callable object.

    Args:
        args (iter): The first element is necessarily a funk name. The others
                     elements (if any exist) vary depending on what command is
                     being used.
        color (bool): If True, colorize output (if command produces output).
        global_ (bool): If True, the global database will be used instead of the
                        local database.
        verbose (bool): If True, Show command displays verbose command
                        definition.

    IMPORTANT: The class docstring of a Command subclass is used by argparse to
               generate output for the help command.
    """

    __metaclass__ = ABCMeta

    FUNKY_DB_FILENAME = ".funky"
    GLOBAL_FUNKY_DB_FILENAME = "{}/.funky".format(os.path.expanduser("~"))

    def __init__(
        self,
        args: Union[None, str, List[str]],
        color: bool = False,
        global_: bool = False,
        verbose: bool = False,
    ) -> None:
        if isinstance(args, str):
            args = [args]

        if global_:
            self.ACTIVE_DB_FILENAME = self.GLOBAL_FUNKY_DB_FILENAME
        else:
            self.ACTIVE_DB_FILENAME = self.FUNKY_DB_FILENAME

        if args is None:
            self.funk = None
            self.args = []
        else:
            self.funk = args[0]
            self.args = args[1:]

        self.color = color
        self.verbose = verbose
        self.global_ = global_
        self.funk_dict = self.read_db_file(self.ACTIVE_DB_FILENAME)

        log.logger.vdebug("Existing Funks: {}".format(self.funk_dict))  # type: ignore

    @staticmethod
    def abort() -> None:
        """Print abort message."""
        print()
        log.logger.info("OK. Aborting...")

    def purge_db(self) -> None:
        """Removes the database file."""
        try:
            os.remove(self.ACTIVE_DB_FILENAME)
        except (IOError, OSError):
            pass

    def commit(self) -> None:
        """Saves funk changes to database."""
        if self.funk_dict:
            log.logger.debug(
                "Committing changes to database: %s", self.ACTIVE_DB_FILENAME
            )
            with open(self.ACTIVE_DB_FILENAME, "w") as f:
                json.dump(self.funk_dict, f)
        else:
            log.logger.debug("Removing %s.", self.ACTIVE_DB_FILENAME)
            self.purge_db()

    @staticmethod
    def read_db_file(db_fname: str) -> Dict[str, str]:
        """Reads the provided database file."""
        try:
            with open(db_fname, "r") as f:
                result: Dict[str, str] = json.load(f)
                return result
        except (IOError, OSError):
            return {}

    @abstractmethod
    def __call__(self) -> None:
        """Runs the current command.

        This is where a concrete Command class should implement its
        functionality.
        """
        log.logger.debug("Running %s command.", self.__class__.__name__)


class Show(Command):
    """
    When no action command is specified, the default action is to display
    existing funks. An funk name (FUNK) can optionally be provided as an
    argument to display only FUNK. If FUNK ends in two periods ('..'), it is
    treated as a prefix instead of an exact match: all funks that start with
    FUNK (not including the trailing '..') will be displayed.
    """

    def show(self, funk: str) -> None:
        """Print funk and funk command definition to stdout."""
        cmd_string = self.funk_dict[funk]
        if "\n" in cmd_string:
            show_output = "{0}() {{\n\t{1}\n}}".format(
                funk, cmd_string.replace("\n", "\n\t")
            )
        else:
            show_output = "{0}() {{ {1}; }}".format(funk, cmd_string)

        if self.verbose:
            unalias_out = "unalias {} &> /dev/null\n".format(funk)

            show_output = "".join([unalias_out, show_output])

        if self.color:
            final_output = highlight(
                show_output, BashLexer(), TerminalFormatter()
            ).strip()
        else:
            final_output = show_output

        print(final_output)

    def show_search(self, prefix: str) -> None:
        """Prints all funks that start with @prefix to stdout."""
        log.logger.debug("Running show command for all defined funks.")
        sorted_funks = sorted(
            [funk for funk in self.funk_dict if funk.startswith(prefix)],
            key=lambda x: x.lower(),
        )

        if not sorted_funks:
            raise errors.FunkNotDefinedError(funk=self.funk)

        for funk in sorted_funks:
            if self.verbose:
                print()
            self.show(funk)

    def __call__(self) -> None:
        """See Command.__call__."""
        super().__call__()
        if not self.funk_dict:
            self.purge_db()
            raise errors.FunkNotDefinedError(global_=self.global_)

        if self.funk is None:
            self.show_search(prefix="")
        elif self.funk[-2:] == "..":
            self.show_search(prefix=self.funk[:-2])
        elif self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)
        else:
            self.show(self.funk)


class Rename(Command):
    """Rename an existing funk. OLD funk is renamed to NEW."""

    def __call__(self) -> None:
        """See Command.__call__."""
        super().__call__()
        if self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)

        new_funk = self.args[0]
        if new_funk in self.funk_dict:
            y_or_n = utils.getch(
                '"{}" is already in use. Overwrite? (y/n): '.format(new_funk)
            )
            if y_or_n == "y":
                print()
            else:
                return self.abort()

        self.funk_dict[new_funk] = self.funk_dict[self.funk]
        self.funk_dict.pop(self.funk)

        log.logger.info(
            'Funk "%s" has successfully been renamed to "%s".',
            self.funk,
            new_funk,
        )
        self.commit()


class Edit(Command):
    """Edit an existing funk."""

    NONE_FUNK_ERROR = (
        "Logic Error: Must provide a funk name when using the --edit option."
    )

    def remove_funk(self) -> None:
        """Removes the funk defined at instance creation time."""
        assert self.funk is not None, self.NONE_FUNK_ERROR
        self.funk_dict.pop(self.funk)
        log.logger.info('Removed funk "%s".', self.funk)

    def edit_funk(self, startinsert: bool = False) -> None:
        """Opens up funk definition using temp file in $EDITOR for editing.

        Args:
            startinsert: If vim is your editor, should we start in insert mode?
        """
        tf = tempfile.NamedTemporaryFile(
            prefix="{}.".format(self.funk),
            suffix=".sh",
            dir="/var/tmp",
            mode="w",
            delete=False,
        )
        if self.funk in self.funk_dict:
            tf.write(self.funk_dict[self.funk])
        tf.close()

        editor_cmd_list = self._editor_cmd_list(startinsert)

        editor_cmd_list.append(tf.name)
        try:
            sp.check_call(editor_cmd_list)
        except sp.CalledProcessError as e:
            raise errors.FunkyError(
                "Failed to open editor using: {}".format(editor_cmd_list)
            ) from e

        tf = open(tf.name, "r")
        edited_cmd_string = tf.read()
        tf.close()
        os.unlink(tf.name)

        if edited_cmd_string.strip() == "":
            raise errors.BlankDefinition("Funk definition cannot be blank.")

        log.logger.debug('New Command String: "%s"', edited_cmd_string)
        formatted_cmd_string = self._apply_shortcuts(edited_cmd_string.strip())

        assert self.funk is not None, self.NONE_FUNK_ERROR
        self.funk_dict[self.funk] = formatted_cmd_string

    @staticmethod
    def _editor_cmd_list(startinsert: bool = False) -> List[str]:
        """Generates and returns editor command list."""
        if "EDITOR" in os.environ:
            editor_cmd_list = shlex.split(os.environ["EDITOR"])
            log.logger.debug(
                "Editor command set to $EDITOR: %s", editor_cmd_list
            )
        else:
            editor_cmd_list = ["vim"]
            log.logger.debug(
                "Editor command falling back to default: %s",
                editor_cmd_list,
            )

        if any("vim" in arg for arg in editor_cmd_list) and startinsert:
            editor_cmd_list.append("+startinsert")

        return editor_cmd_list

    @staticmethod
    def _apply_shortcuts(cmd_string: str) -> str:
        """Formats command string for correct execution and display."""
        if cmd_string.startswith("@./"):
            cmd_string = 'cd {}/"$@" || return 1'.format(
                cmd_string.replace("@./", "{}/".format(os.getcwd()))
            )

        double_quoted_conds = [
            cmd_string.startswith('"'),
            cmd_string.endswith('"'),
        ]
        single_quoted_conds = [
            cmd_string.startswith("'"),
            cmd_string.endswith("'"),
        ]
        if all(double_quoted_conds) or all(single_quoted_conds):
            cmd_string = "echo {}".format(cmd_string)

        bad_keys = [r"\$", r"\n", "return", "done", "fi"]
        if re.search("({})".format("|".join(bad_keys)), cmd_string):
            new_cmd_string = cmd_string
        else:
            new_cmd_string = '{} "$@"'.format(cmd_string)

        return new_cmd_string

    def __call__(self) -> None:
        """See Command.__call__."""
        super().__call__()
        if self.funk and self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)

        try:
            self.edit_funk()
            log.logger.info('Edited funk "%s".', self.funk)
        except errors.BlankDefinition as e:
            log.logger.info(str(e))
            self.remove_funk()

        self.commit()


class Remove(Edit):
    """
    Remove an existing funk. Or (if FUNK is not given) remove all funks defined
    in this directory.
    """

    def __call__(self) -> None:
        """See Command.__call__."""
        Command.__call__(self)
        if self.funk and self.funk not in self.funk_dict:
            raise errors.FunkNotDefinedError(funk=self.funk)

        if not self.funk_dict:
            raise errors.FunkNotDefinedError(global_=self.global_)

        if self.funk is None:
            log.logger.debug("Prompting to destroy local funk database.")
            prompt = (
                "Remove all local funks defined in this directory? (y/n): "
            )
            y_or_n = utils.getch(prompt)
            if y_or_n == "y":
                self.funk_dict = {}
                print()
                log.logger.info(
                    "Done. The local funk database has been removed."
                )
            else:
                return self.abort()
        else:
            self.remove_funk()

        self.commit()


class Add(Edit):
    """Add a new funk."""

    def __call__(self) -> None:
        """See Command.__call__."""
        Command.__call__(self)
        already_exists = False
        if self.funk in self.funk_dict:
            already_exists = True
            log.logger.info(
                'Funk "%s" is already defined. Running edit command.',
                self.funk,
            )

        try:
            self.edit_funk(startinsert=(not already_exists))
            log.logger.info(
                '%s funk "%s".',
                "Edited" if already_exists else "Added",
                self.funk,
            )
        except errors.BlankDefinition as e:
            raise errors.FunkyError(str(e))

        self.commit()

Command definitions. # noqa: F401  # pylint: disable=redefined-builtin,unused-import # type: ignore # type: ignore # type: ignore Abstract base command class.      To use a command, the corresponding command class should be used to build a     command instance.  A command instance is a callable object.      Args:         args (iter): The first element is necessarily a funk name. The others                      elements (if any exist) vary depending on what command is                      being used.         color (bool): If True, colorize output (if command produces output).         global_ (bool): If True, the global database will be used instead of the                         local database.         verbose (bool): If True, Show command displays verbose command                         definition.      IMPORTANT: The class docstring of a Command subclass is used by argparse to                generate output for the help command. # type: ignore Print abort message. Removes the database file. Saves funk changes to database. Reads the provided database file. Runs the current command.          This is where a concrete Command class should implement its         functionality. When no action command is specified, the default action is to display     existing funks. An funk name (FUNK) can optionally be provided as an     argument to display only FUNK. If FUNK ends in two periods ('..'), it is     treated as a prefix instead of an exact match: all funks that start with     FUNK (not including the trailing '..') will be displayed. Print funk and funk command definition to stdout. Prints all funks that start with @prefix to stdout. See Command.__call__. Rename an existing funk. OLD funk is renamed to NEW. See Command.__call__. Edit an existing funk. Removes the funk defined at instance creation time. Opens up funk definition using temp file in $EDITOR for editing.          Args:             startinsert: If vim is your editor, should we start in insert mode? Generates and returns editor command list. Formats command string for correct execution and display. See Command.__call__. Remove an existing funk. Or (if FUNK is not given) remove all funks defined     in this directory. See Command.__call__. Add a new funk. See Command.__call__.