src/lib/configuration_files.c - master - githubmirror/libreport

src/lib/configuration_files.c
505 строк16 KB
Michal Fabik
configuration_files: Fix leaks
22 сен 2020, 15:11
22 сен 2020, 15:116bf6907
/*
    Copyright (C) 2013  ABRT Team
    Copyright (C) 2009  Zdenek Prikryl (zprikryl@redhat.com)
    Copyright (C) 2009  RedHat inc.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 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 General Public License for more details.

    You should have received a copy of the GNU 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.
*/
#include "internal_libreport.h"
#include <augeas.h>
#include <libgen.h>

/* Cannot use realpath() only because the function doesn't work for
 * non-existing files.
 *
 * libreport uses these path patterns:
 * /etc/libreport/plugins/cool-plugin.conf
 * $HOME/.config/abrt/settings/sweat-plugin.conf
 *
 * unit test uses relative paths:
 * ../../conf/default/file.conf
 */
static bool canonicalize_path(const char *path, char *canon_path)
{
    if (realpath(path, canon_path) != NULL)
        return true;

    if (errno != ENOENT && errno != ENOTDIR)
        return false;

    bool retval = false;

    g_autofree char *dirc = g_strdup(path);
    g_autofree char *basec = g_strdup(path);
    /* Be ware that dirname("..") == ".." */
    char *dname = dirname(dirc);
    /* Be ware that basename("/"|".."|".") == "/"|".."|"." */
    char *bname = basename(basec);

    /* Don't want to support paths like '/root/notexist/notexist2/../file.conf' */
    if (strcmp(bname, "..") == 0
        || strcmp(bname, ".") == 0
        /* Cannot get realpath for "/", how this could happened? */
        || strcmp(bname, "/") == 0
        /* It seems that CWD does not exist (CDW + ../file.conf)*/
        || strcmp(dname, "..") == 0
        /* Here as well as above */
        || strcmp(dname, ".") == 0)
    {
        errno = ENOTDIR;
        return retval;
    }

    if (!canonicalize_path(dname, canon_path))
        return retval;

    size_t canon_path_len = strlen(canon_path);
    const size_t bname_len = strlen(bname);
    /* + 1 for slash */
    if (canon_path_len + bname_len + 1 >= PATH_MAX)
    {
        errno = ENAMETOOLONG;
        return retval;
    }

    if (canon_path[canon_path_len - 1] != '/')
    {
        canon_path[canon_path_len] = '/';
        ++canon_path_len;
        canon_path[canon_path_len] = '\0';
    }

    strcpy(canon_path + canon_path_len, bname);
    retval = true;

    return retval;
}

/* augeas refuses to create a directories :(
 * http://www.redhat.com/archives/augeas-devel/2008-November/msg00012.html
 * https://bugzilla.redhat.com/show_bug.cgi?id=1032562
 */
static bool create_parentdir(char *path)
{
    bool ret;
    g_autofree char *c = NULL;

    c = g_path_get_dirname(path);
    ret = g_mkdir_with_parents(c, 0700);

    return ret;
}

static void internal_aug_error_msg(augeas *aug, const char *def_msg)
{
    const char *err_msg = def_msg;

    if (aug_error(aug) != AUG_NOERROR)
    {
        /* Try to get the most detailed error. */
        err_msg = aug_error_details(aug);

        if (err_msg == NULL)
            /* The detailed error message was not provided. */
            /* Try to get a message elaborating the error code. */
            err_msg = aug_error_minor_message(aug);

        if (err_msg == NULL)
            /* No more detailed message for the error code. */
            /* Get a message for the error code. */
            err_msg = aug_error_message(aug);

        if (err_msg == NULL)
            /* Paranoia: aug_error_message() always return a message, */
            /* at leas "No error" */
            err_msg = def_msg;
    }

    error_msg("%s", err_msg);
}

/* Only for debugging */
#define NOAUTOLOAD 1

