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