#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2009 B. Malengier
#
# 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, see <https://www.gnu.org/licenses/>.
#

"""
General utility functions useful for the generic plugin system
"""

# -------------------------------------------------------------------------
#
# Python modules
#
# -------------------------------------------------------------------------
import datetime
import json
import logging
import os
import sys
from io import BytesIO

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from ...version import VERSION_TUPLE
from ..config import config
from ..const import GRAMPS_LOCALE as glocale
from ..const import USER_PLUGINS
from ..constfunc import mac
from . import BasePluginManager
from ._pluginreg import make_environment

LOG = logging.getLogger(".gen.plug")

_ = glocale.translation.sgettext


# -------------------------------------------------------------------------
#
# Local utility functions for gen.plug
#
# -------------------------------------------------------------------------
def version_str_to_tup(sversion, positions):
    """
    Given a string version and positions count, returns a tuple of
    integers.

    >>> version_str_to_tup("1.02.9", 2)
    (1, 2)
    """
    try:
        tup = tuple(map(int, sversion.split(".")))
        tup += (0,) * (positions - len(tup))
    except:
        tup = (0,) * positions
    return tup[:positions]


class FakeRegistrar:
    """
    Fakes ``register`` and ``newplugin``.
    """

    def __init__(self):
        self.results = []

    @property
    def newplugin(self):
        class _newplugin:
            """
            Fake newplugin.
            """

            def __init__(inner_self):
                self.results.append({})

            def __setattr__(inner_self, attr, value):
                self.results[-1][attr] = value

        return _newplugin

    def register(self, ptype, **kwargs):
        """
        Fake registration. Side-effect sets results to kwargs.
        """
        retval = {"ptype": ptype}
        retval.update(kwargs)
        # Get the results back to calling function
        self.results.append(retval)


class Zipfile:
    """
    Class to duplicate the methods of tarfile.TarFile, for Python 2.5.
    """

    def __init__(self, buffer):
        import zipfile

        self.buffer = buffer
        self.zip_obj = zipfile.ZipFile(buffer)

    def extractall(self, path, members=None):
        """
        Extract all of the files in the zip into path.
        """
        names = self.zip_obj.namelist()
        for name in self.get_paths(names):
            fullname = os.path.join(path, name)
            if not os.path.exists(fullname):
                os.mkdir(fullname)
        for name in self.get_files(names):
            fullname = os.path.join(path, name)
            with open(fullname, "wb") as outfile:
                outfile.write(self.zip_obj.read(name))

    def extractfile(self, name):
        """
        Extract a name from the zip file.

        >>> Zipfile(buffer).extractfile("Dir/dile.py").read()
        <Contents>
        """

        class ExtractFile:
            """
            Simple class to extract a file
            """

            def __init__(self, zip_obj, name):
                self.zip_obj = zip_obj
                self.name = name

            def read(self):
                data = self.zip_obj.read(self.name)
                del self.zip_obj
                return data

        return ExtractFile(self.zip_obj, name)

    def close(self):
        """
        Close the zip object.
        """
        self.zip_obj.close()

    def getnames(self):
        """
        Get the files and directories of the zipfile.
        """
        return self.zip_obj.namelist()

    def get_paths(self, items):
        """
        Get the directories from the items.
        """
        return (name for name in items if self.is_path(name) and not self.is_file(name))

    def get_files(self, items):
        """
        Get the files from the items.
        """
        return (name for name in items if self.is_file(name))

    def is_path(self, name):
        """
        Is the name a path?
        """
        return os.path.split(name)[0]

    def is_file(self, name):
        """
        Is the name a directory?
        """
        return os.path.split(name)[1]


def urlopen_maybe_no_check_cert(url):
    """
    Similar to urllib.request.urlopen, but disables certificate
    verification on Mac.
    """
    context = None
    from urllib.request import urlopen

    if mac():
        from ssl import CERT_NONE, create_default_context

        context = create_default_context()
        context.check_hostname = False
        context.verify_mode = CERT_NONE
    timeout = 10  # seconds
    fptr = None
    try:
        fptr = urlopen(url, timeout=timeout, context=context)
    except TypeError:
        fptr = urlopen(url, timeout=timeout)
    return fptr


