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