deb.py

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright 2015-2023 Canonical Ltd.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# 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/>.

"""Support for deb files."""

import fileinput
import functools
import logging
import os
import pathlib
import re
import subprocess
import sys
import tempfile
from io import StringIO
from pathlib import Path
from typing import Any, Callable, Dict, List, Optional, Sequence, Set, Tuple

from craft_parts.utils import deb_utils, file_utils, os_utils

from . import errors
from .base import BaseRepository, get_pkg_name_parts, mark_origin_stage_package
from .deb_package import DebPackage
from .normalize import normalize

logger = logging.getLogger(__name__)

# Catch the ImportError to set availability of apt on this system
# to fail appropriately on use instead. This implementation is
# independent of the underlying host OS.
try:
    from .apt_cache import AptCache

    _APT_CACHE_AVAILABLE = True
except ImportError as import_error:
    logger.debug(
        "AppCache cannot be imported due to: %r: %s", import_error.name, import_error
    )
    _APT_CACHE_AVAILABLE = False


_HASHSUM_MISMATCH_PATTERN = re.compile(r"(E:Failed to fetch.+Hash Sum mismatch)+")
_DEFAULT_FILTERED_STAGE_PACKAGES: List[str] = [
    "adduser",
    "apt",
    "apt-utils",
    "base-files",
    "base-passwd",
    "bash",
    "bsdutils",
    "coreutils",
    "dash",
    "debconf",
    "debconf-i18n",
    "debianutils",
    "diffutils",
    "dmsetup",
    "dpkg",
    "e2fslibs",
    "e2fsprogs",
    "file",
    "findutils",
    "gcc-4.9-base",
    "gcc-5-base",
    "gnupg",
    "gpgv",
    "grep",
    "gzip",
    "hostname",
    "init",
    "initscripts",
    "insserv",
    "libacl1",
    "libapparmor1",
    "libapt",
    "libapt-inst1.5",
    "libapt-pkg4.12",
    "libattr1",
    "libaudit-common",
    "libaudit1",
    "libblkid1",
    "libbz2-1.0",
    "libc-bin",
    "libc6",
    "libcap2",
    "libcap2-bin",
    "libcomerr2",
    "libcryptsetup4",
    "libdb5.3",
    "libdebconfclient0",
    "libdevmapper1.02.1",
    "libgcc1",
    "libgcrypt20",
    "libgpg-error0",
    "libgpm2",
    "libkmod2",
    "liblocale-gettext-perl",
    "liblzma5",
    "libmagic1",
    "libmount1",
    "libncurses5",
    "libncursesw5",
    "libpam-modules",
    "libpam-modules-bin",
    "libpam-runtime",
    "libpam0g",
    "libpcre3",
    "libprocps3",
    "libreadline6",
    "libselinux1",
    "libsemanage-common",
    "libsemanage1",
    "libsepol1",
    "libslang2",
    "libsmartcols1",
    "libss2",
    "libstdc++6",
    "libsystemd0",
    "libtext-charwidth-perl",
    "libtext-iconv-perl",
    "libtext-wrapi18n-perl",
    "libtinfo5",
    "libudev1",
    "libusb-0.1-4",
    "libustr-1.0-1",
    "libuuid1",
    "locales",
    "login",
    "lsb-base",
    "makedev",
    "manpages",
    "manpages-dev",
    "mawk",
    "mount",
    "multiarch-support",
    "ncurses-base",
    "ncurses-bin",
    "passwd",
    "perl-base",
    "procps",
    "readline-common",
    "sed",
    "sensible-utils",
    "systemd",
    "systemd-sysv",
    "sysv-rc",
    "sysvinit-utils",
    "tar",
    "tzdata",
    "ubuntu-keyring",
    "udev",
    "util-linux",
    "zlib1g",
]