/* Initializes augeas for libreport only
 *
 * The default initialization of augeas takes ages because it parses all
 * configuration files which are known to augeas. Unfortunately we do want work
 * only with the libreport configuration files. Hence, we have to disable the
 * autoloading and configure augeas to load only the Libreport module.
 *
 * The list of loaded modules is stored in /augeas/load/\* nodes. If the
 * autoloading is enabled, the path is populated with all augeas modules.  But
 * in our case the path is empty (there is no child node at /augeas/load/ path)
 * so we have to add Libreport node (aug_set() creates a new node if it not
 * exists yet) and configure the lens and the included files for Libreport
 * node.
 */
static bool
internal_aug_init(augeas **aug, const char *path)
{
    int aug_flag = AUG_NO_ERR_CLOSE /* without this flag aug_init() returns
                                     * NULL on errors and we cannot read the
                                     * error message
                                     */
#if NOAUTOLOAD
                 | AUG_NO_MODL_AUTOLOAD /* do not parse all configuration files
                                         * in the system (empty /augeas/load)
                                         */
#endif
                 ;

    *aug = aug_init(/* default root */ NULL, /* default lens lib */ NULL, aug_flag);

    if (aug_error(*aug) != AUG_NOERROR)
    {
        error_msg("%s", aug_error_message(*aug));
        return false;
    }

#if NOAUTOLOAD
    /* Libreport.lns -> use the lens from the Libreport module. */
    /* Cannot use '@Libreport' (Libreport module) because this construction works */
    /* only for autoloaded modules (augeas-1.1.0) */
    if (aug_set(*aug, "/augeas/load/Libreport/lens", "Libreport.lns") < 0)
    {
        internal_aug_error_msg(*aug, "Cannot configure augeas to use Libreport.lns");
        return false;
    }

    /* parse only this configuration file */
    if (aug_set(*aug, "/augeas/load/Libreport/incl[1]", path) < 0)
    {
        internal_aug_error_msg(*aug, "Cannot configure augeas to read the configuration file");
        return false;
    }

    if (aug_load(*aug) < 0)
    {
        internal_aug_error_msg(*aug, "Cannot load the configuration file");
        return false;
    }
#endif

    return true;
}

enum {
    GAON_NO_FLAG = 0,   /* Explicit default value */
    GAON_FAIL_ON_NOENT, /* Fail if configuration file does not exist */
};

#define IS_FAIL_ON_NOENT(f) ((f) & GAON_FAIL_ON_NOENT)

/* Finds names of all options from a file placed on the real_path and returns
 * the names in an array of strings.
 *
 * In default configuration, the function does no return FALSE if the
 * configuration file does not exist. If you require this behavior, add
 * GAON_FAIL_ON_NOENT to the flags.
 */
static bool internal_aug_get_all_option_names(augeas *aug, const char *real_path,
        char ***matches, int *match_num, int flags)
{
    /* We expect that the file tree contains only option and #comment nodes */
    g_autofree char *aug_expr = g_strdup_printf("/files%s/*[label() != \"#comment\"]", real_path);
    *match_num = aug_match(aug, aug_expr, matches);

    if (*match_num < 0)
    {
        internal_aug_error_msg(aug, "An error occurred while searching for configuration options");
        return false;
    }

    if (*match_num > 0)
        return true;

    /* match_num == 0 means 'no option found'; let's find out why */
    struct stat buf;
    if (0 != stat(real_path, &buf))
    {
        /* We expect that the path doesn't exist, therefore print ENOENT */
        /* message in verbose mode and all other error messages in */
        /* non-verbose mode. */
        if (errno != ENOENT || libreport_g_verbose > 1)
            perror_msg("Cannot read conf file '%s'", real_path);

        /* Return FALSE on ENOENT only if flags contains GAON_FAIL_ON_NOENT. */
        return (errno == ENOENT && !IS_FAIL_ON_NOENT(flags));
    }
    else if (!S_ISREG(buf.st_mode))
    {
        /* A user should know that the path to configuration file is not */
        /* a regular file. */
        error_msg("Configuration path '%s' is not a regular file", real_path);
        return false;
    }

    /* The file is empty or contains only comments and new lines */
    log_info("Configuration file '%s' contains no option", real_path);
    return true;
}

