cache.py

#
# Sonar Scanner Python
# Copyright (C) 2011-2026 SonarSource Sàrl
# mailto:info AT sonarsource DOT 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, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#

import pathlib
import typing
from dataclasses import dataclass

from pysonar_scanner import utils
from pysonar_scanner.configuration.properties import SONAR_USER_HOME

OpenBinaryMode = typing.Literal["wb", "xb"]


@dataclass(frozen=True)
class CacheFile:
    filepath: pathlib.Path
    checksum: str

    def exists(self) -> bool:
        return self.filepath.exists()

    def is_valid(self) -> bool:
        try:
            with open(self.filepath, "rb") as f:
                calculated_checksum = utils.calculate_checksum(f)

            return calculated_checksum == self.checksum
        except OSError:
            return False

    def open(self, mode: OpenBinaryMode) -> typing.BinaryIO:
        return open(self.filepath, mode=mode)


class Cache:
    def __init__(self, cache_folder: pathlib.Path):
        if not cache_folder.exists():
            raise FileNotFoundError(f"Cache folder {cache_folder} does not exist")
        self.cache_folder = cache_folder

    def get_file(self, filename: str, checksum: str) -> CacheFile:
        path = self.cache_folder / filename
        return CacheFile(path, checksum)

    def get_file_path(self, filename: str) -> pathlib.Path:
        return self.cache_folder / filename

    @staticmethod
    def create_cache(cache_folder: pathlib.Path):
        if not cache_folder.exists():
            cache_folder.mkdir(parents=True)
        return Cache(cache_folder)


def get_cache(config) -> Cache:
    if SONAR_USER_HOME in config:
        cache_folder = pathlib.Path(config[SONAR_USER_HOME]) / "cache"
    else:
        cache_folder = pathlib.Path.home() / ".sonar/cache"
    return Cache.create_cache(cache_folder)