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"
33 #include "configfile.h"
34 #include "filter_chain.h"
36 #include "types_list.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 {
57 int (*callback)(const char *, const char *);
61 struct cf_callback *next;
64 typedef struct cf_complex_callback_s {
66 int (*callback)(oconfig_item_t *);
68 struct cf_complex_callback_s *next;
69 } cf_complex_callback_t;
71 typedef struct cf_value_map_s {
73 int (*func)(oconfig_item_t *);
76 typedef struct cf_global_option_s {
79 bool from_cli; /* value set from CLI */
84 * Prototypes of callback functions
86 static int dispatch_value_typesdb(oconfig_item_t *ci);
87 static int dispatch_value_plugindir(oconfig_item_t *ci);
88 static int dispatch_loadplugin(oconfig_item_t *ci);
89 static int dispatch_block_plugin(oconfig_item_t *ci);
94 static cf_callback_t *first_callback;
95 static cf_complex_callback_t *complex_callback_head;
97 static cf_value_map_t cf_value_map[] = {{"TypesDB", dispatch_value_typesdb},
98 {"PluginDir", dispatch_value_plugindir},
99 {"LoadPlugin", dispatch_loadplugin},
100 {"Plugin", dispatch_block_plugin}};
101 static int cf_value_map_num = STATIC_ARRAY_SIZE(cf_value_map);
103 static cf_global_option_t cf_global_options[] = {
104 {"BaseDir", NULL, 0, PKGLOCALSTATEDIR},
105 {"PIDFile", NULL, 0, PIDFILE},
106 {"Hostname", NULL, 0, NULL},
107 {"FQDNLookup", NULL, 0, "true"},
108 {"Interval", NULL, 0, NULL},
109 {"ReadThreads", NULL, 0, "5"},
110 {"WriteThreads", NULL, 0, "5"},
111 {"WriteQueueLimitHigh", NULL, 0, NULL},
112 {"WriteQueueLimitLow", NULL, 0, NULL},
113 {"Timeout", NULL, 0, "2"},
114 {"AutoLoadPlugin", NULL, 0, "false"},
115 {"CollectInternalStats", NULL, 0, "false"},
116 {"PreCacheChain", NULL, 0, "PreCache"},
117 {"PostCacheChain", NULL, 0, "PostCache"},
118 {"MaxReadInterval", NULL, 0, "86400"}};
119 static int cf_global_options_num = STATIC_ARRAY_SIZE(cf_global_options);
121 static int cf_default_typesdb = 1;
124 * Functions to handle register/unregister, search, and other plugin related
127 static cf_callback_t *cf_search(const char *type) {
128 cf_callback_t *cf_cb;
133 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
134 if (strcasecmp(cf_cb->type, type) == 0)
140 static int cf_dispatch(const char *type, const char *orig_key,
141 const char *orig_value) {
142 cf_callback_t *cf_cb;
143 plugin_ctx_t old_ctx;
149 if (orig_key == NULL)
152 DEBUG("type = %s, key = %s, value = %s", ESCAPE_NULL(type), orig_key,
153 ESCAPE_NULL(orig_value));
155 if ((cf_cb = cf_search(type)) == NULL) {
156 WARNING("Found a configuration for the `%s' plugin, but "
157 "the plugin isn't loaded or didn't register "
158 "a configuration callback.",
163 if ((key = strdup(orig_key)) == NULL)
165 if ((value = strdup(orig_value)) == NULL) {
172 old_ctx = plugin_set_ctx(cf_cb->ctx);
174 for (i = 0; i < cf_cb->keys_num; i++) {
175 if ((cf_cb->keys[i] != NULL) && (strcasecmp(cf_cb->keys[i], key) == 0)) {
176 ret = (*cf_cb->callback)(key, value);
181 plugin_set_ctx(old_ctx);
183 if (i >= cf_cb->keys_num)
184 WARNING("Plugin `%s' did not register for value `%s'.", type, key);
190 } /* int cf_dispatch */
192 static int dispatch_global_option(const oconfig_item_t *ci) {
193 if (ci->values_num != 1) {
194 ERROR("configfile: Global option `%s' needs exactly one argument.",
199 if (ci->values[0].type == OCONFIG_TYPE_STRING)
200 return global_option_set(ci->key, ci->values[0].value.string, 0);
201 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER) {
203 snprintf(tmp, sizeof(tmp), "%lf", ci->values[0].value.number);
204 return global_option_set(ci->key, tmp, 0);
205 } else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN) {
206 if (ci->values[0].value.boolean)
207 return global_option_set(ci->key, "true", 0);
209 return global_option_set(ci->key, "false", 0);
212 ERROR("configfile: Global option `%s' argument has unknown type.", ci->key);
215 } /* int dispatch_global_option */
217 static int dispatch_value_typesdb(oconfig_item_t *ci) {
218 assert(strcasecmp(ci->key, "TypesDB") == 0);
220 cf_default_typesdb = 0;
222 if (ci->values_num < 1) {
223 ERROR("configfile: `TypesDB' needs at least one argument.");
227 for (int i = 0; i < ci->values_num; ++i) {
228 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
229 WARNING("configfile: TypesDB: Skipping %i. argument which "
235 read_types_list(ci->values[i].value.string);
238 } /* int dispatch_value_typesdb */
240 static int dispatch_value_plugindir(oconfig_item_t *ci) {
241 assert(strcasecmp(ci->key, "PluginDir") == 0);
243 if (ci->values_num != 1 || ci->values[0].type != OCONFIG_TYPE_STRING) {
244 ERROR("configfile: The `PluginDir' option needs exactly one string "
249 plugin_set_dir(ci->values[0].value.string);
253 static int dispatch_loadplugin(oconfig_item_t *ci) {
256 assert(strcasecmp(ci->key, "LoadPlugin") == 0);
258 if (ci->values_num != 1 || ci->values[0].type != OCONFIG_TYPE_STRING) {
259 ERROR("configfile: The `LoadPlugin' block needs exactly one string "
264 const char *name = ci->values[0].value.string;
265 if (strcmp("libvirt", name) == 0)
268 /* default to the global interval set before loading this plugin */
270 .interval = cf_get_default_interval(), .name = strdup(name),
272 if (ctx.name == NULL)
275 for (int i = 0; i < ci->children_num; ++i) {
276 oconfig_item_t *child = ci->children + i;
278 if (strcasecmp("Globals", child->key) == 0)
279 cf_util_get_boolean(child, &global);
280 else if (strcasecmp("Interval", child->key) == 0)
281 cf_util_get_cdtime(child, &ctx.interval);
282 else if (strcasecmp("FlushInterval", child->key) == 0)
283 cf_util_get_cdtime(child, &ctx.flush_interval);
284 else if (strcasecmp("FlushTimeout", child->key) == 0)
285 cf_util_get_cdtime(child, &ctx.flush_timeout);
287 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
293 plugin_ctx_t old_ctx = plugin_set_ctx(ctx);
294 int ret_val = plugin_load(name, global);
295 /* reset to the "global" context */
296 plugin_set_ctx(old_ctx);
299 } /* int dispatch_value_loadplugin */
301 static int dispatch_value_plugin(const char *plugin, oconfig_item_t *ci) {
307 buffer_free = sizeof(buffer);
309 for (int i = 0; i < ci->values_num; i++) {
312 if (ci->values[i].type == OCONFIG_TYPE_STRING)
314 snprintf(buffer_ptr, buffer_free, " %s", ci->values[i].value.string);
315 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
317 snprintf(buffer_ptr, buffer_free, " %lf", ci->values[i].value.number);
318 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
319 status = snprintf(buffer_ptr, buffer_free, " %s",
320 ci->values[i].value.boolean ? "true" : "false");
322 if ((status < 0) || (status >= buffer_free))
324 buffer_free -= status;
325 buffer_ptr += status;
327 /* skip the initial space */
328 buffer_ptr = buffer + 1;
330 return cf_dispatch(plugin, ci->key, buffer_ptr);
331 } /* int dispatch_value_plugin */
333 static int dispatch_value(oconfig_item_t *ci) {
336 for (int i = 0; i < cf_value_map_num; i++)
337 if (strcasecmp(cf_value_map[i].key, ci->key) == 0) {
338 ret = cf_value_map[i].func(ci);
345 for (int i = 0; i < cf_global_options_num; i++)
346 if (strcasecmp(cf_global_options[i].key, ci->key) == 0) {
347 ret = dispatch_global_option(ci);
352 } /* int dispatch_value */
354 static int dispatch_block_plugin(oconfig_item_t *ci) {
355 assert(strcasecmp(ci->key, "Plugin") == 0);
357 if (ci->values_num < 1) {
358 ERROR("configfile: The `Plugin' block requires arguments.");
361 if (ci->values[0].type != OCONFIG_TYPE_STRING) {
362 ERROR("configfile: First argument of `Plugin' block should be a string.");
366 const char *name = ci->values[0].value.string;
367 if (strcmp("libvirt", name) == 0) {
368 /* TODO(octo): Remove this legacy. */
369 WARNING("The \"libvirt\" plugin has been renamed to \"virt\" to avoid "
370 "problems with the build system. "
371 "Your configuration is still using the old name. "
372 "Please change it to use \"virt\" as soon as possible. "
373 "This compatibility code will go away eventually.");
377 if (IS_TRUE(global_option_get("AutoLoadPlugin"))) {
378 plugin_ctx_t ctx = {0};
379 plugin_ctx_t old_ctx;
382 /* default to the global interval set before loading this plugin */
383 ctx.interval = cf_get_default_interval();
385 old_ctx = plugin_set_ctx(ctx);
386 status = plugin_load(name, /* flags = */ false);
387 /* reset to the "global" context */
388 plugin_set_ctx(old_ctx);
391 ERROR("Automatically loading plugin \"%s\" failed "
398 /* Check for a complex callback first */
399 for (cf_complex_callback_t *cb = complex_callback_head; cb != NULL;
401 if (strcasecmp(name, cb->type) == 0) {
402 plugin_ctx_t old_ctx;
405 old_ctx = plugin_set_ctx(cb->ctx);
406 ret_val = (cb->callback(ci));
407 plugin_set_ctx(old_ctx);
412 /* Hm, no complex plugin found. Dispatch the values one by one */
413 for (int i = 0; i < ci->children_num; i++) {
414 if (ci->children[i].children == NULL)
415 dispatch_value_plugin(name, ci->children + i);
417 WARNING("There is a `%s' block within the "
418 "configuration for the %s plugin. "
419 "The plugin either only expects "
420 "\"simple\" configuration statements "
421 "or wasn't loaded using `LoadPlugin'."
422 " Please check your configuration.",
423 ci->children[i].key, name);
430 static int dispatch_block(oconfig_item_t *ci) {
431 if (strcasecmp(ci->key, "LoadPlugin") == 0)
432 return dispatch_loadplugin(ci);
433 else if (strcasecmp(ci->key, "Plugin") == 0)
434 return dispatch_block_plugin(ci);
435 else if (strcasecmp(ci->key, "Chain") == 0)
436 return fc_configure(ci);
441 static int cf_ci_replace_child(oconfig_item_t *dst, oconfig_item_t *src,
443 oconfig_item_t *temp;
446 assert(dst->children_num > offset);
448 /* Free the memory used by the replaced child. Usually that's the
449 * `Include "blah"' statement. */
450 temp = dst->children + offset;
451 for (int i = 0; i < temp->values_num; i++) {
452 if (temp->values[i].type == OCONFIG_TYPE_STRING) {
453 sfree(temp->values[i].value.string);
459 /* If (src->children_num == 0) the array size is decreased. If offset
460 * is _not_ the last element, (offset < (dst->children_num - 1)), then
461 * we need to move the trailing elements before resizing the array. */
462 if ((src->children_num == 0) && (offset < (dst->children_num - 1))) {
463 int nmemb = dst->children_num - (offset + 1);
464 memmove(dst->children + offset, dst->children + offset + 1,
465 sizeof(oconfig_item_t) * nmemb);
468 /* Resize the memory containing the children to be big enough to hold
470 if (dst->children_num + src->children_num - 1 == 0) {
471 dst->children_num = 0;
475 temp = realloc(dst->children,
476 sizeof(oconfig_item_t) *
477 (dst->children_num + src->children_num - 1));
479 ERROR("configfile: realloc failed.");
482 dst->children = temp;
484 /* If there are children behind the include statement, and they have
485 * not yet been moved because (src->children_num == 0), then move them
486 * to the end of the list, so that the new children have room before
488 if ((src->children_num > 0) && ((dst->children_num - (offset + 1)) > 0)) {
489 int nmemb = dst->children_num - (offset + 1);
490 int old_offset = offset + 1;
491 int new_offset = offset + src->children_num;
493 memmove(dst->children + new_offset, dst->children + old_offset,
494 sizeof(oconfig_item_t) * nmemb);
497 /* Last but not least: If there are new children, copy them to the
498 * memory reserved for them. */
499 if (src->children_num > 0) {
500 memcpy(dst->children + offset, src->children,
501 sizeof(oconfig_item_t) * src->children_num);
504 /* Update the number of children. */
505 dst->children_num += (src->children_num - 1);
508 } /* int cf_ci_replace_child */
510 static int cf_ci_append_children(oconfig_item_t *dst, oconfig_item_t *src) {
511 oconfig_item_t *temp;
513 if ((src == NULL) || (src->children_num == 0))
517 realloc(dst->children,
518 sizeof(oconfig_item_t) * (dst->children_num + src->children_num));
520 ERROR("configfile: realloc failed.");
523 dst->children = temp;
525 memcpy(dst->children + dst->children_num, src->children,
526 sizeof(oconfig_item_t) * src->children_num);
527 dst->children_num += src->children_num;
530 } /* int cf_ci_append_children */
532 #define CF_MAX_DEPTH 8
533 static oconfig_item_t *cf_read_generic(const char *path, const char *pattern,
536 static int cf_include_all(oconfig_item_t *root, int depth) {
537 for (int i = 0; i < root->children_num; i++) {
541 char *pattern = NULL;
543 if (strcasecmp(root->children[i].key, "Include") != 0)
546 old = root->children + i;
548 if ((old->values_num != 1) ||
549 (old->values[0].type != OCONFIG_TYPE_STRING)) {
550 ERROR("configfile: `Include' needs exactly one string argument.");
554 for (int j = 0; j < old->children_num; ++j) {
555 oconfig_item_t *child = old->children + j;
557 if (strcasecmp(child->key, "Filter") == 0)
558 cf_util_get_string(child, &pattern);
560 ERROR("configfile: Option `%s' not allowed in <Include> block.",
564 new = cf_read_generic(old->values[0].value.string, pattern, depth + 1);
570 /* Now replace the i'th child in `root' with `new'. */
571 if (cf_ci_replace_child(root, new, i) < 0) {
577 /* ... and go back to the new i'th child. */
582 } /* for (i = 0; i < root->children_num; i++) */
585 } /* int cf_include_all */
587 static oconfig_item_t *cf_read_file(const char *file, const char *pattern,
589 oconfig_item_t *root;
592 assert(depth < CF_MAX_DEPTH);
594 if (pattern != NULL) {
595 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
596 char *tmp = sstrdup(file);
597 char *filename = basename(tmp);
599 if ((filename != NULL) && (fnmatch(pattern, filename, 0) != 0)) {
600 DEBUG("configfile: Not including `%s' because it "
601 "does not match pattern `%s'.",
609 ERROR("configfile: Cannot apply pattern filter '%s' "
610 "to file '%s': functions basename() and / or "
611 "fnmatch() not available.",
613 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
616 root = oconfig_parse_file(file);
618 ERROR("configfile: Cannot read file `%s'.", file);
622 status = cf_include_all(root, depth);
629 } /* oconfig_item_t *cf_read_file */
631 static int cf_compare_string(const void *p1, const void *p2) {
632 return strcmp(*(const char **)p1, *(const char **)p2);
635 static oconfig_item_t *cf_read_dir(const char *dir, const char *pattern,
637 oconfig_item_t *root = NULL;
640 char **filenames = NULL;
641 int filenames_num = 0;
644 assert(depth < CF_MAX_DEPTH);
648 ERROR("configfile: opendir failed: %s", STRERRNO);
652 root = calloc(1, sizeof(*root));
654 ERROR("configfile: calloc failed.");
659 while ((de = readdir(dh)) != NULL) {
663 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
666 status = snprintf(name, sizeof(name), "%s/%s", dir, de->d_name);
667 if ((status < 0) || ((size_t)status >= sizeof(name))) {
668 ERROR("configfile: Not including `%s/%s' because its"
669 " name is too long.",
672 for (int i = 0; i < filenames_num; ++i)
680 tmp = realloc(filenames, filenames_num * sizeof(*filenames));
682 ERROR("configfile: realloc failed.");
684 for (int i = 0; i < filenames_num - 1; ++i)
692 filenames[filenames_num - 1] = sstrdup(name);
695 if (filenames == NULL) {
700 qsort((void *)filenames, filenames_num, sizeof(*filenames),
703 for (int i = 0; i < filenames_num; ++i) {
704 oconfig_item_t *temp;
705 char *name = filenames[i];
707 temp = cf_read_generic(name, pattern, depth);
709 /* An error should already have been reported. */
714 cf_ci_append_children(root, temp);
715 sfree(temp->children);
724 } /* oconfig_item_t *cf_read_dir */
729 * Path is stat'ed and either cf_read_file or cf_read_dir is called
732 * There are two versions of this function: If `wordexp' exists shell wildcards
733 * will be expanded and the function will include all matches found. If
734 * `wordexp' (or, more precisely, its header file) is not available the
735 * simpler function is used which does not do any such expansion.
738 static oconfig_item_t *cf_read_generic(const char *path, const char *pattern,
740 oconfig_item_t *root = NULL;
742 const char *path_ptr;
745 if (depth >= CF_MAX_DEPTH) {
746 ERROR("configfile: Not including `%s' because the maximum "
747 "nesting depth has been reached.",
752 status = wordexp(path, &we, WRDE_NOCMD);
754 ERROR("configfile: wordexp (%s) failed.", path);
758 root = calloc(1, sizeof(*root));
760 ERROR("configfile: calloc failed.");
764 /* wordexp() might return a sorted list already. That's not
765 * documented though, so let's make sure we get what we want. */
766 qsort((void *)we.we_wordv, we.we_wordc, sizeof(*we.we_wordv),
769 for (size_t i = 0; i < we.we_wordc; i++) {
770 oconfig_item_t *temp;
773 path_ptr = we.we_wordv[i];
775 status = stat(path_ptr, &statbuf);
777 WARNING("configfile: stat (%s) failed: %s", path_ptr, STRERRNO);
781 if (S_ISREG(statbuf.st_mode))
782 temp = cf_read_file(path_ptr, pattern, depth);
783 else if (S_ISDIR(statbuf.st_mode))
784 temp = cf_read_dir(path_ptr, pattern, depth);
786 WARNING("configfile: %s is neither a file nor a "
797 cf_ci_append_children(root, temp);
798 sfree(temp->children);
805 } /* oconfig_item_t *cf_read_generic */
806 /* #endif HAVE_WORDEXP_H */
808 #else /* if !HAVE_WORDEXP_H */
809 static oconfig_item_t *cf_read_generic(const char *path, const char *pattern,
814 if (depth >= CF_MAX_DEPTH) {
815 ERROR("configfile: Not including `%s' because the maximum "
816 "nesting depth has been reached.",
821 status = stat(path, &statbuf);
823 ERROR("configfile: stat (%s) failed: %s", path, STRERRNO);
827 if (S_ISREG(statbuf.st_mode))
828 return cf_read_file(path, pattern, depth);
829 else if (S_ISDIR(statbuf.st_mode))
830 return cf_read_dir(path, pattern, depth);
832 ERROR("configfile: %s is neither a file nor a directory.", path);
834 } /* oconfig_item_t *cf_read_generic */
835 #endif /* !HAVE_WORDEXP_H */
840 int global_option_set(const char *option, const char *value, bool from_cli) {
842 DEBUG("option = %s; value = %s;", option, value);
844 for (i = 0; i < cf_global_options_num; i++)
845 if (strcasecmp(cf_global_options[i].key, option) == 0)
848 if (i >= cf_global_options_num) {
849 ERROR("configfile: Cannot set unknown global option `%s'.", option);
853 if (cf_global_options[i].from_cli && (!from_cli)) {
854 DEBUG("configfile: Ignoring %s `%s' option because "
855 "it was overriden by a command-line option.",
860 sfree(cf_global_options[i].value);
863 cf_global_options[i].value = strdup(value);
865 cf_global_options[i].value = NULL;
867 cf_global_options[i].from_cli = from_cli;
872 const char *global_option_get(const char *option) {
874 for (i = 0; i < cf_global_options_num; i++)
875 if (strcasecmp(cf_global_options[i].key, option) == 0)
878 if (i >= cf_global_options_num) {
879 ERROR("configfile: Cannot get unknown global option `%s'.", option);
883 return (cf_global_options[i].value != NULL) ? cf_global_options[i].value
884 : cf_global_options[i].def;
885 } /* char *global_option_get */
887 long global_option_get_long(const char *option, long default_value) {
891 str = global_option_get(option);
893 return default_value;
896 value = strtol(str, /* endptr = */ NULL, /* base = */ 0);
898 return default_value;
901 } /* char *global_option_get_long */
903 cdtime_t global_option_get_time(const char *name, cdtime_t def) /* {{{ */
909 optstr = global_option_get(name);
914 v = strtod(optstr, &endptr);
915 if ((endptr == NULL) || (*endptr != 0) || (errno != 0))
920 return DOUBLE_TO_CDTIME_T(v);
921 } /* }}} cdtime_t global_option_get_time */
923 cdtime_t cf_get_default_interval(void) {
924 return global_option_get_time("Interval",
925 DOUBLE_TO_CDTIME_T(COLLECTD_DEFAULT_INTERVAL));
928 void cf_unregister(const char *type) {
929 for (cf_callback_t *prev = NULL, *this = first_callback; this != NULL;
930 prev = this, this = this->next)
931 if (strcasecmp(this->type, type) == 0) {
933 first_callback = this->next;
935 prev->next = this->next;
940 } /* void cf_unregister */
942 void cf_unregister_complex(const char *type) {
943 for (cf_complex_callback_t *prev = NULL, *this = complex_callback_head;
944 this != NULL; prev = this, this = this->next)
945 if (strcasecmp(this->type, type) == 0) {
947 complex_callback_head = this->next;
949 prev->next = this->next;
955 } /* void cf_unregister */
957 void cf_register(const char *type, int (*callback)(const char *, const char *),
958 const char **keys, int keys_num) {
959 cf_callback_t *cf_cb;
961 /* Remove this module from the list, if it already exists */
964 /* This pointer will be free'd in `cf_unregister' */
965 if ((cf_cb = malloc(sizeof(*cf_cb))) == NULL)
969 cf_cb->callback = callback;
971 cf_cb->keys_num = keys_num;
972 cf_cb->ctx = plugin_get_ctx();
974 cf_cb->next = first_callback;
975 first_callback = cf_cb;
976 } /* void cf_register */
978 int cf_register_complex(const char *type, int (*callback)(oconfig_item_t *)) {
979 cf_complex_callback_t *new;
981 new = malloc(sizeof(*new));
985 new->type = strdup(type);
986 if (new->type == NULL) {
991 new->callback = callback;
994 new->ctx = plugin_get_ctx();
996 if (complex_callback_head == NULL) {
997 complex_callback_head = new;
999 cf_complex_callback_t *last = complex_callback_head;
1000 while (last->next != NULL)
1006 } /* int cf_register_complex */
1008 int cf_read(const char *filename) {
1009 oconfig_item_t *conf;
1012 conf = cf_read_generic(filename, /* pattern = */ NULL, /* depth = */ 0);
1014 ERROR("Unable to read config file %s.", filename);
1016 } else if (conf->children_num == 0) {
1017 ERROR("Configuration file %s is empty.", filename);
1022 for (int i = 0; i < conf->children_num; i++) {
1023 if (conf->children[i].children == NULL) {
1024 if (dispatch_value(conf->children + i) != 0)
1027 if (dispatch_block(conf->children + i) != 0)
1034 /* Read the default types.db if no `TypesDB' option was given. */
1035 if (cf_default_typesdb) {
1036 if (read_types_list(PKGDATADIR "/types.db") != 0)
1044 void cf_log(int level, const char *format, ...) {
1045 char msg[1024] = ""; // Size inherits from plugin_log()
1047 char const *name = plugin_get_ctx().name;
1050 va_start(ap, format);
1051 vsnprintf(msg, sizeof(msg), format, ap);
1054 plugin_log(level, "%s plugin: %s", name, msg);
1057 #define CF_ERROR(...) cf_log(LOG_ERR, __VA_ARGS__)
1058 #define CF_WARNING(...) cf_log(LOG_WARNING, __VA_ARGS__)
1060 /* Assures the config option is a string, duplicates it and returns the copy in
1061 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1063 int cf_util_get_string(const oconfig_item_t *ci, char **ret_string) /* {{{ */
1065 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1066 CF_ERROR("The `%s' option requires exactly one string argument.", ci->key);
1070 char *string = strdup(ci->values[0].value.string);
1074 if (*ret_string != NULL)
1076 *ret_string = string;
1079 } /* }}} int cf_util_get_string */
1081 /* Assures the config option is a string and copies it to the provided buffer.
1082 * Assures null-termination. */
1083 int cf_util_get_string_buffer(const oconfig_item_t *ci, char *buffer, /* {{{ */
1084 size_t buffer_size) {
1085 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1088 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1089 CF_ERROR("The `%s' option requires exactly one string argument.", ci->key);
1093 strncpy(buffer, ci->values[0].value.string, buffer_size);
1094 buffer[buffer_size - 1] = 0;
1097 } /* }}} int cf_util_get_string_buffer */
1099 /* Assures the config option is a number and returns it as an int. */
1100 int cf_util_get_int(const oconfig_item_t *ci, int *ret_value) /* {{{ */
1102 if ((ci == NULL) || (ret_value == NULL))
1105 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
1106 CF_ERROR("The `%s' option requires exactly one numeric argument.", ci->key);
1110 *ret_value = (int)ci->values[0].value.number;
1113 } /* }}} int cf_util_get_int */
1115 int cf_util_get_double(const oconfig_item_t *ci, double *ret_value) /* {{{ */
1117 if ((ci == NULL) || (ret_value == NULL))
1120 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
1121 CF_ERROR("The `%s' option requires exactly one numeric argument.", ci->key);
1125 *ret_value = ci->values[0].value.number;
1128 } /* }}} int cf_util_get_double */
1130 int cf_util_get_boolean(const oconfig_item_t *ci, bool *ret_bool) /* {{{ */
1132 if ((ci == NULL) || (ret_bool == NULL))
1135 if ((ci->values_num != 1) || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN) &&
1136 (ci->values[0].type != OCONFIG_TYPE_STRING))) {
1137 CF_ERROR("The `%s' option requires exactly one boolean argument.", ci->key);
1141 switch (ci->values[0].type) {
1142 case OCONFIG_TYPE_BOOLEAN:
1143 *ret_bool = ci->values[0].value.boolean ? true : false;
1145 case OCONFIG_TYPE_STRING:
1146 CF_WARNING("Using string value `%s' for boolean option `%s' is deprecated "
1147 "and will be removed in future releases. Use unquoted true or "
1149 ci->values[0].value.string, ci->key);
1151 if (IS_TRUE(ci->values[0].value.string))
1153 else if (IS_FALSE(ci->values[0].value.string))
1156 CF_ERROR("Cannot parse string value `%s' of the `%s' option as a boolean "
1158 ci->values[0].value.string, ci->key);
1165 } /* }}} int cf_util_get_boolean */
1167 int cf_util_get_flag(const oconfig_item_t *ci, /* {{{ */
1168 unsigned int *ret_value, unsigned int flag) {
1171 if (ret_value == NULL)
1175 status = cf_util_get_boolean(ci, &b);
1182 *ret_value &= ~flag;
1186 } /* }}} int cf_util_get_flag */
1188 /* Assures that the config option is a string or a number if the correct range
1189 * of 1-65535. The string is then converted to a port number using
1190 * `service_name_to_port_number' and returned.
1191 * Returns the port number in the range [1-65535] or less than zero upon
1193 int cf_util_get_port_number(const oconfig_item_t *ci) /* {{{ */
1197 if ((ci->values_num != 1) || ((ci->values[0].type != OCONFIG_TYPE_STRING) &&
1198 (ci->values[0].type != OCONFIG_TYPE_NUMBER))) {
1199 CF_ERROR("The `%s' option requires exactly one string argument.", ci->key);
1203 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1204 return service_name_to_port_number(ci->values[0].value.string);
1206 assert(ci->values[0].type == OCONFIG_TYPE_NUMBER);
1207 tmp = (int)(ci->values[0].value.number + 0.5);
1208 if ((tmp < 1) || (tmp > 65535)) {
1209 CF_ERROR("The `%s' option requires a service name or a port number. The "
1210 "number you specified, %i, is not in the valid range of 1-65535.",
1216 } /* }}} int cf_util_get_port_number */
1218 int cf_util_get_service(const oconfig_item_t *ci, char **ret_string) /* {{{ */
1224 if (ci->values_num != 1) {
1225 CF_ERROR("The `%s` option requires exactly one argument.", ci->key);
1229 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1230 return cf_util_get_string(ci, ret_string);
1231 if (ci->values[0].type != OCONFIG_TYPE_NUMBER) {
1232 CF_ERROR("The `%s` option requires exactly one string or numeric argument.",
1237 status = cf_util_get_int(ci, &port);
1240 else if ((port < 1) || (port > 65535)) {
1241 CF_ERROR("The port number given for the `%s` option is out of range (%i).",
1246 service = malloc(6);
1247 if (service == NULL) {
1248 CF_ERROR("cf_util_get_service: Out of memory.");
1251 snprintf(service, 6, "%i", port);
1254 *ret_string = service;
1257 } /* }}} int cf_util_get_service */
1259 int cf_util_get_cdtime(const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1261 if ((ci == NULL) || (ret_value == NULL))
1264 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
1265 CF_ERROR("The `%s' option requires exactly one numeric argument.", ci->key);
1269 if (ci->values[0].value.number < 0.0) {
1270 CF_ERROR("The numeric argument of the `%s' option must not be negative.",
1275 *ret_value = DOUBLE_TO_CDTIME_T(ci->values[0].value.number);
1278 } /* }}} int cf_util_get_cdtime */