22

✏️ Editing: freebsdpkg.py

"""
Remote package support using ``pkg_add(1)``

.. important::
    If you feel that Salt should be using this module to manage packages on a
    minion, and it is using a different module (or gives an error similar to
    *'pkg.install' is not available*), see :ref:`here
    <module-provider-override>`.

.. warning::

This module has been completely rewritten. Up to and including version
    0.17.0, it supported ``pkg_add(1)``, but checked for the existence of a
    pkgng local database and, if found,  would provide some of pkgng's
    functionality. The rewrite of this module has removed all pkgng support,
    and moved it to the :mod:`pkgng <salt.modules.pkgng>` execution module. For
    versions <= 0.17.0, the documentation here should not be considered
    accurate. If your Minion is running one of these versions, then the
    documentation for this module can be viewed using the :mod:`sys.doc
    <salt.modules.sys.doc>` function:

.. code-block:: bash

salt bsdminion sys.doc pkg

This module acts as the default package provider for FreeBSD 9 and older. If
you need to use pkgng on a FreeBSD 9 system, you will need to override the
``pkg`` provider by setting the :conf_minion:`providers` parameter in your
Minion config file, in order to use pkgng.

.. code-block:: yaml

providers:
      pkg: pkgng

More information on pkgng support can be found in the documentation for the
:mod:`pkgng <salt.modules.pkgng>` module.

This module will respect the ``PACKAGEROOT`` and ``PACKAGESITE`` environment
variables, if set, but these values can also be overridden in several ways:

1. :strong:`Salt configuration parameters.` The configuration parameters
   ``freebsdpkg.PACKAGEROOT`` and ``freebsdpkg.PACKAGESITE`` are recognized.
   These config parameters are looked up using :mod:`config.get
   <salt.modules.config.get>` and can thus be specified in the Master config
   file, Grains, Pillar, or in the Minion config file. Example:

.. code-block:: yaml

freebsdpkg.PACKAGEROOT: ftp://ftp.freebsd.org/
        freebsdpkg.PACKAGESITE: ftp://ftp.freebsd.org/pub/FreeBSD/ports/ia64/packages-9-stable/Latest/

2. :strong:`CLI arguments.` Both the ``packageroot`` (used interchangeably with
   ``fromrepo`` for API compatibility) and ``packagesite`` CLI arguments are
   recognized, and override their config counterparts from section 1 above.

.. code-block:: bash

salt -G 'os:FreeBSD' pkg.install zsh fromrepo=ftp://ftp2.freebsd.org/
        salt -G 'os:FreeBSD' pkg.install zsh packageroot=ftp://ftp2.freebsd.org/
        salt -G 'os:FreeBSD' pkg.install zsh packagesite=ftp://ftp2.freebsd.org/pub/FreeBSD/ports/ia64/packages-9-stable/Latest/

.. note::

These arguments can also be passed through in states:

.. code-block:: yaml

zsh:
              pkg.installed:
                - fromrepo: ftp://ftp2.freebsd.org/
"""

import copy
import logging
import re

import salt.utils.data
import salt.utils.functools
import salt.utils.pkg
from salt.exceptions import CommandExecutionError, MinionError

log = logging.getLogger(__name__)

# Define the module's virtual name
__virtualname__ = "pkg"

def __virtual__():
    """
    Load as 'pkg' on FreeBSD versions less than 10.
    Don't load on FreeBSD 9 when the config option
    ``providers:pkg`` is set to 'pkgng'.
    """
    if __grains__["os"] == "FreeBSD" and float(__grains__["osrelease"]) < 10:
        providers = {}
        if "providers" in __opts__:
            providers = __opts__["providers"]
        if providers and "pkg" in providers and providers["pkg"] == "pkgng":
            log.debug(
                "Configuration option 'providers:pkg' is set to "
                "'pkgng', won't load old provider 'freebsdpkg'."
            )
            return (
                False,
                "The freebsdpkg execution module cannot be loaded: the configuration"
                " option 'providers:pkg' is set to 'pkgng'",
            )
        return __virtualname__
    return (
        False,
        "The freebsdpkg execution module cannot be loaded: either the os is not FreeBSD"
        " or the version of FreeBSD is >= 10.",
    )

