src/configfile.c

   1 /**
   2  * collectd - src/configfile.c
   3  * Copyright (C) 2005-2011  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.
   9  *
  10  * This program 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.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Florian octo Forster <octo at collectd.org>
  21  *   Sebastian tokkee Harl <sh at tokkee.org>
  22  **/
  23
  24 #include "collectd.h"
  25
  26 #include "liboconfig/oconfig.h"
  27
  28 #include "common.h"
  29 #include "plugin.h"
  30 #include "configfile.h"
  31 #include "types_list.h"
  32 #include "filter_chain.h"
  33
  34 #if HAVE_WORDEXP_H
  35 # include <wordexp.h>
  36 #endif /* HAVE_WORDEXP_H */
  37
  38 #if HAVE_FNMATCH_H
  39 # include <fnmatch.h>
  40 #endif /* HAVE_FNMATCH_H */
  41
  42 #if HAVE_LIBGEN_H
  43 # include <libgen.h>
  44 #endif /* HAVE_LIBGEN_H */
  45
  46 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
  47
  48 /*
  49  * Private types
  50  */
  51 typedef struct cf_callback
  52 {
  53         const char  *type;
  54         int  (*callback) (const char *, const char *);
  55         const char **keys;
  56         int    keys_num;
  57         plugin_ctx_t ctx;
  58         struct cf_callback *next;
  59 } cf_callback_t;
  60
  61 typedef struct cf_complex_callback_s
  62 {
  63         char *type;
  64         int (*callback) (oconfig_item_t *);
  65         plugin_ctx_t ctx;
  66         struct cf_complex_callback_s *next;
  67 } cf_complex_callback_t;
  68
  69 typedef struct cf_value_map_s
  70 {
  71         char *key;
  72         int (*func) (const oconfig_item_t *);
  73 } cf_value_map_t;
  74
  75 typedef struct cf_global_option_s
  76 {
  77         char *key;
  78         char *value;
  79         char *def;
  80 } cf_global_option_t;
  81
  82 /*
  83  * Prototypes of callback functions
  84  */
  85 static int dispatch_value_typesdb (const oconfig_item_t *ci);
  86 static int dispatch_value_plugindir (const oconfig_item_t *ci);
  87 static int dispatch_loadplugin (const oconfig_item_t *ci);
  88
  89 /*
  90  * Private variables
  91  */
  92 static cf_callback_t *first_callback = NULL;
  93 static cf_complex_callback_t *complex_callback_head = NULL;
  94
  95 static cf_value_map_t cf_value_map[] =
  96 {
  97         {"TypesDB",    dispatch_value_typesdb},
  98         {"PluginDir",  dispatch_value_plugindir},
  99         {"LoadPlugin", dispatch_loadplugin}
 100 };
 101 static int cf_value_map_num = STATIC_ARRAY_SIZE (cf_value_map);
 102
 103 static cf_global_option_t cf_global_options[] =
 104 {
 105         {"BaseDir",     NULL, PKGLOCALSTATEDIR},
 106         {"PIDFile",     NULL, PIDFILE},
 107         {"Hostname",    NULL, NULL},
 108         {"FQDNLookup",  NULL, "true"},
 109         {"Interval",    NULL, NULL},
 110         {"ReadThreads", NULL, "5"},
 111         {"WriteThreads", NULL, "5"},
 112         {"Timeout",     NULL, "2"},
 113         {"PreCacheChain",  NULL, "PreCache"},
 114         {"PostCacheChain", NULL, "PostCache"}
 115 };
 116 static int cf_global_options_num = STATIC_ARRAY_SIZE (cf_global_options);
 117
 118 static int cf_default_typesdb = 1;
 119
 120 /*
 121  * Functions to handle register/unregister, search, and other plugin related
 122  * stuff
 123  */
 124 static cf_callback_t *cf_search (const char *type)
 125 {
 126         cf_callback_t *cf_cb;
 127
 128         if (type == NULL)
 129                 return (NULL);
 130
 131         for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
 132                 if (strcasecmp (cf_cb->type, type) == 0)
 133                         break;
 134
 135         return (cf_cb);
 136 }
 137
 138 static int cf_dispatch (const char *type, const char *orig_key,
 139                 const char *orig_value)
 140 {
 141         cf_callback_t *cf_cb;
 142         plugin_ctx_t old_ctx;
 143         char *key;
 144         char *value;
 145         int ret;
 146         int i;
 147
 148         DEBUG ("type = %s, key = %s, value = %s",
 149                         ESCAPE_NULL(type),
 150                         ESCAPE_NULL(orig_key),
 151                         ESCAPE_NULL(orig_value));
 152
 153         if ((cf_cb = cf_search (type)) == NULL)
 154         {
 155                 WARNING ("Found a configuration for the `%s' plugin, but "
 156                                 "the plugin isn't loaded or didn't register "
 157                                 "a configuration callback.", type);
 158                 return (-1);
 159         }
 160
 161         if ((key = strdup (orig_key)) == NULL)
 162                 return (1);
 163         if ((value = strdup (orig_value)) == NULL)
 164         {
 165                 free (key);
 166                 return (2);
 167         }
 168
 169         ret = -1;
 170
 171         old_ctx = plugin_set_ctx (cf_cb->ctx);
 172
 173         for (i = 0; i < cf_cb->keys_num; i++)
 174         {
 175                 if ((cf_cb->keys[i] != NULL)
 176                                 && (strcasecmp (cf_cb->keys[i], key) == 0))
 177                 {
 178                         ret = (*cf_cb->callback) (key, value);
 179                         break;
 180                 }
 181         }
 182
 183         plugin_set_ctx (old_ctx);
 184
 185         if (i >= cf_cb->keys_num)
 186                 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
 187
 188         free (key);
 189         free (value);
 190
 191         DEBUG ("cf_dispatch: return (%i)", ret);
 192
 193         return (ret);
 194 } /* int cf_dispatch */
 195
 196 static int dispatch_global_option (const oconfig_item_t *ci)
 197 {
 198         if (ci->values_num != 1)
 199                 return (-1);
 200         if (ci->values[0].type == OCONFIG_TYPE_STRING)
 201                 return (global_option_set (ci->key, ci->values[0].value.string));
 202         else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
 203         {
 204                 char tmp[128];
 205                 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
 206                 return (global_option_set (ci->key, tmp));
 207         }
 208         else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
 209         {
 210                 if (ci->values[0].value.boolean)
 211                         return (global_option_set (ci->key, "true"));
 212                 else
 213                         return (global_option_set (ci->key, "false"));
 214         }
 215
 216         return (-1);
 217 } /* int dispatch_global_option */
 218
 219 static int dispatch_value_typesdb (const oconfig_item_t *ci)
 220 {
 221         int i = 0;
 222
 223         assert (strcasecmp (ci->key, "TypesDB") == 0);
 224
 225         cf_default_typesdb = 0;
 226
 227         if (ci->values_num < 1) {
 228                 ERROR ("configfile: `TypesDB' needs at least one argument.");
 229                 return (-1);
 230         }
 231
 232         for (i = 0; i < ci->values_num; ++i)
 233         {
 234                 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
 235                         WARNING ("configfile: TypesDB: Skipping %i. argument which "
 236                                         "is not a string.", i + 1);
 237                         continue;
 238                 }
 239
 240                 read_types_list (ci->values[i].value.string);
 241         }
 242         return (0);
 243 } /* int dispatch_value_typesdb */
 244
 245 static int dispatch_value_plugindir (const oconfig_item_t *ci)
 246 {
 247         assert (strcasecmp (ci->key, "PluginDir") == 0);
 248
 249         if (ci->values_num != 1)
 250                 return (-1);
 251         if (ci->values[0].type != OCONFIG_TYPE_STRING)
 252                 return (-1);
 253
 254         plugin_set_dir (ci->values[0].value.string);
 255         return (0);
 256 }
 257
 258 static int dispatch_loadplugin (const oconfig_item_t *ci)
 259 {
 260         int i;
 261         const char *name;
 262         unsigned int flags = 0;
 263         plugin_ctx_t ctx;
 264         plugin_ctx_t old_ctx;
 265         int ret_val;
 266
 267         assert (strcasecmp (ci->key, "LoadPlugin") == 0);
 268
 269         if (ci->values_num != 1)
 270                 return (-1);
 271         if (ci->values[0].type != OCONFIG_TYPE_STRING)
 272                 return (-1);
 273
 274         name = ci->values[0].value.string;
 275
 276         /* default to the global interval set before loading this plugin */
 277         memset (&ctx, 0, sizeof (ctx));
 278         ctx.interval = cf_get_default_interval ();
 279
 280         /*
 281          * XXX: Magic at work:
 282          *
 283          * Some of the language bindings, for example the Python and Perl
 284          * plugins, need to be able to export symbols to the scripts they run.
 285          * For this to happen, the "Globals" flag needs to be set.
 286          * Unfortunately, this technical detail is hard to explain to the
 287          * average user and she shouldn't have to worry about this, ideally.
 288          * So in order to save everyone's sanity use a different default for a
 289          * handful of special plugins. --octo
 290          */
 291         if ((strcasecmp ("Perl", name) == 0)
 292                         || (strcasecmp ("Python", name) == 0))
 293                 flags |= PLUGIN_FLAGS_GLOBAL;
 294
 295         for (i = 0; i < ci->children_num; ++i) {
 296                 if (strcasecmp("Globals", ci->children[i].key) == 0)
 297                         cf_util_get_flag (ci->children + i, &flags, PLUGIN_FLAGS_GLOBAL);
 298                 else if (strcasecmp ("Interval", ci->children[i].key) == 0) {
 299                         double interval = 0.0;
 300
 301                         if (cf_util_get_double (ci->children + i, &interval) != 0) {
 302                                 /* cf_util_get_double will log an error */
 303                                 continue;
 304                         }
 305
 306                         ctx.interval = DOUBLE_TO_CDTIME_T (interval);
 307                 }
 308                 else {
 309                         WARNING("Ignoring unknown LoadPlugin option \"%s\" "
 310                                         "for plugin \"%s\"",
 311                                         ci->children[i].key, ci->values[0].value.string);
 312                 }
 313         }
 314
 315         old_ctx = plugin_set_ctx (ctx);
 316         ret_val = plugin_load (name, (uint32_t) flags);
 317         /* reset to the "global" context */
 318         plugin_set_ctx (old_ctx);
 319
 320         return (ret_val);
 321 } /* int dispatch_value_loadplugin */
 322
 323 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
 324 {
 325         char  buffer[4096];
 326         char *buffer_ptr;
 327         int   buffer_free;
 328         int i;
 329
 330         buffer_ptr = buffer;
 331         buffer_free = sizeof (buffer);
 332
 333         for (i = 0; i < ci->values_num; i++)
 334         {
 335                 int status = -1;
 336
 337                 if (ci->values[i].type == OCONFIG_TYPE_STRING)
 338                         status = ssnprintf (buffer_ptr, buffer_free, " %s",
 339                                         ci->values[i].value.string);
 340                 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
 341                         status = ssnprintf (buffer_ptr, buffer_free, " %lf",
 342                                         ci->values[i].value.number);
 343                 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
 344                         status = ssnprintf (buffer_ptr, buffer_free, " %s",
 345                                         ci->values[i].value.boolean
 346                                         ? "true" : "false");
 347
 348                 if ((status < 0) || (status >= buffer_free))
 349                         return (-1);
 350                 buffer_free -= status;
 351                 buffer_ptr  += status;
 352         }
 353         /* skip the initial space */
 354         buffer_ptr = buffer + 1;
 355
 356         return (cf_dispatch (plugin, ci->key, buffer_ptr));
 357 } /* int dispatch_value_plugin */
 358
 359 static int dispatch_value (const oconfig_item_t *ci)
 360 {
 361         int ret = -2;
 362         int i;
 363
 364         for (i = 0; i < cf_value_map_num; i++)
 365                 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
 366                 {
 367                         ret = cf_value_map[i].func (ci);
 368                         break;
 369                 }
 370
 371         for (i = 0; i < cf_global_options_num; i++)
 372                 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
 373                 {
 374                         ret = dispatch_global_option (ci);
 375                         break;
 376                 }
 377
 378         return (ret);
 379 } /* int dispatch_value */
 380
 381 static int dispatch_block_plugin (oconfig_item_t *ci)
 382 {
 383         int i;
 384         char *name;
 385
 386         cf_complex_callback_t *cb;
 387
 388         if (strcasecmp (ci->key, "Plugin") != 0)
 389                 return (-1);
 390         if (ci->values_num < 1)
 391                 return (-1);
 392         if (ci->values[0].type != OCONFIG_TYPE_STRING)
 393                 return (-1);
 394
 395         name = ci->values[0].value.string;
 396
 397         /* Check for a complex callback first */
 398         for (cb = complex_callback_head; cb != NULL; cb = cb->next)
 399         {
 400                 if (strcasecmp (name, cb->type) == 0)
 401                 {
 402                         plugin_ctx_t old_ctx;
 403                         int ret_val;
 404
 405                         old_ctx = plugin_set_ctx (cb->ctx);
 406                         ret_val = (cb->callback (ci));
 407                         plugin_set_ctx (old_ctx);
 408                         return (ret_val);
 409                 }
 410         }
 411
 412         /* Hm, no complex plugin found. Dispatch the values one by one */
 413         for (i = 0; i < ci->children_num; i++)
 414         {
 415                 if (ci->children[i].children == NULL)
 416                         dispatch_value_plugin (name, ci->children + i);
 417                 else
 418                 {
 419                         WARNING ("There is a `%s' block within the "
 420                                         "configuration for the %s plugin. "
 421                                         "The plugin either only expects "
 422                                         "\"simple\" configuration statements "
 423                                         "or wasn't loaded using `LoadPlugin'."
 424                                         " Please check your configuration.",
 425                                         ci->children[i].key, name);
 426                 }
 427         }
 428
 429         return (0);
 430 }
 431
 432
 433 static int dispatch_block (oconfig_item_t *ci)
 434 {
 435         if (strcasecmp (ci->key, "LoadPlugin") == 0)
 436                 return (dispatch_loadplugin (ci));
 437         else if (strcasecmp (ci->key, "Plugin") == 0)
 438                 return (dispatch_block_plugin (ci));
 439         else if (strcasecmp (ci->key, "Chain") == 0)
 440                 return (fc_configure (ci));
 441
 442         return (0);
 443 }
 444
 445 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
 446                 int offset)
 447 {
 448         oconfig_item_t *temp;
 449         int i;
 450
 451         assert (offset >= 0);
 452         assert (dst->children_num > offset);
 453
 454         /* Free the memory used by the replaced child. Usually that's the
 455          * `Include "blah"' statement. */
 456         temp = dst->children + offset;
 457         for (i = 0; i < temp->values_num; i++)
 458         {
 459                 if (temp->values[i].type == OCONFIG_TYPE_STRING)
 460                 {
 461                         sfree (temp->values[i].value.string);
 462                 }
 463         }
 464         sfree (temp->values);
 465         temp = NULL;
 466
 467         /* If (src->children_num == 0) the array size is decreased. If offset
 468          * is _not_ the last element, (offset < (dst->children_num - 1)), then
 469          * we need to move the trailing elements before resizing the array. */
 470         if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
 471         {
 472                 int nmemb = dst->children_num - (offset + 1);
 473                 memmove (dst->children + offset, dst->children + offset + 1,
 474                                 sizeof (oconfig_item_t) * nmemb);
 475         }
 476
 477         /* Resize the memory containing the children to be big enough to hold
 478          * all children. */
 479         temp = (oconfig_item_t *) realloc (dst->children,
 480                         sizeof (oconfig_item_t)
 481                         * (dst->children_num + src->children_num - 1));
 482         if (temp == NULL)
 483         {
 484                 ERROR ("configfile: realloc failed.");
 485                 return (-1);
 486         }
 487         dst->children = temp;
 488
 489         /* If there are children behind the include statement, and they have
 490          * not yet been moved because (src->children_num == 0), then move them
 491          * to the end of the list, so that the new children have room before
 492          * them. */
 493         if ((src->children_num > 0)
 494                         && ((dst->children_num - (offset + 1)) > 0))
 495         {
 496                 int nmemb = dst->children_num - (offset + 1);
 497                 int old_offset = offset + 1;
 498                 int new_offset = offset + src->children_num;
 499
 500                 memmove (dst->children + new_offset,
 501                                 dst->children + old_offset,
 502                                 sizeof (oconfig_item_t) * nmemb);
 503         }
 504
 505         /* Last but not least: If there are new children, copy them to the
 506          * memory reserved for them. */
 507         if (src->children_num > 0)
 508         {
 509                 memcpy (dst->children + offset,
 510                                 src->children,
 511                                 sizeof (oconfig_item_t) * src->children_num);
 512         }
 513
 514         /* Update the number of children. */
 515         dst->children_num += (src->children_num - 1);
 516
 517         return (0);
 518 } /* int cf_ci_replace_child */
 519
 520 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
 521 {
 522         oconfig_item_t *temp;
 523
 524         if ((src == NULL) || (src->children_num == 0))
 525                 return (0);
 526
 527         temp = (oconfig_item_t *) realloc (dst->children,
 528                         sizeof (oconfig_item_t)
 529                         * (dst->children_num + src->children_num));
 530         if (temp == NULL)
 531         {
 532                 ERROR ("configfile: realloc failed.");
 533                 return (-1);
 534         }
 535         dst->children = temp;
 536
 537         memcpy (dst->children + dst->children_num,
 538                         src->children,
 539                         sizeof (oconfig_item_t)
 540                         * src->children_num);
 541         dst->children_num += src->children_num;
 542
 543         return (0);
 544 } /* int cf_ci_append_children */
 545
 546 #define CF_MAX_DEPTH 8
 547 static oconfig_item_t *cf_read_generic (const char *path,
 548                 const char *pattern, int depth);
 549
 550 static int cf_include_all (oconfig_item_t *root, int depth)
 551 {
 552         int i;
 553
 554         for (i = 0; i < root->children_num; i++)
 555         {
 556                 oconfig_item_t *new;
 557                 oconfig_item_t *old;
 558
 559                 char *pattern = NULL;
 560
 561                 int j;
 562
 563                 if (strcasecmp (root->children[i].key, "Include") != 0)
 564                         continue;
 565
 566                 old = root->children + i;
 567
 568                 if ((old->values_num != 1)
 569                                 || (old->values[0].type != OCONFIG_TYPE_STRING))
 570                 {
 571                         ERROR ("configfile: `Include' needs exactly one string argument.");
 572                         continue;
 573                 }
 574
 575                 for (j = 0; j < old->children_num; ++j)
 576                 {
 577                         oconfig_item_t *child = old->children + j;
 578
 579                         if (strcasecmp (child->key, "Filter") == 0)
 580                                 cf_util_get_string (child, &pattern);
 581                         else
 582                                 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
 583                                                 child->key);
 584                 }
 585
 586                 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
 587                 sfree (pattern);
 588
 589                 if (new == NULL)
 590                         continue;
 591
 592                 /* Now replace the i'th child in `root' with `new'. */
 593                 cf_ci_replace_child (root, new, i);
 594
 595                 /* ... and go back to the new i'th child. */
 596                 --i;
 597
 598                 sfree (new->values);
 599                 sfree (new);
 600         } /* for (i = 0; i < root->children_num; i++) */
 601
 602         return (0);
 603 } /* int cf_include_all */
 604
 605 static oconfig_item_t *cf_read_file (const char *file,
 606                 const char *pattern, int depth)
 607 {
 608         oconfig_item_t *root;
 609
 610         assert (depth < CF_MAX_DEPTH);
 611
 612         if (pattern != NULL) {
 613 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
 614                 char *tmp = sstrdup (file);
 615                 char *filename = basename (tmp);
 616
 617                 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
 618                         DEBUG ("configfile: Not including `%s' because it "
 619                                         "does not match pattern `%s'.",
 620                                         filename, pattern);
 621                         free (tmp);
 622                         return (NULL);
 623                 }
 624
 625                 free (tmp);
 626 #else
 627                 ERROR ("configfile: Cannot apply pattern filter '%s' "
 628                                 "to file '%s': functions basename() and / or "
 629                                 "fnmatch() not available.", pattern, file);
 630 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
 631         }
 632
 633         root = oconfig_parse_file (file);
 634         if (root == NULL)
 635         {
 636                 ERROR ("configfile: Cannot read file `%s'.", file);
 637                 return (NULL);
 638         }
 639
 640         cf_include_all (root, depth);
 641
 642         return (root);
 643 } /* oconfig_item_t *cf_read_file */
 644
 645 static int cf_compare_string (const void *p1, const void *p2)
 646 {
 647         return strcmp (*(const char **) p1, *(const char **) p2);
 648 }
 649
 650 static oconfig_item_t *cf_read_dir (const char *dir,
 651                 const char *pattern, int depth)
 652 {
 653         oconfig_item_t *root = NULL;
 654         DIR *dh;
 655         struct dirent *de;
 656         char **filenames = NULL;
 657         int filenames_num = 0;
 658         int status;
 659         int i;
 660
 661         assert (depth < CF_MAX_DEPTH);
 662
 663         dh = opendir (dir);
 664         if (dh == NULL)
 665         {
 666                 char errbuf[1024];
 667                 ERROR ("configfile: opendir failed: %s",
 668                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 669                 return (NULL);
 670         }
 671
 672         root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
 673         if (root == NULL)
 674         {
 675                 ERROR ("configfile: malloc failed.");
 676                 return (NULL);
 677         }
 678         memset (root, 0, sizeof (oconfig_item_t));
 679
 680         while ((de = readdir (dh)) != NULL)
 681         {
 682                 char   name[1024];
 683                 char **tmp;
 684
 685                 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
 686                         continue;
 687
 688                 status = ssnprintf (name, sizeof (name), "%s/%s",
 689                                 dir, de->d_name);
 690                 if ((status < 0) || ((size_t) status >= sizeof (name)))
 691                 {
 692                         ERROR ("configfile: Not including `%s/%s' because its"
 693                                         " name is too long.",
 694                                         dir, de->d_name);
 695                         for (i = 0; i < filenames_num; ++i)
 696                                 free (filenames[i]);
 697                         free (filenames);
 698                         free (root);
 699                         return (NULL);
 700                 }
 701
 702                 ++filenames_num;
 703                 tmp = (char **) realloc (filenames,
 704                                 filenames_num * sizeof (*filenames));
 705                 if (tmp == NULL) {
 706                         ERROR ("configfile: realloc failed.");
 707                         for (i = 0; i < filenames_num - 1; ++i)
 708                                 free (filenames[i]);
 709                         free (filenames);
 710                         free (root);
 711                         return (NULL);
 712                 }
 713                 filenames = tmp;
 714
 715                 filenames[filenames_num - 1] = sstrdup (name);
 716         }
 717
 718         qsort ((void *) filenames, filenames_num, sizeof (*filenames),
 719                         cf_compare_string);
 720
 721         for (i = 0; i < filenames_num; ++i)
 722         {
 723                 oconfig_item_t *temp;
 724                 char *name = filenames[i];
 725
 726                 temp = cf_read_generic (name, pattern, depth);
 727                 if (temp == NULL)
 728                 {
 729                         /* An error should already have been reported. */
 730                         sfree (name);
 731                         continue;
 732                 }
 733
 734                 cf_ci_append_children (root, temp);
 735                 sfree (temp->children);
 736                 sfree (temp);
 737
 738                 free (name);
 739         }
 740
 741         free(filenames);
 742         return (root);
 743 } /* oconfig_item_t *cf_read_dir */
 744
 745 /*
 746  * cf_read_generic
 747  *
 748  * Path is stat'ed and either cf_read_file or cf_read_dir is called
 749  * accordingly.
 750  *
 751  * There are two versions of this function: If `wordexp' exists shell wildcards
 752  * will be expanded and the function will include all matches found. If
 753  * `wordexp' (or, more precisely, it's header file) is not available the
 754  * simpler function is used which does not do any such expansion.
 755  */
 756 #if HAVE_WORDEXP_H
 757 static oconfig_item_t *cf_read_generic (const char *path,
 758                 const char *pattern, int depth)
 759 {
 760         oconfig_item_t *root = NULL;
 761         int status;
 762         const char *path_ptr;
 763         wordexp_t we;
 764         size_t i;
 765
 766         if (depth >= CF_MAX_DEPTH)
 767         {
 768                 ERROR ("configfile: Not including `%s' because the maximum "
 769                                 "nesting depth has been reached.", path);
 770                 return (NULL);
 771         }
 772
 773         status = wordexp (path, &we, WRDE_NOCMD);
 774         if (status != 0)
 775         {
 776                 ERROR ("configfile: wordexp (%s) failed.", path);
 777                 return (NULL);
 778         }
 779
 780         root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
 781         if (root == NULL)
 782         {
 783                 ERROR ("configfile: malloc failed.");
 784                 return (NULL);
 785         }
 786         memset (root, '\0', sizeof (oconfig_item_t));
 787
 788         /* wordexp() might return a sorted list already. That's not
 789          * documented though, so let's make sure we get what we want. */
 790         qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
 791                         cf_compare_string);
 792
 793         for (i = 0; i < we.we_wordc; i++)
 794         {
 795                 oconfig_item_t *temp;
 796                 struct stat statbuf;
 797
 798                 path_ptr = we.we_wordv[i];
 799
 800                 status = stat (path_ptr, &statbuf);
 801                 if (status != 0)
 802                 {
 803                         char errbuf[1024];
 804                         WARNING ("configfile: stat (%s) failed: %s",
 805                                         path_ptr,
 806                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 807                         continue;
 808                 }
 809
 810                 if (S_ISREG (statbuf.st_mode))
 811                         temp = cf_read_file (path_ptr, pattern, depth);
 812                 else if (S_ISDIR (statbuf.st_mode))
 813                         temp = cf_read_dir (path_ptr, pattern, depth);
 814                 else
 815                 {
 816                         WARNING ("configfile: %s is neither a file nor a "
 817                                         "directory.", path);
 818                         continue;
 819                 }
 820
 821                 if (temp == NULL) {
 822                         oconfig_free (root);
 823                         return (NULL);
 824                 }
 825
 826                 cf_ci_append_children (root, temp);
 827                 sfree (temp->children);
 828                 sfree (temp);
 829         }
 830
 831         wordfree (&we);
 832
 833         if (root->children == NULL)
 834         {
 835                 oconfig_free (root);
 836                 return (NULL);
 837         }
 838
 839         return (root);
 840 } /* oconfig_item_t *cf_read_generic */
 841 /* #endif HAVE_WORDEXP_H */
 842
 843 #else /* if !HAVE_WORDEXP_H */
 844 static oconfig_item_t *cf_read_generic (const char *path,
 845                 const char *pattern, int depth)
 846 {
 847         struct stat statbuf;
 848         int status;
 849
 850         if (depth >= CF_MAX_DEPTH)
 851         {
 852                 ERROR ("configfile: Not including `%s' because the maximum "
 853                                 "nesting depth has been reached.", path);
 854                 return (NULL);
 855         }
 856
 857         status = stat (path, &statbuf);
 858         if (status != 0)
 859         {
 860                 char errbuf[1024];
 861                 ERROR ("configfile: stat (%s) failed: %s",
 862                                 path,
 863                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 864                 return (NULL);
 865         }
 866
 867         if (S_ISREG (statbuf.st_mode))
 868                 return (cf_read_file (path, pattern, depth));
 869         else if (S_ISDIR (statbuf.st_mode))
 870                 return (cf_read_dir (path, pattern, depth));
 871
 872         ERROR ("configfile: %s is neither a file nor a directory.", path);
 873         return (NULL);
 874 } /* oconfig_item_t *cf_read_generic */
 875 #endif /* !HAVE_WORDEXP_H */
 876
 877 /*
 878  * Public functions
 879  */
 880 int global_option_set (const char *option, const char *value)
 881 {
 882         int i;
 883
 884         DEBUG ("option = %s; value = %s;", option, value);
 885
 886         for (i = 0; i < cf_global_options_num; i++)
 887                 if (strcasecmp (cf_global_options[i].key, option) == 0)
 888                         break;
 889
 890         if (i >= cf_global_options_num)
 891                 return (-1);
 892
 893         sfree (cf_global_options[i].value);
 894
 895         if (value != NULL)
 896                 cf_global_options[i].value = strdup (value);
 897         else
 898                 cf_global_options[i].value = NULL;
 899
 900         return (0);
 901 }
 902
 903 const char *global_option_get (const char *option)
 904 {
 905         int i;
 906
 907         for (i = 0; i < cf_global_options_num; i++)
 908                 if (strcasecmp (cf_global_options[i].key, option) == 0)
 909                         break;
 910
 911         if (i >= cf_global_options_num)
 912                 return (NULL);
 913
 914         return ((cf_global_options[i].value != NULL)
 915                         ? cf_global_options[i].value
 916                         : cf_global_options[i].def);
 917 } /* char *global_option_get */
 918
 919 cdtime_t cf_get_default_interval (void)
 920 {
 921   char const *str = global_option_get ("Interval");
 922   double interval_double = COLLECTD_DEFAULT_INTERVAL;
 923
 924   if (str != NULL)
 925   {
 926     char *endptr = NULL;
 927     double tmp = strtod (str, &endptr);
 928
 929     if ((endptr == NULL) || (endptr == str) || (*endptr != 0))
 930       ERROR ("cf_get_default_interval: Unable to parse string \"%s\" "
 931           "as number.", str);
 932     else if (tmp <= 0.0)
 933       ERROR ("cf_get_default_interval: Interval must be a positive number. "
 934           "The current number is %g.", tmp);
 935     else
 936       interval_double = tmp;
 937   }
 938
 939   return (DOUBLE_TO_CDTIME_T (interval_double));
 940 } /* }}} cdtime_t cf_get_default_interval */
 941
 942 void cf_unregister (const char *type)
 943 {
 944         cf_callback_t *this, *prev;
 945
 946         for (prev = NULL, this = first_callback;
 947                         this != NULL;
 948                         prev = this, this = this->next)
 949                 if (strcasecmp (this->type, type) == 0)
 950                 {
 951                         if (prev == NULL)
 952                                 first_callback = this->next;
 953                         else
 954                                 prev->next = this->next;
 955
 956                         free (this);
 957                         break;
 958                 }
 959 } /* void cf_unregister */
 960
 961 void cf_unregister_complex (const char *type)
 962 {
 963         cf_complex_callback_t *this, *prev;
 964
 965         for (prev = NULL, this = complex_callback_head;
 966                         this != NULL;
 967                         prev = this, this = this->next)
 968                 if (strcasecmp (this->type, type) == 0)
 969                 {
 970                         if (prev == NULL)
 971                                 complex_callback_head = this->next;
 972                         else
 973                                 prev->next = this->next;
 974
 975                         sfree (this->type);
 976                         sfree (this);
 977                         break;
 978                 }
 979 } /* void cf_unregister */
 980
 981 void cf_register (const char *type,
 982                 int (*callback) (const char *, const char *),
 983                 const char **keys, int keys_num)
 984 {
 985         cf_callback_t *cf_cb;
 986
 987         /* Remove this module from the list, if it already exists */
 988         cf_unregister (type);
 989
 990         /* This pointer will be free'd in `cf_unregister' */
 991         if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
 992                 return;
 993
 994         cf_cb->type     = type;
 995         cf_cb->callback = callback;
 996         cf_cb->keys     = keys;
 997         cf_cb->keys_num = keys_num;
 998         cf_cb->ctx      = plugin_get_ctx ();
 999
1000         cf_cb->next = first_callback;
1001         first_callback = cf_cb;
1002 } /* void cf_register */
1003
1004 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1005 {
1006         cf_complex_callback_t *new;
1007
1008         new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
1009         if (new == NULL)
1010                 return (-1);
1011
1012         new->type = strdup (type);
1013         if (new->type == NULL)
1014         {
1015                 sfree (new);
1016                 return (-1);
1017         }
1018
1019         new->callback = callback;
1020         new->next = NULL;
1021
1022         new->ctx = plugin_get_ctx ();
1023
1024         if (complex_callback_head == NULL)
1025         {
1026                 complex_callback_head = new;
1027         }
1028         else
1029         {
1030                 cf_complex_callback_t *last = complex_callback_head;
1031                 while (last->next != NULL)
1032                         last = last->next;
1033                 last->next = new;
1034         }
1035
1036         return (0);
1037 } /* int cf_register_complex */
1038
1039 int cf_read (char *filename)
1040 {
1041         oconfig_item_t *conf;
1042         int i;
1043
1044         conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1045         if (conf == NULL)
1046         {
1047                 ERROR ("Unable to read config file %s.", filename);
1048                 return (-1);
1049         }
1050
1051         for (i = 0; i < conf->children_num; i++)
1052         {
1053                 if (conf->children[i].children == NULL)
1054                         dispatch_value (conf->children + i);
1055                 else
1056                         dispatch_block (conf->children + i);
1057         }
1058
1059         oconfig_free (conf);
1060
1061         /* Read the default types.db if no `TypesDB' option was given. */
1062         if (cf_default_typesdb)
1063                 read_types_list (PKGDATADIR"/types.db");
1064
1065         return (0);
1066 } /* int cf_read */
1067
1068 /* Assures the config option is a string, duplicates it and returns the copy in
1069  * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1070  * success. */
1071 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1072 {
1073         char *string;
1074
1075         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1076         {
1077                 ERROR ("cf_util_get_string: The %s option requires "
1078                                 "exactly one string argument.", ci->key);
1079                 return (-1);
1080         }
1081
1082         string = strdup (ci->values[0].value.string);
1083         if (string == NULL)
1084                 return (-1);
1085
1086         if (*ret_string != NULL)
1087                 sfree (*ret_string);
1088         *ret_string = string;
1089
1090         return (0);
1091 } /* }}} int cf_util_get_string */
1092
1093 /* Assures the config option is a string and copies it to the provided buffer.
1094  * Assures null-termination. */
1095 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1096                 size_t buffer_size)
1097 {
1098         if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1099                 return (EINVAL);
1100
1101         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1102         {
1103                 ERROR ("cf_util_get_string_buffer: The %s option requires "
1104                                 "exactly one string argument.", ci->key);
1105                 return (-1);
1106         }
1107
1108         strncpy (buffer, ci->values[0].value.string, buffer_size);
1109         buffer[buffer_size - 1] = 0;
1110
1111         return (0);
1112 } /* }}} int cf_util_get_string_buffer */
1113
1114 /* Assures the config option is a number and returns it as an int. */
1115 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1116 {
1117         if ((ci == NULL) || (ret_value == NULL))
1118                 return (EINVAL);
1119
1120         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1121         {
1122                 ERROR ("cf_util_get_int: The %s option requires "
1123                                 "exactly one numeric argument.", ci->key);
1124                 return (-1);
1125         }
1126
1127         *ret_value = (int) ci->values[0].value.number;
1128
1129         return (0);
1130 } /* }}} int cf_util_get_int */
1131
1132 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1133 {
1134         if ((ci == NULL) || (ret_value == NULL))
1135                 return (EINVAL);
1136
1137         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1138         {
1139                 ERROR ("cf_util_get_double: The %s option requires "
1140                                 "exactly one numeric argument.", ci->key);
1141                 return (-1);
1142         }
1143
1144         *ret_value = ci->values[0].value.number;
1145
1146         return (0);
1147 } /* }}} int cf_util_get_double */
1148
1149 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1150 {
1151         if ((ci == NULL) || (ret_bool == NULL))
1152                 return (EINVAL);
1153
1154         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1155         {
1156                 ERROR ("cf_util_get_boolean: The %s option requires "
1157                                 "exactly one boolean argument.", ci->key);
1158                 return (-1);
1159         }
1160
1161         *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1162
1163         return (0);
1164 } /* }}} int cf_util_get_boolean */
1165
1166 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1167                 unsigned int *ret_value, unsigned int flag)
1168 {
1169         int status;
1170         _Bool b;
1171
1172         if (ret_value == NULL)
1173                 return (EINVAL);
1174
1175         b = 0;
1176         status = cf_util_get_boolean (ci, &b);
1177         if (status != 0)
1178                 return (status);
1179
1180         if (b)
1181         {
1182                 *ret_value |= flag;
1183         }
1184         else
1185         {
1186                 *ret_value &= ~flag;
1187         }
1188
1189         return (0);
1190 } /* }}} int cf_util_get_flag */
1191
1192 /* Assures that the config option is a string or a number if the correct range
1193  * of 1-65535. The string is then converted to a port number using
1194  * `service_name_to_port_number' and returned.
1195  * Returns the port number in the range [1-65535] or less than zero upon
1196  * failure. */
1197 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1198 {
1199         int tmp;
1200
1201         if ((ci->values_num != 1)
1202                         || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1203                                 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1204         {
1205                 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1206                                 "exactly one string argument.", ci->key);
1207                 return (-1);
1208         }
1209
1210         if (ci->values[0].type == OCONFIG_TYPE_STRING)
1211                 return (service_name_to_port_number (ci->values[0].value.string));
1212
1213         assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1214         tmp = (int) (ci->values[0].value.number + 0.5);
1215         if ((tmp < 1) || (tmp > 65535))
1216         {
1217                 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1218                                 "a service name or a port number. The number "
1219                                 "you specified, %i, is not in the valid "
1220                                 "range of 1-65535.",
1221                                 ci->key, tmp);
1222                 return (-1);
1223         }
1224
1225         return (tmp);
1226 } /* }}} int cf_util_get_port_number */
1227
1228 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1229 {
1230         int port;
1231         char *service;
1232         int status;
1233
1234         if (ci->values_num != 1)
1235         {
1236                 ERROR ("cf_util_get_service: The %s option requires exactly "
1237                                 "one argument.", ci->key);
1238                 return (-1);
1239         }
1240
1241         if (ci->values[0].type == OCONFIG_TYPE_STRING)
1242                 return (cf_util_get_string (ci, ret_string));
1243         if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1244         {
1245                 ERROR ("cf_util_get_service: The %s option requires "
1246                                 "exactly one string or numeric argument.",
1247                                 ci->key);
1248         }
1249
1250         port = 0;
1251         status = cf_util_get_int (ci, &port);
1252         if (status != 0)
1253                 return (status);
1254         else if ((port < 1) || (port > 65535))
1255         {
1256                 ERROR ("cf_util_get_service: The port number given "
1257                                 "for the %s option is out of "
1258                                 "range (%i).", ci->key, port);
1259                 return (-1);
1260         }
1261
1262         service = malloc (6);
1263         if (service == NULL)
1264         {
1265                 ERROR ("cf_util_get_service: Out of memory.");
1266                 return (-1);
1267         }
1268         ssnprintf (service, 6, "%i", port);
1269
1270         sfree (*ret_string);
1271         *ret_string = service;
1272
1273         return (0);
1274 } /* }}} int cf_util_get_service */
1275
1276 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1277 {
1278         if ((ci == NULL) || (ret_value == NULL))
1279                 return (EINVAL);
1280
1281         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1282         {
1283                 ERROR ("cf_util_get_cdtime: The %s option requires "
1284                                 "exactly one numeric argument.", ci->key);
1285                 return (-1);
1286         }
1287
1288         if (ci->values[0].value.number < 0.0)
1289         {
1290                 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1291                                 "option must not be negative.", ci->key);
1292                 return (-1);
1293         }
1294
1295         *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1296
1297         return (0);
1298 } /* }}} int cf_util_get_cdtime */
1299