asserts
[oweals/gnunet.git] / src / util / configuration.c
index 2541a79f455486d408f8324d003c550e99a64e7e..a244d5f011b77a5eabd778a6d69e12a5a0a00c5d 100644 (file)
@@ -99,6 +99,18 @@ struct GNUNET_CONFIGURATION_Handle
 };
 
 
+/**
+ * Used for diffing a configuration object against
+ * the default one
+ */
+struct DiffHandle
+{
+  const struct GNUNET_CONFIGURATION_Handle *cfgDefault;
+  struct GNUNET_CONFIGURATION_Handle *cfgDiff;
+};
+
+
+
 /**
  * Create a GNUNET_CONFIGURATION_Handle.
  *
@@ -197,7 +209,7 @@ GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
       if (1 == sscanf (line, "@INLINE@ %191[^\n]", value))
         {
           /* @INLINE@ value */
-          if (0 != GNUNET_CONFIGURATION_parse (cfg, value))
+          if (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg, value))
             ret = GNUNET_SYSERR;        /* failed to parse included config */
         }
       else if (1 == sscanf (line, "[%99[^]]]", value))
@@ -344,10 +356,10 @@ GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
   GNUNET_assert (0 == fclose (fp));
   if (error != 0)
     {
-      cfg->dirty = GNUNET_SYSERR;      /* last write failed */
+      cfg->dirty = GNUNET_SYSERR;       /* last write failed */
       return GNUNET_SYSERR;
     }
-  cfg->dirty = GNUNET_NO;      /* last write succeeded */
+  cfg->dirty = GNUNET_NO;       /* last write succeeded */
   return GNUNET_OK;
 }
 
@@ -359,9 +371,10 @@ GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
  * @param iter function to call on each option
  * @param iter_cls closure for iter
  */
-void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                                  GNUNET_CONFIGURATION_Iterator iter,
-                                  void *iter_cls)
+void
+GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                              GNUNET_CONFIGURATION_Iterator iter,
+                              void *iter_cls)
 {
   struct ConfigSection *spos;
   struct ConfigEntry *epos;
@@ -371,10 +384,10 @@ void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg
     {
       epos = spos->entries;
       while (epos != NULL)
-       {
-         iter (iter_cls, spos->name, epos->key, epos->val);
-         epos = epos->next;
-       }
+        {
+          iter (iter_cls, spos->name, epos->key, epos->val);
+          epos = epos->next;
+        }
       spos = spos->next;
     }
 }
@@ -391,9 +404,7 @@ void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg
  */
 static void
 copy_entry (void *cls,
-           const char *section,
-           const char *option,
-           const char *value)
+            const char *section, const char *option, const char *value)
 {
   struct GNUNET_CONFIGURATION_Handle *dst = cls;
   GNUNET_CONFIGURATION_set_value_string (dst, section, option, value);
@@ -425,7 +436,8 @@ GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg)
  * @return matching entry, NULL if not found
  */
 static struct ConfigSection *