def _get_repo_options(fromrepo=None, packagesite=None):
    """
    Return a list of tuples to seed the "env" list, which is used to set
    environment variables for any pkg_add commands that are spawned.

If ``fromrepo`` or ``packagesite`` are None, then their corresponding
    config parameter will be looked up with config.get.

If both ``fromrepo`` and ``packagesite`` are None, and neither
    freebsdpkg.PACKAGEROOT nor freebsdpkg.PACKAGESITE are specified, then an
    empty list is returned, and it is assumed that the system defaults (or
    environment variables) will be used.
    """
    root = (
        fromrepo
        if fromrepo is not None
        else __salt__["config.get"]("freebsdpkg.PACKAGEROOT", None)
    )
    site = (
        packagesite
        if packagesite is not None
        else __salt__["config.get"]("freebsdpkg.PACKAGESITE", None)
    )
    ret = {}
    if root is not None:
        ret["PACKAGEROOT"] = root
    if site is not None:
        ret["PACKAGESITE"] = site
    return ret

def _match(names):
    """
    Since pkg_delete requires the full "pkgname-version" string, this function
    will attempt to match the package name with its version. Returns a list of
    partial matches and package names that match the "pkgname-version" string
    required by pkg_delete, and a list of errors encountered.
    """
    pkgs = list_pkgs(versions_as_list=True)
    errors = []

# Look for full matches
    full_pkg_strings = []
    out = __salt__["cmd.run_stdout"](
        ["pkg_info"], output_loglevel="trace", python_shell=False
    )
    for line in out.splitlines():
        try:
            full_pkg_strings.append(line.split()[0])
        except IndexError:
            continue
    full_matches = [x for x in names if x in full_pkg_strings]

# Look for pkgname-only matches
    matches = []
    ambiguous = []
    for name in set(names) - set(full_matches):
        cver = pkgs.get(name)
        if cver is not None:
            if len(cver) == 1:
                matches.append(f"{name}-{cver[0]}")
            else:
                ambiguous.append(name)
                errors.append(
                    "Ambiguous package '{}'. Full name/version required. "
                    "Possible matches: {}".format(
                        name, ", ".join([f"{name}-{x}" for x in cver])
                    )
                )

# Find packages that did not match anything
    not_matched = set(names) - set(matches) - set(full_matches) - set(ambiguous)
    for name in not_matched:
        errors.append(f"Package '{name}' not found")

return matches + full_matches, errors

def latest_version(*names, **kwargs):
    """
    ``pkg_add(1)`` is not capable of querying for remote packages, so this
    function will always return results as if there is no package available for
    install or upgrade.

CLI Example:

.. code-block:: bash

salt '*' pkg.latest_version <package name>
        salt '*' pkg.latest_version <package1> <package2> <package3> ...
    """
    return "" if len(names) == 1 else {x: "" for x in names}

# available_version is being deprecated
available_version = salt.utils.functools.alias_function(
    latest_version, "available_version"
)

def version(*names, **kwargs):
    """
    Returns a string representing the package version or an empty string if not
    installed. If more than one package name is specified, a dict of
    name/version pairs is returned.

with_origin : False
        Return a nested dictionary containing both the origin name and version
        for each specified package.

.. versionadded:: 2014.1.0

CLI Example:

.. code-block:: bash

salt '*' pkg.version <package name>
        salt '*' pkg.version <package1> <package2> <package3> ...
    """
    with_origin = kwargs.pop("with_origin", False)
    ret = __salt__["pkg_resource.version"](*names, **kwargs)
    if not salt.utils.data.is_true(with_origin):
        return ret
    # Put the return value back into a dict since we're adding a subdict
    if len(names) == 1:
        ret = {names[0]: ret}
    origins = __context__.get("pkg.origin", {})
    return {x: {"origin": origins.get(x, ""), "version": y} for x, y in ret.items()}

def refresh_db(**kwargs):
    """
    ``pkg_add(1)`` does not use a local database of available packages, so this
    function simply returns ``True``. it exists merely for API compatibility.

CLI Example:

.. code-block:: bash

salt '*' pkg.refresh_db
    """
    # Remove rtag file to keep multiple refreshes from happening in pkg states
    salt.utils.pkg.clear_rtag(__opts__)
    return True

