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) (const oconfig_item_t *);
79 typedef struct cf_global_option_s
87 * Prototypes of callback functions
89 static int dispatch_value_typesdb (const oconfig_item_t *ci);
90 static int dispatch_value_plugindir (const oconfig_item_t *ci);
91 static int dispatch_loadplugin (const oconfig_item_t *ci);
96 static cf_callback_t *first_callback = NULL;
97 static cf_complex_callback_t *complex_callback_head = NULL;
99 static cf_value_map_t cf_value_map[] =
101 {"TypesDB", dispatch_value_typesdb},
102 {"PluginDir", dispatch_value_plugindir},
103 {"LoadPlugin", dispatch_loadplugin}
105 static int cf_value_map_num = STATIC_ARRAY_SIZE (cf_value_map);
107 static cf_global_option_t cf_global_options[] =
109 {"BaseDir", NULL, PKGLOCALSTATEDIR},
110 {"PIDFile", NULL, PIDFILE},
111 {"Hostname", NULL, NULL},
112 {"FQDNLookup", NULL, "true"},
113 {"Interval", NULL, NULL},
114 {"ReadThreads", NULL, "5"},
115 {"WriteThreads", NULL, "5"},
116 {"WriteQueueLimitHigh", NULL, NULL},
117 {"WriteQueueLimitLow", NULL, NULL},
118 {"Timeout", NULL, "2"},
119 {"AutoLoadPlugin", NULL, "false"},
120 {"CollectInternalStats", NULL, "false"},
121 {"PreCacheChain", NULL, "PreCache"},
122 {"PostCacheChain", NULL, "PostCache"},
123 {"MaxReadInterval", NULL, "86400"}
125 static int cf_global_options_num = STATIC_ARRAY_SIZE (cf_global_options);
127 static int cf_default_typesdb = 1;
130 * Functions to handle register/unregister, search, and other plugin related
133 static cf_callback_t *cf_search (const char *type)
135 cf_callback_t *cf_cb;
140 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
141 if (strcasecmp (cf_cb->type, type) == 0)
147 static int cf_dispatch (const char *type, const char *orig_key,
148 const char *orig_value)
150 cf_callback_t *cf_cb;
151 plugin_ctx_t old_ctx;
157 DEBUG ("type = %s, key = %s, value = %s",
159 ESCAPE_NULL(orig_key),
160 ESCAPE_NULL(orig_value));
162 if ((cf_cb = cf_search (type)) == NULL)
164 WARNING ("Found a configuration for the `%s' plugin, but "
165 "the plugin isn't loaded or didn't register "
166 "a configuration callback.", type);
170 if ((key = strdup (orig_key)) == NULL)
172 if ((value = strdup (orig_value)) == NULL)
180 old_ctx = plugin_set_ctx (cf_cb->ctx);
182 for (i = 0; i < cf_cb->keys_num; i++)
184 if ((cf_cb->keys[i] != NULL)
185 && (strcasecmp (cf_cb->keys[i], key) == 0))
187 ret = (*cf_cb->callback) (key, value);
192 plugin_set_ctx (old_ctx);
194 if (i >= cf_cb->keys_num)
195 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
200 DEBUG ("cf_dispatch: return (%i)", ret);
203 } /* int cf_dispatch */
205 static int dispatch_global_option (const oconfig_item_t *ci)
207 if (ci->values_num != 1)
209 if (ci->values[0].type == OCONFIG_TYPE_STRING)
210 return (global_option_set (ci->key, ci->values[0].value.string));
211 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
214 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
215 return (global_option_set (ci->key, tmp));
217 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
219 if (ci->values[0].value.boolean)
220 return (global_option_set (ci->key, "true"));
222 return (global_option_set (ci->key, "false"));
226 } /* int dispatch_global_option */
228 static int dispatch_value_typesdb (const oconfig_item_t *ci)
232 assert (strcasecmp (ci->key, "TypesDB") == 0);
234 cf_default_typesdb = 0;
236 if (ci->values_num < 1) {
237 ERROR ("configfile: `TypesDB' needs at least one argument.");
241 for (i = 0; i < ci->values_num; ++i)
243 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
244 WARNING ("configfile: TypesDB: Skipping %i. argument which "
245 "is not a string.", i + 1);
249 read_types_list (ci->values[i].value.string);
252 } /* int dispatch_value_typesdb */
254 static int dispatch_value_plugindir (const oconfig_item_t *ci)
256 assert (strcasecmp (ci->key, "PluginDir") == 0);
258 if (ci->values_num != 1)
260 if (ci->values[0].type != OCONFIG_TYPE_STRING)
263 plugin_set_dir (ci->values[0].value.string);
267 static int dispatch_loadplugin (const oconfig_item_t *ci)
271 unsigned int flags = 0;
273 plugin_ctx_t old_ctx;
276 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
278 if (ci->values_num != 1)
280 if (ci->values[0].type != OCONFIG_TYPE_STRING)
283 name = ci->values[0].value.string;
285 /* default to the global interval set before loading this plugin */
286 memset (&ctx, 0, sizeof (ctx));
287 ctx.interval = cf_get_default_interval ();
289 for (i = 0; i < ci->children_num; ++i) {
290 if (strcasecmp("Globals", ci->children[i].key) == 0)
291 cf_util_get_flag (ci->children + i, &flags, PLUGIN_FLAGS_GLOBAL);
292 else if (strcasecmp ("Interval", ci->children[i].key) == 0) {
293 if (cf_util_get_cdtime (ci->children + i, &ctx.interval) != 0) {
294 /* cf_util_get_cdtime will log an error */
299 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
301 ci->children[i].key, ci->values[0].value.string);
305 old_ctx = plugin_set_ctx (ctx);
306 ret_val = plugin_load (name, (uint32_t) flags);
307 /* reset to the "global" context */
308 plugin_set_ctx (old_ctx);
311 } /* int dispatch_value_loadplugin */
313 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
321 buffer_free = sizeof (buffer);
323 for (i = 0; i < ci->values_num; i++)
327 if (ci->values[i].type == OCONFIG_TYPE_STRING)
328 status = ssnprintf (buffer_ptr, buffer_free, " %s",
329 ci->values[i].value.string);
330 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
331 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
332 ci->values[i].value.number);
333 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
334 status = ssnprintf (buffer_ptr, buffer_free, " %s",
335 ci->values[i].value.boolean
338 if ((status < 0) || (status >= buffer_free))
340 buffer_free -= status;
341 buffer_ptr += status;
343 /* skip the initial space */
344 buffer_ptr = buffer + 1;
346 return (cf_dispatch (plugin, ci->key, buffer_ptr));
347 } /* int dispatch_value_plugin */
349 static int dispatch_value (const oconfig_item_t *ci)
354 for (i = 0; i < cf_value_map_num; i++)
355 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
357 ret = cf_value_map[i].func (ci);
361 for (i = 0; i < cf_global_options_num; i++)
362 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
364 ret = dispatch_global_option (ci);
369 } /* int dispatch_value */
371 static int dispatch_block_plugin (oconfig_item_t *ci)
376 cf_complex_callback_t *cb;
378 if (strcasecmp (ci->key, "Plugin") != 0)
380 if (ci->values_num < 1)
382 if (ci->values[0].type != OCONFIG_TYPE_STRING)
385 name = ci->values[0].value.string;
387 if (IS_TRUE (global_option_get ("AutoLoadPlugin")))
391 status = plugin_load (name, /* flags = */ 0);
394 ERROR ("Automatically loading plugin \"%s\" failed "
395 "with status %i.", name, status);
400 /* Check for a complex callback first */
401 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
403 if (strcasecmp (name, cb->type) == 0)
405 plugin_ctx_t old_ctx;
408 old_ctx = plugin_set_ctx (cb->ctx);
409 ret_val = (cb->callback (ci));
410 plugin_set_ctx (old_ctx);
415 /* Hm, no complex plugin found. Dispatch the values one by one */
416 for (i = 0; i < ci->children_num; i++)
418 if (ci->children[i].children == NULL)
419 dispatch_value_plugin (name, ci->children + i);
422 WARNING ("There is a `%s' block within the "
423 "configuration for the %s plugin. "
424 "The plugin either only expects "
425 "\"simple\" configuration statements "
426 "or wasn't loaded using `LoadPlugin'."
427 " Please check your configuration.",
428 ci->children[i].key, name);
436 static int dispatch_block (oconfig_item_t *ci)
438 if (strcasecmp (ci->key, "LoadPlugin") == 0)
439 return (dispatch_loadplugin (ci));
440 else if (strcasecmp (ci->key, "Plugin") == 0)
441 return (dispatch_block_plugin (ci));
442 else if (strcasecmp (ci->key, "Chain") == 0)
443 return (fc_configure (ci));
448 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
451 oconfig_item_t *temp;
454 assert (offset >= 0);
455 assert (dst->children_num > offset);
457 /* Free the memory used by the replaced child. Usually that's the
458 * `Include "blah"' statement. */
459 temp = dst->children + offset;
460 for (i = 0; i < temp->values_num; i++)
462 if (temp->values[i].type == OCONFIG_TYPE_STRING)
464 sfree (temp->values[i].value.string);
467 sfree (temp->values);
470 /* If (src->children_num == 0) the array size is decreased. If offset
471 * is _not_ the last element, (offset < (dst->children_num - 1)), then
472 * we need to move the trailing elements before resizing the array. */
473 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
475 int nmemb = dst->children_num - (offset + 1);
476 memmove (dst->children + offset, dst->children + offset + 1,
477 sizeof (oconfig_item_t) * nmemb);
480 /* Resize the memory containing the children to be big enough to hold
482 if (dst->children_num + src->children_num - 1 == 0)
484 dst->children_num = 0;
488 temp = (oconfig_item_t *) realloc (dst->children,
489 sizeof (oconfig_item_t)
490 * (dst->children_num + src->children_num - 1));
493 ERROR ("configfile: realloc failed.");
496 dst->children = temp;
498 /* If there are children behind the include statement, and they have
499 * not yet been moved because (src->children_num == 0), then move them
500 * to the end of the list, so that the new children have room before
502 if ((src->children_num > 0)
503 && ((dst->children_num - (offset + 1)) > 0))
505 int nmemb = dst->children_num - (offset + 1);
506 int old_offset = offset + 1;
507 int new_offset = offset + src->children_num;
509 memmove (dst->children + new_offset,
510 dst->children + old_offset,
511 sizeof (oconfig_item_t) * nmemb);
514 /* Last but not least: If there are new children, copy them to the
515 * memory reserved for them. */
516 if (src->children_num > 0)
518 memcpy (dst->children + offset,
520 sizeof (oconfig_item_t) * src->children_num);
523 /* Update the number of children. */
524 dst->children_num += (src->children_num - 1);
527 } /* int cf_ci_replace_child */
529 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
531 oconfig_item_t *temp;
533 if ((src == NULL) || (src->children_num == 0))
536 temp = (oconfig_item_t *) realloc (dst->children,
537 sizeof (oconfig_item_t)
538 * (dst->children_num + src->children_num));
541 ERROR ("configfile: realloc failed.");
544 dst->children = temp;
546 memcpy (dst->children + dst->children_num,
548 sizeof (oconfig_item_t)
549 * src->children_num);
550 dst->children_num += src->children_num;
553 } /* int cf_ci_append_children */
555 #define CF_MAX_DEPTH 8
556 static oconfig_item_t *cf_read_generic (const char *path,
557 const char *pattern, int depth);
559 static int cf_include_all (oconfig_item_t *root, int depth)
563 for (i = 0; i < root->children_num; i++)
568 char *pattern = NULL;
572 if (strcasecmp (root->children[i].key, "Include") != 0)
575 old = root->children + i;
577 if ((old->values_num != 1)
578 || (old->values[0].type != OCONFIG_TYPE_STRING))
580 ERROR ("configfile: `Include' needs exactly one string argument.");
584 for (j = 0; j < old->children_num; ++j)
586 oconfig_item_t *child = old->children + j;
588 if (strcasecmp (child->key, "Filter") == 0)
589 cf_util_get_string (child, &pattern);
591 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
595 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
601 /* Now replace the i'th child in `root' with `new'. */
602 if (cf_ci_replace_child (root, new, i) < 0)
605 /* ... and go back to the new i'th child. */
610 } /* for (i = 0; i < root->children_num; i++) */
613 } /* int cf_include_all */
615 static oconfig_item_t *cf_read_file (const char *file,
616 const char *pattern, int depth)
618 oconfig_item_t *root;
621 assert (depth < CF_MAX_DEPTH);
623 if (pattern != NULL) {
624 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
625 char *tmp = sstrdup (file);
626 char *filename = basename (tmp);
628 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
629 DEBUG ("configfile: Not including `%s' because it "
630 "does not match pattern `%s'.",
638 ERROR ("configfile: Cannot apply pattern filter '%s' "
639 "to file '%s': functions basename() and / or "
640 "fnmatch() not available.", pattern, file);
641 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
644 root = oconfig_parse_file (file);
647 ERROR ("configfile: Cannot read file `%s'.", file);
651 status = cf_include_all (root, depth);
659 } /* oconfig_item_t *cf_read_file */
661 static int cf_compare_string (const void *p1, const void *p2)
663 return strcmp (*(const char **) p1, *(const char **) p2);
666 static oconfig_item_t *cf_read_dir (const char *dir,
667 const char *pattern, int depth)
669 oconfig_item_t *root = NULL;
672 char **filenames = NULL;
673 int filenames_num = 0;
677 assert (depth < CF_MAX_DEPTH);
683 ERROR ("configfile: opendir failed: %s",
684 sstrerror (errno, errbuf, sizeof (errbuf)));
688 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
691 ERROR ("configfile: malloc failed.");
694 memset (root, 0, sizeof (oconfig_item_t));
696 while ((de = readdir (dh)) != NULL)
701 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
704 status = ssnprintf (name, sizeof (name), "%s/%s",
706 if ((status < 0) || ((size_t) status >= sizeof (name)))
708 ERROR ("configfile: Not including `%s/%s' because its"
709 " name is too long.",
711 for (i = 0; i < filenames_num; ++i)
719 tmp = (char **) realloc (filenames,
720 filenames_num * sizeof (*filenames));
722 ERROR ("configfile: realloc failed.");
723 for (i = 0; i < filenames_num - 1; ++i)
731 filenames[filenames_num - 1] = sstrdup (name);
734 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
737 for (i = 0; i < filenames_num; ++i)
739 oconfig_item_t *temp;
740 char *name = filenames[i];
742 temp = cf_read_generic (name, pattern, depth);
745 /* An error should already have been reported. */
750 cf_ci_append_children (root, temp);
751 sfree (temp->children);
759 } /* oconfig_item_t *cf_read_dir */
764 * Path is stat'ed and either cf_read_file or cf_read_dir is called
767 * There are two versions of this function: If `wordexp' exists shell wildcards
768 * will be expanded and the function will include all matches found. If
769 * `wordexp' (or, more precisely, it's header file) is not available the
770 * simpler function is used which does not do any such expansion.
773 static oconfig_item_t *cf_read_generic (const char *path,
774 const char *pattern, int depth)
776 oconfig_item_t *root = NULL;
778 const char *path_ptr;
782 if (depth >= CF_MAX_DEPTH)
784 ERROR ("configfile: Not including `%s' because the maximum "
785 "nesting depth has been reached.", path);
789 status = wordexp (path, &we, WRDE_NOCMD);
792 ERROR ("configfile: wordexp (%s) failed.", path);
796 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
799 ERROR ("configfile: malloc failed.");
802 memset (root, '\0', sizeof (oconfig_item_t));
804 /* wordexp() might return a sorted list already. That's not
805 * documented though, so let's make sure we get what we want. */
806 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
809 for (i = 0; i < we.we_wordc; i++)
811 oconfig_item_t *temp;
814 path_ptr = we.we_wordv[i];
816 status = stat (path_ptr, &statbuf);
820 WARNING ("configfile: stat (%s) failed: %s",
822 sstrerror (errno, errbuf, sizeof (errbuf)));
826 if (S_ISREG (statbuf.st_mode))
827 temp = cf_read_file (path_ptr, pattern, depth);
828 else if (S_ISDIR (statbuf.st_mode))
829 temp = cf_read_dir (path_ptr, pattern, depth);
832 WARNING ("configfile: %s is neither a file nor a "
842 cf_ci_append_children (root, temp);
843 sfree (temp->children);
850 } /* oconfig_item_t *cf_read_generic */
851 /* #endif HAVE_WORDEXP_H */
853 #else /* if !HAVE_WORDEXP_H */
854 static oconfig_item_t *cf_read_generic (const char *path,
855 const char *pattern, int depth)
860 if (depth >= CF_MAX_DEPTH)
862 ERROR ("configfile: Not including `%s' because the maximum "
863 "nesting depth has been reached.", path);
867 status = stat (path, &statbuf);
871 ERROR ("configfile: stat (%s) failed: %s",
873 sstrerror (errno, errbuf, sizeof (errbuf)));
877 if (S_ISREG (statbuf.st_mode))
878 return (cf_read_file (path, pattern, depth));
879 else if (S_ISDIR (statbuf.st_mode))
880 return (cf_read_dir (path, pattern, depth));
882 ERROR ("configfile: %s is neither a file nor a directory.", path);
884 } /* oconfig_item_t *cf_read_generic */
885 #endif /* !HAVE_WORDEXP_H */
890 int global_option_set (const char *option, const char *value)
894 DEBUG ("option = %s; value = %s;", option, value);
896 for (i = 0; i < cf_global_options_num; i++)
897 if (strcasecmp (cf_global_options[i].key, option) == 0)
900 if (i >= cf_global_options_num)
903 if (strcasecmp (option, "PIDFile") == 0 && pidfile_from_cli == 1)
905 DEBUG ("Configfile: Ignoring `PIDFILE' option because "
906 "command-line option `-P' take precedence.");
910 sfree (cf_global_options[i].value);
913 cf_global_options[i].value = strdup (value);
915 cf_global_options[i].value = NULL;
920 const char *global_option_get (const char *option)
924 for (i = 0; i < cf_global_options_num; i++)
925 if (strcasecmp (cf_global_options[i].key, option) == 0)
928 if (i >= cf_global_options_num)
931 return ((cf_global_options[i].value != NULL)
932 ? cf_global_options[i].value
933 : cf_global_options[i].def);
934 } /* char *global_option_get */
936 long global_option_get_long (const char *option, long default_value)
941 str = global_option_get (option);
943 return (default_value);
946 value = strtol (str, /* endptr = */ NULL, /* base = */ 0);
948 return (default_value);
951 } /* char *global_option_get_long */
953 cdtime_t global_option_get_time (const char *name, cdtime_t def) /* {{{ */
959 optstr = global_option_get (name);
964 v = strtod (optstr, &endptr);
965 if ((endptr == NULL) || (*endptr != 0) || (errno != 0))
970 return (DOUBLE_TO_CDTIME_T (v));
971 } /* }}} cdtime_t global_option_get_time */
973 cdtime_t cf_get_default_interval (void)
975 return (global_option_get_time ("Interval", COLLECTD_DEFAULT_INTERVAL));
978 void cf_unregister (const char *type)
980 cf_callback_t *this, *prev;
982 for (prev = NULL, this = first_callback;
984 prev = this, this = this->next)
985 if (strcasecmp (this->type, type) == 0)
988 first_callback = this->next;
990 prev->next = this->next;
995 } /* void cf_unregister */
997 void cf_unregister_complex (const char *type)
999 cf_complex_callback_t *this, *prev;
1001 for (prev = NULL, this = complex_callback_head;
1003 prev = this, this = this->next)
1004 if (strcasecmp (this->type, type) == 0)
1007 complex_callback_head = this->next;
1009 prev->next = this->next;
1015 } /* void cf_unregister */
1017 void cf_register (const char *type,
1018 int (*callback) (const char *, const char *),
1019 const char **keys, int keys_num)
1021 cf_callback_t *cf_cb;
1023 /* Remove this module from the list, if it already exists */
1024 cf_unregister (type);
1026 /* This pointer will be free'd in `cf_unregister' */
1027 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
1031 cf_cb->callback = callback;
1033 cf_cb->keys_num = keys_num;
1034 cf_cb->ctx = plugin_get_ctx ();
1036 cf_cb->next = first_callback;
1037 first_callback = cf_cb;
1038 } /* void cf_register */
1040 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1042 cf_complex_callback_t *new;
1044 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
1048 new->type = strdup (type);
1049 if (new->type == NULL)
1055 new->callback = callback;
1058 new->ctx = plugin_get_ctx ();
1060 if (complex_callback_head == NULL)
1062 complex_callback_head = new;
1066 cf_complex_callback_t *last = complex_callback_head;
1067 while (last->next != NULL)
1073 } /* int cf_register_complex */
1075 int cf_read (char *filename)
1077 oconfig_item_t *conf;
1080 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1083 ERROR ("Unable to read config file %s.", filename);
1086 else if (conf->children_num == 0)
1088 ERROR ("Configuration file %s is empty.", filename);
1089 oconfig_free (conf);
1093 for (i = 0; i < conf->children_num; i++)
1095 if (conf->children[i].children == NULL)
1096 dispatch_value (conf->children + i);
1098 dispatch_block (conf->children + i);
1101 oconfig_free (conf);
1103 /* Read the default types.db if no `TypesDB' option was given. */
1104 if (cf_default_typesdb)
1105 read_types_list (PKGDATADIR"/types.db");
1110 /* Assures the config option is a string, duplicates it and returns the copy in
1111 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1113 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1117 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1119 ERROR ("cf_util_get_string: The %s option requires "
1120 "exactly one string argument.", ci->key);
1124 string = strdup (ci->values[0].value.string);
1128 if (*ret_string != NULL)
1129 sfree (*ret_string);
1130 *ret_string = string;
1133 } /* }}} int cf_util_get_string */
1135 /* Assures the config option is a string and copies it to the provided buffer.
1136 * Assures null-termination. */
1137 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1140 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1143 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1145 ERROR ("cf_util_get_string_buffer: The %s option requires "
1146 "exactly one string argument.", ci->key);
1150 strncpy (buffer, ci->values[0].value.string, buffer_size);
1151 buffer[buffer_size - 1] = 0;
1154 } /* }}} int cf_util_get_string_buffer */
1156 /* Assures the config option is a number and returns it as an int. */
1157 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1159 if ((ci == NULL) || (ret_value == NULL))
1162 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1164 ERROR ("cf_util_get_int: The %s option requires "
1165 "exactly one numeric argument.", ci->key);
1169 *ret_value = (int) ci->values[0].value.number;
1172 } /* }}} int cf_util_get_int */
1174 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1176 if ((ci == NULL) || (ret_value == NULL))
1179 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1181 ERROR ("cf_util_get_double: The %s option requires "
1182 "exactly one numeric argument.", ci->key);
1186 *ret_value = ci->values[0].value.number;
1189 } /* }}} int cf_util_get_double */
1191 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1193 if ((ci == NULL) || (ret_bool == NULL))
1196 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1198 ERROR ("cf_util_get_boolean: The %s option requires "
1199 "exactly one boolean argument.", ci->key);
1203 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1206 } /* }}} int cf_util_get_boolean */
1208 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1209 unsigned int *ret_value, unsigned int flag)
1214 if (ret_value == NULL)
1218 status = cf_util_get_boolean (ci, &b);
1228 *ret_value &= ~flag;
1232 } /* }}} int cf_util_get_flag */
1234 /* Assures that the config option is a string or a number if the correct range
1235 * of 1-65535. The string is then converted to a port number using
1236 * `service_name_to_port_number' and returned.
1237 * Returns the port number in the range [1-65535] or less than zero upon
1239 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1243 if ((ci->values_num != 1)
1244 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1245 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1247 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1248 "exactly one string argument.", ci->key);
1252 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1253 return (service_name_to_port_number (ci->values[0].value.string));
1255 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1256 tmp = (int) (ci->values[0].value.number + 0.5);
1257 if ((tmp < 1) || (tmp > 65535))
1259 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1260 "a service name or a port number. The number "
1261 "you specified, %i, is not in the valid "
1262 "range of 1-65535.",
1268 } /* }}} int cf_util_get_port_number */
1270 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1276 if (ci->values_num != 1)
1278 ERROR ("cf_util_get_service: The %s option requires exactly "
1279 "one argument.", ci->key);
1283 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1284 return (cf_util_get_string (ci, ret_string));
1285 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1287 ERROR ("cf_util_get_service: The %s option requires "
1288 "exactly one string or numeric argument.",
1293 status = cf_util_get_int (ci, &port);
1296 else if ((port < 1) || (port > 65535))
1298 ERROR ("cf_util_get_service: The port number given "
1299 "for the %s option is out of "
1300 "range (%i).", ci->key, port);
1304 service = malloc (6);
1305 if (service == NULL)
1307 ERROR ("cf_util_get_service: Out of memory.");
1310 ssnprintf (service, 6, "%i", port);
1312 sfree (*ret_string);
1313 *ret_string = service;
1316 } /* }}} int cf_util_get_service */
1318 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1320 if ((ci == NULL) || (ret_value == NULL))
1323 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1325 ERROR ("cf_util_get_cdtime: The %s option requires "
1326 "exactly one numeric argument.", ci->key);
1330 if (ci->values[0].value.number < 0.0)
1332 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1333 "option must not be negative.", ci->key);
1337 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1340 } /* }}} int cf_util_get_cdtime */