def get_addons(project, url):
    """
    Get addons
    """
    LOG.debug("Checking for updated addons...")
    if not url.startswith(("http://", "https://", "file://")):
        return []
    langs = glocale.get_language_list()
    langs.append("en")
    # now we have a list of languages to try:
    fptr = None
    for lang in langs:
        addon_url = f"{url}/listings/addons-{lang}.json"
        LOG.debug("   trying: %s", addon_url)
        try:
            fptr = urlopen_maybe_no_check_cert(addon_url)
        except:
            try:
                addon_url = f"{url}/listings/addons-{lang[:2]}.json"
                fptr = urlopen_maybe_no_check_cert(addon_url)
            except Exception as err:  # some error
                LOG.warning(
                    "Failed to open addon metadata for %s %s: %s", lang, addon_url, err
                )
                fptr = None
        if fptr and (fptr.getcode() == 200 or fptr.file):
            break

    addon_list = []
    if fptr and (fptr.getcode() == 200 or fptr.file):
        addon_list = json.load(fptr)
        for plugin_dict in addon_list:
            if "a" not in plugin_dict:
                plugin_dict["a"] = 0
            if "s" not in plugin_dict:
                plugin_dict["s"] = 0
            if "h" not in plugin_dict:
                plugin_dict["h"] = ""
            plugin_dict["_p"] = project
            plugin_dict["_u"] = url
            pmgr = BasePluginManager.get_instance()
            plugin = pmgr.get_plugin(plugin_dict["i"])
            if plugin:
                plugin_dict["_v"] = plugin.version
    else:
        LOG.debug("Checking Addons Failed")
    LOG.debug("Done checking!")

    return addon_list


def get_all_addons():
    """
    Get addons for all projects
    """
    projects = config.get("behavior.addons-projects")
    all_addons = []
    for project, url, enabled in projects:
        if enabled:
            addons_list = get_addons(project, url)
            all_addons.extend(addons_list)
    return all_addons


def available_updates():
    """
    Check for available updates
    """
    whattypes = config.get("behavior.check-for-addon-update-types")
    addon_update_list = []
    for plugin_dict in get_all_addons():
        if "_v" in plugin_dict:
            LOG.debug(
                "Comparing %s > %s",
                version_str_to_tup(plugin_dict["v"], 3),
                version_str_to_tup(plugin_dict["_v"], 3),
            )
            if version_str_to_tup(plugin_dict["v"], 3) > version_str_to_tup(
                plugin_dict["_v"], 3
            ):
                LOG.debug("   Downloading '%s'...", plugin_dict["z"])
                if "update" in whattypes:
                    if not config.get(
                        "behavior.do-not-show-previously-seen-addon-updates"
                    ) or plugin_dict["i"] not in config.get(
                        "behavior.previously-seen-addon-updates"
                    ):
                        addon_update_list.append(
                            (
                                _("Updated"),
                                "%s/download/%s"
                                % (plugin_dict["_u"], plugin_dict["z"]),
                                plugin_dict,
                            )
                        )
            else:
                LOG.debug("   '%s' is ok", plugin_dict["n"])
        else:
            LOG.debug("   '%s' is not installed", plugin_dict["n"])
            if "new" in whattypes:
                if not config.get(
                    "behavior.do-not-show-previously-seen-addon-updates"
                ) or plugin_dict["i"] not in config.get(
                    "behavior.previously-seen-addon-updates"
                ):
                    addon_update_list.append(
                        (
                            _("New", "updates"),
                            "%s/download/%s" % (plugin_dict["_u"], plugin_dict["z"]),
                            plugin_dict,
                        )
                    )
    config.set(
        "behavior.last-check-for-addon-updates",
        datetime.date.today().strftime("%Y/%m/%d"),
    )

    return addon_update_list