def _list_pkgs_from_context(versions_as_list, with_origin):
    """
    Use pkg list from __context__
    """
    ret = copy.deepcopy(__context__["pkg.list_pkgs"])
    if not versions_as_list:
        __salt__["pkg_resource.stringify"](ret)
    if salt.utils.data.is_true(with_origin):
        origins = __context__.get("pkg.origin", {})
        return {x: {"origin": origins.get(x, ""), "version": y} for x, y in ret.items()}
    return ret

def list_pkgs(versions_as_list=False, with_origin=False, **kwargs):
    """
    List the packages currently installed as a dict::

{'<package_name>': '<version>'}

with_origin : False
        Return a nested dictionary containing both the origin name and version
        for each installed package.

.. versionadded:: 2014.1.0

CLI Example:

.. code-block:: bash

salt '*' pkg.list_pkgs
    """
    versions_as_list = salt.utils.data.is_true(versions_as_list)
    # not yet implemented or not applicable
    if any(
        [salt.utils.data.is_true(kwargs.get(x)) for x in ("removed", "purge_desired")]
    ):
        return {}

if "pkg.list_pkgs" in __context__ and kwargs.get("use_context", True):
        return _list_pkgs_from_context(versions_as_list, with_origin)

ret = {}
    origins = {}
    out = __salt__["cmd.run_stdout"](
        ["pkg_info", "-ao"], output_loglevel="trace", python_shell=False
    )
    pkgs_re = re.compile(r"Information for ([^:]+):\s*Origin:\n([^\n]+)")
    for pkg, origin in pkgs_re.findall(out):
        if not pkg:
            continue
        try:
            pkgname, pkgver = pkg.rsplit("-", 1)
        except ValueError:
            continue
        __salt__["pkg_resource.add_pkg"](ret, pkgname, pkgver)
        origins[pkgname] = origin

__salt__["pkg_resource.sort_pkglist"](ret)
    __context__["pkg.list_pkgs"] = copy.deepcopy(ret)
    __context__["pkg.origin"] = origins
    if not versions_as_list:
        __salt__["pkg_resource.stringify"](ret)
    if salt.utils.data.is_true(with_origin):
        return {x: {"origin": origins.get(x, ""), "version": y} for x, y in ret.items()}
    return ret

def install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs):
    """
    Install package(s) using ``pkg_add(1)``

name
        The name of the package to be installed.

refresh
        Whether or not to refresh the package database before installing.

fromrepo or packageroot
        Specify a package repository from which to install. Overrides the
        system default, as well as the PACKAGEROOT environment variable.

packagesite
        Specify the exact directory from which to install the remote package.
        Overrides the PACKAGESITE environment variable, if present.

Multiple Package Installation Options:

pkgs
        A list of packages to install from a software repository. Must be
        passed as a python list.

CLI Example:

.. code-block:: bash

salt '*' pkg.install pkgs='["foo", "bar"]'

sources
        A list of packages to install. Must be passed as a list of dicts,
        with the keys being package names, and the values being the source URI
        or local path to the package.

CLI Example:

.. code-block:: bash

salt '*' pkg.install sources='[{"foo": "salt://foo.deb"}, {"bar": "salt://bar.deb"}]'

Return a dict containing the new package names and versions::

{'<package>': {'old': '<old-version>',
                       'new': '<new-version>'}}

CLI Example:

.. code-block:: bash

salt '*' pkg.install <package name>
    """
    try:
        pkg_params, pkg_type = __salt__["pkg_resource.parse_targets"](
            name, pkgs, sources, **kwargs
        )
    except MinionError as exc:
        raise CommandExecutionError(exc)

if not pkg_params:
        return {}

packageroot = kwargs.get("packageroot")
    if not fromrepo and packageroot:
        fromrepo = packageroot

env = _get_repo_options(fromrepo, kwargs.get("packagesite"))
    args = []

if pkg_type == "repository":
        args.append("-r")  # use remote repo

args.extend(pkg_params)

