2 * collectd - src/configfile.c
3 * Copyright (C) 2005-2011 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian tokkee Harl <sh at tokkee.org>
30 #include "liboconfig/oconfig.h"
34 #include "configfile.h"
35 #include "types_list.h"
36 #include "filter_chain.h"
40 #endif /* HAVE_WORDEXP_H */
44 #endif /* HAVE_FNMATCH_H */
48 #endif /* HAVE_LIBGEN_H */
50 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
55 typedef struct cf_callback
58 int (*callback) (const char *, const char *);
62 struct cf_callback *next;
65 typedef struct cf_complex_callback_s
68 int (*callback) (oconfig_item_t *);
70 struct cf_complex_callback_s *next;
71 } cf_complex_callback_t;
73 typedef struct cf_value_map_s
76 int (*func) (oconfig_item_t *);
79 typedef struct cf_global_option_s
87 * Prototypes of callback functions
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);
97 static cf_callback_t *first_callback = NULL;
98 static cf_complex_callback_t *complex_callback_head = NULL;
100 static cf_value_map_t cf_value_map[] =
102 {"TypesDB", dispatch_value_typesdb},
103 {"PluginDir", dispatch_value_plugindir},
104 {"LoadPlugin", dispatch_loadplugin},
105 {"Plugin", dispatch_block_plugin}
107 static int cf_value_map_num = STATIC_ARRAY_SIZE (cf_value_map);
109 static cf_global_option_t cf_global_options[] =
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"}
127 static int cf_global_options_num = STATIC_ARRAY_SIZE (cf_global_options);
129 static int cf_default_typesdb = 1;
132 * Functions to handle register/unregister, search, and other plugin related
135 static cf_callback_t *cf_search (const char *type)
137 cf_callback_t *cf_cb;
142 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
143 if (strcasecmp (cf_cb->type, type) == 0)
149 static int cf_dispatch (const char *type, const char *orig_key,
150 const char *orig_value)
152 cf_callback_t *cf_cb;
153 plugin_ctx_t old_ctx;
159 if (orig_key == NULL)
162 DEBUG ("type = %s, key = %s, value = %s",
165 ESCAPE_NULL(orig_value));
167 if ((cf_cb = cf_search (type)) == NULL)
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);
175 if ((key = strdup (orig_key)) == NULL)
177 if ((value = strdup (orig_value)) == NULL)
185 old_ctx = plugin_set_ctx (cf_cb->ctx);
187 for (i = 0; i < cf_cb->keys_num; i++)
189 if ((cf_cb->keys[i] != NULL)
190 && (strcasecmp (cf_cb->keys[i], key) == 0))
192 ret = (*cf_cb->callback) (key, value);
197 plugin_set_ctx (old_ctx);
199 if (i >= cf_cb->keys_num)
200 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
206 } /* int cf_dispatch */
208 static int dispatch_global_option (const oconfig_item_t *ci)
210 if (ci->values_num != 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)
217 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
218 return (global_option_set (ci->key, tmp));
220 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
222 if (ci->values[0].value.boolean)
223 return (global_option_set (ci->key, "true"));
225 return (global_option_set (ci->key, "false"));
229 } /* int dispatch_global_option */
231 static int dispatch_value_typesdb (oconfig_item_t *ci)
235 assert (strcasecmp (ci->key, "TypesDB") == 0);
237 cf_default_typesdb = 0;
239 if (ci->values_num < 1) {
240 ERROR ("configfile: `TypesDB' needs at least one argument.");
244 for (i = 0; i < ci->values_num; ++i)
246 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
247 WARNING ("configfile: TypesDB: Skipping %i. argument which "
248 "is not a string.", i + 1);
252 read_types_list (ci->values[i].value.string);
255 } /* int dispatch_value_typesdb */
257 static int dispatch_value_plugindir (oconfig_item_t *ci)
259 assert (strcasecmp (ci->key, "PluginDir") == 0);
261 if (ci->values_num != 1)
263 if (ci->values[0].type != OCONFIG_TYPE_STRING)
266 plugin_set_dir (ci->values[0].value.string);
270 static int dispatch_loadplugin (oconfig_item_t *ci)
274 unsigned int flags = 0;
276 plugin_ctx_t old_ctx;
279 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
281 if (ci->values_num != 1)
283 if (ci->values[0].type != OCONFIG_TYPE_STRING)
286 name = ci->values[0].value.string;
287 if (strcmp ("libvirt", name) == 0)
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;
296 for (i = 0; i < ci->children_num; ++i)
298 oconfig_item_t *child = ci->children + i;
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);
309 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
311 child->key, ci->values[0].value.string);
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);
321 } /* int dispatch_value_loadplugin */
323 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
331 buffer_free = sizeof (buffer);
333 for (i = 0; i < ci->values_num; i++)
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
348 if ((status < 0) || (status >= buffer_free))
350 buffer_free -= status;
351 buffer_ptr += status;
353 /* skip the initial space */
354 buffer_ptr = buffer + 1;
356 return (cf_dispatch (plugin, ci->key, buffer_ptr));
357 } /* int dispatch_value_plugin */
359 static int dispatch_value (oconfig_item_t *ci)
364 for (i = 0; i < cf_value_map_num; i++)
365 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
367 ret = cf_value_map[i].func (ci);
371 for (i = 0; i < cf_global_options_num; i++)
372 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
374 ret = dispatch_global_option (ci);
379 } /* int dispatch_value */
381 static int dispatch_block_plugin (oconfig_item_t *ci)
386 cf_complex_callback_t *cb;
388 if (strcasecmp (ci->key, "Plugin") != 0)
390 if (ci->values_num < 1)
392 if (ci->values[0].type != OCONFIG_TYPE_STRING)
395 name = ci->values[0].value.string;
396 if (strcmp ("libvirt", name) == 0)
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.");
406 if (IS_TRUE (global_option_get ("AutoLoadPlugin")))
409 plugin_ctx_t old_ctx;
412 /* default to the global interval set before loading this plugin */
413 memset (&ctx, 0, sizeof (ctx));
414 ctx.interval = cf_get_default_interval ();
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);
423 ERROR ("Automatically loading plugin \"%s\" failed "
424 "with status %i.", name, status);
429 /* Check for a complex callback first */
430 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
432 if (strcasecmp (name, cb->type) == 0)
434 plugin_ctx_t old_ctx;
437 old_ctx = plugin_set_ctx (cb->ctx);
438 ret_val = (cb->callback (ci));
439 plugin_set_ctx (old_ctx);
444 /* Hm, no complex plugin found. Dispatch the values one by one */
445 for (i = 0; i < ci->children_num; i++)
447 if (ci->children[i].children == NULL)
448 dispatch_value_plugin (name, ci->children + i);
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);
465 static int dispatch_block (oconfig_item_t *ci)
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));
477 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
480 oconfig_item_t *temp;
483 assert (offset >= 0);
484 assert (dst->children_num > offset);
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++)
491 if (temp->values[i].type == OCONFIG_TYPE_STRING)
493 sfree (temp->values[i].value.string);
496 sfree (temp->values);
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)))
504 int nmemb = dst->children_num - (offset + 1);
505 memmove (dst->children + offset, dst->children + offset + 1,
506 sizeof (oconfig_item_t) * nmemb);
509 /* Resize the memory containing the children to be big enough to hold
511 if (dst->children_num + src->children_num - 1 == 0)
513 dst->children_num = 0;
517 temp = realloc (dst->children,
518 sizeof (oconfig_item_t)
519 * (dst->children_num + src->children_num - 1));
522 ERROR ("configfile: realloc failed.");
525 dst->children = temp;
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
531 if ((src->children_num > 0)
532 && ((dst->children_num - (offset + 1)) > 0))
534 int nmemb = dst->children_num - (offset + 1);
535 int old_offset = offset + 1;
536 int new_offset = offset + src->children_num;
538 memmove (dst->children + new_offset,
539 dst->children + old_offset,
540 sizeof (oconfig_item_t) * nmemb);
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)
547 memcpy (dst->children + offset,
549 sizeof (oconfig_item_t) * src->children_num);
552 /* Update the number of children. */
553 dst->children_num += (src->children_num - 1);
556 } /* int cf_ci_replace_child */
558 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
560 oconfig_item_t *temp;
562 if ((src == NULL) || (src->children_num == 0))
565 temp = realloc (dst->children,
566 sizeof (oconfig_item_t)
567 * (dst->children_num + src->children_num));
570 ERROR ("configfile: realloc failed.");
573 dst->children = temp;
575 memcpy (dst->children + dst->children_num,
577 sizeof (oconfig_item_t)
578 * src->children_num);
579 dst->children_num += src->children_num;
582 } /* int cf_ci_append_children */
584 #define CF_MAX_DEPTH 8
585 static oconfig_item_t *cf_read_generic (const char *path,
586 const char *pattern, int depth);
588 static int cf_include_all (oconfig_item_t *root, int depth)
592 for (i = 0; i < root->children_num; i++)
597 char *pattern = NULL;
601 if (strcasecmp (root->children[i].key, "Include") != 0)
604 old = root->children + i;
606 if ((old->values_num != 1)
607 || (old->values[0].type != OCONFIG_TYPE_STRING))
609 ERROR ("configfile: `Include' needs exactly one string argument.");
613 for (j = 0; j < old->children_num; ++j)
615 oconfig_item_t *child = old->children + j;
617 if (strcasecmp (child->key, "Filter") == 0)
618 cf_util_get_string (child, &pattern);
620 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
624 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
630 /* Now replace the i'th child in `root' with `new'. */
631 if (cf_ci_replace_child (root, new, i) < 0) {
637 /* ... and go back to the new i'th child. */
642 } /* for (i = 0; i < root->children_num; i++) */
645 } /* int cf_include_all */
647 static oconfig_item_t *cf_read_file (const char *file,
648 const char *pattern, int depth)
650 oconfig_item_t *root;
653 assert (depth < CF_MAX_DEPTH);
655 if (pattern != NULL) {
656 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
657 char *tmp = sstrdup (file);
658 char *filename = basename (tmp);
660 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
661 DEBUG ("configfile: Not including `%s' because it "
662 "does not match pattern `%s'.",
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 */
676 root = oconfig_parse_file (file);
679 ERROR ("configfile: Cannot read file `%s'.", file);
683 status = cf_include_all (root, depth);
691 } /* oconfig_item_t *cf_read_file */
693 static int cf_compare_string (const void *p1, const void *p2)
695 return strcmp (*(const char **) p1, *(const char **) p2);
698 static oconfig_item_t *cf_read_dir (const char *dir,
699 const char *pattern, int depth)
701 oconfig_item_t *root = NULL;
704 char **filenames = NULL;
705 int filenames_num = 0;
709 assert (depth < CF_MAX_DEPTH);
715 ERROR ("configfile: opendir failed: %s",
716 sstrerror (errno, errbuf, sizeof (errbuf)));
720 root = calloc (1, sizeof (*root));
723 ERROR ("configfile: calloc failed.");
728 while ((de = readdir (dh)) != NULL)
733 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
736 status = ssnprintf (name, sizeof (name), "%s/%s",
738 if ((status < 0) || ((size_t) status >= sizeof (name)))
740 ERROR ("configfile: Not including `%s/%s' because its"
741 " name is too long.",
744 for (i = 0; i < filenames_num; ++i)
752 tmp = realloc (filenames,
753 filenames_num * sizeof (*filenames));
755 ERROR ("configfile: realloc failed.");
757 for (i = 0; i < filenames_num - 1; ++i)
765 filenames[filenames_num - 1] = sstrdup (name);
768 if (filenames == NULL)
774 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
777 for (i = 0; i < filenames_num; ++i)
779 oconfig_item_t *temp;
780 char *name = filenames[i];
782 temp = cf_read_generic (name, pattern, depth);
785 /* An error should already have been reported. */
790 cf_ci_append_children (root, temp);
791 sfree (temp->children);
800 } /* oconfig_item_t *cf_read_dir */
805 * Path is stat'ed and either cf_read_file or cf_read_dir is called
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.
814 static oconfig_item_t *cf_read_generic (const char *path,
815 const char *pattern, int depth)
817 oconfig_item_t *root = NULL;
819 const char *path_ptr;
823 if (depth >= CF_MAX_DEPTH)
825 ERROR ("configfile: Not including `%s' because the maximum "
826 "nesting depth has been reached.", path);
830 status = wordexp (path, &we, WRDE_NOCMD);
833 ERROR ("configfile: wordexp (%s) failed.", path);
837 root = calloc (1, sizeof (*root));
840 ERROR ("configfile: calloc failed.");
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),
849 for (i = 0; i < we.we_wordc; i++)
851 oconfig_item_t *temp;
854 path_ptr = we.we_wordv[i];
856 status = stat (path_ptr, &statbuf);
860 WARNING ("configfile: stat (%s) failed: %s",
862 sstrerror (errno, errbuf, sizeof (errbuf)));
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);
872 WARNING ("configfile: %s is neither a file nor a "
882 cf_ci_append_children (root, temp);
883 sfree (temp->children);
890 } /* oconfig_item_t *cf_read_generic */
891 /* #endif HAVE_WORDEXP_H */
893 #else /* if !HAVE_WORDEXP_H */
894 static oconfig_item_t *cf_read_generic (const char *path,
895 const char *pattern, int depth)
900 if (depth >= CF_MAX_DEPTH)
902 ERROR ("configfile: Not including `%s' because the maximum "
903 "nesting depth has been reached.", path);
907 status = stat (path, &statbuf);
911 ERROR ("configfile: stat (%s) failed: %s",
913 sstrerror (errno, errbuf, sizeof (errbuf)));
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));
922 ERROR ("configfile: %s is neither a file nor a directory.", path);
924 } /* oconfig_item_t *cf_read_generic */
925 #endif /* !HAVE_WORDEXP_H */
930 int global_option_set (const char *option, const char *value)
934 DEBUG ("option = %s; value = %s;", option, value);
936 for (i = 0; i < cf_global_options_num; i++)
937 if (strcasecmp (cf_global_options[i].key, option) == 0)
940 if (i >= cf_global_options_num)
943 if (strcasecmp (option, "PIDFile") == 0 && pidfile_from_cli == 1)
945 DEBUG ("Configfile: Ignoring `PIDFILE' option because "
946 "command-line option `-P' take precedence.");
950 sfree (cf_global_options[i].value);
953 cf_global_options[i].value = strdup (value);
955 cf_global_options[i].value = NULL;
960 const char *global_option_get (const char *option)
964 for (i = 0; i < cf_global_options_num; i++)
965 if (strcasecmp (cf_global_options[i].key, option) == 0)
968 if (i >= cf_global_options_num)
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 */
976 long global_option_get_long (const char *option, long default_value)
981 str = global_option_get (option);
983 return (default_value);
986 value = strtol (str, /* endptr = */ NULL, /* base = */ 0);
988 return (default_value);
991 } /* char *global_option_get_long */
993 cdtime_t global_option_get_time (const char *name, cdtime_t def) /* {{{ */
999 optstr = global_option_get (name);
1004 v = strtod (optstr, &endptr);
1005 if ((endptr == NULL) || (*endptr != 0) || (errno != 0))
1010 return (DOUBLE_TO_CDTIME_T (v));
1011 } /* }}} cdtime_t global_option_get_time */
1013 cdtime_t cf_get_default_interval (void)
1015 return (global_option_get_time ("Interval",
1016 DOUBLE_TO_CDTIME_T (COLLECTD_DEFAULT_INTERVAL)));
1019 void cf_unregister (const char *type)
1021 cf_callback_t *this, *prev;
1023 for (prev = NULL, this = first_callback;
1025 prev = this, this = this->next)
1026 if (strcasecmp (this->type, type) == 0)
1029 first_callback = this->next;
1031 prev->next = this->next;
1036 } /* void cf_unregister */
1038 void cf_unregister_complex (const char *type)
1040 cf_complex_callback_t *this, *prev;
1042 for (prev = NULL, this = complex_callback_head;
1044 prev = this, this = this->next)
1045 if (strcasecmp (this->type, type) == 0)
1048 complex_callback_head = this->next;
1050 prev->next = this->next;
1056 } /* void cf_unregister */
1058 void cf_register (const char *type,
1059 int (*callback) (const char *, const char *),
1060 const char **keys, int keys_num)
1062 cf_callback_t *cf_cb;
1064 /* Remove this module from the list, if it already exists */
1065 cf_unregister (type);
1067 /* This pointer will be free'd in `cf_unregister' */
1068 if ((cf_cb = malloc (sizeof (*cf_cb))) == NULL)
1072 cf_cb->callback = callback;
1074 cf_cb->keys_num = keys_num;
1075 cf_cb->ctx = plugin_get_ctx ();
1077 cf_cb->next = first_callback;
1078 first_callback = cf_cb;
1079 } /* void cf_register */
1081 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1083 cf_complex_callback_t *new;
1085 new = malloc (sizeof (*new));
1089 new->type = strdup (type);
1090 if (new->type == NULL)
1096 new->callback = callback;
1099 new->ctx = plugin_get_ctx ();
1101 if (complex_callback_head == NULL)
1103 complex_callback_head = new;
1107 cf_complex_callback_t *last = complex_callback_head;
1108 while (last->next != NULL)
1114 } /* int cf_register_complex */
1116 int cf_read (const char *filename)
1118 oconfig_item_t *conf;
1122 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1125 ERROR ("Unable to read config file %s.", filename);
1128 else if (conf->children_num == 0)
1130 ERROR ("Configuration file %s is empty.", filename);
1131 oconfig_free (conf);
1135 for (i = 0; i < conf->children_num; i++)
1137 if (conf->children[i].children == NULL)
1139 if (dispatch_value (conf->children + i) != 0)
1144 if (dispatch_block (conf->children + i) != 0)
1149 oconfig_free (conf);
1151 /* Read the default types.db if no `TypesDB' option was given. */
1152 if (cf_default_typesdb)
1154 if (read_types_list (PKGDATADIR"/types.db") != 0)
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
1164 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1168 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1170 ERROR ("cf_util_get_string: The %s option requires "
1171 "exactly one string argument.", ci->key);
1175 string = strdup (ci->values[0].value.string);
1179 if (*ret_string != NULL)
1180 sfree (*ret_string);
1181 *ret_string = string;
1184 } /* }}} int cf_util_get_string */
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, /* {{{ */
1191 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1194 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1196 ERROR ("cf_util_get_string_buffer: The %s option requires "
1197 "exactly one string argument.", ci->key);
1201 strncpy (buffer, ci->values[0].value.string, buffer_size);
1202 buffer[buffer_size - 1] = 0;
1205 } /* }}} int cf_util_get_string_buffer */
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) /* {{{ */
1210 if ((ci == NULL) || (ret_value == NULL))
1213 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1215 ERROR ("cf_util_get_int: The %s option requires "
1216 "exactly one numeric argument.", ci->key);
1220 *ret_value = (int) ci->values[0].value.number;
1223 } /* }}} int cf_util_get_int */
1225 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1227 if ((ci == NULL) || (ret_value == NULL))
1230 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1232 ERROR ("cf_util_get_double: The %s option requires "
1233 "exactly one numeric argument.", ci->key);
1237 *ret_value = ci->values[0].value.number;
1240 } /* }}} int cf_util_get_double */
1242 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1244 if ((ci == NULL) || (ret_bool == NULL))
1247 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1249 ERROR ("cf_util_get_boolean: The %s option requires "
1250 "exactly one boolean argument.", ci->key);
1254 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1257 } /* }}} int cf_util_get_boolean */
1259 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1260 unsigned int *ret_value, unsigned int flag)
1265 if (ret_value == NULL)
1269 status = cf_util_get_boolean (ci, &b);
1279 *ret_value &= ~flag;
1283 } /* }}} int cf_util_get_flag */
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
1290 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1294 if ((ci->values_num != 1)
1295 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1296 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1298 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1299 "exactly one string argument.", ci->key);
1303 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1304 return (service_name_to_port_number (ci->values[0].value.string));
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))
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.",
1319 } /* }}} int cf_util_get_port_number */
1321 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1327 if (ci->values_num != 1)
1329 ERROR ("cf_util_get_service: The %s option requires exactly "
1330 "one argument.", ci->key);
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)
1338 ERROR ("cf_util_get_service: The %s option requires "
1339 "exactly one string or numeric argument.",
1344 status = cf_util_get_int (ci, &port);
1347 else if ((port < 1) || (port > 65535))
1349 ERROR ("cf_util_get_service: The port number given "
1350 "for the %s option is out of "
1351 "range (%i).", ci->key, port);
1355 service = malloc (6);
1356 if (service == NULL)
1358 ERROR ("cf_util_get_service: Out of memory.");
1361 ssnprintf (service, 6, "%i", port);
1363 sfree (*ret_string);
1364 *ret_string = service;
1367 } /* }}} int cf_util_get_service */
1369 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1371 if ((ci == NULL) || (ret_value == NULL))
1374 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1376 ERROR ("cf_util_get_cdtime: The %s option requires "
1377 "exactly one numeric argument.", ci->key);
1381 if (ci->values[0].value.number < 0.0)
1383 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1384 "option must not be negative.", ci->key);
1388 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1391 } /* }}} int cf_util_get_cdtime */