def load_addon_file(path, callback=None):
    """
    Load an addon from a particular path (from URL or file system).
    """
    import tarfile

    if path.startswith(("http://", "https://", "ftp://", "file://")):
        try:
            fptr = urlopen_maybe_no_check_cert(path)
        except:
            if callback:
                callback(_("Unable to open '%s'") % path)
            return False
    else:
        try:
            fptr = open(path, "rb")
        except:
            if callback:
                callback(_("Unable to open '%s'") % path)
            return False
    try:
        content = fptr.read()
        buffer = BytesIO(content)
    except:
        if callback:
            callback(_("Error in reading '%s'") % path)
        return False
    fptr.close()
    # file_obj is either Zipfile or TarFile
    if path.endswith((".zip", ".ZIP")):
        file_obj = Zipfile(buffer)
    elif path.endswith((".tar.gz", ".tgz")):
        try:
            file_obj = tarfile.open(None, fileobj=buffer)
        except:
            if callback:
                callback(_("Error: cannot open '%s'") % path)
            return False
    else:
        if callback:
            callback(_("Error: unknown file type: '%s'") % path)
        return False
    # First, see what versions we have/are getting:
    good_gpr = set()
    for gpr_file in [name for name in file_obj.getnames() if name.endswith(".gpr.py")]:
        if callback:
            callback((_("Examining '%s'...") % gpr_file) + "\n")
        contents = file_obj.extractfile(gpr_file).read()
        registrar = FakeRegistrar()
        # Put a fake register and _ function in environment:
        env = make_environment(
            register=registrar.register,
            newplugin=registrar.newplugin,
            _=lambda text: text,
        )
        # evaluate the contents:
        try:
            exec(contents, env)
        except Exception as exp:
            if callback:
                msg = _("Error in '%s' file: cannot load.") % gpr_file
                callback("   " + msg + "\n" + str(exp))
            continue
        # There can be multiple addons per gpr file:
        for results in registrar.results:
            gramps_target_version = results.get("gramps_target_version", None)
            if gramps_target_version:
                vtup = version_str_to_tup(gramps_target_version, 2)
                # Is it for the right version of gramps?
                if vtup == VERSION_TUPLE[0:2]:
                    # If this version is not installed, or > installed, install it
                    good_gpr.add(gpr_file)
                    if callback:
                        callback(
                            "   "
                            + (_("'%s' is for this version of Gramps.") % id)
                            + "\n"
                        )
                else:
                    # If the plugin is for another version; inform and do nothing
                    if callback:
                        callback(
                            "   "
                            + (_("'%s' is NOT for this version of Gramps.") % id)
                            + "\n"
                        )
                        callback(
                            "   "
                            + (
                                _("It is for version %(v1)d.%(v2)d")
                                % {"v1": vtup[0], "v2": vtup[1]}
                                + "\n"
                            )
                        )
                    continue
            else:
                # another register function doesn't have gramps_target_version
                if gpr_file in good_gpr:
                    os.remove(gpr_file)
                if callback:
                    callback(
                        "   "
                        + (
                            _("Error: missing gramps_target_version in '%s'...")
                            % gpr_file
                        )
                        + "\n"
                    )
    registered_count = 0
    if len(good_gpr) > 0:
        # Now, install the ok ones
        try:
            file_obj.extractall(USER_PLUGINS)
        except OSError:
            if callback:
                callback(f"OSError installing '{path}', skipped!")
            file_obj.close()
            return False
        if callback:
            callback((_("Installing '%s'...") % path) + "\n")
        gpr_files = {
            os.path.split(os.path.join(USER_PLUGINS, name))[0] for name in good_gpr
        }
        for gpr_file in gpr_files:
            if callback:
                callback("   " + (_("Registered '%s'") % gpr_file) + "\n")
            registered_count += 1
    file_obj.close()
    if registered_count:
        return True
    return False


# -------------------------------------------------------------------------
#
# OpenFileOrStdout class
#
# -------------------------------------------------------------------------
class OpenFileOrStdout:
    """Context manager to open a file or stdout for writing."""

    def __init__(self, filename, encoding=None, errors=None, newline=None):
        self.filename = filename
        self.filehandle = None
        self.encoding = encoding
        self.errors = errors
        self.newline = newline

    def __enter__(self):
        if self.filename == "-":
            self.filehandle = sys.stdout
        else:
            self.filehandle = open(
                self.filename,
                "w",
                encoding=self.encoding,
                errors=self.errors,
                newline=self.newline,
            )
        return self.filehandle

    def __exit__(self, exc_type, exc_value, traceback):
        if self.filehandle and self.filename != "-":
            self.filehandle.close()
        return False


# -------------------------------------------------------------------------
#
# OpenFileOrStdin class
#
# -------------------------------------------------------------------------
class OpenFileOrStdin:
    """Context manager to open a file or stdin for reading."""

    def __init__(self, filename, add_mode="", encoding=None):
        self.filename = filename
        self.mode = f"r{add_mode}"
        self.filehandle = None
        self.encoding = encoding

    def __enter__(self):
        if self.filename == "-":
            self.filehandle = sys.stdin
        elif self.encoding:
            self.filehandle = open(self.filename, self.mode, encoding=self.encoding)
        else:
            self.filehandle = open(self.filename, self.mode)
        return self.filehandle

    def __exit__(self, exc_type, exc_value, traceback):
        if self.filename != "-":
            self.filehandle.close()
        return False


# -------------------------------------------------------------------------
#
# get_cite function
#
# -------------------------------------------------------------------------
def get_cite():
    """
    Function that returns the active cite plugin.
    """
    plugman = BasePluginManager.get_instance()
    for pdata in plugman.get_reg_cite():
        if pdata.id != config.get("preferences.cite-plugin"):
            continue
        module = plugman.load_plugin(pdata)
        if not module:
            print(f"Error loading formatter '{pdata.name}': skipping content")
            continue
        cite = getattr(module, "Formatter")()
        return cite