-findSection (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
+findSection (const struct GNUNET_CONFIGURATION_Handle *cfg,
+             const char *section)
 {
   struct ConfigSection *pos;
 
@@ -461,6 +473,59 @@ findEntry (const struct GNUNET_CONFIGURATION_Handle *cfg,
 }
 
 
+/**
+ * A callback function, compares entries from two configurations
+ * (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 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
+compareEntries (void *cls,
+                const char *section, const char *option, const char *value)
+{
+  struct DiffHandle *dh = cls;
+  struct ConfigEntry *entNew;
+  entNew = findEntry (dh->cfgDefault, section, option);
+  if ( (entNew != NULL) &&
+       (strcmp (entNew->val, value) == 0) )
+    return;
+  GNUNET_CONFIGURATION_set_value_string (dh->cfgDiff,
+                                        section,
+                                        option,
+                                        value);
+}
+
+
+/**
+ * Write only configuration entries that have been changed to configuration file
+ * @param cfgDefault default configuration
+ * @param cfgNew new configuration
+ * @param filename where to write the configuration diff between default and new
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle
+                                  *cfgDefault,
+                                  const struct GNUNET_CONFIGURATION_Handle *cfgNew,
+                                  const char *filename)
+{
+  int ret;
+  struct DiffHandle diffHandle;
+
+  diffHandle.cfgDiff = GNUNET_CONFIGURATION_create ();
+  diffHandle.cfgDefault = cfgDefault;
+  GNUNET_CONFIGURATION_iterate (cfgNew, compareEntries, &diffHandle);
+  ret = GNUNET_CONFIGURATION_write (diffHandle.cfgDiff, filename);
+  GNUNET_CONFIGURATION_destroy (diffHandle.cfgDiff);
+  return ret;
+}
+
+
 /**
  * Set a configuration value that should be a string.
  *
@@ -531,8 +596,9 @@ GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int
-GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
-                                       *cfg, const char *section,
+GNUNET_CONFIGURATION_get_value_number (const struct
+                                       GNUNET_CONFIGURATION_Handle *cfg,
+                                       const char *section,
                                        const char *option,
                                        unsigned long long *number)
 {
@@ -558,17 +624,14 @@ GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
  */
 int
 GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle
-                                    *cfg, const char *section,
-                                    const char *option,
-                                    struct GNUNET_TIME_Relative *time)
+                                     *cfg, const char *section,
+                                     const char *option,
+                                     struct GNUNET_TIME_Relative *time)
 {
   unsigned long long num;
   int ret;
 
-  ret = GNUNET_CONFIGURATION_get_value_number (cfg,
-                                              section,
-                                              option,
-                                              &num);
+  ret = GNUNET_CONFIGURATION_get_value_number (cfg, section, option, &num);
   if (ret == GNUNET_OK)
     time->value = (uint64_t) num;
   return ret;
@@ -586,8 +649,9 @@ GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int
-GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle
-                                       *cfg, const char *section,
+GNUNET_CONFIGURATION_get_value_string (const struct
+                                       GNUNET_CONFIGURATION_Handle *cfg,
+                                       const char *section,
                                        const char *option, char **value)
 {
   struct ConfigEntry *e;
@@ -616,8 +680,9 @@ GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int
-GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle
-                                       *cfg, const char *section,
+GNUNET_CONFIGURATION_get_value_choice (const struct
+                                       GNUNET_CONFIGURATION_Handle *cfg,
+                                       const char *section,
                                        const char *option,
                                        const char **choices,
                                        const char **value)
@@ -656,8 +721,9 @@ GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle
  * @return GNUNET_YES if so, GNUNET_NO if not.
  */
 int
-GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                                 const char *section, const char *option)
+GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle
+                                 *cfg, const char *section,
+                                 const char *option)
 {
   struct ConfigEntry *e;
   if ((NULL == (e = findEntry (cfg, section, option))) || (e->val == NULL))
@@ -676,8 +742,8 @@ GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
  * @return $-expanded string
  */
 char *
-GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                                    char *orig)
+GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle
+                                    *cfg, char *orig)
 {
   int i;
   char *prefix;
@@ -699,9 +765,9 @@ GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cf
       orig[i] = '\0';
       post = &orig[i + 1];
     }
-  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
-                                                          "PATHS",
-                                                          &orig[1], &prefix))
+  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (cfg,
+                                                           "PATHS",
+                                                           &orig[1], &prefix))
     {
       if (NULL == (env = getenv (&orig[1])))
         {
@@ -733,8 +799,9 @@ GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cf
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int
-GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle
-                                         *cfg, const char *section,
+GNUNET_CONFIGURATION_get_value_filename (const struct
+                                         GNUNET_CONFIGURATION_Handle *cfg,
+                                         const char *section,
                                          const char *option, char **value)
 {
   int ret;
@@ -770,8 +837,9 @@ GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handl
  * @return GNUNET_YES, GNUNET_NO or GNUNET_SYSERR
  */
 int
-GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                                      const char *section, const char *option)
+GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle
+                                      *cfg, const char *section,
+                                      const char *option)
 {
   static const char *yesno[] = { "YES", "NO", NULL };
   const char *val;
@@ -801,7 +869,7 @@ int
 GNUNET_CONFIGURATION_iterate_value_filenames (const struct
                                               GNUNET_CONFIGURATION_Handle
                                               *cfg, const char *section,
-                                             const char *option,
+                                              const char *option,
                                               GNUNET_FileNameCallback cb,
                                               void *cb_cls)
 {
@@ -1076,6 +1144,14 @@ GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg,
       return GNUNET_SYSERR;
     }
   GNUNET_free (baseconfig);
+  if ( ((GNUNET_YES != GNUNET_CONFIGURATION_have_value (cfg,
+                                                       "PATHS",
+                                                       "DEFAULTCONFIG"))) &&
+       (filename != NULL) )
+    GNUNET_CONFIGURATION_set_value_string (cfg,
+                                          "PATHS",
+                                          "DEFAULTCONFIG",
+                                          filename);
   if ((GNUNET_YES == GNUNET_CONFIGURATION_have_value (cfg,
                                                       "TESTING",
                                                       "WEAKRANDOM")) &&