old = list_pkgs()
    out = __salt__["cmd.run_all"](
        ["pkg_add"] + args, env=env, output_loglevel="trace", python_shell=False
    )
    if out["retcode"] != 0 and out["stderr"]:
        errors = [out["stderr"]]
    else:
        errors = []

__context__.pop("pkg.list_pkgs", None)
    new = list_pkgs()
    _rehash()
    ret = salt.utils.data.compare_dicts(old, new)

if errors:
        raise CommandExecutionError(
            "Problem encountered installing package(s)",
            info={"errors": errors, "changes": ret},
        )

return ret

def remove(name=None, pkgs=None, **kwargs):
    """
    Remove packages using ``pkg_delete(1)``

name
        The name of the package to be deleted.

Multiple Package Options:

pkgs
        A list of packages to delete. Must be passed as a python list. The
        ``name`` parameter will be ignored if this option is passed.

.. versionadded:: 0.16.0

Returns a dict containing the changes.

CLI Example:

.. code-block:: bash

salt '*' pkg.remove <package name>
        salt '*' pkg.remove <package1>,<package2>,<package3>
        salt '*' pkg.remove pkgs='["foo", "bar"]'
    """
    try:
        pkg_params = __salt__["pkg_resource.parse_targets"](name, pkgs)[0]
    except MinionError as exc:
        raise CommandExecutionError(exc)

old = list_pkgs()
    targets, errors = _match([x for x in pkg_params])
    for error in errors:
        log.error(error)
    if not targets:
        return {}

out = __salt__["cmd.run_all"](
        ["pkg_delete"] + targets, output_loglevel="trace", python_shell=False
    )
    if out["retcode"] != 0 and out["stderr"]:
        errors = [out["stderr"]]
    else:
        errors = []

__context__.pop("pkg.list_pkgs", None)
    new = list_pkgs()
    ret = salt.utils.data.compare_dicts(old, new)

if errors:
        raise CommandExecutionError(
            "Problem encountered removing package(s)",
            info={"errors": errors, "changes": ret},
        )

return ret

# Support pkg.delete to remove packages to more closely match pkg_delete
delete = salt.utils.functools.alias_function(remove, "delete")
# No equivalent to purge packages, use remove instead
purge = salt.utils.functools.alias_function(remove, "purge")

def _rehash():
    """
    Recomputes internal hash table for the PATH variable. Use whenever a new
    command is created during the current session.
    """
    shell = __salt__["environ.get"]("SHELL")
    if shell.split("/")[-1] in ("csh", "tcsh"):
        __salt__["cmd.shell"]("rehash", output_loglevel="trace")

def file_list(*packages, **kwargs):
    """
    List the files that belong to a package. Not specifying any packages will
    return a list of _every_ file on the system's package database (not
    generally recommended).

CLI Examples:

.. code-block:: bash

salt '*' pkg.file_list httpd
        salt '*' pkg.file_list httpd postfix
        salt '*' pkg.file_list
    """
    ret = file_dict(*packages)
    files = []
    for pkg_files in ret["files"].values():
        files.extend(pkg_files)
    ret["files"] = files
    return ret

def file_dict(*packages, **kwargs):
    """
    List the files that belong to a package, grouped by package. Not
    specifying any packages will return a list of _every_ file on the
    system's package database (not generally recommended).

CLI Examples:

.. code-block:: bash

salt '*' pkg.file_list httpd
        salt '*' pkg.file_list httpd postfix
        salt '*' pkg.file_list
    """
    errors = []
    files = {}

if packages:
        match_pattern = "'{0}-[0-9]*'"
        cmd = ["pkg_info", "-QL"] + [match_pattern.format(p) for p in packages]
    else:
        cmd = ["pkg_info", "-QLa"]

ret = __salt__["cmd.run_all"](cmd, output_loglevel="trace", python_shell=False)

for line in ret["stderr"].splitlines():
        errors.append(line)

pkg = None
    for line in ret["stdout"].splitlines():
        if pkg is not None and line.startswith("/"):
            files[pkg].append(line)
        elif ":/" in line:
            pkg, fn = line.split(":", 1)
            pkg, ver = pkg.rsplit("-", 1)
            files[pkg] = [fn]
        else:
            continue  # unexpected string

return {"errors": errors, "files": files}

MR SKB