#
# Copyright (C) 2019-2022 Mathieu Parent <math.parent@gmail.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations

from hashlib import sha256
from logging import getLogger
from os.path import getsize, isfile
from shutil import copy, copyfileobj
from tempfile import NamedTemporaryFile
from typing import IO, TYPE_CHECKING, BinaryIO
from urllib.parse import quote

from requests import HTTPError, Response, codes

from gitlabracadabra.containers.const import DIGEST_HEADER, DOCKER_MANIFEST_SCHEMA1_SIGNED
from gitlabracadabra.containers.scope import PULL, Scope
from gitlabracadabra.disk_cache import cache_dir

if TYPE_CHECKING:
    from typing import Self

    from gitlabracadabra.containers.registry_importer import RegistryImporter


logger = getLogger(__name__)


class WithDigest:
    """An object with a digest."""

    supported_mime_types: tuple[str, ...] | None = None

    def __init__(
        self,
        registry: RegistryImporter,
        manifest_name: str,
        digest: str | None = None,
        *,
        size: int | None = None,
        mime_type: str | None = None,
    ) -> None:
        """Initialize an object with a digest.

        Args:
            registry: Registry.
            manifest_name: Manifest name (Example: library/debian).
            digest: Digest (Example: sha256:5890f8ba95f680c87fcf89e51190098641b4f646102ce7ca906e7f83c84874dc).
            size: Size (Example: 42).
            mime_type: Content-Type / mediaType.
        """
        self._registry = registry
        self._manifest_name = manifest_name
        self._digest = digest
        self._size = size
        self._mime_type = mime_type
        self._exists: bool | None = None
        self._fd: BinaryIO | None = None
        self._retrieve_mehod = "head"
        self.forced_digest = False

    def __eq__(self, other: object) -> bool:
        """Compare.

        Args:
            other: Compare

        Returns:
            True if registry, manifest name, digest, size and mime_types are equal.
        """
        return (isinstance(self, type(other)) or isinstance(other, type(self))) and self.__dict__ == other.__dict__

    @property
    def registry(self) -> RegistryImporter:
        """Get the registry.

        Returns:
            The registry.
        """
        return self._registry

    @property
    def manifest_name(self) -> str:
        """Get the manifest name.

        Returns:
            The manifest name.
        """
        return self._manifest_name

    @property
    def digest(self) -> str:
        """Get the digest.

        Returns:
            The digest.

        Raises:
            ValueError: Unable to get digest.
        """
        if self._digest is None:
            self._retrieve()
        if self._digest is None:
            msg = "Unable to get digest"
            raise ValueError(msg)
        return self._digest

    @property
    def size(self) -> int:
        """Get the size.

        Returns:
            The size.

        Raises:
            ValueError: Unable to get size.
        """
        if self._size is None:
            try:
                self._size = getsize(self.cache_path)
            except FileNotFoundError:
                self._retrieve()
        if self._size is None:
            msg = "Unable to get size"
            raise ValueError(msg)
        return self._size

    @property
    def mime_type(self) -> str | None:
        """Get the MIME type (mediaType).

        Returns:
            The MIME type.
        """
        if self._mime_type is None:
            self._retrieve()
        return self._mime_type

    @property
    def cache_path(self) -> str:
        """Get the cache path (local).

        Returns:
            Local path.
        """
        return str(cache_dir("containers_cache") / quote(self.digest, safe=""))

    @property
    def registry_path(self) -> str:
        """Get the registry path.

        Raises:
            NotImplementedError: Needs to be implemented in subclasses.
        """
        raise NotImplementedError

    def __enter__(self) -> Self:
        """Open the cached file.

        Returns:
            self.

        Raises:
            RuntimeError: File already opened.
        """
        self._ensure_cached()
        if self._fd is not None:
            msg = "File already opened"
            raise RuntimeError(msg)
        self._fd = open(self.cache_path, "rb")  # noqa: SIM115
        return self

    def __exit__(self, exc_type, exc_val, exc_tb) -> None:  # type: ignore
        """Close the cached file.

        Args:
            exc_type: Exception type.
            exc_val: Exception value.
            exc_tb: Exception traceback.
        """
        if self._fd is not None:
            self._fd.close()
            self._fd = None

    def read(self, n: int = -1) -> bytes:
        """Read the cached file.

        Args:
            n: buffer size.

        Returns:
            Bytes.

        Raises:
            ValueError: File is not opened.
        """
        if self._fd is None:
            msg = "File is not opened"
            raise ValueError(msg)
        return self._fd.read(n)

    def scope(self, actions: str = PULL) -> Scope:
        """Get a scope.

        Args:
            actions: Scope action.

        Returns:
            A scope.
        """
        return Scope(self.manifest_name, actions)

    def exists(self) -> bool:
        """Get Blob/Manifest existence in the associated registry.

        Returns:
            True or False.

        Raises:
            HTTPError: Error when fetching existence.
        """
        if self._exists is None:
            try:
                self._retrieve()
                self._exists = True
            except HTTPError as err:
                if (err.response is None) or (err.response.status_code != codes["not_found"]):
                    raise
                self._exists = False
            if self._exists:
                self.register()
        return self._exists

    def register(self) -> None:
        """Notify the registry that the Digest exists."""
        # Overridden in Blob

    def _ensure_cached(self) -> None:
        if self._digest is None or not isfile(self.cache_path):
            self._retrieve(with_content=True)

    def _retrieve(self, *, with_content: bool = False) -> None:
        method = self._retrieve_mehod
        if with_content:
            method = "get"
        with self._request(method) as response:
            if self._digest is None:
                self._digest = response.headers.get(DIGEST_HEADER)
            elif DIGEST_HEADER in response.headers and self._digest != response.headers.get(DIGEST_HEADER):
                msg = f"Retrieved digest does not match {response.headers.get(DIGEST_HEADER)} != {self._digest}"
                raise ValueError(msg)
            if "Content-Type" in response.headers:
                self._mime_type = response.headers.get("Content-Type")
            self._size = int(response.headers["Content-Length"])
            if method != "head":
                self._download_and_verify(response)

    def _request(self, method: str) -> Response:
        return self.registry.request(
            method,
            self.registry_path,
            scopes={self.scope()},
            accept=self.supported_mime_types,
            stream=True,
        )

    def _download_and_verify(self, response: Response) -> None:
        with NamedTemporaryFile(dir=cache_dir("containers_cache")) as fp:
            copyfileobj(response.raw, fp)
            downloaded_digest = self._compute_digest(fp)
            if self._digest is None:
                self._digest = downloaded_digest
            else:
                self._verify_digest(downloaded_digest)
            copy(fp.name, self.cache_path)

    def _verify_digest(self, digest: str) -> None:
        if digest != self._digest:
            if self._mime_type == DOCKER_MANIFEST_SCHEMA1_SIGNED:
                # https://docs.docker.com/registry/spec/api/#content-digests
                # "manifest body without the signature content, also known as the JWS payload"
                logger.info(
                    "Ignoring checksum mismatch for signed manifest %s: %s ! %s",
                    str(self),
                    digest,
                    self._digest,
                )
            else:
                msg = f"Checksum mismatch: {digest} != {self._digest}"
                raise ValueError(msg)

    def _compute_digest(self, fp: IO[bytes]) -> str:
        sha256_hash = sha256()
        buf_len = 4096
        fp.seek(0)
        for byte_block in iter(lambda: fp.read(buf_len), b""):
            sha256_hash.update(byte_block)
        return f"sha256:{sha256_hash.hexdigest()}"
