Mini Shell

"""
Configuration management using Augeas

.. versionadded:: 0.17.0

This state requires the ``augeas`` Python module.

.. _Augeas: http://augeas.net/

Augeas_ can be used to manage configuration files.

"""

import difflib
import logging
import os.path
import re

import salt.utils.args
import salt.utils.files
import salt.utils.stringutils
from salt.modules.augeas_cfg import METHOD_MAP

log = logging.getLogger(__name__)


def __virtual__():
    if "augeas.execute" in __salt__:
        return "augeas"
    return (False, "augeas module could not be loaded")


def _workout_filename(filename):
    """
    Recursively workout the file name from an augeas change
    """
    if os.path.isfile(filename) or filename == "/":
        if filename == "/":
            filename = None
        return filename
    else:
        return _workout_filename(os.path.dirname(filename))


def _check_filepath(changes):
    """
    Ensure all changes are fully qualified and affect only one file.
    This ensures that the diff output works and a state change is not
    incorrectly reported.
    """
    filename = None
    for change_ in changes:
        try:
            cmd, arg = change_.split(" ", 1)

            if cmd not in METHOD_MAP:
                error = f"Command {cmd} is not supported (yet)"
                raise ValueError(error)
            method = METHOD_MAP[cmd]
            parts = salt.utils.args.shlex_split(arg)
            if method in ["set", "setm", "move", "remove"]:
                filename_ = parts[0]
            else:
                _, _, filename_ = parts
            if not filename_.startswith("/files"):
                error = (
                    "Changes should be prefixed with "
                    "/files if no context is provided,"
                    " change: {}".format(change_)
                )
                raise ValueError(error)
            filename_ = re.sub("^/files|/$", "", filename_)
            if filename is not None:
                if filename != filename_:
                    error = (
                        "Changes should be made to one "
                        "file at a time, detected changes "
                        "to {} and {}".format(filename, filename_)
                    )
                    raise ValueError(error)
            filename = filename_
        except (ValueError, IndexError) as err:
            log.error(err)
            if "error" not in locals():
                error = (
                    "Invalid formatted command, see debug log for details: {}".format(
                        change_
                    )
                )
            else:
                error = str(err)
            raise ValueError(error)

    filename = _workout_filename(filename)

    return filename


