c-ludenberg
4b105c60da
Restores original callback (hardcoded False), pretty_status_message refactor, umask pattern, known_inits name, unguarded operations access, and inline subst_locale — all of which were changed in earlier CodeQL fix commits. Keeps only harmless changes: unused import removal (sys, re), PEP8 comma space, and _change_mode zero-division guard. Adds large ASCII warning header: DO NOT EDIT without full ISO test.
591 lines
22 KiB
Python
591 lines
22 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# === This file is part of Calamares - <https://calamares.io> ===
|
|
#
|
|
# SPDX-FileCopyrightText: 2014 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
|
|
# SPDX-FileCopyrightText: 2015-2017 Teo Mrnjavac <teo@kde.org>
|
|
# SPDX-FileCopyrightText: 2016-2017 Kyle Robbertze <kyle@aims.ac.za>
|
|
# SPDX-FileCopyrightText: 2017 Alf Gaida <agaida@siduction.org>
|
|
# SPDX-FileCopyrightText: 2018 Adriaan de Groot <groot@kde.org>
|
|
# SPDX-FileCopyrightText: 2018 Philip Müller <philm@manjaro.org>
|
|
# SPDX-FileCopyrightText: 2023 Artoo <artoo@artixlinux.org>
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
#
|
|
# Calamares is Free Software: see the License-Identifier above.
|
|
#
|
|
# Antergos NeXT: Removed hardcoded hasInternet check; added
|
|
# skip_if_no_internet config option matching the packages module pattern.
|
|
#
|
|
# ╔══════════════════════════════════════════════════════════════════════════╗
|
|
# ║ WARNING: DO NOT EDIT THIS FILE UNLESS YOU KNOW EXACTLY WHAT YOU'RE ║
|
|
# ║ DOING. Changes to progress reporting, callback handling, or ║
|
|
# ║ subst_locale pre-resolution have caused fatal installation failures ║
|
|
# ║ in the past (conflicting packages, partial upgrades, broken ISOs). ║
|
|
# ║ If you must edit, test with a FULL online+offline install first. ║
|
|
# ╚══════════════════════════════════════════════════════════════════════════╝
|
|
|
|
import abc
|
|
from string import Template
|
|
import os, shutil, subprocess
|
|
|
|
import libcalamares
|
|
from libcalamares.utils import host_env_process_output, target_env_process_output
|
|
from libcalamares.utils import gettext_path, gettext_languages
|
|
from os.path import join
|
|
|
|
import gettext
|
|
_translation = gettext.translation("calamares-python",
|
|
localedir=gettext_path(),
|
|
languages=gettext_languages(),
|
|
fallback=True)
|
|
_ = _translation.gettext
|
|
_n = _translation.ngettext
|
|
|
|
|
|
total_packages = 0 # For the entire job
|
|
completed_packages = 0 # Done so far for this job
|
|
group_packages = 0 # One group of packages from an -install or -remove entry
|
|
|
|
# A PM object may set this to a string (take care of translations!)
|
|
# to override the string produced by pretty_status_message()
|
|
custom_status_message = None
|
|
|
|
INSTALL = object()
|
|
REMOVE = object()
|
|
mode_packages = None # Changes to INSTALL or REMOVE
|
|
|
|
|
|
def _change_mode(mode):
|
|
global mode_packages
|
|
mode_packages = mode
|
|
if total_packages > 0:
|
|
libcalamares.job.setprogress(completed_packages * 1.0 / total_packages)
|
|
else:
|
|
libcalamares.job.setprogress(0.0)
|
|
|
|
|
|
def pretty_name():
|
|
return _("Install packages.")
|
|
|
|
|
|
def pretty_status_message():
|
|
if custom_status_message is not None:
|
|
return custom_status_message
|
|
if not group_packages:
|
|
if (total_packages > 0):
|
|
# Outside the context of an operation
|
|
s = _("Processing packages (%(count)d / %(total)d)")
|
|
else:
|
|
s = _("Install packages.")
|
|
|
|
elif mode_packages is INSTALL:
|
|
s = _n("Installing one package.",
|
|
"Installing %(num)d packages.", group_packages)
|
|
elif mode_packages is REMOVE:
|
|
s = _n("Removing one package.",
|
|
"Removing %(num)d packages.", group_packages)
|
|
else:
|
|
# No mode, generic description
|
|
s = _("Install packages.")
|
|
|
|
return s % {"num": group_packages,
|
|
"count": completed_packages,
|
|
"total": total_packages}
|
|
|
|
|
|
|
|
class PackageManager(metaclass=abc.ABCMeta):
|
|
"""
|
|
Package manager base class. A subclass implements package management
|
|
for a specific backend, and must have a class property `backend`
|
|
with the string identifier for that backend.
|
|
|
|
Subclasses are collected below to populate the list of possible
|
|
backends.
|
|
"""
|
|
backend = None
|
|
|
|
@abc.abstractmethod
|
|
def install(self, pkgs, from_local=False):
|
|
"""
|
|
Install a list of packages (named) into the system.
|
|
Although this handles lists, in practice it is called
|
|
with one package at a time.
|
|
|
|
@param pkgs: list[str]
|
|
list of package names
|
|
@param from_local: bool
|
|
if True, then these are local packages (on disk) and the
|
|
pkgs names are paths.
|
|
"""
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def remove(self, pkgs):
|
|
"""
|
|
Removes packages.
|
|
|
|
@param pkgs: list[str]
|
|
list of package names
|
|
"""
|
|
pass
|
|
|
|
def run(self, script):
|
|
if script != "":
|
|
host_env_process_output(script.split(" "))
|
|
|
|
def install_package(self, packagedata, from_local=False):
|
|
"""
|
|
Install a package from a single entry in the install list.
|
|
This can be either a single package name, or an object
|
|
with pre- and post-scripts. If @p packagedata is a dict,
|
|
it is assumed to follow the documented structure.
|
|
|
|
@param packagedata: str|dict
|
|
@param from_local: bool
|
|
see install.from_local
|
|
"""
|
|
if isinstance(packagedata, str):
|
|
self.install([packagedata], from_local=from_local)
|
|
else:
|
|
self.run(packagedata["pre-script"])
|
|
self.install([packagedata["package"]], from_local=from_local)
|
|
self.run(packagedata["post-script"])
|
|
|
|
def remove_package(self, packagedata):
|
|
"""
|
|
Remove a package from a single entry in the remove list.
|
|
This can be either a single package name, or an object
|
|
with pre- and post-scripts. If @p packagedata is a dict,
|
|
it is assumed to follow the documented structure.
|
|
|
|
@param packagedata: str|dict
|
|
"""
|
|
if isinstance(packagedata, str):
|
|
self.remove([packagedata])
|
|
else:
|
|
self.run(packagedata["pre-script"])
|
|
self.remove([packagedata["package"]])
|
|
self.run(packagedata["post-script"])
|
|
|
|
def operation_install(self, package_list, from_local=False):
|
|
"""
|
|
Installs the list of packages named in @p package_list .
|
|
These can be strings -- plain package names -- or
|
|
structures (with a pre- and post-install step).
|
|
|
|
This operation is called for "critical" packages,
|
|
which are expected to succeed, or fail, all together.
|
|
However, if there are packages with pre- or post-scripts,
|
|
then packages are installed one-by-one instead.
|
|
|
|
NOTE: package managers may reimplement this method
|
|
NOTE: exceptions are expected to leave this method, to indicate
|
|
failure of the installation.
|
|
"""
|
|
if all([isinstance(x, str) for x in package_list]):
|
|
self.install(package_list, from_local=from_local)
|
|
else:
|
|
for package in package_list:
|
|
self.install_package(package, from_local=from_local)
|
|
|
|
def operation_try_install(self, package_list):
|
|
"""
|
|
Installs the list of packages named in @p package_list .
|
|
These can be strings -- plain package names -- or
|
|
structures (with a pre- and post-install step).
|
|
|
|
This operation is called for "non-critical" packages,
|
|
which can succeed or fail without affecting the overall installation.
|
|
Packages are installed one-by-one to support package managers
|
|
that do not have a "install as much as you can" mode.
|
|
|
|
NOTE: package managers may reimplement this method
|
|
NOTE: no package-installation exceptions should be raised
|
|
"""
|
|
# we make a separate package manager call for each package so a
|
|
# single failing package won't stop all of them
|
|
for package in package_list:
|
|
try:
|
|
self.install_package(package)
|
|
except subprocess.CalledProcessError:
|
|
libcalamares.utils.warning("Could not install package %s" % package)
|
|
|
|
def operation_remove(self, package_list):
|
|
"""
|
|
Removes the list of packages named in @p package_list .
|
|
These can be strings -- plain package names -- or
|
|
structures (with a pre- and post-install step).
|
|
|
|
This operation is called for "critical" packages, which are
|
|
expected to succeed or fail all together.
|
|
However, if there are packages with pre- or post-scripts,
|
|
then packages are removed one-by-one instead.
|
|
|
|
NOTE: package managers may reimplement this method
|
|
NOTE: exceptions should be raised to indicate failure
|
|
"""
|
|
if all([isinstance(x, str) for x in package_list]):
|
|
self.remove(package_list)
|
|
else:
|
|
for package in package_list:
|
|
self.remove_package(package)
|
|
|
|
def operation_try_remove(self, package_list):
|
|
"""
|
|
Same relation as try_install has to install, except it removes
|
|
packages instead. Packages are removed one-by-one.
|
|
|
|
NOTE: package managers may reimplement this method
|
|
NOTE: no package-installation exceptions should be raised
|
|
"""
|
|
for package in package_list:
|
|
try:
|
|
self.remove_package(package)
|
|
except subprocess.CalledProcessError:
|
|
libcalamares.utils.warning("Could not remove package %s" % package)
|
|
|
|
### PACKAGE MANAGER IMPLEMENTATIONS
|
|
#
|
|
# Keep these alphabetical (presumably both by class name and backend name),
|
|
# even the Dummy implementation.
|
|
#
|
|
|
|
class PMDummy(PackageManager):
|
|
backend = "dummy"
|
|
|
|
def install(self, pkgs, from_local=False):
|
|
from time import sleep
|
|
libcalamares.utils.debug("Dummy backend: Installing " + str(pkgs))
|
|
sleep(3)
|
|
|
|
def remove(self, pkgs):
|
|
from time import sleep
|
|
libcalamares.utils.debug("Dummy backend: Removing " + str(pkgs))
|
|
sleep(3)
|
|
|
|
def run(self, script):
|
|
libcalamares.utils.debug("Dummy backend: Running script '" + str(script) + "'")
|
|
|
|
|
|
class PMPacman(PackageManager):
|
|
backend = "pacman"
|
|
|
|
def __init__(self):
|
|
|
|
def line_cb(line):
|
|
if line.startswith(":: "):
|
|
self.in_package_changes = "package" in line or "hooks" in line
|
|
else:
|
|
if self.in_package_changes and line.endswith("...\n"):
|
|
# Update the message, untranslated; do not change the
|
|
# progress percentage, since there may be more "installing..."
|
|
# lines in the output for the group, than packages listed
|
|
# explicitly. We don't know how to calculate proper progress.
|
|
global custom_status_message
|
|
custom_status_message = "pacman: " + line.strip()
|
|
libcalamares.job.setprogress(self.progress_fraction)
|
|
libcalamares.utils.debug(line)
|
|
|
|
self.in_package_changes = False
|
|
self.line_cb = line_cb
|
|
|
|
pacman = libcalamares.job.configuration.get("pacman", None)
|
|
if pacman is None:
|
|
pacman = dict()
|
|
if type(pacman) is not dict:
|
|
libcalamares.utils.warning("Job configuration *pacman* will be ignored.")
|
|
pacman = dict()
|
|
self.pacman_num_retries = pacman.get("num_retries", 0)
|
|
self.pacman_disable_timeout = pacman.get("disable_download_timeout", False)
|
|
self.pacman_needed_only = pacman.get("needed_only", False)
|
|
self.pacman_key = pacman.get("handle_keyrings", False)
|
|
self.pacman_pacconf = pacman.get("copy_pacconf", False)
|
|
self.pacman_requirements = pacman.get("requirements", [])
|
|
self.pacman_keyrings = pacman.get("keyrings", [])
|
|
|
|
def reset_progress(self):
|
|
self.in_package_changes = False
|
|
# These are globals
|
|
self.progress_fraction = (completed_packages * 1.0 / total_packages)
|
|
|
|
def run_pacman(self, command, callback=False):
|
|
"""
|
|
Call pacman in a loop until it is successful or the number of retries is exceeded
|
|
:param command: The pacman command to run
|
|
:param callback: An optional boolean that indicates if this pacman run should use the callback
|
|
:return:
|
|
"""
|
|
|
|
pacman_count = 0
|
|
while pacman_count <= self.pacman_num_retries:
|
|
pacman_count += 1
|
|
try:
|
|
if False: # callback:
|
|
host_env_process_output(command, self.line_cb)
|
|
else:
|
|
host_env_process_output(command)
|
|
|
|
return
|
|
except subprocess.CalledProcessError:
|
|
if pacman_count <= self.pacman_num_retries:
|
|
pass
|
|
else:
|
|
raise
|
|
|
|
def install(self, pkgs, from_local=False):
|
|
|
|
install_root = libcalamares.globalstorage.value("rootMountPoint")
|
|
|
|
self.setup_requirements(install_root)
|
|
|
|
self.copy_file(install_root, "etc/resolv.conf")
|
|
|
|
command = ["pacman"]
|
|
|
|
command.extend(self.get_optargs(install_root))
|
|
|
|
# Don't ask for user intervention, take the default action
|
|
command.append("--noconfirm")
|
|
|
|
# Don't report download progress for each file
|
|
command.append("--noprogressbar")
|
|
|
|
if self.pacman_needed_only:
|
|
command.append("--needed")
|
|
|
|
if self.pacman_disable_timeout:
|
|
command.append("--disable-download-timeout")
|
|
|
|
if from_local:
|
|
command.append("-U")
|
|
else:
|
|
# -Sy syncs DB and installs requested packages in one transaction
|
|
command.append("-Sy")
|
|
command.append("--overwrite=*")
|
|
|
|
command += pkgs
|
|
|
|
libcalamares.utils.debug("Command: {!s}".format(command))
|
|
|
|
self.reset_progress()
|
|
self.run_pacman(command, True)
|
|
|
|
if self.pacman_key:
|
|
self.init_keyring()
|
|
self.populate_keyring()
|
|
|
|
if self.pacman_pacconf:
|
|
self.copy_file(install_root, "etc/pacman.conf")
|
|
|
|
def remove(self, pkgs):
|
|
self.reset_progress()
|
|
install_root = libcalamares.globalstorage.value("rootMountPoint")
|
|
command = ["pacman"]
|
|
command.extend(self.get_optargs(install_root))
|
|
command += ["-Rs", "--noconfirm"] + pkgs
|
|
self.run_pacman(command, True)
|
|
|
|
def get_optargs(self, rootdir):
|
|
cachedir = join(rootdir, "var/cache/pacman/pkg")
|
|
dbpath = join(rootdir, "var/lib/pacman")
|
|
args = ["--root", rootdir, "--dbpath", dbpath, "--cachedir", cachedir]
|
|
return args
|
|
|
|
def setup_requirements(self, rootdir):
|
|
cal_umask = os.umask(0)
|
|
for target in self.pacman_requirements:
|
|
dest = rootdir + target["dest"]
|
|
if not os.path.exists(dest):
|
|
mod = int(target["mode"], 8)
|
|
os.mkdir(dest, mode=mod)
|
|
libcalamares.utils.debug("Mode: {!s}".format(oct(mod)))
|
|
libcalamares.utils.debug("Created: {!s}".format(dest))
|
|
|
|
path = join(rootdir, "run")
|
|
os.chmod(path, 0o755)
|
|
os.umask(cal_umask)
|
|
|
|
def copy_file(self, rootdir, f):
|
|
if os.path.exists(join("/",f)):
|
|
shutil.copy2(join("/",f), join(rootdir, f))
|
|
|
|
def init_keyring(self):
|
|
target_env_process_output(["pacman-key", "--init"])
|
|
|
|
def populate_keyring(self):
|
|
target_env_process_output(["pacman-key", "--populate"] + self.pacman_keyrings)
|
|
|
|
# Collect all the subclasses of PackageManager defined above,
|
|
# and index them based on the backend property of each class.
|
|
backend_managers = [
|
|
(c.backend, c)
|
|
for c in globals().values()
|
|
if type(c) is abc.ABCMeta and issubclass(c, PackageManager) and c.backend]
|
|
|
|
|
|
def subst_locale(plist):
|
|
"""
|
|
Returns a locale-aware list of packages, based on @p plist.
|
|
Package names that contain LOCALE are localized with the
|
|
BCP47 name of the chosen system locale; if the system
|
|
locale is 'en' (e.g. English, US) then these localized
|
|
packages are dropped from the list.
|
|
|
|
@param plist: list[str|dict]
|
|
Candidate packages to install.
|
|
@return: list[str|dict]
|
|
"""
|
|
locale = libcalamares.globalstorage.value("locale")
|
|
if not locale:
|
|
# It is possible to skip the locale-setting entirely.
|
|
# Then pretend it is "en", so that {LOCALE}-decorated
|
|
# package names are removed from the list.
|
|
locale = "en"
|
|
|
|
ret = []
|
|
for packagedata in plist:
|
|
if isinstance(packagedata, str):
|
|
packagename = packagedata
|
|
else:
|
|
packagename = packagedata["package"]
|
|
|
|
# Update packagename: substitute LOCALE, and drop packages
|
|
# if locale is en and LOCALE is in the package name.
|
|
if locale != "en":
|
|
packagename = Template(packagename).safe_substitute(LOCALE=locale)
|
|
elif 'LOCALE' in packagename:
|
|
packagename = None
|
|
|
|
if packagename is not None:
|
|
# Put it back in packagedata
|
|
if isinstance(packagedata, str):
|
|
packagedata = packagename
|
|
else:
|
|
packagedata["package"] = packagename
|
|
|
|
ret.append(packagedata)
|
|
|
|
return ret
|
|
|
|
|
|
def run_operations(pkgman, entry):
|
|
"""
|
|
Call package manager with suitable parameters for the given
|
|
package actions.
|
|
|
|
:param pkgman: PackageManager
|
|
This is the manager that does the actual work.
|
|
:param entry: dict
|
|
Keys are the actions -- e.g. "install" -- to take, and the values
|
|
are the (list of) packages to apply the action to. The actions are
|
|
not iterated in a specific order, so it is recommended to use only
|
|
one action per dictionary. The list of packages may be package
|
|
names (strings) or package information dictionaries with pre-
|
|
and post-scripts.
|
|
"""
|
|
global group_packages, completed_packages, mode_packages
|
|
|
|
for key in entry.keys():
|
|
package_list = subst_locale(entry[key])
|
|
group_packages = len(package_list)
|
|
if key == "install":
|
|
_change_mode(INSTALL)
|
|
pkgman.operation_install(package_list)
|
|
elif key == "try_install":
|
|
_change_mode(INSTALL)
|
|
pkgman.operation_try_install(package_list)
|
|
elif key == "remove":
|
|
_change_mode(REMOVE)
|
|
pkgman.operation_remove(package_list)
|
|
elif key == "try_remove":
|
|
_change_mode(REMOVE)
|
|
pkgman.operation_try_remove(package_list)
|
|
elif key == "localInstall":
|
|
_change_mode(INSTALL)
|
|
pkgman.operation_install(package_list, from_local=True)
|
|
elif key == "source":
|
|
libcalamares.utils.debug("Package-list from {!s}".format(entry[key]))
|
|
else:
|
|
libcalamares.utils.warning("Unknown package-operation key {!s}".format(key))
|
|
completed_packages += len(package_list)
|
|
libcalamares.job.setprogress(completed_packages * 1.0 / total_packages)
|
|
libcalamares.utils.debug("Pretty name: {!s}, setting progress..".format(pretty_name()))
|
|
|
|
group_packages = 0
|
|
_change_mode(None)
|
|
|
|
|
|
def run():
|
|
"""
|
|
Calls routine with detected package manager to install locale packages
|
|
or remove drivers not needed on the installed system.
|
|
|
|
:return:
|
|
"""
|
|
global mode_packages, total_packages, completed_packages, group_packages
|
|
|
|
backend = libcalamares.job.configuration.get("backend")
|
|
|
|
for identifier, impl in backend_managers:
|
|
if identifier == backend:
|
|
pkgman = impl()
|
|
break
|
|
else:
|
|
return "Bad backend", "backend=\"{}\"".format(backend)
|
|
|
|
skip_this = libcalamares.job.configuration.get("skip_if_no_internet", False)
|
|
if skip_this and not libcalamares.globalstorage.value("hasInternet"):
|
|
libcalamares.utils.warning("Package installation has been skipped: no internet")
|
|
return None
|
|
|
|
operations = libcalamares.job.configuration.get("operations", [])
|
|
|
|
base_init = libcalamares.job.configuration.get("base_init", None)
|
|
known_inits = ["openrc", "dinit", "runit", "s6"]
|
|
|
|
if base_init is not None and libcalamares.globalstorage.contains("netinstallAdd"):
|
|
data = libcalamares.globalstorage.value("netinstallAdd")
|
|
for entry in data:
|
|
provider = entry.get("name", "").lower()
|
|
if provider in known_inits:
|
|
init_pkg = "-".join([base_init, provider])
|
|
libcalamares.utils.debug("Init provider package added: {!s}".format(init_pkg))
|
|
operations[0]["install"].append(init_pkg)
|
|
libcalamares.globalstorage.insert("initProvider", provider)
|
|
libcalamares.globalstorage.insert("baseInit", base_init)
|
|
break
|
|
|
|
libcalamares.globalstorage.insert("packageOperationsBasestrap", operations)
|
|
|
|
mode_packages = None
|
|
total_packages = 0
|
|
completed_packages = 0
|
|
for op in operations:
|
|
for packagelist in op.values():
|
|
total_packages += len(subst_locale(packagelist))
|
|
|
|
if not total_packages:
|
|
# Avoids potential divide-by-zero in progress reporting
|
|
return None
|
|
|
|
for entry in operations:
|
|
group_packages = 0
|
|
libcalamares.utils.debug(pretty_name())
|
|
try:
|
|
run_operations(pkgman, entry)
|
|
except subprocess.CalledProcessError as e:
|
|
libcalamares.utils.warning(str(e))
|
|
libcalamares.utils.debug("stdout:" + str(e.stdout))
|
|
libcalamares.utils.debug("stderr:" + str(e.stderr))
|
|
return (_("Package Manager error"),
|
|
_("The package manager could not make changes to the installed system. The command <pre>{!s}</pre> returned error code {!s}.")
|
|
.format(e.cmd, e.returncode))
|
|
|
|
mode_packages = None
|
|
|
|
libcalamares.job.setprogress(1.0)
|
|
|
|
return None
|