_IGNORE_FILTERS: Dict[str, Set[str]] = {
    "core20": {
        "python3-attr",
        "python3-blinker",
        "python3-certifi",
        "python3-cffi-backend",
        "python3-chardet",
        "python3-configobj",
        "python3-cryptography",
        # Rely on setuptools installed by plugin or found in base, unless
        # explicitly requested.
        # "python3-distutils"
        "python3-idna",
        "python3-importlib-metadata",
        "python3-jinja2",
        "python3-json-pointer",
        "python3-jsonpatch",
        "python3-jsonschema",
        "python3-jwt",
        "python3-lib2to3",
        "python3-markupsafe",
        # Provides /usr/bin/python3, don't bring in unless explicitly requested.
        # "python3-minimal"
        "python3-more-itertools",
        "python3-netifaces",
        "python3-oauthlib",
        # Rely on version brought in by setuptools, unless explicitly requested.
        # "python3-pkg-resources"
        "python3-pyrsistent",
        "python3-pyudev",
        "python3-requests",
        "python3-requests-unixsocket",
        "python3-serial",
        # Rely on version installed by plugin or found in base, unless
        # explicitly requested.
        # "python3-setuptools"
        "python3-six",
        "python3-urllib3",
        "python3-urwid",
        "python3-yaml",
        "python3-zipp",
    },
    "core22": {
        "python3-attr",
        "python3-blinker",
        "python3-certifi",
        "python3-cffi-backend",
        "python3-chardet",
        "python3-configobj",
        "python3-cryptography",
        # Rely on setuptools installed by plugin or found in base, unless
        # explicitly requested.
        # "python3-distutils"
        "python3-idna",
        "python3-importlib-metadata",
        "python3-jinja2",
        "python3-json-pointer",
        "python3-jsonpatch",
        "python3-jsonschema",
        "python3-jwt",
        "python3-markupsafe",
        # Provides /usr/bin/python3, don't bring in unless explicitly requested.
        # "python3-minimal"
        "python3-more-itertools",
        "python3-netifaces",
        "python3-oauthlib",
        # Rely on version brought in by setuptools, unless explicitly requested.
        # "python3-pkg-resources"
        "python3-pyrsistent",
        "python3-pyudev",
        "python3-requests",
        "python3-requests-unixsocket",
        "python3-serial",
        # Rely on version installed by plugin or found in base, unless
        # explicitly requested.
        # "python3-setuptools"
        "python3-six",
        "python3-urllib3",
        "python3-urwid",
        "python3-yaml",
        "python3-zipp",
    },
}


def _apt_cache_wrapper(method: Any) -> Callable[..., Any]:
    """Decorate a method to handle apt availability."""

    @functools.wraps(method)
    def wrapped(*args: Any, **kwargs: Any) -> Any:
        if not _APT_CACHE_AVAILABLE:
            raise errors.PackageBackendNotSupported("apt")
        return method(*args, **kwargs)

    return wrapped


@functools.lru_cache(maxsize=256)
def _run_dpkg_query_search(file_path: str) -> str:
    try:
        output = (
            subprocess.check_output(
                ["dpkg-query", "-S", os.path.join(os.path.sep, file_path)],
                stderr=subprocess.STDOUT,
                env={"LANG": "C.UTF-8"},
            )
            .decode()
            .strip()
        )
    except subprocess.CalledProcessError as call_error:
        logger.debug("Error finding package for %s: %s", file_path, str(call_error))
        raise errors.FileProviderNotFound(file_path=file_path) from call_error

    # Remove diversions
    provides_output = [p for p in output.splitlines() if not p.startswith("diversion")][
        0
    ]
    return provides_output.split(":")[0]


@functools.lru_cache(maxsize=256)
def _run_dpkg_query_list_files(package_name: str) -> Set[str]:
    output = (
        subprocess.check_output(["dpkg", "-L", package_name])
        .decode(sys.getfilesystemencoding())
        .strip()
        .split()
    )

    return {i for i in output if ("lib" in i and os.path.isfile(i))}


def _get_dpkg_list_path(base: str) -> pathlib.Path:
    return pathlib.Path(f"/snap/{base}/current/usr/share/snappy/dpkg.list")


def _get_filtered_stage_package_names(
    *,
    base: str,
    package_list: List[DebPackage],
    base_package_names: Optional[Set[str]],
) -> Set[str]:
    """Get filtered packages by name only - no version or architectures."""
    if base_package_names:
        filtered_packages = base_package_names
    else:
        manifest_packages = {p.name for p in get_packages_in_base(base=base)}
        ignored_packages = _IGNORE_FILTERS.get(base, set())
        filtered_packages = manifest_packages - ignored_packages

    stage_packages = {p.name for p in package_list}

    return filtered_packages - stage_packages


def get_packages_in_base(*, base: str) -> List[DebPackage]:
    """Get the list of packages for the given base."""
    # We do not want to break what we already have.
    if base in ("core", "core16", "core18"):
        return [DebPackage.from_unparsed(p) for p in _DEFAULT_FILTERED_STAGE_PACKAGES]

    base_package_list_path = _get_dpkg_list_path(base)
    if not base_package_list_path.exists():
        return []

    # Lines we care about in dpkg.list had the following format:
    # ii adduser 3.118ubuntu1 all add and rem
    package_list = []
    with fileinput.input(str(base_package_list_path)) as file:
        for line in file:
            if not str(line).startswith("ii "):
                continue
            package = DebPackage.from_unparsed(str(line.split()[1]))
            package_list.append(package)

    return package_list