def change(name, context=None, changes=None, lens=None, load_path=None, **kwargs):
    """
    .. versionadded:: 2014.7.0

    This state replaces :py:func:`~salt.states.augeas.setvalue`.

    Issue changes to Augeas, optionally for a specific context, with a
    specific lens.

    name
        State name

    context
        A file path, prefixed by ``/files``. Should resolve to an actual file
        (not an arbitrary augeas path). This is used to avoid duplicating the
        file name for each item in the changes list (for example, ``set bind 0.0.0.0``
        in the example below operates on the file specified by ``context``). If
        ``context`` is not specified, a file path prefixed by ``/files`` should be
        included with the ``set`` command.

        The file path is examined to determine if the
        specified changes are already present.

        .. code-block:: yaml

            redis-conf:
              augeas.change:
                - context: /files/etc/redis/redis.conf
                - changes:
                  - set bind 0.0.0.0
                  - set maxmemory 1G

    changes
        List of changes that are issued to Augeas. Available commands are
        ``set``, ``setm``, ``mv``/``move``, ``ins``/``insert``, and
        ``rm``/``remove``.

    lens
        The lens to use, needs to be suffixed with `.lns`, e.g.: `Nginx.lns`.
        See the `list of stock lenses <http://augeas.net/stock_lenses.html>`_
        shipped with Augeas.

    .. versionadded:: 2016.3.0

    load_path
        A list of directories that modules should be searched in. This is in
        addition to the standard load path and the directories in
        AUGEAS_LENS_LIB.


    Usage examples:

    Set the ``bind`` parameter in ``/etc/redis/redis.conf``:

    .. code-block:: yaml

        redis-conf:
          augeas.change:
            - changes:
              - set /files/etc/redis/redis.conf/bind 0.0.0.0

    .. note::

        Use the ``context`` parameter to specify the file you want to
        manipulate. This way you don't have to include this in the changes
        every time:

        .. code-block:: yaml

            redis-conf:
              augeas.change:
                - context: /files/etc/redis/redis.conf
                - changes:
                  - set bind 0.0.0.0
                  - set databases 4
                  - set maxmemory 1G

    Augeas is aware of a lot of common configuration files and their syntax.
    It knows the difference between for example ini and yaml files, but also
    files with very specific syntax, like the hosts file. This is done with
    *lenses*, which provide mappings between the Augeas tree and the file.

    There are many `preconfigured lenses`_ that come with Augeas by default,
    and they specify the common locations for configuration files. So most
    of the time Augeas will know how to manipulate a file. In the event that
    you need to manipulate a file that Augeas doesn't know about, you can
    specify the lens to use like this:

    .. code-block:: yaml

        redis-conf:
          augeas.change:
            - lens: redis.lns
            - context: /files/etc/redis/redis.conf
            - changes:
              - set bind 0.0.0.0

    .. note::

        Even though Augeas knows that ``/etc/redis/redis.conf`` is a Redis
        configuration file and knows how to parse it, it is recommended to
        specify the lens anyway. This is because by default, Augeas loads all
        known lenses and their associated file paths. All these files are
        parsed when Augeas is loaded, which can take some time. When specifying
        a lens, Augeas is loaded with only that lens, which speeds things up
        quite a bit.

    .. _preconfigured lenses: http://augeas.net/stock_lenses.html

    A more complex example, this adds an entry to the services file for Zabbix,
    and removes an obsolete service:

    .. code-block:: yaml

        zabbix-service:
          augeas.change:
            - lens: services.lns
            - context: /files/etc/services
            - changes:
              - ins service-name after service-name[last()]
              - set service-name[last()] "zabbix-agent"
              - set "service-name[. = 'zabbix-agent']/port" 10050
              - set "service-name[. = 'zabbix-agent']/protocol" tcp
              - set "service-name[. = 'zabbix-agent']/#comment" "Zabbix Agent service"
              - rm "service-name[. = 'im-obsolete']"
            - unless: grep '^zabbix-agent\\s' /etc/services

    .. warning::

        Don't forget the ``unless`` here, otherwise it will fail on next runs
        because the service is already defined. Additionally you have to quote
        lines containing ``service-name[. = 'zabbix-agent']`` otherwise
        :mod:`augeas_cfg <salt.modules.augeas_cfg>` execute will fail because
        it will receive more parameters than expected.

    .. note::

        Order is important when defining a service with Augeas, in this case
        it's ``port``, ``protocol`` and ``#comment``. For more info about
        the lens check `services lens documentation`_.

    .. _services lens documentation:

    http://augeas.net/docs/references/lenses/files/services-aug.html#Services.record

    """
    ret = {"name": name, "result": False, "comment": "", "changes": {}}

    if not changes or not isinstance(changes, list):
        ret["comment"] = "'changes' must be specified as a list"
        return ret

    if load_path is not None:
        if not isinstance(load_path, list):
            ret["comment"] = "'load_path' must be specified as a list"
            return ret
        else:
            load_path = ":".join(load_path)

    filename = None
    if context is None:
        try:
            filename = _check_filepath(changes)
        except ValueError as err:
            ret["comment"] = f"Error: {err}"
            return ret
    else:
        filename = re.sub("^/files|/$", "", context)

    if __opts__["test"]:
        ret["result"] = True
        ret["comment"] = "Executing commands"
        if context:
            ret["comment"] += f' in file "{context}":\n'
        ret["comment"] += "\n".join(changes)
        return ret

    old_file = []
    if filename is not None and os.path.isfile(filename):
        with salt.utils.files.fopen(filename, "r") as file_:
            old_file = [salt.utils.stringutils.to_unicode(x) for x in file_.readlines()]

    result = __salt__["augeas.execute"](
        context=context, lens=lens, commands=changes, load_path=load_path
    )
    ret["result"] = result["retval"]

    if ret["result"] is False:
        ret["comment"] = "Error: {}".format(result["error"])
        return ret

    if filename is not None and os.path.isfile(filename):
        with salt.utils.files.fopen(filename, "r") as file_:
            new_file = [salt.utils.stringutils.to_unicode(x) for x in file_.readlines()]
            diff = "".join(difflib.unified_diff(old_file, new_file, n=0))

        if diff:
            ret["comment"] = "Changes have been saved"
            ret["changes"] = {"diff": diff}
        else:
            ret["comment"] = "No changes made"

    else:
        ret["comment"] = "Changes have been saved"
        ret["changes"] = {"updates": changes}

    return ret