src/util/configuration.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2006, 2007, 2008, 2009, 2013 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20
  21 /**
  22  * @file src/util/configuration.c
  23  * @brief configuration management
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_crypto_lib.h"
  29 #include "gnunet_strings_lib.h"
  30 #include "gnunet_configuration_lib.h"
  31 #include "gnunet_disk_lib.h"
  32
  33 #define LOG(kind, ...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  34
  35 #define LOG_STRERROR_FILE(kind, syscall, filename) \
  36   GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
  37
  38 /**
  39  * @brief configuration entry
  40  */
  41 struct ConfigEntry
  42 {
  43
  44   /**
  45    * This is a linked list.
  46    */
  47   struct ConfigEntry *next;
  48
  49   /**
  50    * key for this entry
  51    */
  52   char *key;
  53
  54   /**
  55    * current, commited value
  56    */
  57   char *val;
  58 };
  59
  60
  61 /**
  62  * @brief configuration section
  63  */
  64 struct ConfigSection
  65 {
  66   /**
  67    * This is a linked list.
  68    */
  69   struct ConfigSection *next;
  70
  71   /**
  72    * entries in the section
  73    */
  74   struct ConfigEntry *entries;
  75
  76   /**
  77    * name of the section
  78    */
  79   char *name;
  80 };
  81
  82
  83 /**
  84  * @brief configuration data
  85  */
  86 struct GNUNET_CONFIGURATION_Handle
  87 {
  88   /**
  89    * Configuration sections.
  90    */
  91   struct ConfigSection *sections;
  92
  93   /**
  94    * Modification indication since last save
  95    * #GNUNET_NO if clean, #GNUNET_YES if dirty,
  96    * #GNUNET_SYSERR on error (i.e. last save failed)
  97    */
  98   int dirty;
  99 };
 100
 101
 102 /**
 103  * Used for diffing a configuration object against
 104  * the default one
 105  */
 106 struct DiffHandle
 107 {
 108   const struct GNUNET_CONFIGURATION_Handle *cfg_default;
 109
 110   struct GNUNET_CONFIGURATION_Handle *cfgDiff;
 111 };
 112
 113
 114 /**
 115  * Create a GNUNET_CONFIGURATION_Handle.
 116  *
 117  * @return fresh configuration object
 118  */
 119 struct GNUNET_CONFIGURATION_Handle *
 120 GNUNET_CONFIGURATION_create ()
 121 {
 122   return GNUNET_new (struct GNUNET_CONFIGURATION_Handle);
 123 }
 124
 125
 126 /**
 127  * Destroy configuration object.
 128  *
 129  * @param cfg configuration to destroy
 130  */
 131 void
 132 GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg)
 133 {
 134   struct ConfigSection *sec;
 135
 136   while (NULL != (sec = cfg->sections))
 137     GNUNET_CONFIGURATION_remove_section (cfg, sec->name);
 138   GNUNET_free (cfg);
 139 }
 140
 141
 142 /**
 143  * Parse a configuration file @a filename and run the function
 144  * @a cb with the resulting configuration object. Then free the
 145  * configuration object and return the status value from @a cb.
 146  *
 147  * @param filename configuration to parse, NULL for "default"
 148  * @param cb function to run
 149  * @param cb_cls closure for @a cb
 150  * @return #GNUNET_SYSERR if parsing the configuration failed,
 151  *   otherwise return value from @a cb.
 152  */
 153 int
 154 GNUNET_CONFIGURATION_parse_and_run (const char *filename,
 155                                     GNUNET_CONFIGURATION_Callback cb,
 156                                     void *cb_cls)
 157 {
 158   struct GNUNET_CONFIGURATION_Handle *cfg;
 159   int ret;
 160
 161   cfg = GNUNET_CONFIGURATION_create ();
 162   if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, filename))
 163   {
 164     GNUNET_break (0);
 165     GNUNET_CONFIGURATION_destroy (cfg);
 166     return GNUNET_SYSERR;
 167   }
 168   ret = cb (cb_cls, cfg);
 169   GNUNET_CONFIGURATION_destroy (cfg);
 170   return ret;
 171 }
 172
 173
 174 /**
 175  * De-serializes configuration
 176  *
 177  * @param cfg configuration to update
 178  * @param mem the memory block of serialized configuration
 179  * @param size the size of the memory block
 180  * @param basedir set to path from which we recursively load configuration
 181  *          from inlined configurations; NULL if not and raise warnings
 182  *          when we come across them
 183  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 184  */
 185 int
 186 GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg,
 187                                   const char *mem,
 188                                   size_t size,
 189                                   const char *basedir)
 190 {
 191   char *line;
 192   char *line_orig;
 193   size_t line_size;
 194   char *pos;
 195   unsigned int nr;
 196   size_t r_bytes;
 197   size_t to_read;
 198   size_t i;
 199   int emptyline;
 200   int ret;
 201   char *section;
 202   char *eq;
 203   char *tag;
 204   char *value;
 205
 206   ret = GNUNET_OK;
 207   section = GNUNET_strdup ("");
 208   nr = 0;
 209   r_bytes = 0;
 210   line_orig = NULL;
 211   while (r_bytes < size)
 212   {
 213     GNUNET_free_non_null (line_orig);
 214     /* fgets-like behaviour on buffer */
 215     to_read = size - r_bytes;
 216     pos = memchr (&mem[r_bytes], '\n', to_read);
 217     if (NULL == pos)
 218     {
 219       line_orig = GNUNET_strndup (&mem[r_bytes], line_size = to_read);
 220       r_bytes += line_size;
 221     }
 222     else
 223     {
 224       line_orig =
 225         GNUNET_strndup (&mem[r_bytes], line_size = (pos - &mem[r_bytes]));
 226       r_bytes += line_size + 1;
 227     }
 228     line = line_orig;
 229     /* increment line number */
 230     nr++;
 231     /* tabs and '\r' are whitespace */
 232     emptyline = GNUNET_YES;
 233     for (i = 0; i < line_size; i++)
 234     {
 235       if (line[i] == '\t')
 236         line[i] = ' ';
 237       if (line[i] == '\r')
 238         line[i] = ' ';
 239       if (' ' != line[i])
 240         emptyline = GNUNET_NO;
 241     }
 242     /* ignore empty lines */
 243     if (GNUNET_YES == emptyline)
 244       continue;
 245
 246     /* remove tailing whitespace */
 247     for (i = line_size - 1; (i >= 1) && (isspace ((unsigned char) line[i]));
 248          i--)
 249       line[i] = '\0';
 250
 251     /* remove leading whitespace */
 252     for (; line[0] != '\0' && (isspace ((unsigned char) line[0])); line++)
 253       ;
 254
 255     /* ignore comments */
 256     if (('#' == line[0]) || ('%' == line[0]))
 257       continue;
 258
 259     /* handle special "@INLINE@" directive */
 260     if (0 == strncasecmp (line, "@INLINE@ ", strlen ("@INLINE@ ")))
 261     {
 262       /* @INLINE@ value */
 263       value = &line[strlen ("@INLINE@ ")];
 264       if (NULL != basedir)
 265       {
 266         char *fn;
 267
 268         GNUNET_asprintf (&fn, "%s/%s", basedir, value);
 269         if (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg, fn))
 270         {
 271           GNUNET_free (fn);
 272           ret = GNUNET_SYSERR; /* failed to parse included config */
 273           break;
 274         }
 275         GNUNET_free (fn);
 276       }
 277       else
 278       {
 279         LOG (GNUNET_ERROR_TYPE_DEBUG,
 280              "Ignoring parsing @INLINE@ configurations, not allowed!\n");
 281         ret = GNUNET_SYSERR;
 282         break;
 283       }
 284       continue;
 285     }
 286     if (('[' == line[0]) && (']' == line[line_size - 1]))
 287     {
 288       /* [value] */
 289       line[line_size - 1] = '\0';
 290       value = &line[1];
 291       GNUNET_free (section);
 292       section = GNUNET_strdup (value);
 293       continue;
 294     }
 295     if (NULL != (eq = strchr (line, '=')))
 296     {
 297       /* tag = value */
 298       tag = GNUNET_strndup (line, eq - line);
 299       /* remove tailing whitespace */
 300       for (i = strlen (tag) - 1; (i >= 1) && (isspace ((unsigned char) tag[i]));
 301            i--)
 302         tag[i] = '\0';
 303
 304       /* Strip whitespace */
 305       value = eq + 1;
 306       while (isspace ((unsigned char) value[0]))
 307         value++;
 308       for (i = strlen (value) - 1;
 309            (i >= 1) && (isspace ((unsigned char) value[i]));
 310            i--)
 311         value[i] = '\0';
 312
 313       /* remove quotes */
 314       i = 0;
 315       if (('"' == value[0]) && ('"' == value[strlen (value) - 1]))
 316       {
 317         value[strlen (value) - 1] = '\0';
 318         value++;
 319       }
 320       GNUNET_CONFIGURATION_set_value_string (cfg, section, tag, &value[i]);
 321       GNUNET_free (tag);
 322       continue;
 323     }
 324     /* parse error */
 325     LOG (GNUNET_ERROR_TYPE_WARNING,
 326          _ ("Syntax error while deserializing in line %u\n"),
 327          nr);
 328     ret = GNUNET_SYSERR;
 329     break;
 330   }
 331   GNUNET_free_non_null (line_orig);
 332   GNUNET_free (section);
 333   GNUNET_assert ((GNUNET_OK != ret) || (r_bytes == size));
 334   return ret;
 335 }
 336
 337
 338 /**
 339  * Parse a configuration file, add all of the options in the
 340  * file to the configuration environment.
 341  *
 342  * @param cfg configuration to update
 343  * @param filename name of the configuration file
 344  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 345  */
 346 int
 347 GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
 348                             const char *filename)
 349 {
 350   uint64_t fs64;
 351   size_t fs;
 352   char *fn;
 353   char *mem;
 354   char *endsep;
 355   int dirty;
 356   int ret;
 357   ssize_t sret;
 358
 359   fn = GNUNET_STRINGS_filename_expand (filename);
 360   LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to parse config file `%s'\n", fn);
 361   if (NULL == fn)
 362     return GNUNET_SYSERR;
 363   dirty = cfg->dirty; /* back up value! */
 364   if (GNUNET_SYSERR ==
 365       GNUNET_DISK_file_size (fn, &fs64, GNUNET_YES, GNUNET_YES))
 366   {
 367     LOG (GNUNET_ERROR_TYPE_WARNING,
 368          "Error while determining the file size of `%s'\n",
 369          fn);
 370     GNUNET_free (fn);
 371     return GNUNET_SYSERR;
 372   }
 373   if (fs64 > SIZE_MAX)
 374   {
 375     GNUNET_break (0); /* File size is more than the heap size */
 376     GNUNET_free (fn);
 377     return GNUNET_SYSERR;
 378   }
 379   fs = fs64;
 380   mem = GNUNET_malloc (fs);
 381   sret = GNUNET_DISK_fn_read (fn, mem, fs);
 382   if ((sret < 0) || (fs != (size_t) sret))
 383   {
 384     LOG (GNUNET_ERROR_TYPE_WARNING, _ ("Error while reading file `%s'\n"), fn);
 385     GNUNET_free (fn);
 386     GNUNET_free (mem);
 387     return GNUNET_SYSERR;
 388   }
 389   LOG (GNUNET_ERROR_TYPE_DEBUG, "Deserializing contents of file `%s'\n", fn);
 390   endsep = strrchr (fn, (int) '/');
 391   if (NULL != endsep)
 392     *endsep = '\0';
 393   ret = GNUNET_CONFIGURATION_deserialize (cfg, mem, fs, fn);
 394   GNUNET_free (fn);
 395   GNUNET_free (mem);
 396   /* restore dirty flag - anything we set in the meantime
 397    * came from disk */
 398   cfg->dirty = dirty;
 399   return ret;
 400 }
 401
 402
 403 /**
 404  * Test if there are configuration options that were
 405  * changed since the last save.
 406  *
 407  * @param cfg configuration to inspect
 408  * @return #GNUNET_NO if clean, #GNUNET_YES if dirty, #GNUNET_SYSERR on error (i.e. last save failed)
 409  */
 410 int
 411 GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg)
 412 {
 413   return cfg->dirty;
 414 }
 415
 416
 417 /**
 418  * Serializes the given configuration.
 419  *
 420  * @param cfg configuration to serialize
 421  * @param size will be set to the size of the serialized memory block
 422  * @return the memory block where the serialized configuration is
 423  *           present. This memory should be freed by the caller
 424  */
 425 char *
 426 GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg,
 427                                 size_t *size)
 428 {
 429   struct ConfigSection *sec;
 430   struct ConfigEntry *ent;
 431   char *mem;
 432   char *cbuf;
 433   char *val;
 434   char *pos;
 435   int len;
 436   size_t m_size;
 437   size_t c_size;
 438
 439   /* Pass1 : calculate the buffer size required */
 440   m_size = 0;
 441   for (sec = cfg->sections; NULL != sec; sec = sec->next)
 442   {
 443     /* For each section we need to add 3 charaters: {'[',']','\n'} */
 444     m_size += strlen (sec->name) + 3;
 445     for (ent = sec->entries; NULL != ent; ent = ent->next)
 446     {
 447       if (NULL != ent->val)
 448       {
 449         /* if val has any '\n' then they occupy +1 character as '\n'->'\\','n' */
 450         pos = ent->val;
 451         while (NULL != (pos = strstr (pos, "\n")))
 452         {
 453           m_size++;
 454           pos++;
 455         }
 456         /* For each key = value pair we need to add 4 characters (2
 457            spaces and 1 equal-to character and 1 new line) */
 458         m_size += strlen (ent->key) + strlen (ent->val) + 4;
 459       }
 460     }
 461     /* A new line after section end */
 462     m_size++;
 463   }
 464
 465   /* Pass2: Allocate memory and write the configuration to it */
 466   mem = GNUNET_malloc (m_size);
 467   sec = cfg->sections;
 468   c_size = 0;
 469   *size = c_size;
 470   while (NULL != sec)
 471   {
 472     len = GNUNET_asprintf (&cbuf, "[%s]\n", sec->name);
 473     GNUNET_assert (0 < len);
 474     GNUNET_memcpy (mem + c_size, cbuf, len);
 475     c_size += len;
 476     GNUNET_free (cbuf);
 477     for (ent = sec->entries; NULL != ent; ent = ent->next)
 478     {
 479       if (NULL != ent->val)
 480       {
 481         val = GNUNET_malloc (strlen (ent->val) * 2 + 1);
 482         strcpy (val, ent->val);
 483         while (NULL != (pos = strstr (val, "\n")))
 484         {
 485           memmove (&pos[2], &pos[1], strlen (&pos[1]));
 486           pos[0] = '\\';
 487           pos[1] = 'n';
 488         }
 489         len = GNUNET_asprintf (&cbuf, "%s = %s\n", ent->key, val);
 490         GNUNET_free (val);
 491         GNUNET_memcpy (mem + c_size, cbuf, len);
 492         c_size += len;
 493         GNUNET_free (cbuf);
 494       }
 495     }
 496     GNUNET_memcpy (mem + c_size, "\n", 1);
 497     c_size++;
 498     sec = sec->next;
 499   }
 500   GNUNET_assert (c_size == m_size);
 501   *size = c_size;
 502   return mem;
 503 }
 504
 505
 506 /**
 507  * Write configuration file.
 508  *
 509  * @param cfg configuration to write
 510  * @param filename where to write the configuration
 511  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 512  */
 513 int
 514 GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
 515                             const char *filename)
 516 {
 517   char *fn;
 518   char *cfg_buf;
 519   size_t size;
 520   ssize_t sret;
 521
 522   fn = GNUNET_STRINGS_filename_expand (filename);
 523   if (fn == NULL)
 524     return GNUNET_SYSERR;
 525   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn))
 526   {
 527     GNUNET_free (fn);
 528     return GNUNET_SYSERR;
 529   }
 530   cfg_buf = GNUNET_CONFIGURATION_serialize (cfg, &size);
 531   sret = GNUNET_DISK_fn_write (fn,
 532                                cfg_buf,
 533                                size,
 534                                GNUNET_DISK_PERM_USER_READ |
 535                                  GNUNET_DISK_PERM_USER_WRITE |
 536                                  GNUNET_DISK_PERM_GROUP_READ |
 537                                  GNUNET_DISK_PERM_GROUP_WRITE);
 538   if ((sret < 0) || (size != (size_t) sret))
 539   {
 540     GNUNET_free (fn);
 541     GNUNET_free (cfg_buf);
 542     LOG (GNUNET_ERROR_TYPE_WARNING,
 543          "Writing configuration to file `%s' failed\n",
 544          filename);
 545     cfg->dirty = GNUNET_SYSERR; /* last write failed */
 546     return GNUNET_SYSERR;
 547   }
 548   GNUNET_free (fn);
 549   GNUNET_free (cfg_buf);
 550   cfg->dirty = GNUNET_NO; /* last write succeeded */
 551   return GNUNET_OK;
 552 }
 553
 554
 555 /**
 556  * Iterate over all options in the configuration.
 557  *
 558  * @param cfg configuration to inspect
 559  * @param iter function to call on each option
 560  * @param iter_cls closure for @a iter
 561  */
 562 void
 563 GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
 564                               GNUNET_CONFIGURATION_Iterator iter,
 565                               void *iter_cls)
 566 {
 567   struct ConfigSection *spos;
 568   struct ConfigEntry *epos;
 569
 570   for (spos = cfg->sections; NULL != spos; spos = spos->next)
 571     for (epos = spos->entries; NULL != epos; epos = epos->next)
 572       if (NULL != epos->val)
 573         iter (iter_cls, spos->name, epos->key, epos->val);
 574 }
 575
 576
 577 /**
 578  * Iterate over values of a section in the configuration.
 579  *
 580  * @param cfg configuration to inspect
 581  * @param section the section
 582  * @param iter function to call on each option
 583  * @param iter_cls closure for @a iter
 584  */
 585 void
 586 GNUNET_CONFIGURATION_iterate_section_values (
 587   const struct GNUNET_CONFIGURATION_Handle *cfg,
 588   const char *section,
 589   GNUNET_CONFIGURATION_Iterator iter,
 590   void *iter_cls)
 591 {
 592   struct ConfigSection *spos;
 593   struct ConfigEntry *epos;
 594
 595   spos = cfg->sections;
 596   while ((spos != NULL) && (0 != strcasecmp (spos->name, section)))
 597     spos = spos->next;
 598   if (NULL == spos)
 599     return;
 600   for (epos = spos->entries; NULL != epos; epos = epos->next)
 601     if (NULL != epos->val)
 602       iter (iter_cls, spos->name, epos->key, epos->val);
 603 }
 604
 605
 606 /**
 607  * Iterate over all sections in the configuration.
 608  *
 609  * @param cfg configuration to inspect
 610  * @param iter function to call on each section
 611  * @param iter_cls closure for @a iter
 612  */
 613 void
 614 GNUNET_CONFIGURATION_iterate_sections (
 615   const struct GNUNET_CONFIGURATION_Handle *cfg,
 616   GNUNET_CONFIGURATION_Section_Iterator iter,
 617   void *iter_cls)
 618 {
 619   struct ConfigSection *spos;
 620   struct ConfigSection *next;
 621
 622   next = cfg->sections;
 623   while (next != NULL)
 624   {
 625     spos = next;
 626     next = spos->next;
 627     iter (iter_cls, spos->name);
 628   }
 629 }
 630
 631
 632 /**
 633  * Remove the given section and all options in it.
 634  *
 635  * @param cfg configuration to inspect
 636  * @param section name of the section to remove
 637  */
 638 void
 639 GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg,
 640                                      const char *section)
 641 {
 642   struct ConfigSection *spos;
 643   struct ConfigSection *prev;
 644   struct ConfigEntry *ent;
 645
 646   prev = NULL;
 647   spos = cfg->sections;
 648   while (NULL != spos)
 649   {
 650     if (0 == strcasecmp (section, spos->name))
 651     {
 652       if (NULL == prev)
 653         cfg->sections = spos->next;
 654       else
 655         prev->next = spos->next;
 656       while (NULL != (ent = spos->entries))
 657       {
 658         spos->entries = ent->next;
 659         GNUNET_free (ent->key);
 660         GNUNET_free_non_null (ent->val);
 661         GNUNET_free (ent);
 662         cfg->dirty = GNUNET_YES;
 663       }
 664       GNUNET_free (spos->name);
 665       GNUNET_free (spos);
 666       return;
 667     }
 668     prev = spos;
 669     spos = spos->next;
 670   }
 671 }
 672
 673
 674 /**
 675  * Copy a configuration value to the given target configuration.
 676  * Overwrites existing entries.
 677  *
 678  * @param cls the destination configuration (`struct GNUNET_CONFIGURATION_Handle *`)
 679  * @param section section for the value
 680  * @param option option name of the value
 681  * @param value value to copy
 682  */
 683 static void
 684 copy_entry (void *cls,
 685             const char *section,
 686             const char *option,
 687             const char *value)
 688 {
 689   struct GNUNET_CONFIGURATION_Handle *dst = cls;
 690
 691   GNUNET_CONFIGURATION_set_value_string (dst, section, option, value);
 692 }
 693
 694
 695 /**
 696  * Duplicate an existing configuration object.
 697  *
 698  * @param cfg configuration to duplicate
 699  * @return duplicate configuration
 700  */
 701 struct GNUNET_CONFIGURATION_Handle *
 702 GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg)
 703 {
 704   struct GNUNET_CONFIGURATION_Handle *ret;
 705
 706   ret = GNUNET_CONFIGURATION_create ();
 707   GNUNET_CONFIGURATION_iterate (cfg, &copy_entry, ret);
 708   return ret;
 709 }
 710
 711
 712 /**
 713  * Find a section entry from a configuration.
 714  *
 715  * @param cfg configuration to search in
 716  * @param section name of the section to look for
 717  * @return matching entry, NULL if not found
 718  */
 719 static struct ConfigSection *
 720 find_section (const struct GNUNET_CONFIGURATION_Handle *cfg,
 721               const char *section)
 722 {
 723   struct ConfigSection *pos;
 724
 725   pos = cfg->sections;
 726   while ((pos != NULL) && (0 != strcasecmp (section, pos->name)))
 727     pos = pos->next;
 728   return pos;
 729 }
 730
 731
 732 /**
 733  * Find an entry from a configuration.
 734  *
 735  * @param cfg handle to the configuration
 736  * @param section section the option is in
 737  * @param key the option
 738  * @return matching entry, NULL if not found
 739  */
 740 static struct ConfigEntry *
 741 find_entry (const struct GNUNET_CONFIGURATION_Handle *cfg,
 742             const char *section,
 743             const char *key)
 744 {
 745   struct ConfigSection *sec;
 746   struct ConfigEntry *pos;
 747
 748   if (NULL == (sec = find_section (cfg, section)))
 749     return NULL;
 750   pos = sec->entries;
 751   while ((pos != NULL) && (0 != strcasecmp (key, pos->key)))
 752     pos = pos->next;
 753   return pos;
 754 }
 755
 756
 757 /**
 758  * A callback function, compares entries from two configurations
 759  * (default against a new configuration) and write the diffs in a
 760  * diff-configuration object (the callback object).
 761  *
 762  * @param cls the diff configuration (`struct DiffHandle *`)
 763  * @param section section for the value (of the default conf.)
 764  * @param option option name of the value (of the default conf.)
 765  * @param value value to copy (of the default conf.)
 766  */
 767 static void
 768 compare_entries (void *cls,
 769                  const char *section,
 770                  const char *option,
 771                  const char *value)
 772 {
 773   struct DiffHandle *dh = cls;
 774   struct ConfigEntry *entNew;
 775
 776   entNew = find_entry (dh->cfg_default, section, option);
 777   if ((NULL != entNew) && (NULL != entNew->val) &&
 778       (0 == strcmp (entNew->val, value)))
 779     return;
 780   GNUNET_CONFIGURATION_set_value_string (dh->cfgDiff, section, option, value);
 781 }
 782
 783
 784 /**
 785  * Compute configuration with only entries that have been changed
 786  *
 787  * @param cfg_default original configuration
 788  * @param cfg_new new configuration
 789  * @return configuration with only the differences, never NULL
 790  */
 791 struct GNUNET_CONFIGURATION_Handle *
 792 GNUNET_CONFIGURATION_get_diff (
 793   const struct GNUNET_CONFIGURATION_Handle *cfg_default,
 794   const struct GNUNET_CONFIGURATION_Handle *cfg_new)
 795 {
 796   struct DiffHandle diffHandle;
 797
 798   diffHandle.cfgDiff = GNUNET_CONFIGURATION_create ();
 799   diffHandle.cfg_default = cfg_default;
 800   GNUNET_CONFIGURATION_iterate (cfg_new, &compare_entries, &diffHandle);
 801   return diffHandle.cfgDiff;
 802 }
 803
 804
 805 /**
 806  * Write only configuration entries that have been changed to configuration file
 807  *
 808  * @param cfg_default default configuration
 809  * @param cfg_new new configuration
 810  * @param filename where to write the configuration diff between default and new
 811  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 812  */
 813 int
 814 GNUNET_CONFIGURATION_write_diffs (
 815   const struct GNUNET_CONFIGURATION_Handle *cfg_default,
 816   const struct GNUNET_CONFIGURATION_Handle *cfg_new,
 817   const char *filename)
 818 {
 819   int ret;
 820   struct GNUNET_CONFIGURATION_Handle *diff;
 821
 822   diff = GNUNET_CONFIGURATION_get_diff (cfg_default, cfg_new);
 823   ret = GNUNET_CONFIGURATION_write (diff, filename);
 824   GNUNET_CONFIGURATION_destroy (diff);
 825   return ret;
 826 }
 827
 828
 829 /**
 830  * Set a configuration value that should be a string.
 831  *
 832  * @param cfg configuration to update
 833  * @param section section of interest
 834  * @param option option of interest
 835  * @param value value to set
 836  */
 837 void
 838 GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle *cfg,
 839                                        const char *section,
 840                                        const char *option,
 841                                        const char *value)
 842 {
 843   struct ConfigSection *sec;
 844   struct ConfigEntry *e;
 845   char *nv;
 846
 847   e = find_entry (cfg, section, option);
 848   if (NULL != e)
 849   {
 850     if (NULL == value)
 851     {
 852       GNUNET_free_non_null (e->val);
 853       e->val = NULL;
 854     }
 855     else
 856     {
 857       nv = GNUNET_strdup (value);
 858       GNUNET_free_non_null (e->val);
 859       e->val = nv;
 860     }
 861     return;
 862   }
 863   sec = find_section (cfg, section);
 864   if (sec == NULL)
 865   {
 866     sec = GNUNET_new (struct ConfigSection);
 867     sec->name = GNUNET_strdup (section);
 868     sec->next = cfg->sections;
 869     cfg->sections = sec;
 870   }
 871   e = GNUNET_new (struct ConfigEntry);
 872   e->key = GNUNET_strdup (option);
 873   e->val = GNUNET_strdup (value);
 874   e->next = sec->entries;
 875   sec->entries = e;
 876 }
 877
 878
 879 /**
 880  * Set a configuration value that should be a number.
 881  *
 882  * @param cfg configuration to update
 883  * @param section section of interest
 884  * @param option option of interest
 885  * @param number value to set
 886  */
 887 void
 888 GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle *cfg,
 889                                        const char *section,
 890                                        const char *option,
 891                                        unsigned long long number)
 892 {
 893   char s[64];
 894
 895   GNUNET_snprintf (s, 64, "%llu", number);
 896   GNUNET_CONFIGURATION_set_value_string (cfg, section, option, s);
 897 }
 898
 899
 900 /**
 901  * Get a configuration value that should be a number.
 902  *
 903  * @param cfg configuration to inspect
 904  * @param section section of interest
 905  * @param option option of interest
 906  * @param number where to store the numeric value of the option
 907  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 908  */
 909 int
 910 GNUNET_CONFIGURATION_get_value_number (
 911   const struct GNUNET_CONFIGURATION_Handle *cfg,
 912   const char *section,
 913   const char *option,
 914   unsigned long long *number)
 915 {
 916   struct ConfigEntry *e;
 917   char dummy[2];
 918
 919   if (NULL == (e = find_entry (cfg, section, option)))
 920     return GNUNET_SYSERR;
 921   if (NULL == e->val)
 922     return GNUNET_SYSERR;
 923   if (1 != sscanf (e->val, "%llu%1s", number, dummy))
 924     return GNUNET_SYSERR;
 925   return GNUNET_OK;
 926 }
 927
 928
 929 /**
 930  * Get a configuration value that should be a floating point number.
 931  *
 932  * @param cfg configuration to inspect
 933  * @param section section of interest
 934  * @param option option of interest
 935  * @param number where to store the floating value of the option
 936  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 937  */
 938 int
 939 GNUNET_CONFIGURATION_get_value_float (
 940   const struct GNUNET_CONFIGURATION_Handle *cfg,
 941   const char *section,
 942   const char *option,
 943   float *number)
 944 {
 945   struct ConfigEntry *e;
 946   char dummy[2];
 947
 948   if (NULL == (e = find_entry (cfg, section, option)))
 949     return GNUNET_SYSERR;
 950   if (NULL == e->val)
 951     return GNUNET_SYSERR;
 952   if (1 != sscanf (e->val, "%f%1s", number, dummy))
 953     return GNUNET_SYSERR;
 954   return GNUNET_OK;
 955 }
 956
 957
 958 /**
 959  * Get a configuration value that should be a relative time.
 960  *
 961  * @param cfg configuration to inspect
 962  * @param section section of interest
 963  * @param option option of interest
 964  * @param time set to the time value stored in the configuration
 965  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 966  */
 967 int
 968 GNUNET_CONFIGURATION_get_value_time (
 969   const struct GNUNET_CONFIGURATION_Handle *cfg,
 970   const char *section,
 971   const char *option,
 972   struct GNUNET_TIME_Relative *time)
 973 {
 974   struct ConfigEntry *e;
 975   int ret;
 976
 977   if (NULL == (e = find_entry (cfg, section, option)))
 978     return GNUNET_SYSERR;
 979   if (NULL == e->val)
 980     return GNUNET_SYSERR;
 981   ret = GNUNET_STRINGS_fancy_time_to_relative (e->val, time);
 982   if (GNUNET_OK != ret)
 983     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
 984                                section,
 985                                option,
 986                                _ ("Not a valid relative time specification"));
 987   return ret;
 988 }
 989
 990
 991 /**
 992  * Get a configuration value that should be a size in bytes.
 993  *
 994  * @param cfg configuration to inspect
 995  * @param section section of interest
 996  * @param option option of interest
 997  * @param size set to the size in bytes as stored in the configuration
 998  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 999  */