/* Returns false if any error occurs, else returns true.
 */
bool libreport_load_conf_file(const char *path, GHashTable *settings, bool skipKeysWithoutValue)
{
    bool retval = false;
    char real_path[PATH_MAX + 1];
    augeas *aug = NULL;

    if (!canonicalize_path(path, real_path))
    {
        VERB3 perror_msg("Cannot get real path for '%s'", path);
        goto finalize;
    }

    if (!internal_aug_init(&aug, real_path))
        goto finalize;

    char **matches = NULL;
    int match_num = 0;
    if (!internal_aug_get_all_option_names(aug, real_path, &matches, &match_num, GAON_FAIL_ON_NOENT))
        goto finalize;

    int i = 0;
    for (; i < match_num; ++i)
    {
        const char *option = strrchr(matches[i], '/') + 1;
        const char *value = NULL;
        const int ret = aug_get(aug, matches[i], &value);
        if (ret == 0)
        {
            log_warning("Option '%s' disappeared from '%s' while parsing", option, real_path);
            goto cleanup;
        }
        if (ret == -1)
        {
            internal_aug_error_msg(aug, "An error occurred while retrieving an option's value");
            goto cleanup;
        }

        log_info("Loaded option '%s' = '%s'", option, value);

        if (!skipKeysWithoutValue || value[0] != '\0')
            g_hash_table_replace(settings, g_strdup(option), g_strdup(value));

        free(matches[i]);
    }
    retval = true;

cleanup:
    for (; i < match_num; ++i)
        free(matches[i]);
    free(matches);

finalize:
    if (aug != NULL)
        aug_close(aug);

    return retval;
}

const char *libreport_get_user_conf_base_dir(void)
{
    static char *base_dir = NULL;

    const char *debug_base_dir = getenv("LIBREPORT_DEBUG_USER_CONF_BASE_DIR");
    if (debug_base_dir != NULL)
        return debug_base_dir;

    if (base_dir == NULL)
    {
        char* user_config_dir = (char*)g_get_user_config_dir();
        base_dir = g_build_filename(user_config_dir ? user_config_dir : "", "abrt/settings/", NULL);
    }

    return base_dir;
}

bool libreport_load_conf_file_from_dirs(const char *base_name, const char *const *directories, GHashTable *settings, bool skipKeysWithoutValue)
{
    return libreport_load_conf_file_from_dirs_ext(base_name, directories, NULL, settings, skipKeysWithoutValue);
}

bool libreport_load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories, const int *dir_flags, GHashTable *settings, bool skipKeysWithoutValue)
{
    if (NULL == directories || NULL == *directories)
    {
        log_error("No configuration directory specified");
        return false;
    }

    bool result = true;
    for (size_t i = 0; directories[i] != NULL; ++i)
    {
        g_autofree char *conf_file = g_build_filename(directories[i], base_name, NULL);
        if (!libreport_load_conf_file(conf_file, settings, skipKeysWithoutValue))
        {
            if (dir_flags && (dir_flags[i] & CONF_DIR_FLAG_OPTIONAL))
                log_notice("Can't open '%s'", conf_file);
            else
            {
                perror_msg("Can't open '%s'", conf_file);
                result = false;
            }
        }
    }

    return result;
}

bool libreport_load_plugin_conf_file(const char *name, GHashTable *settings, bool skipKeysWithoutValue)
{
    const char *dirs[] = {
        PLUGINS_CONF_DIR,
        NULL,
    };

    const char *plugins_conf_dir = getenv("LIBREPORT_DEBUG_PLUGINS_CONF_DIR");
    if (plugins_conf_dir != NULL)
        dirs[0] = plugins_conf_dir;

    return libreport_load_conf_file_from_dirs(name, dirs, settings, skipKeysWithoutValue);
}

