src/configfile.c

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