1000 int
1001 GNUNET_CONFIGURATION_get_value_size (
1002   const struct GNUNET_CONFIGURATION_Handle *cfg,
1003   const char *section,
1004   const char *option,
1005   unsigned long long *size)
1006 {
1007   struct ConfigEntry *e;
1008
1009   if (NULL == (e = find_entry (cfg, section, option)))
1010     return GNUNET_SYSERR;
1011   if (NULL == e->val)
1012     return GNUNET_SYSERR;
1013   return GNUNET_STRINGS_fancy_size_to_bytes (e->val, size);
1014 }
1015
1016
1017 /**
1018  * Get a configuration value that should be a string.
1019  *
1020  * @param cfg configuration to inspect
1021  * @param section section of interest
1022  * @param option option of interest
1023  * @param value will be set to a freshly allocated configuration
1024  *        value, or NULL if option is not specified
1025  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1026  */
1027 int
1028 GNUNET_CONFIGURATION_get_value_string (
1029   const struct GNUNET_CONFIGURATION_Handle *cfg,
1030   const char *section,
1031   const char *option,
1032   char **value)
1033 {
1034   struct ConfigEntry *e;
1035
1036   if ((NULL == (e = find_entry (cfg, section, option))) || (NULL == e->val))
1037   {
1038     *value = NULL;
1039     return GNUNET_SYSERR;
1040   }
1041   *value = GNUNET_strdup (e->val);
1042   return GNUNET_OK;
1043 }
1044
1045
1046 /**
1047  * Get a configuration value that should be in a set of
1048  * predefined strings
1049  *
1050  * @param cfg configuration to inspect
1051  * @param section section of interest
1052  * @param option option of interest
1053  * @param choices NULL-terminated list of legal values
1054  * @param value will be set to an entry in the legal list,
1055  *        or NULL if option is not specified and no default given
1056  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1057  */
1058 int
1059 GNUNET_CONFIGURATION_get_value_choice (
1060   const struct GNUNET_CONFIGURATION_Handle *cfg,
1061   const char *section,
1062   const char *option,
1063   const char *const *choices,
1064   const char **value)
1065 {
1066   struct ConfigEntry *e;
1067   unsigned int i;
1068
1069   if (NULL == (e = find_entry (cfg, section, option)))
1070     return GNUNET_SYSERR;
1071   for (i = 0; NULL != choices[i]; i++)
1072     if (0 == strcasecmp (choices[i], e->val))
1073       break;
1074   if (NULL == choices[i])
1075   {
1076     LOG (GNUNET_ERROR_TYPE_ERROR,
1077          _ ("Configuration value '%s' for '%s'"
1078             " in section '%s' is not in set of legal choices\n"),
1079          e->val,
1080          option,
1081          section);
1082     return GNUNET_SYSERR;
1083   }
1084   *value = choices[i];
1085   return GNUNET_OK;
1086 }
1087
1088
1089 /**
1090  * Get crockford32-encoded fixed-size binary data from a configuration.
1091  *
1092  * @param cfg configuration to access
1093  * @param section section to access
1094  * @param option option to access
1095  * @param buf where to store the decoded binary result
1096  * @param buf_size exact number of bytes to store in @a buf
1097  * @return #GNUNET_OK on success
1098  *         #GNUNET_NO is the value does not exist
1099  *         #GNUNET_SYSERR on decoding error
1100  */
1101 int
1102 GNUNET_CONFIGURATION_get_data (const struct GNUNET_CONFIGURATION_Handle *cfg,
1103                                const char *section,
1104                                const char *option,
1105                                void *buf,
1106                                size_t buf_size)
1107 {
1108   char *enc;
1109   int res;
1110   size_t data_size;
1111
1112   if (GNUNET_OK !=
1113       (res =
1114          GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &enc)))
1115     return res;
1116   data_size = (strlen (enc) * 5) / 8;
1117   if (data_size != buf_size)
1118   {
1119     GNUNET_free (enc);
1120     return GNUNET_SYSERR;
1121   }
1122   if (GNUNET_OK !=
1123       GNUNET_STRINGS_string_to_data (enc, strlen (enc), buf, buf_size))
1124   {
1125     GNUNET_free (enc);
1126     return GNUNET_SYSERR;
1127   }
1128   GNUNET_free (enc);
1129   return GNUNET_OK;
1130 }
1131
1132
1133 /**
1134  * Test if we have a value for a particular option
1135  *
1136  * @param cfg configuration to inspect
1137  * @param section section of interest
1138  * @param option option of interest
1139  * @return #GNUNET_YES if so, #GNUNET_NO if not.
1140  */
1141 int
1142 GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
1143                                  const char *section,
1144                                  const char *option)
1145 {
1146   struct ConfigEntry *e;
1147
1148   if ((NULL == (e = find_entry (cfg, section, option))) || (NULL == e->val))
1149     return GNUNET_NO;
1150   return GNUNET_YES;
1151 }
1152
1153
1154 /**
1155  * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
1156  * where either in the "PATHS" section or the environtment "FOO" is
1157  * set to "DIRECTORY".  We also support default expansion,
1158  * i.e. ${VARIABLE:-default} will expand to $VARIABLE if VARIABLE is
1159  * set in PATHS or the environment, and otherwise to "default".  Note
1160  * that "default" itself can also be a $-expression, thus
1161  * "${VAR1:-{$VAR2}}" will expand to VAR1 and if that is not defined
1162  * to VAR2.
1163  *
1164  * @param cfg configuration to use for path expansion
1165  * @param orig string to $-expand (will be freed!)
1166  * @param depth recursion depth, used to detect recursive expansions
1167  * @return $-expanded string
1168  */
1169 static char *
1170 expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg,
1171                char *orig,
1172                unsigned int depth)
1173 {
1174   int i;
1175   char *prefix;
1176   char *result;
1177   char *start;
1178   const char *post;
1179   const char *env;
1180   char *def;
1181   char *end;
1182   unsigned int lopen;
1183   char erased_char;
1184   char *erased_pos;
1185   size_t len;
1186
1187   if (NULL == orig)
1188     return NULL;
1189   if (depth > 128)
1190   {
1191     LOG (GNUNET_ERROR_TYPE_WARNING,
1192          _ (
1193            "Recursive expansion suspected, aborting $-expansion for term `%s'\n"),
1194          orig);
1195     return orig;
1196   }
1197   LOG (GNUNET_ERROR_TYPE_DEBUG, "Asked to $-expand %s\n", orig);
1198   if ('$' != orig[0])
1199   {
1200     LOG (GNUNET_ERROR_TYPE_DEBUG, "Doesn't start with $ - not expanding\n");
1201     return orig;
1202   }
1203   erased_char = 0;
1204   erased_pos = NULL;
1205   if ('{' == orig[1])
1206   {
1207     start = &orig[2];
1208     lopen = 1;
1209     end = &orig[1];
1210     while (lopen > 0)
1211     {
1212       end++;
1213       switch (*end)
1214       {
1215       case '}':
1216         lopen--;
1217         break;
1218       case '{':
1219         lopen++;
1220         break;
1221       case '\0':
1222         LOG (GNUNET_ERROR_TYPE_WARNING,
1223              _ ("Missing closing `%s' in option `%s'\n"),
1224              "}",
1225              orig);
1226         return orig;
1227       default:
1228         break;
1229       }
1230     }
1231     erased_char = *end;
1232     erased_pos = end;
1233     *end = '\0';
1234     post = end + 1;
1235     def = strchr (orig, ':');
1236     if (NULL != def)
1237     {
1238       *def = '\0';
1239       def++;
1240       if (('-' == *def) || ('=' == *def))
1241         def++;
1242       def = GNUNET_strdup (def);
1243     }
1244   }
1245   else
1246   {
1247     start = &orig[1];
1248     def = NULL;
1249     i = 0;
1250     while ((orig[i] != '/') && (orig[i] != '\\') && (orig[i] != '\0') &&
1251            (orig[i] != ' '))
1252       i++;
1253     if (orig[i] == '\0')
1254     {
1255       post = "";
1256     }
1257     else
1258     {
1259       erased_char = orig[i];
1260       erased_pos = &orig[i];
1261       orig[i] = '\0';
1262       post = &orig[i + 1];
1263     }
1264   }
1265   LOG (GNUNET_ERROR_TYPE_DEBUG,
1266        "Split into `%s' and `%s' with default %s\n",
1267        start,
1268        post,
1269        def);
1270   if (GNUNET_OK !=
1271       GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS", start, &prefix))
1272   {
1273     if (NULL == (env = getenv (start)))
1274     {
1275       /* try default */
1276       def = expand_dollar (cfg, def, depth + 1);
1277       env = def;
1278     }
1279     if (NULL == env)
1280     {
1281       start = GNUNET_strdup (start);
1282       if (erased_pos)
1283         *erased_pos = erased_char;
1284       LOG (GNUNET_ERROR_TYPE_WARNING,
1285            _ (
1286              "Failed to expand `%s' in `%s' as it is neither found in [PATHS] nor defined as an environmental variable\n"),
1287            start,
1288            orig);
1289       GNUNET_free (start);
1290       return orig;
1291     }
1292     prefix = GNUNET_strdup (env);
1293   }
1294   prefix = GNUNET_CONFIGURATION_expand_dollar (cfg, prefix);
1295   if ((erased_pos) && ('}' != erased_char))
1296   {
1297     len = strlen (prefix) + 1;
1298     prefix = GNUNET_realloc (prefix, len + 1);
1299     prefix[len - 1] = erased_char;
1300     prefix[len] = '\0';
1301   }
1302   result = GNUNET_malloc (strlen (prefix) + strlen (post) + 1);
1303   strcpy (result, prefix);
1304   strcat (result, post);
1305   GNUNET_free_non_null (def);
1306   GNUNET_free (prefix);
1307   GNUNET_free (orig);
1308   return result;
1309 }
1310
1311
1312 /**
1313  * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
1314  * where either in the "PATHS" section or the environtment "FOO" is
1315  * set to "DIRECTORY".  We also support default expansion,
1316  * i.e. ${VARIABLE:-default} will expand to $VARIABLE if VARIABLE is
1317  * set in PATHS or the environment, and otherwise to "default".  Note
1318  * that "default" itself can also be a $-expression, thus
1319  * "${VAR1:-{$VAR2}}" will expand to VAR1 and if that is not defined
1320  * to VAR2.
1321  *
1322  * @param cfg configuration to use for path expansion
1323  * @param orig string to $-expand (will be freed!).  Note that multiple
1324  *          $-expressions can be present in this string.  They will all be
1325  *          $-expanded.
1326  * @return $-expanded string
1327  */
1328 char *
1329 GNUNET_CONFIGURATION_expand_dollar (
1330   const struct GNUNET_CONFIGURATION_Handle *cfg,
1331   char *orig)
1332 {
1333   char *dup;
1334   size_t i;
1335   size_t len;
1336
1337   for (i = 0; '\0' != orig[i]; i++)
1338   {
1339     if ('$' != orig[i])
1340       continue;
1341     dup = GNUNET_strdup (orig + i);
1342     dup = expand_dollar (cfg, dup, 0);
1343     len = strlen (dup) + 1;
1344     orig = GNUNET_realloc (orig, i + len);
1345     GNUNET_memcpy (orig + i, dup, len);
1346     GNUNET_free (dup);
1347   }
1348   return orig;
1349 }
1350
1351
1352 /**
1353  * Get a configuration value that should be a string.
1354  *
1355  * @param cfg configuration to inspect
1356  * @param section section of interest
1357  * @param option option of interest
1358  * @param value will be set to a freshly allocated configuration
1359  *        value, or NULL if option is not specified
1360  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1361  */
1362 int
1363 GNUNET_CONFIGURATION_get_value_filename (
1364   const struct GNUNET_CONFIGURATION_Handle *cfg,
1365   const char *section,
1366   const char *option,
1367   char **value)
1368 {
1369   char *tmp;
1370
1371   if (GNUNET_OK !=
1372       GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &tmp))
1373   {
1374     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to retrieve filename\n");
1375     *value = NULL;
1376     return GNUNET_SYSERR;
1377   }
1378   tmp = GNUNET_CONFIGURATION_expand_dollar (cfg, tmp);
1379   *value = GNUNET_STRINGS_filename_expand (tmp);
1380   GNUNET_free (tmp);
1381   if (*value == NULL)
1382     return GNUNET_SYSERR;
1383   return GNUNET_OK;
1384 }
1385
1386
1387 /**
1388  * Get a configuration value that should be in a set of
1389  * "YES" or "NO".
1390  *
1391  * @param cfg configuration to inspect
1392  * @param section section of interest
1393  * @param option option of interest
1394  * @return #GNUNET_YES, #GNUNET_NO or #GNUNET_SYSERR
1395  */
1396 int
1397 GNUNET_CONFIGURATION_get_value_yesno (
1398   const struct GNUNET_CONFIGURATION_Handle *cfg,
1399   const char *section,
1400   const char *option)
1401 {
1402   static const char *yesno[] = {"YES", "NO", NULL};
1403   const char *val;
1404   int ret;
1405
1406   ret =
1407     GNUNET_CONFIGURATION_get_value_choice (cfg, section, option, yesno, &val);
1408   if (ret == GNUNET_SYSERR)
1409     return ret;
1410   if (val == yesno[0])
1411     return GNUNET_YES;
1412   return GNUNET_NO;
1413 }
1414
1415
1416 /**
1417  * Iterate over the set of filenames stored in a configuration value.
1418  *
1419  * @param cfg configuration to inspect
1420  * @param section section of interest
1421  * @param option option of interest
1422  * @param cb function to call on each filename
1423  * @param cb_cls closure for @a cb
1424  * @return number of filenames iterated over, -1 on error
1425  */
1426 int
1427 GNUNET_CONFIGURATION_iterate_value_filenames (
1428   const struct GNUNET_CONFIGURATION_Handle *cfg,
1429   const char *section,
1430   const char *option,
1431   GNUNET_FileNameCallback cb,
1432   void *cb_cls)
1433 {
1434   char *list;
1435   char *pos;
1436   char *end;
1437   char old;
1438   int ret;
1439
1440   if (GNUNET_OK !=
1441       GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &list))
1442     return 0;
1443   GNUNET_assert (list != NULL);
1444   ret = 0;
1445   pos = list;
1446   while (1)
1447   {
1448     while (pos[0] == ' ')
1449       pos++;
1450     if (strlen (pos) == 0)
1451       break;
1452     end = pos + 1;
1453     while ((end[0] != ' ') && (end[0] != '\0'))
1454     {
1455       if (end[0] == '\\')
1456       {
1457         switch (end[1])
1458         {
1459         case '\\':
1460         case ' ':
1461           memmove (end, &end[1], strlen (&end[1]) + 1);
1462         case '\0':
1463           /* illegal, but just keep it */
1464           break;
1465         default:
1466           /* illegal, but just ignore that there was a '/' */
1467           break;
1468         }
1469       }
1470       end++;
1471     }
1472     old = end[0];
1473     end[0] = '\0';
1474     if (strlen (pos) > 0)
1475     {
1476       ret++;
1477       if ((cb != NULL) && (GNUNET_OK != cb (cb_cls, pos)))
1478       {
1479         ret = GNUNET_SYSERR;
1480         break;
1481       }
1482     }
1483     if (old == '\0')
1484       break;
1485     pos = end + 1;
1486   }
1487   GNUNET_free (list);
1488   return ret;
1489 }
1490
1491
1492 /**
1493  * FIXME.
1494  *
1495  * @param value FIXME
1496  * @return FIXME
1497  */
1498 static char *
1499 escape_name (const char *value)
1500 {
1501   char *escaped;
1502   const char *rpos;
1503   char *wpos;
1504
1505   escaped = GNUNET_malloc (strlen (value) * 2 + 1);
1506   memset (escaped, 0, strlen (value) * 2 + 1);
1507   rpos = value;
1508   wpos = escaped;
1509   while (rpos[0] != '\0')
1510   {
1511     switch (rpos[0])
1512     {
1513     case '\\':
1514     case ' ':
1515       wpos[0] = '\\';
1516       wpos[1] = rpos[0];
1517       wpos += 2;
1518       break;
1519     default:
1520       wpos[0] = rpos[0];
1521       wpos++;
1522     }
1523     rpos++;
1524   }
1525   return escaped;
1526 }
1527
1528
1529 /**
1530  * FIXME.
1531  *
1532  * @param cls string we compare with (const char*)
1533  * @param fn filename we are currently looking at
1534  * @return #GNUNET_OK if the names do not match, #GNUNET_SYSERR if they do
1535  */
1536 static int
1537 test_match (void *cls, const char *fn)
1538 {
1539   const char *of = cls;
1540
1541   return (0 == strcmp (of, fn)) ? GNUNET_SYSERR : GNUNET_OK;
1542 }
1543
1544
1545 /**
1546  * Append a filename to a configuration value that
1547  * represents a list of filenames
1548  *
1549  * @param cfg configuration to update
1550  * @param section section of interest
1551  * @param option option of interest
1552  * @param value filename to append
1553  * @return #GNUNET_OK on success,
1554  *         #GNUNET_NO if the filename already in the list
1555  *         #GNUNET_SYSERR on error
1556  */
1557 int
1558 GNUNET_CONFIGURATION_append_value_filename (
1559   struct GNUNET_CONFIGURATION_Handle *cfg,
1560   const char *section,
1561   const char *option,
1562   const char *value)
1563 {
1564   char *escaped;
1565   char *old;
1566   char *nw;
1567
1568   if (GNUNET_SYSERR ==
1569       GNUNET_CONFIGURATION_iterate_value_filenames (cfg,
1570                                                     section,
1571                                                     option,
1572                                                     &test_match,
1573                                                     (void *) value))
1574     return GNUNET_NO; /* already exists */
1575   if (GNUNET_OK !=
1576       GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &old))
1577     old = GNUNET_strdup ("");
1578   escaped = escape_name (value);
1579   nw = GNUNET_malloc (strlen (old) + strlen (escaped) + 2);
1580   strcpy (nw, old);
1581   if (strlen (old) > 0)
1582     strcat (nw, " ");
1583   strcat (nw, escaped);
1584   GNUNET_CONFIGURATION_set_value_string (cfg, section, option, nw);
1585   GNUNET_free (old);
1586   GNUNET_free (nw);
1587   GNUNET_free (escaped);
1588   return GNUNET_OK;
1589 }
1590
1591
1592 /**
1593  * Remove a filename from a configuration value that
1594  * represents a list of filenames
1595  *
1596  * @param cfg configuration to update
1597  * @param section section of interest
1598  * @param option option of interest
1599  * @param value filename to remove
1600  * @return #GNUNET_OK on success,
1601  *         #GNUNET_NO if the filename is not in the list,
1602  *         #GNUNET_SYSERR on error
1603  */
1604 int
1605 GNUNET_CONFIGURATION_remove_value_filename (
1606   struct GNUNET_CONFIGURATION_Handle *cfg,
1607   const char *section,
1608   const char *option,
1609   const char *value)
1610 {
1611   char *list;
1612   char *pos;
1613   char *end;
1614   char *match;
1615   char old;
1616
1617   if (GNUNET_OK !=
1618       GNUNET_CONFIGURATION_get_value_string (cfg, section, option, &list))
1619     return GNUNET_NO;
1620   match = escape_name (value);
1621   pos = list;
1622   while (1)
1623   {
1624     while (pos[0] == ' ')
1625       pos++;
1626     if (strlen (pos) == 0)
1627       break;
1628     end = pos + 1;
1629     while ((end[0] != ' ') && (end[0] != '\0'))
1630     {
1631       if (end[0] == '\\')
1632       {
1633         switch (end[1])
1634         {
1635         case '\\':
1636         case ' ':
1637           end++;
1638           break;
1639         case '\0':
1640           /* illegal, but just keep it */
1641           break;
1642         default:
1643           /* illegal, but just ignore that there was a '/' */
1644           break;
1645         }
1646       }
1647       end++;
1648     }
1649     old = end[0];
1650     end[0] = '\0';
1651     if (0 == strcmp (pos, match))
1652     {
1653       if (old != '\0')
1654         memmove (pos, &end[1], strlen (&end[1]) + 1);
1655       else
1656       {
1657         if (pos != list)
1658           pos[-1] = '\0';
1659         else
1660           pos[0] = '\0';
1661       }
1662       GNUNET_CONFIGURATION_set_value_string (cfg, section, option, list);
1663       GNUNET_free (list);
1664       GNUNET_free (match);
1665       return GNUNET_OK;
1666     }
1667     if (old == '\0')
1668       break;
1669     end[0] = old;
1670     pos = end + 1;
1671   }
1672   GNUNET_free (list);
1673   GNUNET_free (match);
1674   return GNUNET_NO;
1675 }
1676
1677
1678 /**
1679  * Wrapper around #GNUNET_CONFIGURATION_parse.  Called on each
1680  * file in a directory, we trigger parsing on those files that
1681  * end with ".conf".
1682  *
1683  * @param cls the cfg
1684  * @param filename file to parse
1685  * @return #GNUNET_OK on success
1686  */
1687 static int
1688 parse_configuration_file (void *cls, const char *filename)
1689 {
1690   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
1691   char *ext;
1692   int ret;
1693
1694   /* Examine file extension */
1695   ext = strrchr (filename, '.');
1696   if ((NULL == ext) || (0 != strcmp (ext, ".conf")))
1697   {
1698     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Skipping file `%s'\n", filename);
1699     return GNUNET_OK;
1700   }
1701
1702   ret = GNUNET_CONFIGURATION_parse (cfg, filename);
1703   return ret;
1704 }
1705
1706
1707 /**
1708  * Load default configuration.  This function will parse the
1709  * defaults from the given defaults_d directory.
1710  *
1711  * @param cfg configuration to update
1712  * @param defaults_d directory with the defaults
1713  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1714  */
1715 int
1716 GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg,
1717                                 const char *defaults_d)
1718 {
1719   if (GNUNET_SYSERR ==
1720       GNUNET_DISK_directory_scan (defaults_d, &parse_configuration_file, cfg))
1721     return GNUNET_SYSERR; /* no configuration at all found */
1722   return GNUNET_OK;
1723 }
1724
1725
1726 /* end of configuration.c */