static int
cmpstringp(const void *p1, const void *p2)
{
    /* The actual arguments to this function are "pointers to
     * pointers to char", but strcmp(3) arguments are "pointers
     * to char", hence the following cast plus dereference */
    return strcmp(*(char *const *)p1, *(char *const *)p2);
}

/* Returns false if saving failed */
bool libreport_save_conf_file(const char *path, GHashTable *settings)
{
    bool retval = false;
    char real_path[PATH_MAX + 1];
    augeas *aug = NULL;
    char **option_names = NULL;
    int option_count = 0;

    if (!canonicalize_path(path, real_path))
    {
        perror_msg("Cannot get real path for '%s'", path);
        goto finalize;
    }

    if (!internal_aug_init(&aug, real_path))
        goto finalize;

    /* Get all option names to be able to delete those which have
     * no corresponding key in settings */
    if (!internal_aug_get_all_option_names(aug, real_path, &option_names, &option_count, GAON_NO_FLAG))
        goto finalize;

    /* Sort the list of option names for bseach() */
    qsort(option_names, option_count, sizeof(char *), cmpstringp);

    gpointer name = NULL;
    gpointer value = NULL;
    GHashTableIter iter;
    g_hash_table_iter_init(&iter, settings);
    while (g_hash_table_iter_next(&iter, &name, &value))
    {
        g_autofree char *aug_path = g_strdup_printf("/files%s/%s", real_path, (char *)name);
        const int ret = aug_set(aug, aug_path, (char *)value);

        /* Check whether the name already exists and if it exists remark it by
         * erasing its value from the list of option names.
         * At the end we will go through the lif of option names and will
         * remove those which won't be NULL from the configuration file */
        char **opt = bsearch(&aug_path, option_names, option_count, sizeof(char *), cmpstringp);
        if (opt != NULL)
        {
            free(*opt);

            /* Move NULL at the end of the list. */
            for (char **iter = opt; iter != option_names + (option_count - 1); ++iter)
                *iter = (*(iter + 1));

            --option_count;
        }

        /* FYI: the bsearch above can be moved below the following if statement
         * but we need aug_path as the input for bsearch(), therefore I chose
         * this form because it is one from the simplest, however, potentially
         * less efficient in case where aug_set() failed (we could skip the
         * search in that case). */
        if (ret < 0)
        {
            internal_aug_error_msg(aug, "Cannot set a value of a tree path");
            goto finalize;
        }
    }

    /* Go through the list of option names and remove those which were not
     * found in settings */
    for (int i = 0; i < option_count; ++i)
    {
        if (option_names[i] == NULL)
            continue;

        const int ret = aug_rm(aug, option_names[i]);
        if (ret < 0)
        {
            internal_aug_error_msg(aug, "Cannot remove a configuration option from the file");
            goto finalize;
        }

        free(option_names[i]);
        option_names[i] = NULL;
    }

    /* Notify the finalize algorithm that we already freed all individual indexes */
    option_count = 0;

    create_parentdir(real_path);
    if (aug_save(aug) < 0)
    {
        internal_aug_error_msg(aug, "Cannot save the changes made to the configuration");
        goto finalize;
    }

    retval = true;

finalize:
    for (int i = 0; i < option_count; ++i)
    {
        if (option_names[i] != NULL)
            free(option_names[i]);
    }

    free(option_names);

    if (aug != NULL)
        aug_close(aug);

    return retval;
}

bool libreport_save_plugin_conf_file(const char *name, GHashTable *settings)
{
    const char *plugins_conf_dir = getenv("LIBREPORT_DEBUG_PLUGINS_CONF_DIR");
    if (plugins_conf_dir == NULL)
        plugins_conf_dir = PLUGINS_CONF_DIR;

    g_autofree char *conf_path = g_build_filename(plugins_conf_dir, name, NULL);
    bool ret = libreport_save_conf_file(conf_path, settings);

    return ret;
}