/**
* Modification indication since last save
- * GNUNET_NO if clean, GNUNET_YES if dirty,
- * GNUNET_SYSERR on error (i.e. last save failed)
+ * #GNUNET_NO if clean, #GNUNET_YES if dirty,
+ * #GNUNET_SYSERR on error (i.e. last save failed)
*/
int dirty;
*/
struct DiffHandle
{
- const struct GNUNET_CONFIGURATION_Handle *cfgDefault;
+ const struct GNUNET_CONFIGURATION_Handle *cfg_default;
+
struct GNUNET_CONFIGURATION_Handle *cfgDiff;
};
-
/**
* Create a GNUNET_CONFIGURATION_Handle.
*
* @param cfg configuration to update
* @param mem the memory block of serialized configuration
* @param size the size of the memory block
- * @param allow_inline set to GNUNET_YES if we recursively load configuration
- * from inlined configurations; GNUNET_NO if not and raise warnings
+ * @param allow_inline set to #GNUNET_YES if we recursively load configuration
+ * from inlined configurations; #GNUNET_NO if not and raise warnings
* when we come across them
- * @return GNUNET_OK on success, GNUNET_ERROR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg,
*
* @param cfg configuration to update
* @param filename name of the configuration file
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
int dirty;
int ret;
- LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to parse config file `%s'\n", filename);
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Asked to parse config file `%s'\n",
+ filename);
fn = GNUNET_STRINGS_filename_expand (filename);
- LOG (GNUNET_ERROR_TYPE_DEBUG, "Config file name expanded to `%s'\n", fn);
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Config file name expanded to `%s'\n",
+ fn);
if (fn == NULL)
return GNUNET_SYSERR;
dirty = cfg->dirty; /* back up value! */
* changed since the last save.
*
* @param cfg configuration to inspect
- * @return GNUNET_NO if clean, GNUNET_YES if dirty, GNUNET_SYSERR on error (i.e. last save failed)
+ * @return #GNUNET_NO if clean, #GNUNET_YES if dirty, #GNUNET_SYSERR on error (i.e. last save failed)
*/
int
GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg)
*
* @param cfg configuration to write
* @param filename where to write the configuration
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
*
* @param cfg configuration to inspect
* @param iter function to call on each option
- * @param iter_cls closure for iter
+ * @param iter_cls closure for @a iter
*/
void
GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
* @param cfg configuration to inspect
* @param section the section
* @param iter function to call on each option
- * @param iter_cls closure for iter
+ * @param iter_cls closure for @a iter
*/
void
GNUNET_CONFIGURATION_iterate_section_values (const struct
*
* @param cfg configuration to inspect
* @param iter function to call on each section
- * @param iter_cls closure for iter
+ * @param iter_cls closure for @a iter
*/
void
GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle
}
}
+
/**
* Remove the given section and all options in it.
*
* Copy a configuration value to the given target configuration.
* Overwrites existing entries.
*
- * @param cls the destination configuration (struct GNUNET_CONFIGURATION_Handle*)
+ * @param cls the destination configuration (`struct GNUNET_CONFIGURATION_Handle *`)
* @param section section for the value
* @param option option name of the value
* @param value value to copy
*/
static void
-copy_entry (void *cls, const char *section, const char *option,
+copy_entry (void *cls,
+ const char *section,
+ const char *option,
const char *value)
{
struct GNUNET_CONFIGURATION_Handle *dst = cls;
/**
* Find a section entry from a configuration.
*
- * @param cfg FIXME
- * @param section FIXME
+ * @param cfg configuration to search in
+ * @param section name of the section to look for
* @return matching entry, NULL if not found
*/
static struct ConfigSection *
-findSection (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
+find_section (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section)
{
struct ConfigSection *pos;
* @return matching entry, NULL if not found
*/
static struct ConfigEntry *
-findEntry (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section,
+find_entry (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section,
const char *key)
{
struct ConfigSection *sec;
struct ConfigEntry *pos;
- if (NULL == (sec = findSection (cfg, section)))
+ if (NULL == (sec = find_section (cfg, section)))
return NULL;
pos = sec->entries;
while ((pos != NULL) && (0 != strcasecmp (key, pos->key)))
* (default against a new configuration) and write the diffs in a
* diff-configuration object (the callback object).
*
- * @param cls the diff configuration (struct DiffHandle*)
+ * @param cls the diff configuration (`struct DiffHandle *`)
* @param section section for the value (of the default conf.)
* @param option option name of the value (of the default conf.)
* @param value value to copy (of the default conf.)
*/
static void
-compare_entries (void *cls, const char *section, const char *option,
+compare_entries (void *cls,
+ const char *section,
+ const char *option,
const char *value)
{
struct DiffHandle *dh = cls;
struct ConfigEntry *entNew;
- entNew = findEntry (dh->cfgDefault, section, option);
+ entNew = find_entry (dh->cfg_default, section, option);
if ( (NULL != entNew) &&
(NULL != entNew->val) &&
(0 == strcmp (entNew->val, value)) )
/**
* Compute configuration with only entries that have been changed
*
- * @param cfgDefault original configuration
- * @param cfgNew new configuration
+ * @param cfg_default original configuration
+ * @param cfg_new new configuration
* @return configuration with only the differences, never NULL
*/
struct GNUNET_CONFIGURATION_Handle *
-GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle
- *cfgDefault,
- const struct GNUNET_CONFIGURATION_Handle
- *cfgNew)
+GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle *cfg_default,
+ const struct GNUNET_CONFIGURATION_Handle *cfg_new)
{
struct DiffHandle diffHandle;
diffHandle.cfgDiff = GNUNET_CONFIGURATION_create ();
- diffHandle.cfgDefault = cfgDefault;
- GNUNET_CONFIGURATION_iterate (cfgNew, &compare_entries, &diffHandle);
+ diffHandle.cfg_default = cfg_default;
+ GNUNET_CONFIGURATION_iterate (cfg_new, &compare_entries, &diffHandle);
return diffHandle.cfgDiff;
}
/**
* Write only configuration entries that have been changed to configuration file
- * @param cfgDefault default configuration
- * @param cfgNew new configuration
+ *
+ * @param cfg_default default configuration
+ * @param cfg_new new configuration
* @param filename where to write the configuration diff between default and new
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle
- *cfgDefault,
+ *cfg_default,
const struct GNUNET_CONFIGURATION_Handle
- *cfgNew, const char *filename)
+ *cfg_new, const char *filename)
{
int ret;
struct GNUNET_CONFIGURATION_Handle *diff;
- diff = GNUNET_CONFIGURATION_get_diff (cfgDefault, cfgNew);
+ diff = GNUNET_CONFIGURATION_get_diff (cfg_default, cfg_new);
ret = GNUNET_CONFIGURATION_write (diff, filename);
GNUNET_CONFIGURATION_destroy (diff);
return ret;
struct ConfigEntry *e;
char *nv;
- e = findEntry (cfg, section, option);
+ e = find_entry (cfg, section, option);
if (NULL != e)
{
if (NULL == value)
}
return;
}
- sec = findSection (cfg, section);
+ sec = find_section (cfg, section);
if (sec == NULL)
{
sec = GNUNET_new (struct ConfigSection);
* @param section section of interest
* @param option option of interest
* @param number where to store the numeric value of the option
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
{
struct ConfigEntry *e;
- if (NULL == (e = findEntry (cfg, section, option)))
+ if (NULL == (e = find_entry (cfg, section, option)))
return GNUNET_SYSERR;
if (NULL == e->val)
return GNUNET_SYSERR;
* @param section section of interest
* @param option option of interest
* @param time set to the time value stored in the configuration
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle
{
struct ConfigEntry *e;
- if (NULL == (e = findEntry (cfg, section, option)))
+ if (NULL == (e = find_entry (cfg, section, option)))
return GNUNET_SYSERR;
if (NULL == e->val)
return GNUNET_SYSERR;
* @param section section of interest
* @param option option of interest
* @param size set to the size in bytes as stored in the configuration
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
-GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle
- *cfg, const char *section,
+GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section,
const char *option,
unsigned long long *size)
{
struct ConfigEntry *e;
- if (NULL == (e = findEntry (cfg, section, option)))
+ if (NULL == (e = find_entry (cfg, section, option)))
return GNUNET_SYSERR;
if (NULL == e->val)
return GNUNET_SYSERR;
* @param option option of interest
* @param value will be set to a freshly allocated configuration
* value, or NULL if option is not specified
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
-GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle
- *cfg, const char *section,
- const char *option, char **value)
+GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section,
+ const char *option,
+ char **value)
{
struct ConfigEntry *e;
- LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to retrieve string `%s' in section `%s'\n", option, section);
- if ( (NULL == (e = findEntry (cfg, section, option))) ||
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Asked to retrieve string `%s' in section `%s'\n",
+ option,
+ section);
+ if ( (NULL == (e = find_entry (cfg, section, option))) ||
(NULL == e->val) )
{
*value = NULL;
* @param choices NULL-terminated list of legal values
* @param value will be set to an entry in the legal list,
* or NULL if option is not specified and no default given
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
-GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle
- *cfg, const char *section,
- const char *option, const char *const *choices,
+GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section,
+ const char *option,
+ const char *const *choices,
const char **value)
{
struct ConfigEntry *e;
unsigned int i;
- if (NULL == (e = findEntry (cfg, section, option)))
+ if (NULL == (e = find_entry (cfg, section, option)))
return GNUNET_SYSERR;
for (i = 0; NULL != choices[i]; i++)
if (0 == strcasecmp (choices[i], e->val))
{
LOG (GNUNET_ERROR_TYPE_ERROR,
_("Configuration value '%s' for '%s'"
- " in section '%s' is not in set of legal choices\n"), e->val, option,
+ " in section '%s' is not in set of legal choices\n"),
+ e->val,
+ option,
section);
return GNUNET_SYSERR;
}
/**
* Test if we have a value for a particular option
+ *
* @param cfg configuration to inspect
* @param section section of interest
* @param option option of interest
{
struct ConfigEntry *e;
- if ((NULL == (e = findEntry (cfg, section, option))) || (NULL == e->val))
+ if ((NULL == (e = find_entry (cfg, section, option))) || (NULL == e->val))
return GNUNET_NO;
return GNUNET_YES;
}
char *def;
char *end;
unsigned int lopen;
+ char erased_char;
+ char *erased_pos;
+ if (NULL == orig)
+ return NULL;
if (depth > 128)
{
LOG (GNUNET_ERROR_TYPE_WARNING,
"Doesn't start with $ - not expanding\n");
return orig;
}
+ erased_char = 0;
+ erased_pos = NULL;
if ('{' == orig[1])
{
start = &orig[2];
break;
}
}
+ erased_char = *end;
+ erased_pos = end;
*end = '\0';
post = end + 1;
def = strchr (orig, ':');
}
else
{
+ erased_char = orig[i];
+ erased_pos = &orig[i];
orig[i] = '\0';
post = &orig[i + 1];
}
}
if (NULL == env)
{
- orig[strlen (orig)] = DIR_SEPARATOR;
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Expanded to `%s' (returning orig)\n",
- orig);
+ start = GNUNET_strdup (start);
+ if (erased_pos)
+ *erased_pos = erased_char;
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ _("Failed to expand `%s' in `%s' as it is neither found in [PATHS] nor defined as an environmental variable\n"),
+ start, orig);
+ GNUNET_free (start);
return orig;
}
prefix = GNUNET_strdup (env);
* @param option option of interest
* @param value will be set to a freshly allocated configuration
* value, or NULL if option is not specified
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
-GNUNET_CONFIGURATION_get_value_filename (const struct
- GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
- const char *option, char **value)
+ const char *option,
+ char **value)
{
char *tmp;
- LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to retrieve filename `%s' in section `%s'\n", option, section);
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Asked to retrieve filename `%s' in section `%s'\n",
+ option,
+ section);
if (GNUNET_OK !=
GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &tmp))
{
- LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to retrieve filename\n");
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Failed to retrieve filename\n");
*value = NULL;
return GNUNET_SYSERR;
}
/**
* Get a configuration value that should be in a set of
- * "GNUNET_YES" or "GNUNET_NO".
+ * "YES" or "NO".
*
* @param cfg configuration to inspect
* @param section section of interest
* @param option option of interest
- * @return GNUNET_YES, GNUNET_NO or GNUNET_SYSERR
+ * @return #GNUNET_YES, #GNUNET_NO or #GNUNET_SYSERR
*/
int
-GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle
- *cfg, const char *section,
+GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section,
const char *option)
{
static const char *yesno[] = { "YES", "NO", NULL };
* @param section section of interest
* @param option option of interest
* @param cb function to call on each filename
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
* @return number of filenames iterated over, -1 on error
*/
int
-GNUNET_CONFIGURATION_iterate_value_filenames (const struct
- GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
GNUNET_FileNameCallback cb,
*
* @param cls string we compare with (const char*)
* @param fn filename we are currently looking at
- * @return GNUNET_OK if the names do not match, GNUNET_SYSERR if they do
+ * @return #GNUNET_OK if the names do not match, #GNUNET_SYSERR if they do
*/
static int
test_match (void *cls, const char *fn)
* @param section section of interest
* @param option option of interest
* @param value filename to append
- * @return GNUNET_OK on success,
- * GNUNET_NO if the filename already in the list
- * GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success,
+ * #GNUNET_NO if the filename already in the list
+ * #GNUNET_SYSERR on error
*/
int
-GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle
- *cfg, const char *section,
+GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *section,
const char *option,
const char *value)
{
* @param section section of interest
* @param option option of interest
* @param value filename to remove
- * @return GNUNET_OK on success,
- * GNUNET_NO if the filename is not in the list,
- * GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success,
+ * #GNUNET_NO if the filename is not in the list,
+ * #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_remove_value_filename (struct GNUNET_CONFIGURATION_Handle
/**
- * Wrapper around GNUNET_CONFIGURATION_parse.
+ * Wrapper around #GNUNET_CONFIGURATION_parse. Called on each
+ * file in a directory, we trigger parsing on those files that
+ * end with ".conf".
*
* @param cls the cfg
* @param filename file to parse
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
*/
static int
parse_configuration_file (void *cls, const char *filename)
ext = strrchr (filename, '.');
if ((NULL == ext) || (0 != strcmp (ext, ".conf")))
{
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Skipping file `%s'\n", filename);
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ "Skipping file `%s'\n",
+ filename);
return GNUNET_OK;
}
*
* @param cfg configuration to update
* @param defaults_d directory with the defaults
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg,
*
* @param cfg configuration to update
* @param filename name of the configuration file, NULL to load defaults
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg,
}
-
/* end of configuration.c */
projects / oweals / gnunet.git / blobdiff