2 This file is part of GNUnet.
3 (C) 2006, 2007, 2008, 2009, 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file src/util/configuration.c
23 * @brief configuration management
24 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
30 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
32 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
35 * @brief configuration entry
41 * This is a linked list.
43 struct ConfigEntry *next;
51 * current, commited value
58 * @brief configuration section
63 * This is a linked list.
65 struct ConfigSection *next;
68 * entries in the section
70 struct ConfigEntry *entries;
80 * @brief configuration data
82 struct GNUNET_CONFIGURATION_Handle
85 * Configuration sections.
87 struct ConfigSection *sections;
90 * Modification indication since last save
91 * #GNUNET_NO if clean, #GNUNET_YES if dirty,
92 * #GNUNET_SYSERR on error (i.e. last save failed)
100 * Used for diffing a configuration object against
105 const struct GNUNET_CONFIGURATION_Handle *cfg_default;
107 struct GNUNET_CONFIGURATION_Handle *cfgDiff;
112 * Create a GNUNET_CONFIGURATION_Handle.
114 * @return fresh configuration object
116 struct GNUNET_CONFIGURATION_Handle *
117 GNUNET_CONFIGURATION_create ()
119 return GNUNET_new (struct GNUNET_CONFIGURATION_Handle);
124 * Destroy configuration object.
126 * @param cfg configuration to destroy
129 GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg)
131 struct ConfigSection *sec;
133 while (NULL != (sec = cfg->sections))
134 GNUNET_CONFIGURATION_remove_section (cfg, sec->name);
140 * De-serializes configuration
142 * @param cfg configuration to update
143 * @param mem the memory block of serialized configuration
144 * @param size the size of the memory block
145 * @param allow_inline set to #GNUNET_YES if we recursively load configuration
146 * from inlined configurations; #GNUNET_NO if not and raise warnings
147 * when we come across them
148 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
151 GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg,
171 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deserializing config file\n");
173 section = GNUNET_strdup ("");
177 while (r_bytes < size)
179 GNUNET_free_non_null (line_orig);
180 /* fgets-like behaviour on buffer */
181 to_read = size - r_bytes;
182 pos = memchr (&mem[r_bytes], '\n', to_read);
185 line_orig = GNUNET_strndup (&mem[r_bytes], line_size = to_read);
186 r_bytes += line_size;
190 line_orig = GNUNET_strndup (&mem[r_bytes], line_size = (pos - &mem[r_bytes]));
191 r_bytes += line_size + 1;
194 /* increment line number */
196 /* tabs and '\r' are whitespace */
197 emptyline = GNUNET_YES;
198 for (i = 0; i < line_size; i++)
205 emptyline = GNUNET_NO;
207 /* ignore empty lines */
208 if (GNUNET_YES == emptyline)
211 /* remove tailing whitespace */
212 for (i = line_size - 1; (i >= 1) && (isspace ((unsigned char) line[i]));i--)
215 /* remove leading whitespace */
216 for (; line[0] != '\0' && (isspace ((unsigned char) line[0])); line++);
218 /* ignore comments */
219 if ( ('#' == line[0]) || ('%' == line[0]) )
222 /* handle special "@INLINE@" directive */
223 if (0 == strncasecmp (line,
225 strlen ("@INLINE@ ")))
228 value = &line[strlen ("@INLINE@ ")];
229 if (GNUNET_YES == allow_inline)
231 if (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg, value))
233 ret = GNUNET_SYSERR; /* failed to parse included config */
239 LOG (GNUNET_ERROR_TYPE_DEBUG,
240 "Ignoring parsing @INLINE@ configurations, not allowed!\n");
246 if ( ('[' == line[0]) && (']' == line[line_size - 1]) )
249 line[line_size - 1] = '\0';
251 GNUNET_free (section);
252 section = GNUNET_strdup (value);
253 LOG (GNUNET_ERROR_TYPE_DEBUG,
254 "Config section `%s'\n",
258 if (NULL != (eq = strchr (line, '=')))
261 tag = GNUNET_strndup (line, eq - line);
262 /* remove tailing whitespace */
263 for (i = strlen (tag) - 1; (i >= 1) && (isspace ((unsigned char) tag[i]));i--)
266 /* Strip whitespace */
268 while (isspace ((unsigned char) value[0]))
270 for (i = strlen (value) - 1; (i >= 1) && (isspace ((unsigned char) value[i]));i--)
275 if ( ('"' == value[0]) &&
276 ('"' == value[strlen (value) - 1]) )
278 value[strlen (value) - 1] = '\0';
281 LOG (GNUNET_ERROR_TYPE_DEBUG, "Config value %s=\"%s\"\n", tag, value);
282 GNUNET_CONFIGURATION_set_value_string (cfg, section, tag, &value[i]);
287 LOG (GNUNET_ERROR_TYPE_WARNING,
288 _("Syntax error while deserializing in line %u\n"),
293 LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished deserializing config\n");
294 GNUNET_free_non_null (line_orig);
295 GNUNET_free (section);
296 GNUNET_assert ( (GNUNET_OK != ret) || (r_bytes == size) );
302 * Parse a configuration file, add all of the options in the
303 * file to the configuration environment.
305 * @param cfg configuration to update
306 * @param filename name of the configuration file
307 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
310 GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
311 const char *filename)
320 LOG (GNUNET_ERROR_TYPE_DEBUG,
321 "Asked to parse config file `%s'\n",
323 fn = GNUNET_STRINGS_filename_expand (filename);
324 LOG (GNUNET_ERROR_TYPE_DEBUG,
325 "Config file name expanded to `%s'\n",
328 return GNUNET_SYSERR;
329 dirty = cfg->dirty; /* back up value! */
331 GNUNET_DISK_file_size (fn, &fs64, GNUNET_YES, GNUNET_YES))
333 LOG (GNUNET_ERROR_TYPE_WARNING,
334 "Error while determining the file size of %s\n", fn);
336 return GNUNET_SYSERR;
340 GNUNET_break (0); /* File size is more than the heap size */
342 return GNUNET_SYSERR;
345 mem = GNUNET_malloc (fs);
346 if (fs != GNUNET_DISK_fn_read (fn, mem, fs))
348 LOG (GNUNET_ERROR_TYPE_WARNING,
349 "Error while reading file %s\n", fn);
352 return GNUNET_SYSERR;
354 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deserializing contents of file `%s'\n", fn);
356 ret = GNUNET_CONFIGURATION_deserialize (cfg, mem, fs, GNUNET_YES);
358 /* restore dirty flag - anything we set in the meantime
366 * Test if there are configuration options that were
367 * changed since the last save.
369 * @param cfg configuration to inspect
370 * @return #GNUNET_NO if clean, #GNUNET_YES if dirty, #GNUNET_SYSERR on error (i.e. last save failed)
373 GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg)
380 * Serializes the given configuration.
382 * @param cfg configuration to serialize
383 * @param size will be set to the size of the serialized memory block
384 * @return the memory block where the serialized configuration is
385 * present. This memory should be freed by the caller
388 GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg,
391 struct ConfigSection *sec;
392 struct ConfigEntry *ent;
402 /* Pass1 : calculate the buffer size required */
404 for (sec = cfg->sections; NULL != sec; sec = sec->next)
406 /* For each section we need to add 3 charaters: {'[',']','\n'} */
407 m_size += strlen (sec->name) + 3;
408 for (ent = sec->entries; NULL != ent; ent = ent->next)
410 if (NULL != ent->val)
412 /* if val has any '\n' then they occupy +1 character as '\n'->'\\','n' */
414 while (NULL != (pos = strstr (pos, "\n")))
419 /* For each key = value pair we need to add 4 characters (2
420 spaces and 1 equal-to character and 1 new line) */
421 m_size += strlen (ent->key) + strlen (ent->val) + 4;
424 /* A new line after section end */
428 /* Pass2: Allocate memory and write the configuration to it */
429 mem = GNUNET_malloc (m_size);
435 len = GNUNET_asprintf (&cbuf, "[%s]\n", sec->name);
436 GNUNET_assert (0 < len);
437 memcpy (mem + c_size, cbuf, len);
440 for (ent = sec->entries; NULL != ent; ent = ent->next)
442 if (NULL != ent->val)
444 val = GNUNET_malloc (strlen (ent->val) * 2 + 1);
445 strcpy (val, ent->val);
446 while (NULL != (pos = strstr (val, "\n")))
448 memmove (&pos[2], &pos[1], strlen (&pos[1]));
452 len = GNUNET_asprintf (&cbuf, "%s = %s\n", ent->key, val);
454 memcpy (mem + c_size, cbuf, len);
459 memcpy (mem + c_size, "\n", 1);
463 GNUNET_assert (c_size == m_size);
470 * Write configuration file.
472 * @param cfg configuration to write
473 * @param filename where to write the configuration
474 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
477 GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
478 const char *filename)
484 fn = GNUNET_STRINGS_filename_expand (filename);
486 return GNUNET_SYSERR;
487 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn))
490 return GNUNET_SYSERR;
492 cfg_buf = GNUNET_CONFIGURATION_serialize (cfg, &size);
493 if (size != GNUNET_DISK_fn_write (fn, cfg_buf, size,
494 GNUNET_DISK_PERM_USER_READ
495 | GNUNET_DISK_PERM_USER_WRITE
496 | GNUNET_DISK_PERM_GROUP_READ
497 | GNUNET_DISK_PERM_GROUP_WRITE))
500 GNUNET_free (cfg_buf);
501 LOG (GNUNET_ERROR_TYPE_WARNING,
502 "Writing configration to file: %s failed\n", filename);
503 cfg->dirty = GNUNET_SYSERR; /* last write failed */
504 return GNUNET_SYSERR;
507 GNUNET_free (cfg_buf);
508 cfg->dirty = GNUNET_NO; /* last write succeeded */
514 * Iterate over all options in the configuration.
516 * @param cfg configuration to inspect
517 * @param iter function to call on each option
518 * @param iter_cls closure for @a iter
521 GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
522 GNUNET_CONFIGURATION_Iterator iter,
525 struct ConfigSection *spos;
526 struct ConfigEntry *epos;
528 for (spos = cfg->sections; NULL != spos; spos = spos->next)
529 for (epos = spos->entries; NULL != epos; epos = epos->next)
530 if (NULL != epos->val)
531 iter (iter_cls, spos->name, epos->key, epos->val);
536 * Iterate over values of a section in the configuration.
538 * @param cfg configuration to inspect
539 * @param section the section
540 * @param iter function to call on each option
541 * @param iter_cls closure for @a iter
544 GNUNET_CONFIGURATION_iterate_section_values (const struct
545 GNUNET_CONFIGURATION_Handle *cfg,
547 GNUNET_CONFIGURATION_Iterator iter,
550 struct ConfigSection *spos;
551 struct ConfigEntry *epos;
553 spos = cfg->sections;
554 while ((spos != NULL) && (0 != strcasecmp (spos->name, section)))
558 for (epos = spos->entries; NULL != epos; epos = epos->next)
559 if (NULL != epos->val)
560 iter (iter_cls, spos->name, epos->key, epos->val);
565 * Iterate over all sections in the configuration.
567 * @param cfg configuration to inspect
568 * @param iter function to call on each section
569 * @param iter_cls closure for @a iter
572 GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle
574 GNUNET_CONFIGURATION_Section_Iterator
575 iter, void *iter_cls)
577 struct ConfigSection *spos;
578 struct ConfigSection *next;
580 next = cfg->sections;
585 iter (iter_cls, spos->name);
591 * Remove the given section and all options in it.
593 * @param cfg configuration to inspect
594 * @param section name of the section to remove
597 GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg,
600 struct ConfigSection *spos;
601 struct ConfigSection *prev;
602 struct ConfigEntry *ent;
605 spos = cfg->sections;
608 if (0 == strcasecmp (section, spos->name))
611 cfg->sections = spos->next;
613 prev->next = spos->next;
614 while (NULL != (ent = spos->entries))
616 spos->entries = ent->next;
617 GNUNET_free (ent->key);
618 GNUNET_free_non_null (ent->val);
620 cfg->dirty = GNUNET_YES;
622 GNUNET_free (spos->name);
633 * Copy a configuration value to the given target configuration.
634 * Overwrites existing entries.
636 * @param cls the destination configuration (`struct GNUNET_CONFIGURATION_Handle *`)
637 * @param section section for the value
638 * @param option option name of the value
639 * @param value value to copy
642 copy_entry (void *cls,
647 struct GNUNET_CONFIGURATION_Handle *dst = cls;
649 GNUNET_CONFIGURATION_set_value_string (dst, section, option, value);
654 * Duplicate an existing configuration object.
656 * @param cfg configuration to duplicate
657 * @return duplicate configuration
659 struct GNUNET_CONFIGURATION_Handle *
660 GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg)
662 struct GNUNET_CONFIGURATION_Handle *ret;
664 ret = GNUNET_CONFIGURATION_create ();
665 GNUNET_CONFIGURATION_iterate (cfg, ©_entry, ret);
671 * Find a section entry from a configuration.
673 * @param cfg configuration to search in
674 * @param section name of the section to look for
675 * @return matching entry, NULL if not found
677 static struct ConfigSection *
678 find_section (const struct GNUNET_CONFIGURATION_Handle *cfg,
681 struct ConfigSection *pos;
684 while ((pos != NULL) && (0 != strcasecmp (section, pos->name)))
691 * Find an entry from a configuration.
693 * @param cfg handle to the configuration
694 * @param section section the option is in
695 * @param key the option
696 * @return matching entry, NULL if not found
698 static struct ConfigEntry *
699 find_entry (const struct GNUNET_CONFIGURATION_Handle *cfg,
703 struct ConfigSection *sec;
704 struct ConfigEntry *pos;
706 if (NULL == (sec = find_section (cfg, section)))
709 while ((pos != NULL) && (0 != strcasecmp (key, pos->key)))
716 * A callback function, compares entries from two configurations
717 * (default against a new configuration) and write the diffs in a
718 * diff-configuration object (the callback object).
720 * @param cls the diff configuration (`struct DiffHandle *`)
721 * @param section section for the value (of the default conf.)
722 * @param option option name of the value (of the default conf.)
723 * @param value value to copy (of the default conf.)
726 compare_entries (void *cls,
731 struct DiffHandle *dh = cls;
732 struct ConfigEntry *entNew;
734 entNew = find_entry (dh->cfg_default, section, option);
735 if ( (NULL != entNew) &&
736 (NULL != entNew->val) &&
737 (0 == strcmp (entNew->val, value)) )
739 GNUNET_CONFIGURATION_set_value_string (dh->cfgDiff, section, option, value);
744 * Compute configuration with only entries that have been changed
746 * @param cfg_default original configuration
747 * @param cfg_new new configuration
748 * @return configuration with only the differences, never NULL
750 struct GNUNET_CONFIGURATION_Handle *
751 GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle *cfg_default,
752 const struct GNUNET_CONFIGURATION_Handle *cfg_new)
754 struct DiffHandle diffHandle;
756 diffHandle.cfgDiff = GNUNET_CONFIGURATION_create ();
757 diffHandle.cfg_default = cfg_default;
758 GNUNET_CONFIGURATION_iterate (cfg_new, &compare_entries, &diffHandle);
759 return diffHandle.cfgDiff;
764 * Write only configuration entries that have been changed to configuration file
766 * @param cfg_default default configuration
767 * @param cfg_new new configuration
768 * @param filename where to write the configuration diff between default and new
769 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
772 GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle
774 const struct GNUNET_CONFIGURATION_Handle
775 *cfg_new, const char *filename)
778 struct GNUNET_CONFIGURATION_Handle *diff;
780 diff = GNUNET_CONFIGURATION_get_diff (cfg_default, cfg_new);
781 ret = GNUNET_CONFIGURATION_write (diff, filename);
782 GNUNET_CONFIGURATION_destroy (diff);
788 * Set a configuration value that should be a string.
790 * @param cfg configuration to update
791 * @param section section of interest
792 * @param option option of interest
793 * @param value value to set
796 GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle *cfg,
797 const char *section, const char *option,
800 struct ConfigSection *sec;
801 struct ConfigEntry *e;
804 e = find_entry (cfg, section, option);
809 GNUNET_free_non_null (e->val);
814 nv = GNUNET_strdup (value);
815 GNUNET_free_non_null (e->val);
820 sec = find_section (cfg, section);
823 sec = GNUNET_new (struct ConfigSection);
824 sec->name = GNUNET_strdup (section);
825 sec->next = cfg->sections;
828 e = GNUNET_new (struct ConfigEntry);
829 e->key = GNUNET_strdup (option);
830 e->val = GNUNET_strdup (value);
831 e->next = sec->entries;
837 * Set a configuration value that should be a number.
839 * @param cfg configuration to update
840 * @param section section of interest
841 * @param option option of interest
842 * @param number value to set
845 GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle *cfg,
846 const char *section, const char *option,
847 unsigned long long number)
851 GNUNET_snprintf (s, 64, "%llu", number);
852 GNUNET_CONFIGURATION_set_value_string (cfg, section, option, s);
857 * Get a configuration value that should be a number.
859 * @param cfg configuration to inspect
860 * @param section section of interest
861 * @param option option of interest
862 * @param number where to store the numeric value of the option
863 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
866 GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
867 *cfg, const char *section,
869 unsigned long long *number)
871 struct ConfigEntry *e;
873 if (NULL == (e = find_entry (cfg, section, option)))
874 return GNUNET_SYSERR;
876 return GNUNET_SYSERR;
877 if (1 != SSCANF (e->val, "%llu", number))
878 return GNUNET_SYSERR;
884 * Get a configuration value that should be a relative time.
886 * @param cfg configuration to inspect
887 * @param section section of interest
888 * @param option option of interest
889 * @param time set to the time value stored in the configuration
890 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
893 GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle
894 *cfg, const char *section,
896 struct GNUNET_TIME_Relative *time)
898 struct ConfigEntry *e;
900 if (NULL == (e = find_entry (cfg, section, option)))
901 return GNUNET_SYSERR;
903 return GNUNET_SYSERR;
904 return GNUNET_STRINGS_fancy_time_to_relative (e->val, time);
909 * Get a configuration value that should be a size in bytes.
911 * @param cfg configuration to inspect
912 * @param section section of interest
913 * @param option option of interest
914 * @param size set to the size in bytes as stored in the configuration
915 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
918 GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *cfg,
921 unsigned long long *size)
923 struct ConfigEntry *e;
925 if (NULL == (e = find_entry (cfg, section, option)))
926 return GNUNET_SYSERR;
928 return GNUNET_SYSERR;
929 return GNUNET_STRINGS_fancy_size_to_bytes (e->val, size);
934 * Get a configuration value that should be a string.
936 * @param cfg configuration to inspect
937 * @param section section of interest
938 * @param option option of interest
939 * @param value will be set to a freshly allocated configuration
940 * value, or NULL if option is not specified
941 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
944 GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle *cfg,
949 struct ConfigEntry *e;
951 LOG (GNUNET_ERROR_TYPE_DEBUG,
952 "Asked to retrieve string `%s' in section `%s'\n",
955 if ( (NULL == (e = find_entry (cfg, section, option))) ||
959 return GNUNET_SYSERR;
961 *value = GNUNET_strdup (e->val);
967 * Get a configuration value that should be in a set of
970 * @param cfg configuration to inspect
971 * @param section section of interest
972 * @param option option of interest
973 * @param choices NULL-terminated list of legal values
974 * @param value will be set to an entry in the legal list,
975 * or NULL if option is not specified and no default given
976 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
979 GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle *cfg,
982 const char *const *choices,
985 struct ConfigEntry *e;
988 if (NULL == (e = find_entry (cfg, section, option)))
989 return GNUNET_SYSERR;
990 for (i = 0; NULL != choices[i]; i++)
991 if (0 == strcasecmp (choices[i], e->val))
993 if (NULL == choices[i])
995 LOG (GNUNET_ERROR_TYPE_ERROR,
996 _("Configuration value '%s' for '%s'"
997 " in section '%s' is not in set of legal choices\n"),
1001 return GNUNET_SYSERR;
1003 *value = choices[i];
1009 * Test if we have a value for a particular option
1011 * @param cfg configuration to inspect
1012 * @param section section of interest
1013 * @param option option of interest
1014 * @return #GNUNET_YES if so, #GNUNET_NO if not.
1017 GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
1018 const char *section, const char *option)
1020 struct ConfigEntry *e;
1022 if ((NULL == (e = find_entry (cfg, section, option))) || (NULL == e->val))
1029 * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
1030 * where either in the "PATHS" section or the environtment "FOO" is
1031 * set to "DIRECTORY". We also support default expansion,
1032 * i.e. ${VARIABLE:-default} will expand to $VARIABLE if VARIABLE is
1033 * set in PATHS or the environment, and otherwise to "default". Note
1034 * that "default" itself can also be a $-expression, thus
1035 * "${VAR1:-{$VAR2}}" will expand to VAR1 and if that is not defined
1038 * @param cfg configuration to use for path expansion
1039 * @param orig string to $-expand (will be freed!)
1040 * @param depth recursion depth, used to detect recursive expansions
1041 * @return $-expanded string
1044 expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg,
1065 LOG (GNUNET_ERROR_TYPE_WARNING,
1066 _("Recursive expansion suspected, aborting $-expansion for term `%s'\n"),
1070 LOG (GNUNET_ERROR_TYPE_DEBUG,
1071 "Asked to $-expand %s\n", orig);
1074 LOG (GNUNET_ERROR_TYPE_DEBUG,
1075 "Doesn't start with $ - not expanding\n");
1097 LOG (GNUNET_ERROR_TYPE_WARNING,
1098 _("Missing closing `%s' in option `%s'\n"),
1110 def = strchr (orig, ':');
1115 if ( ('-' == *def) ||
1118 def = GNUNET_strdup (def);
1126 while ( (orig[i] != '/') &&
1127 (orig[i] != '\\') &&
1128 (orig[i] != '\0') &&
1131 if (orig[i] == '\0')
1137 erased_char = orig[i];
1138 erased_pos = &orig[i];
1140 post = &orig[i + 1];
1143 LOG (GNUNET_ERROR_TYPE_DEBUG,
1144 "Split into `%s' and `%s' with default %s\n",
1149 GNUNET_CONFIGURATION_get_value_string (cfg,
1154 LOG (GNUNET_ERROR_TYPE_DEBUG,
1155 "Filename for `%s' is not in PATHS config section\n",
1157 if (NULL == (env = getenv (start)))
1159 LOG (GNUNET_ERROR_TYPE_DEBUG,
1160 "`%s' is not an environment variable\n",
1163 def = expand_dollar (cfg, def, depth + 1);
1168 start = GNUNET_strdup (start);
1170 *erased_pos = erased_char;
1171 LOG (GNUNET_ERROR_TYPE_WARNING,
1172 _("Failed to expand `%s' in `%s' as it is neither found in [PATHS] nor defined as an environmental variable\n"),
1174 GNUNET_free (start);
1177 prefix = GNUNET_strdup (env);
1179 prefix = GNUNET_CONFIGURATION_expand_dollar (cfg, prefix);
1180 LOG (GNUNET_ERROR_TYPE_DEBUG,
1183 if ( (erased_pos) && ('}' != erased_char) )
1185 len = strlen (prefix) + 1;
1186 prefix = GNUNET_realloc (prefix, len + 1);
1187 prefix[len - 1] = erased_char;
1190 result = GNUNET_malloc (strlen (prefix) + strlen (post) + 1);
1191 strcpy (result, prefix);
1192 strcat (result, post);
1193 GNUNET_free_non_null (def);
1194 GNUNET_free (prefix);
1196 LOG (GNUNET_ERROR_TYPE_DEBUG,
1197 "Expanded to `%s'\n",
1204 * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
1205 * where either in the "PATHS" section or the environtment "FOO" is
1206 * set to "DIRECTORY". We also support default expansion,
1207 * i.e. ${VARIABLE:-default} will expand to $VARIABLE if VARIABLE is
1208 * set in PATHS or the environment, and otherwise to "default". Note
1209 * that "default" itself can also be a $-expression, thus
1210 * "${VAR1:-{$VAR2}}" will expand to VAR1 and if that is not defined
1213 * @param cfg configuration to use for path expansion
1214 * @param orig string to $-expand (will be freed!). Note that multiple
1215 * $-expressions can be present in this string. They will all be
1217 * @return $-expanded string
1220 GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg,
1227 for (i = 0; '\0' != orig[i]; i++)
1231 dup = GNUNET_strdup (orig + i);
1232 dup = expand_dollar (cfg, dup, 0);
1233 len = strlen (dup) + 1;
1234 orig = GNUNET_realloc (orig, i + len);
1235 memcpy (orig + i, dup, len);
1243 * Get a configuration value that should be a string.
1245 * @param cfg configuration to inspect
1246 * @param section section of interest
1247 * @param option option of interest
1248 * @param value will be set to a freshly allocated configuration
1249 * value, or NULL if option is not specified
1250 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1253 GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
1254 const char *section,
1260 LOG (GNUNET_ERROR_TYPE_DEBUG,
1261 "Asked to retrieve filename `%s' in section `%s'\n",
1265 GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &tmp))
1267 LOG (GNUNET_ERROR_TYPE_DEBUG,
1268 "Failed to retrieve filename\n");
1270 return GNUNET_SYSERR;
1272 LOG (GNUNET_ERROR_TYPE_DEBUG, "Retrieved filename `%s', $-expanding\n", tmp);
1273 tmp = GNUNET_CONFIGURATION_expand_dollar (cfg, tmp);
1274 LOG (GNUNET_ERROR_TYPE_DEBUG, "Expanded to filename `%s', *nix-expanding\n", tmp);
1275 *value = GNUNET_STRINGS_filename_expand (tmp);
1277 LOG (GNUNET_ERROR_TYPE_DEBUG, "Filename result is `%s'\n", *value);
1279 return GNUNET_SYSERR;
1285 * Get a configuration value that should be in a set of
1288 * @param cfg configuration to inspect
1289 * @param section section of interest
1290 * @param option option of interest
1291 * @return #GNUNET_YES, #GNUNET_NO or #GNUNET_SYSERR
1294 GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg,
1295 const char *section,
1298 static const char *yesno[] = { "YES", "NO", NULL };
1303 GNUNET_CONFIGURATION_get_value_choice (cfg, section, option, yesno, &val);
1304 if (ret == GNUNET_SYSERR)
1306 if (val == yesno[0])
1313 * Iterate over the set of filenames stored in a configuration value.
1315 * @param cfg configuration to inspect
1316 * @param section section of interest
1317 * @param option option of interest
1318 * @param cb function to call on each filename
1319 * @param cb_cls closure for @a cb
1320 * @return number of filenames iterated over, -1 on error
1323 GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_Handle *cfg,
1324 const char *section,
1326 GNUNET_FileNameCallback cb,
1336 GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &list))
1338 GNUNET_assert (list != NULL);
1343 while (pos[0] == ' ')
1345 if (strlen (pos) == 0)
1348 while ((end[0] != ' ') && (end[0] != '\0'))
1356 memmove (end, &end[1], strlen (&end[1]) + 1);
1358 /* illegal, but just keep it */
1361 /* illegal, but just ignore that there was a '/' */
1369 if (strlen (pos) > 0)
1372 if ((cb != NULL) && (GNUNET_OK != cb (cb_cls, pos)))
1374 ret = GNUNET_SYSERR;
1390 * @param value FIXME
1394 escape_name (const char *value)
1400 escaped = GNUNET_malloc (strlen (value) * 2 + 1);
1401 memset (escaped, 0, strlen (value) * 2 + 1);
1404 while (rpos[0] != '\0')
1427 * @param cls string we compare with (const char*)
1428 * @param fn filename we are currently looking at
1429 * @return #GNUNET_OK if the names do not match, #GNUNET_SYSERR if they do
1432 test_match (void *cls, const char *fn)
1434 const char *of = cls;
1436 return (0 == strcmp (of, fn)) ? GNUNET_SYSERR : GNUNET_OK;
1441 * Append a filename to a configuration value that
1442 * represents a list of filenames
1444 * @param cfg configuration to update
1445 * @param section section of interest
1446 * @param option option of interest
1447 * @param value filename to append
1448 * @return #GNUNET_OK on success,
1449 * #GNUNET_NO if the filename already in the list
1450 * #GNUNET_SYSERR on error
1453 GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg,
1454 const char *section,
1462 if (GNUNET_SYSERR ==
1463 GNUNET_CONFIGURATION_iterate_value_filenames (cfg, section, option,
1466 return GNUNET_NO; /* already exists */
1468 GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &old))
1469 old = GNUNET_strdup ("");
1470 escaped = escape_name (value);
1471 nw = GNUNET_malloc (strlen (old) + strlen (escaped) + 2);
1473 if (strlen (old) > 0)
1475 strcat (nw, escaped);
1476 GNUNET_CONFIGURATION_set_value_string (cfg, section, option, nw);
1479 GNUNET_free (escaped);
1485 * Remove a filename from a configuration value that
1486 * represents a list of filenames
1488 * @param cfg configuration to update
1489 * @param section section of interest
1490 * @param option option of interest
1491 * @param value filename to remove
1492 * @return #GNUNET_OK on success,
1493 * #GNUNET_NO if the filename is not in the list,
1494 * #GNUNET_SYSERR on error
1497 GNUNET_CONFIGURATION_remove_value_filename (struct GNUNET_CONFIGURATION_Handle
1498 *cfg, const char *section,
1509 GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &list))
1511 match = escape_name (value);
1515 while (pos[0] == ' ')
1517 if (strlen (pos) == 0)
1520 while ((end[0] != ' ') && (end[0] != '\0'))
1531 /* illegal, but just keep it */
1534 /* illegal, but just ignore that there was a '/' */
1542 if (0 == strcmp (pos, match))
1545 memmove (pos, &end[1], strlen (&end[1]) + 1);
1553 GNUNET_CONFIGURATION_set_value_string (cfg, section, option, list);
1555 GNUNET_free (match);
1564 GNUNET_free (match);
1570 * Wrapper around #GNUNET_CONFIGURATION_parse. Called on each
1571 * file in a directory, we trigger parsing on those files that
1574 * @param cls the cfg
1575 * @param filename file to parse
1576 * @return #GNUNET_OK on success
1579 parse_configuration_file (void *cls, const char *filename)
1581 struct GNUNET_CONFIGURATION_Handle *cfg = cls;
1585 /* Examine file extension */
1586 ext = strrchr (filename, '.');
1587 if ((NULL == ext) || (0 != strcmp (ext, ".conf")))
1589 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1590 "Skipping file `%s'\n",
1595 ret = GNUNET_CONFIGURATION_parse (cfg, filename);
1601 * Load default configuration. This function will parse the
1602 * defaults from the given defaults_d directory.
1604 * @param cfg configuration to update
1605 * @param defaults_d directory with the defaults
1606 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1609 GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg,
1610 const char *defaults_d)
1612 if (GNUNET_SYSERR ==
1613 GNUNET_DISK_directory_scan (defaults_d, &parse_configuration_file, cfg))
1614 return GNUNET_SYSERR; /* no configuration at all found */
1620 * Load configuration (starts with defaults, then loads
1621 * system-specific configuration).
1623 * @param cfg configuration to update
1624 * @param filename name of the configuration file, NULL to load defaults
1625 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1628 GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg,
1629 const char *filename)
1634 ipath = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
1636 return GNUNET_SYSERR;
1638 GNUNET_asprintf (&baseconfig, "%s%s", ipath, "config.d");
1639 GNUNET_free (ipath);
1640 if (GNUNET_SYSERR ==
1641 GNUNET_DISK_directory_scan (baseconfig, &parse_configuration_file, cfg))
1643 GNUNET_free (baseconfig);
1644 return GNUNET_SYSERR; /* no configuration at all found */
1646 GNUNET_free (baseconfig);
1647 if ((NULL != filename) &&
1648 (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg, filename)))
1650 /* specified configuration not found */
1651 return GNUNET_SYSERR;
1654 GNUNET_CONFIGURATION_have_value (cfg, "PATHS", "DEFAULTCONFIG"))) &&
1656 GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "DEFAULTCONFIG",
1662 /* end of configuration.c */