#  Licensed under the Apache License, Version 2.0 (the "License"); you may
#  not use this file except in compliance with the License. You may obtain
#  a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#  License for the specific language governing permissions and limitations
#  under the License.

"""Use a cache layer in front of entry point scanning."""

import errno
import glob
import hashlib
import importlib.metadata
import itertools
import json
import logging
import os
import os.path
import struct
import sys
from typing import TypeAlias
from typing import TypedDict

log = logging.getLogger('stevedore._cache')


def _get_cache_dir() -> str:
    """Locate a platform-appropriate cache directory to use.

    Does not ensure that the cache directory exists.
    """
    # Linux, Unix, AIX, etc.
    if os.name == 'posix' and sys.platform != 'darwin':
        # use ~/.cache if empty OR not set
        base_path = os.environ.get('XDG_CACHE_HOME') or os.path.expanduser(
            '~/.cache'
        )
        return os.path.join(base_path, 'python-entrypoints')

    # Mac OS
    elif sys.platform == 'darwin':
        return os.path.expanduser('~/Library/Caches/Python Entry Points')

    # Windows (hopefully)
    else:
        base_path = os.environ.get('LOCALAPPDATA') or os.path.expanduser(
            '~\\AppData\\Local'
        )
        return os.path.join(base_path, 'Python Entry Points')


def _get_mtime(name: str) -> float:
    try:
        s = os.stat(name)
        return s.st_mtime
    except OSError as err:
        if err.errno not in {errno.ENOENT, errno.ENOTDIR}:
            raise
    return -1.0


def _ftobytes(f: float) -> bytes:
    return struct.Struct('f').pack(f)


_PathHashEntryT: TypeAlias = list[tuple[str, float]]
_PathHashSettingsT: TypeAlias = tuple[str, _PathHashEntryT]


def _hash_settings_for_path(path: tuple[str, ...]) -> _PathHashSettingsT:
    """Return a hash and the path settings that created it."""
    paths = []
    h = hashlib.sha256()

    # Tie the cache to the python interpreter, in case it is part of a
    # virtualenv.
    h.update(sys.executable.encode('utf-8'))
    h.update(sys.prefix.encode('utf-8'))

    for entry in path:
        mtime = _get_mtime(entry)
        h.update(entry.encode('utf-8'))
        h.update(_ftobytes(mtime))
        paths.append((entry, mtime))

        for ep_file in itertools.chain(
            glob.iglob(os.path.join(entry, '*.dist-info', 'entry_points.txt')),
            glob.iglob(os.path.join(entry, '*.egg-info', 'entry_points.txt')),
        ):
            mtime = _get_mtime(ep_file)
            h.update(ep_file.encode('utf-8'))
            h.update(_ftobytes(mtime))
            paths.append((ep_file, mtime))

    return (h.hexdigest(), paths)


_CacheEntry = TypedDict(
    '_CacheEntry',
    {
        'groups': dict[str, list[tuple[str, str, str]]],
        'sys.executable': str,
        'sys.prefix': str,
        'path_values': _PathHashEntryT,
    },
)


def _build_cacheable_data() -> _CacheEntry:
    entry_points = importlib.metadata.entry_points()
    groups: dict[str, list[tuple[str, str, str]]] = {}
    for group in entry_points.groups:
        existing = set()
        groups[group] = []
        for ep in entry_points.select(group=group):
            # Filter out duplicates that can occur when testing a
            # package that provides entry points using tox, where the
            # package is installed in the virtualenv that tox builds
            # and is present in the path as '.'.
            item = ep.name, ep.value, ep.group  # convert to tuple
            if item in existing:
                continue
            existing.add(item)
            groups[group].append(item)

    return {
        'groups': groups,
        'sys.executable': sys.executable,
        'sys.prefix': sys.prefix,
        'path_values': [],
    }


class Cache:
    def __init__(self, cache_dir: str | None = None) -> None:
        if cache_dir is None:
            cache_dir = _get_cache_dir()
        self._dir = cache_dir
        self._internal: dict[tuple[str, ...], _CacheEntry] = {}
        self._disable_caching = False

        # Caching can be disabled by either placing .disable file into the
        # target directory or when python executable is under /tmp (this is the
        # case when executed from ansible)
        if any(
            [
                os.path.isfile(os.path.join(self._dir, '.disable')),
                sys.executable[0:4] == '/tmp',  # noqa: S108,
            ]
        ):
            self._disable_caching = True

    def _get_data_for_path(self, path: tuple[str, ...] | None) -> _CacheEntry:
        internal_key = tuple(sys.path) if path is None else tuple(path)

        if internal_key in self._internal:
            return self._internal[internal_key]

        digest, path_values = _hash_settings_for_path(internal_key)
        filename = os.path.join(self._dir, digest)
        try:
            log.debug('reading %s', filename)
            with open(filename) as f:
                data: _CacheEntry = json.load(f)
        except (OSError, json.JSONDecodeError):
            data = _build_cacheable_data()
            data['path_values'] = path_values
            if not self._disable_caching:
                try:
                    log.debug('writing to %s', filename)
                    os.makedirs(self._dir, exist_ok=True)
                    with open(filename, 'w') as f:
                        json.dump(data, f)
                except OSError:
                    # Could not create cache dir or write file.
                    pass

        self._internal[internal_key] = data
        return data

    def get_group_all(
        self, group: str, path: tuple[str, ...] | None = None
    ) -> list[importlib.metadata.EntryPoint]:
        result = []
        data = self._get_data_for_path(path)
        group_data = data.get('groups', {}).get(group, [])
        for vals in group_data:
            result.append(importlib.metadata.EntryPoint(*vals))
        return result

    def get_group_named(
        self, group: str, path: tuple[str, ...] | None = None
    ) -> dict[str, importlib.metadata.EntryPoint]:
        result = {}
        for ep in self.get_group_all(group, path=path):
            if ep.name not in result:
                result[ep.name] = ep
        return result

    def get_single(
        self, group: str, name: str, path: tuple[str, ...] | None = None
    ) -> importlib.metadata.EntryPoint:
        for name, ep in self.get_group_named(group, path=path).items():
            if name == name:
                return ep
        raise ValueError(f'No entrypoint {group!r} in group {name!r}')


_c = Cache()
get_group_all = _c.get_group_all
get_group_named = _c.get_group_named
get_single = _c.get_single