def _is_list_of_slices(names: List[str]) -> bool:
    """Whether `names` contains Chisel slices or Deb packages.

    This function does not "validate" the names to see if they refer to existing slices/
    packages; it only considers the format of the names. It also assumes that the list
    has been pre-processed and is homogeneous - that is, it does *not* contain a mixture
    of slices and deb packages.

    :param name: A list of package names.
    :return: `True` if the list refers to Chisel slices, or `False` if it refers to Deb
    packages (or is empty).
    """
    return any("_" in name for name in names)


class Ubuntu(BaseRepository):
    """Repository management for Ubuntu packages."""

    @classmethod
    @_apt_cache_wrapper
    def configure(cls, application_package_name: str) -> None:
        """Set up apt options and directories."""
        AptCache.configure_apt(application_package_name)

    @classmethod
    def get_package_libraries(cls, package_name: str) -> Set[str]:
        """Return a list of libraries in package_name."""
        return _run_dpkg_query_list_files(package_name)

    @classmethod
    @_apt_cache_wrapper
    def get_packages_for_source_type(cls, source_type: str) -> Set[str]:
        """Return the packages required to work with source_type."""
        if source_type == "bzr":
            packages = {"bzr"}
        elif source_type == "git":
            packages = {"git"}
        elif source_type == "tar":
            packages = {"tar"}
        elif source_type in ["hg", "mercurial"]:
            packages = {"mercurial"}
        elif source_type in ["svn", "subversion"]:
            packages = {"subversion"}
        elif source_type == "rpm2cpio":
            packages = {"rpm2cpio"}
        elif source_type == "rpm":
            packages = {"rpm"}
        elif source_type == "7zip":
            packages = {"p7zip-full"}
        else:
            packages = set()

        return packages

    @classmethod
    @functools.lru_cache(maxsize=1)
    def refresh_packages_list(cls) -> None:
        """Refresh the list of packages available in the repository."""
        # Return early when testing.
        if os.getenv("CRAFT_PARTS_PACKAGE_REFRESH", "1") == "0":
            return

        try:
            cmd = ["apt-get", "update"]
            logger.debug("Executing: %s", cmd)
            process_run(cmd)
        except subprocess.CalledProcessError as call_error:
            raise errors.PackageListRefreshError(
                "failed to run apt update"
            ) from call_error

    @classmethod
    @_apt_cache_wrapper
    def _check_if_all_packages_installed(cls, package_names: List[str]) -> bool:
        """Check if all given packages are installed.

        Will check versions if using <pkg_name>=<pkg_version> syntax parsed by
        get_pkg_name_parts().  Used as an optimization to skip installation
        and cache refresh if dependencies are already satisfied.

        :return True if _all_ packages are installed (with correct versions).
        """
        with AptCache() as apt_cache:
            for package in package_names:
                pkg_name, pkg_version = get_pkg_name_parts(package)
                installed_version = apt_cache.get_installed_version(
                    pkg_name, resolve_virtual_packages=True
                )

                if installed_version is None or (
                    pkg_version is not None and installed_version != pkg_version
                ):
                    return False

        return True

    @classmethod
    @_apt_cache_wrapper
    def _get_installed_package_versions(cls, package_names: Sequence[str]) -> List[str]:
        packages: List[str] = []

        with AptCache() as apt_cache:
            for package_name in package_names:
                package_version = apt_cache.get_installed_version(
                    package_name, resolve_virtual_packages=True
                )
                if package_version is None:
                    logger.debug("Expected package %s not installed", package_name)
                    continue
                logger.debug(
                    "Found installed version %s for package %s",
                    package_version,
                    package_name,
                )
                packages.append(f"{package_name}={package_version}")

        return packages

    @classmethod
    @_apt_cache_wrapper
    def _get_packages_marked_for_installation(
        cls, package_names: List[str]
    ) -> List[Tuple[str, str]]:
        with AptCache() as apt_cache:
            try:
                apt_cache.mark_packages(set(package_names))
            except errors.PackageNotFound as error:
                raise errors.BuildPackageNotFound(error.package_name)

            return apt_cache.get_packages_marked_for_installation()

    @classmethod
    def download_packages(cls, package_names: List[str]) -> None:
        """Download the specified packages to the local package cache area."""
        logger.info("Downloading packages: %s", " ".join(package_names))
        env = os.environ.copy()
        env.update(
            {
                "DEBIAN_FRONTEND": "noninteractive",
                "DEBCONF_NONINTERACTIVE_SEEN": "true",
                "DEBIAN_PRIORITY": "critical",
            }
        )

        apt_command = [
            "apt-get",
            "--no-install-recommends",
            "-y",
            "-oDpkg::Use-Pty=0",
            "--allow-downgrades",
            "--download-only",
            "install",
        ]

        try:
            process_run(apt_command + package_names, env=env)
        except subprocess.CalledProcessError as err:
            raise errors.PackagesDownloadError(packages=package_names) from err

    @classmethod
    def install_packages(
        cls,
        package_names: List[str],
        *,
        list_only: bool = False,
        refresh_package_cache: bool = True,
    ) -> List[str]:
        """Install packages on the host system."""
        if not package_names:
            return []

        install_required = False
        package_names = sorted(package_names)

        logger.debug("Requested build-packages: %s", package_names)

        # Ensure we have an up-to-date cache first if we will have to
        # install anything.
        if not cls._check_if_all_packages_installed(package_names):
            install_required = True

        # Collect the list of marked packages to later construct a manifest
        marked_packages = cls._get_packages_marked_for_installation(package_names)
        marked_package_names = [name for name, _ in sorted(marked_packages)]

        if not list_only:
            if refresh_package_cache and install_required:
                cls.refresh_packages_list()
            if install_required:
                cls._install_packages(package_names)
            else:
                logger.debug(
                    "Requested build-packages already installed: %s", package_names
                )

        # This result is a best effort approach for deps and virtual packages
        # as they are not part of the installation list.
        # Tell static type checkers to ignore until we can use PEP 612 (Python 3.10)
        return cls._get_installed_package_versions(  # type: ignore[no-any-return]
            marked_package_names
        )

    @classmethod
    def _install_packages(cls, package_names: List[str]) -> None:
        logger.debug("Installing packages: %s", " ".join(package_names))
        env = os.environ.copy()
        env.update(
            {
                "DEBIAN_FRONTEND": "noninteractive",
                "DEBCONF_NONINTERACTIVE_SEEN": "true",
                "DEBIAN_PRIORITY": "critical",
            }
        )

        apt_command = [
            "apt-get",
            "--no-install-recommends",
            "-y",
            "-oDpkg::Use-Pty=0",
            "--allow-downgrades",
            "install",
        ]

        # Set stdin to /dev/null to prevent SIGTTIN/SIGTTOU problems, see
        # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=555632

        try:
            process_run(apt_command + package_names, env=env, stdin=subprocess.DEVNULL)
        except subprocess.CalledProcessError as err:
            raise errors.BuildPackagesNotInstalled(packages=package_names) from err

    @classmethod
    def fetch_stage_packages(
        cls,
        *,
        cache_dir: Path,
        package_names: List[str],
        stage_packages_path: pathlib.Path,
        base: str,
        arch: str,
        list_only: bool = False,
        packages_filters: Optional[Set[str]] = None,
    ) -> List[str]:
        """Fetch stage packages to stage_packages_path."""
        logger.debug("Requested stage-packages: %s", sorted(package_names))

        if not package_names:
            return []

        if _is_list_of_slices(package_names):
            # TODO: fetching of Chisel slices is not supported yet.
            return package_names

        # Have static type checkers ignore until we can use PEP 612 (Python 3.10)
        return cls._fetch_stage_debs(  # type: ignore[no-any-return]
            cache_dir=cache_dir,
            package_names=package_names,
            stage_packages_path=stage_packages_path,
            base=base,
            arch=arch,
            list_only=list_only,
            packages_filters=packages_filters,
        )

    @classmethod
    @_apt_cache_wrapper
    def _fetch_stage_debs(
        cls,
        *,
        cache_dir: Path,
        package_names: List[str],
        stage_packages_path: pathlib.Path,
        base: str,
        arch: str,
        list_only: bool = False,
        packages_filters: Optional[Set[str]] = None,
    ) -> List[str]:
        """Fetch .deb stage packages to stage_packages_path."""
        filtered_names = _get_filtered_stage_package_names(
            base=base,
            package_list=[DebPackage.from_unparsed(name) for name in package_names],
            base_package_names=cls.stage_packages_filters,
        )

        if packages_filters:
            filtered_names.update(packages_filters)

        if not list_only:
            stage_packages_path.mkdir(exist_ok=True)

        stage_cache_dir, deb_cache_dir = get_cache_dirs(cache_dir)
        deb_cache_dir.mkdir(parents=True, exist_ok=True)

        installed: Set[str] = set()

        # Update the package cache
        cls.refresh_packages_list()

        with AptCache(stage_cache=stage_cache_dir, stage_cache_arch=arch) as apt_cache:
            apt_cache.mark_packages(set(package_names))
            apt_cache.unmark_packages(filtered_names)

            if list_only:
                marked_packages = apt_cache.get_packages_marked_for_installation()
                installed = {
                    f"{name}={version}" for name, version in sorted(marked_packages)
                }
            else:
                for pkg_name, pkg_version, dl_path in apt_cache.fetch_archives(
                    deb_cache_dir
                ):
                    logger.debug("Extracting stage package: %s", pkg_name)
                    installed.add(f"{pkg_name}={pkg_version}")
                    file_utils.link_or_copy(
                        str(dl_path), str(stage_packages_path / dl_path.name)
                    )

        return sorted(installed)

    @classmethod
    def unpack_stage_packages(
        cls,
        *,
        stage_packages_path: pathlib.Path,
        install_path: pathlib.Path,
        stage_packages: Optional[List[str]] = None,
        track_stage_packages: bool = False,
    ) -> None:
        """Unpack stage packages to install_path."""
        if stage_packages is None:
            stage_packages = []
        if _is_list_of_slices(stage_packages):
            cls._unpack_stage_slices(
                stage_packages=stage_packages, install_path=install_path
            )
        else:
            cls._unpack_stage_debs(
                stage_packages_path=stage_packages_path,
                install_path=install_path,
                track_stage_packages=track_stage_packages,
            )

    @classmethod
    def _unpack_stage_debs(
        cls,
        *,
        stage_packages_path: pathlib.Path,
        install_path: pathlib.Path,
        track_stage_packages: bool,
    ) -> None:
        pkg_path = None

        for pkg_path in stage_packages_path.glob("*.deb"):
            with tempfile.TemporaryDirectory(
                suffix="deb-extract", dir=install_path.parent
            ) as extract_dir:
                # Extract deb package.
                deb_utils.extract_deb(pkg_path, Path(extract_dir), logger.debug)

                # Mark source of files.
                if track_stage_packages:
                    marked_name = cls._extract_deb_name_version(pkg_path)
                    mark_origin_stage_package(extract_dir, marked_name)

                # Stage files to install_dir.
                file_utils.link_or_copy_tree(extract_dir, install_path.as_posix())

        if pkg_path:
            normalize(install_path, repository=cls)

    @classmethod
    def _unpack_stage_slices(
        cls, *, stage_packages: List[str], install_path: pathlib.Path
    ) -> None:
        """Cut Chisel slices into a destination path.

        :param stage_packages: The list of names of slices to cut.
        :param install_path: The destination directory.
        """
        output_stream = StringIO()
        handler = logging.StreamHandler(stream=output_stream)
        logger.addHandler(handler)
        try:
            process_run(
                [
                    "chisel",
                    "cut",
                    "--root",
                    str(install_path),
                ]
                + stage_packages
            )
        except subprocess.CalledProcessError as err:
            command_output = output_stream.getvalue()
            raise errors.ChiselError(
                slices=stage_packages, output=command_output
            ) from err
        finally:
            logger.removeHandler(handler)

    @classmethod
    @_apt_cache_wrapper
    def is_package_installed(cls, package_name: str) -> bool:
        """Inform if a package is installed on the host system."""
        with AptCache() as apt_cache:
            return apt_cache.get_installed_version(package_name) is not None

    @classmethod
    @_apt_cache_wrapper
    def get_installed_packages(cls) -> List[str]:
        """Obtain a list of the installed packages and their versions."""
        with AptCache() as apt_cache:
            return [
                f"{pkg_name}={pkg_version}"
                for pkg_name, pkg_version in apt_cache.get_installed_packages().items()
            ]

    @classmethod
    def _extract_deb_name_version(cls, deb_path: pathlib.Path) -> str:
        try:
            output = subprocess.check_output(
                ["dpkg-deb", "--show", "--showformat=${Package}=${Version}", deb_path]
            )
        except subprocess.CalledProcessError as err:
            raise errors.UnpackError(str(deb_path)) from err

        return output.decode().strip()


def get_cache_dirs(cache_dir: Path) -> Tuple[Path, Path]:
    """Return the paths to the stage and deb cache directories."""
    stage_cache_dir = cache_dir / "stage-packages"
    deb_cache_dir = cache_dir / "download"

    return (stage_cache_dir, deb_cache_dir)


def process_run(command: List[str], **kwargs: Any) -> None:
    """Run a command and log its output."""
    # Pass logger so messages can be logged as originating from this package.
    os_utils.process_run(command, logger.debug, **kwargs)