1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
|
/* SPDX-FileCopyrightText: 2010-2023 Greenbone AG
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
/**
* @file settings.c
* @brief Implementation of API to handle configuration file management
*/
#include "settings.h"
#include <stdio.h>
#include <string.h> /* for strlen */
#undef G_LOG_DOMAIN
/**
* @brief GLib log domain.
*/
#define G_LOG_DOMAIN "libgvm base"
/**
* @brief Initialise a settings struct from a file.
*
* @param[in] settings Settings.
* @param[in] filename Complete name of the configuration file.
* @param[in] group Name of the group in the file.
*
* @return 0 success, -1 error.
*/
static int
settings_init_from_file (settings_t *settings, const gchar *filename,
const gchar *group)
{
GError *error = NULL;
if (filename == NULL || group == NULL)
return -1;
gchar *contents = NULL;
if (!g_file_get_contents (filename, &contents, NULL, &error))
{
g_error_free (error);
return -1;
}
if (contents != NULL)
{
gchar *contents_with_group = g_strjoin ("\n", "[Misc]", contents, NULL);
settings->key_file = g_key_file_new ();
if (!g_key_file_load_from_data (
settings->key_file, contents_with_group,
strlen (contents_with_group),
G_KEY_FILE_KEEP_COMMENTS | G_KEY_FILE_KEEP_TRANSLATIONS, &error))
{
g_warning ("Failed to load configuration from %s: %s", filename,
error->message);
g_error_free (error);
g_free (contents_with_group);
g_free (contents);
return -1;
}
g_free (contents_with_group);
g_free (contents);
}
settings->group_name = g_strdup (group);
settings->file_name = g_strdup (filename);
return 0;
}
/**
* @brief Cleanup a settings structure.
*
* @param[in] settings Settings structure.
*/
void
settings_cleanup (settings_t *settings)
{
g_free (settings->group_name);
g_free (settings->file_name);
g_key_file_free (settings->key_file);
}
/**
* @brief Initialise a settings iterator from a file.
*
* @param[in] iterator Settings iterator.
* @param[in] filename Complete name of the configuration file.
* @param[in] group Name of the group in the file.
*
* @return 0 success, -1 error.
*/
int
init_settings_iterator_from_file (settings_iterator_t *iterator,
const gchar *filename, const gchar *group)
{
int ret;
gsize keys_length;
GError *error = NULL;
ret = settings_init_from_file (&iterator->settings, filename, group);
if (ret)
return ret;
iterator->keys = g_key_file_get_keys (iterator->settings.key_file, group,
&keys_length, &error);
if (iterator->keys == NULL)
{
if (error)
{
g_warning ("Failed to retrieve keys of group %s from %s: %s", group,
filename, error->message);
g_error_free (error);
}
g_key_file_free (iterator->settings.key_file);
return -1;
}
iterator->current_key = iterator->keys - 1;
iterator->last_key = iterator->keys + keys_length - 1;
return 0;
}
/**
* @brief Cleanup a settings iterator.
*
* @param[in] iterator Settings iterator.
*/
void
cleanup_settings_iterator (settings_iterator_t *iterator)
{
g_strfreev (iterator->keys);
settings_cleanup (&iterator->settings);
}
/**
* @brief Increment an iterator.
*
* @param[in] iterator Settings iterator.
*
* @return TRUE if there was a next item, else FALSE.
*/
gboolean
settings_iterator_next (settings_iterator_t *iterator)
{
if (iterator->current_key == iterator->last_key)
return FALSE;
iterator->current_key++;
return TRUE;
}
/**
* @brief Get the name from a settings iterator.
*
* @param[in] iterator Settings iterator.
*
* @return Name of current key.
*/
const gchar *
settings_iterator_name (settings_iterator_t *iterator)
{
return *iterator->current_key;
}
/**
* @brief Get the value from a settings iterator.
*
* @param[in] iterator Settings iterator.
*
* @return Value of current key. Caller must g_free.
*/
gchar *
settings_iterator_value (settings_iterator_t *iterator)
{
return g_key_file_get_value (iterator->settings.key_file,
iterator->settings.group_name,
*iterator->current_key, NULL);
}
|