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;
284 if (strcmp ("libvirt", name) == 0)
287 /* default to the global interval set before loading this plugin */
288 memset (&ctx, 0, sizeof (ctx));
289 ctx.interval = cf_get_default_interval ();
290 ctx.flush_interval = 0;
291 ctx.flush_timeout = 0;
293 for (i = 0; i < ci->children_num; ++i)
295 oconfig_item_t *child = ci->children + i;
297 if (strcasecmp("Globals", child->key) == 0)
298 cf_util_get_flag (child, &flags, PLUGIN_FLAGS_GLOBAL);
299 else if (strcasecmp ("Interval", child->key) == 0) {
300 if (cf_util_get_cdtime (child, &ctx.interval) != 0) {
301 /* cf_util_get_cdtime will log an error */
305 else if (strcasecmp ("FlushInterval", child->key) == 0) {
306 if (cf_util_get_cdtime (child, &ctx.flush_interval) != 0) {
307 /* cf_util_get_cdtime will log an error */
311 else if (strcasecmp ("FlushTimeout", child->key) == 0) {
312 if (cf_util_get_cdtime (child, &ctx.flush_timeout) != 0) {
313 /* cf_util_get_cdtime will log an error */
318 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
320 child->key, ci->values[0].value.string);
324 old_ctx = plugin_set_ctx (ctx);
325 ret_val = plugin_load (name, (uint32_t) flags);
326 /* reset to the "global" context */
327 plugin_set_ctx (old_ctx);
330 } /* int dispatch_value_loadplugin */
332 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
340 buffer_free = sizeof (buffer);
342 for (i = 0; i < ci->values_num; i++)
346 if (ci->values[i].type == OCONFIG_TYPE_STRING)
347 status = ssnprintf (buffer_ptr, buffer_free, " %s",
348 ci->values[i].value.string);
349 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
350 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
351 ci->values[i].value.number);
352 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
353 status = ssnprintf (buffer_ptr, buffer_free, " %s",
354 ci->values[i].value.boolean
357 if ((status < 0) || (status >= buffer_free))
359 buffer_free -= status;
360 buffer_ptr += status;
362 /* skip the initial space */
363 buffer_ptr = buffer + 1;
365 return (cf_dispatch (plugin, ci->key, buffer_ptr));
366 } /* int dispatch_value_plugin */
368 static int dispatch_value (const oconfig_item_t *ci)
373 for (i = 0; i < cf_value_map_num; i++)
374 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
376 ret = cf_value_map[i].func (ci);
380 for (i = 0; i < cf_global_options_num; i++)
381 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
383 ret = dispatch_global_option (ci);
388 } /* int dispatch_value */
390 static int dispatch_block_plugin (oconfig_item_t *ci)
395 cf_complex_callback_t *cb;
397 if (strcasecmp (ci->key, "Plugin") != 0)
399 if (ci->values_num < 1)
401 if (ci->values[0].type != OCONFIG_TYPE_STRING)
404 name = ci->values[0].value.string;
405 if (strcmp ("libvirt", name) == 0)
407 /* TODO(octo): Remove this legacy. */
408 WARNING ("The \"libvirt\" plugin has been renamed to \"virt\" to avoid problems with the build system. "
409 "Your configuration is still using the old name. "
410 "Please change it to use \"virt\" as soon as possible. "
411 "This compatibility code will go away eventually.");
415 if (IS_TRUE (global_option_get ("AutoLoadPlugin")))
419 status = plugin_load (name, /* flags = */ 0);
422 ERROR ("Automatically loading plugin \"%s\" failed "
423 "with status %i.", name, status);
428 /* Check for a complex callback first */
429 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
431 if (strcasecmp (name, cb->type) == 0)
433 plugin_ctx_t old_ctx;
436 old_ctx = plugin_set_ctx (cb->ctx);
437 ret_val = (cb->callback (ci));
438 plugin_set_ctx (old_ctx);
443 /* Hm, no complex plugin found. Dispatch the values one by one */
444 for (i = 0; i < ci->children_num; i++)
446 if (ci->children[i].children == NULL)
447 dispatch_value_plugin (name, ci->children + i);
450 WARNING ("There is a `%s' block within the "
451 "configuration for the %s plugin. "
452 "The plugin either only expects "
453 "\"simple\" configuration statements "
454 "or wasn't loaded using `LoadPlugin'."
455 " Please check your configuration.",
456 ci->children[i].key, name);
464 static int dispatch_block (oconfig_item_t *ci)
466 if (strcasecmp (ci->key, "LoadPlugin") == 0)
467 return (dispatch_loadplugin (ci));
468 else if (strcasecmp (ci->key, "Plugin") == 0)
469 return (dispatch_block_plugin (ci));
470 else if (strcasecmp (ci->key, "Chain") == 0)
471 return (fc_configure (ci));
476 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
479 oconfig_item_t *temp;
482 assert (offset >= 0);
483 assert (dst->children_num > offset);
485 /* Free the memory used by the replaced child. Usually that's the
486 * `Include "blah"' statement. */
487 temp = dst->children + offset;
488 for (i = 0; i < temp->values_num; i++)
490 if (temp->values[i].type == OCONFIG_TYPE_STRING)
492 sfree (temp->values[i].value.string);
495 sfree (temp->values);
498 /* If (src->children_num == 0) the array size is decreased. If offset
499 * is _not_ the last element, (offset < (dst->children_num - 1)), then
500 * we need to move the trailing elements before resizing the array. */
501 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
503 int nmemb = dst->children_num - (offset + 1);
504 memmove (dst->children + offset, dst->children + offset + 1,
505 sizeof (oconfig_item_t) * nmemb);
508 /* Resize the memory containing the children to be big enough to hold
510 if (dst->children_num + src->children_num - 1 == 0)
512 dst->children_num = 0;
516 temp = (oconfig_item_t *) realloc (dst->children,
517 sizeof (oconfig_item_t)
518 * (dst->children_num + src->children_num - 1));
521 ERROR ("configfile: realloc failed.");
524 dst->children = temp;
526 /* If there are children behind the include statement, and they have
527 * not yet been moved because (src->children_num == 0), then move them
528 * to the end of the list, so that the new children have room before
530 if ((src->children_num > 0)
531 && ((dst->children_num - (offset + 1)) > 0))
533 int nmemb = dst->children_num - (offset + 1);
534 int old_offset = offset + 1;
535 int new_offset = offset + src->children_num;
537 memmove (dst->children + new_offset,
538 dst->children + old_offset,
539 sizeof (oconfig_item_t) * nmemb);
542 /* Last but not least: If there are new children, copy them to the
543 * memory reserved for them. */
544 if (src->children_num > 0)
546 memcpy (dst->children + offset,
548 sizeof (oconfig_item_t) * src->children_num);
551 /* Update the number of children. */
552 dst->children_num += (src->children_num - 1);
555 } /* int cf_ci_replace_child */
557 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
559 oconfig_item_t *temp;
561 if ((src == NULL) || (src->children_num == 0))
564 temp = (oconfig_item_t *) realloc (dst->children,
565 sizeof (oconfig_item_t)
566 * (dst->children_num + src->children_num));
569 ERROR ("configfile: realloc failed.");
572 dst->children = temp;
574 memcpy (dst->children + dst->children_num,
576 sizeof (oconfig_item_t)
577 * src->children_num);
578 dst->children_num += src->children_num;
581 } /* int cf_ci_append_children */
583 #define CF_MAX_DEPTH 8
584 static oconfig_item_t *cf_read_generic (const char *path,
585 const char *pattern, int depth);
587 static int cf_include_all (oconfig_item_t *root, int depth)
591 for (i = 0; i < root->children_num; i++)
596 char *pattern = NULL;
600 if (strcasecmp (root->children[i].key, "Include") != 0)
603 old = root->children + i;
605 if ((old->values_num != 1)
606 || (old->values[0].type != OCONFIG_TYPE_STRING))
608 ERROR ("configfile: `Include' needs exactly one string argument.");
612 for (j = 0; j < old->children_num; ++j)
614 oconfig_item_t *child = old->children + j;
616 if (strcasecmp (child->key, "Filter") == 0)
617 cf_util_get_string (child, &pattern);
619 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
623 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
629 /* Now replace the i'th child in `root' with `new'. */
630 if (cf_ci_replace_child (root, new, i) < 0)
633 /* ... and go back to the new i'th child. */
638 } /* for (i = 0; i < root->children_num; i++) */
641 } /* int cf_include_all */
643 static oconfig_item_t *cf_read_file (const char *file,
644 const char *pattern, int depth)
646 oconfig_item_t *root;
649 assert (depth < CF_MAX_DEPTH);
651 if (pattern != NULL) {
652 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
653 char *tmp = sstrdup (file);
654 char *filename = basename (tmp);
656 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
657 DEBUG ("configfile: Not including `%s' because it "
658 "does not match pattern `%s'.",
666 ERROR ("configfile: Cannot apply pattern filter '%s' "
667 "to file '%s': functions basename() and / or "
668 "fnmatch() not available.", pattern, file);
669 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
672 root = oconfig_parse_file (file);
675 ERROR ("configfile: Cannot read file `%s'.", file);
679 status = cf_include_all (root, depth);
687 } /* oconfig_item_t *cf_read_file */
689 static int cf_compare_string (const void *p1, const void *p2)
691 return strcmp (*(const char **) p1, *(const char **) p2);
694 static oconfig_item_t *cf_read_dir (const char *dir,
695 const char *pattern, int depth)
697 oconfig_item_t *root = NULL;
700 char **filenames = NULL;
701 int filenames_num = 0;
705 assert (depth < CF_MAX_DEPTH);
711 ERROR ("configfile: opendir failed: %s",
712 sstrerror (errno, errbuf, sizeof (errbuf)));
716 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
719 ERROR ("configfile: malloc failed.");
722 memset (root, 0, sizeof (oconfig_item_t));
724 while ((de = readdir (dh)) != NULL)
729 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
732 status = ssnprintf (name, sizeof (name), "%s/%s",
734 if ((status < 0) || ((size_t) status >= sizeof (name)))
736 ERROR ("configfile: Not including `%s/%s' because its"
737 " name is too long.",
739 for (i = 0; i < filenames_num; ++i)
747 tmp = (char **) realloc (filenames,
748 filenames_num * sizeof (*filenames));
750 ERROR ("configfile: realloc failed.");
751 for (i = 0; i < filenames_num - 1; ++i)
759 filenames[filenames_num - 1] = sstrdup (name);
762 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
765 for (i = 0; i < filenames_num; ++i)
767 oconfig_item_t *temp;
768 char *name = filenames[i];
770 temp = cf_read_generic (name, pattern, depth);
773 /* An error should already have been reported. */
778 cf_ci_append_children (root, temp);
779 sfree (temp->children);
787 } /* oconfig_item_t *cf_read_dir */
792 * Path is stat'ed and either cf_read_file or cf_read_dir is called
795 * There are two versions of this function: If `wordexp' exists shell wildcards
796 * will be expanded and the function will include all matches found. If
797 * `wordexp' (or, more precisely, it's header file) is not available the
798 * simpler function is used which does not do any such expansion.
801 static oconfig_item_t *cf_read_generic (const char *path,
802 const char *pattern, int depth)
804 oconfig_item_t *root = NULL;
806 const char *path_ptr;
810 if (depth >= CF_MAX_DEPTH)
812 ERROR ("configfile: Not including `%s' because the maximum "
813 "nesting depth has been reached.", path);
817 status = wordexp (path, &we, WRDE_NOCMD);
820 ERROR ("configfile: wordexp (%s) failed.", path);
824 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
827 ERROR ("configfile: malloc failed.");
830 memset (root, '\0', sizeof (oconfig_item_t));
832 /* wordexp() might return a sorted list already. That's not
833 * documented though, so let's make sure we get what we want. */
834 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
837 for (i = 0; i < we.we_wordc; i++)
839 oconfig_item_t *temp;
842 path_ptr = we.we_wordv[i];
844 status = stat (path_ptr, &statbuf);
848 WARNING ("configfile: stat (%s) failed: %s",
850 sstrerror (errno, errbuf, sizeof (errbuf)));
854 if (S_ISREG (statbuf.st_mode))
855 temp = cf_read_file (path_ptr, pattern, depth);
856 else if (S_ISDIR (statbuf.st_mode))
857 temp = cf_read_dir (path_ptr, pattern, depth);
860 WARNING ("configfile: %s is neither a file nor a "
870 cf_ci_append_children (root, temp);
871 sfree (temp->children);
878 } /* oconfig_item_t *cf_read_generic */
879 /* #endif HAVE_WORDEXP_H */
881 #else /* if !HAVE_WORDEXP_H */
882 static oconfig_item_t *cf_read_generic (const char *path,
883 const char *pattern, int depth)
888 if (depth >= CF_MAX_DEPTH)
890 ERROR ("configfile: Not including `%s' because the maximum "
891 "nesting depth has been reached.", path);
895 status = stat (path, &statbuf);
899 ERROR ("configfile: stat (%s) failed: %s",
901 sstrerror (errno, errbuf, sizeof (errbuf)));
905 if (S_ISREG (statbuf.st_mode))
906 return (cf_read_file (path, pattern, depth));
907 else if (S_ISDIR (statbuf.st_mode))
908 return (cf_read_dir (path, pattern, depth));
910 ERROR ("configfile: %s is neither a file nor a directory.", path);
912 } /* oconfig_item_t *cf_read_generic */
913 #endif /* !HAVE_WORDEXP_H */
918 int global_option_set (const char *option, const char *value)
922 DEBUG ("option = %s; value = %s;", option, value);
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 if (strcasecmp (option, "PIDFile") == 0 && pidfile_from_cli == 1)
933 DEBUG ("Configfile: Ignoring `PIDFILE' option because "
934 "command-line option `-P' take precedence.");
938 sfree (cf_global_options[i].value);
941 cf_global_options[i].value = strdup (value);
943 cf_global_options[i].value = NULL;
948 const char *global_option_get (const char *option)
952 for (i = 0; i < cf_global_options_num; i++)
953 if (strcasecmp (cf_global_options[i].key, option) == 0)
956 if (i >= cf_global_options_num)
959 return ((cf_global_options[i].value != NULL)
960 ? cf_global_options[i].value
961 : cf_global_options[i].def);
962 } /* char *global_option_get */
964 long global_option_get_long (const char *option, long default_value)
969 str = global_option_get (option);
971 return (default_value);
974 value = strtol (str, /* endptr = */ NULL, /* base = */ 0);
976 return (default_value);
979 } /* char *global_option_get_long */
981 cdtime_t global_option_get_time (const char *name, cdtime_t def) /* {{{ */
987 optstr = global_option_get (name);
992 v = strtod (optstr, &endptr);
993 if ((endptr == NULL) || (*endptr != 0) || (errno != 0))
998 return (DOUBLE_TO_CDTIME_T (v));
999 } /* }}} cdtime_t global_option_get_time */
1001 cdtime_t cf_get_default_interval (void)
1003 return (global_option_get_time ("Interval",
1004 DOUBLE_TO_CDTIME_T (COLLECTD_DEFAULT_INTERVAL)));
1007 void cf_unregister (const char *type)
1009 cf_callback_t *this, *prev;
1011 for (prev = NULL, this = first_callback;
1013 prev = this, this = this->next)
1014 if (strcasecmp (this->type, type) == 0)
1017 first_callback = this->next;
1019 prev->next = this->next;
1024 } /* void cf_unregister */
1026 void cf_unregister_complex (const char *type)
1028 cf_complex_callback_t *this, *prev;
1030 for (prev = NULL, this = complex_callback_head;
1032 prev = this, this = this->next)
1033 if (strcasecmp (this->type, type) == 0)
1036 complex_callback_head = this->next;
1038 prev->next = this->next;
1044 } /* void cf_unregister */
1046 void cf_register (const char *type,
1047 int (*callback) (const char *, const char *),
1048 const char **keys, int keys_num)
1050 cf_callback_t *cf_cb;
1052 /* Remove this module from the list, if it already exists */
1053 cf_unregister (type);
1055 /* This pointer will be free'd in `cf_unregister' */
1056 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
1060 cf_cb->callback = callback;
1062 cf_cb->keys_num = keys_num;
1063 cf_cb->ctx = plugin_get_ctx ();
1065 cf_cb->next = first_callback;
1066 first_callback = cf_cb;
1067 } /* void cf_register */
1069 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1071 cf_complex_callback_t *new;
1073 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
1077 new->type = strdup (type);
1078 if (new->type == NULL)
1084 new->callback = callback;
1087 new->ctx = plugin_get_ctx ();
1089 if (complex_callback_head == NULL)
1091 complex_callback_head = new;
1095 cf_complex_callback_t *last = complex_callback_head;
1096 while (last->next != NULL)
1102 } /* int cf_register_complex */
1104 int cf_read (char *filename)
1106 oconfig_item_t *conf;
1109 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1112 ERROR ("Unable to read config file %s.", filename);
1115 else if (conf->children_num == 0)
1117 ERROR ("Configuration file %s is empty.", filename);
1118 oconfig_free (conf);
1122 for (i = 0; i < conf->children_num; i++)
1124 if (conf->children[i].children == NULL)
1125 dispatch_value (conf->children + i);
1127 dispatch_block (conf->children + i);
1130 oconfig_free (conf);
1132 /* Read the default types.db if no `TypesDB' option was given. */
1133 if (cf_default_typesdb)
1134 read_types_list (PKGDATADIR"/types.db");
1139 /* Assures the config option is a string, duplicates it and returns the copy in
1140 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1142 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1146 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1148 ERROR ("cf_util_get_string: The %s option requires "
1149 "exactly one string argument.", ci->key);
1153 string = strdup (ci->values[0].value.string);
1157 if (*ret_string != NULL)
1158 sfree (*ret_string);
1159 *ret_string = string;
1162 } /* }}} int cf_util_get_string */
1164 /* Assures the config option is a string and copies it to the provided buffer.
1165 * Assures null-termination. */
1166 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1169 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1172 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1174 ERROR ("cf_util_get_string_buffer: The %s option requires "
1175 "exactly one string argument.", ci->key);
1179 strncpy (buffer, ci->values[0].value.string, buffer_size);
1180 buffer[buffer_size - 1] = 0;
1183 } /* }}} int cf_util_get_string_buffer */
1185 /* Assures the config option is a number and returns it as an int. */
1186 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1188 if ((ci == NULL) || (ret_value == NULL))
1191 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1193 ERROR ("cf_util_get_int: The %s option requires "
1194 "exactly one numeric argument.", ci->key);
1198 *ret_value = (int) ci->values[0].value.number;
1201 } /* }}} int cf_util_get_int */
1203 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1205 if ((ci == NULL) || (ret_value == NULL))
1208 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1210 ERROR ("cf_util_get_double: The %s option requires "
1211 "exactly one numeric argument.", ci->key);
1215 *ret_value = ci->values[0].value.number;
1218 } /* }}} int cf_util_get_double */
1220 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1222 if ((ci == NULL) || (ret_bool == NULL))
1225 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1227 ERROR ("cf_util_get_boolean: The %s option requires "
1228 "exactly one boolean argument.", ci->key);
1232 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1235 } /* }}} int cf_util_get_boolean */
1237 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1238 unsigned int *ret_value, unsigned int flag)
1243 if (ret_value == NULL)
1247 status = cf_util_get_boolean (ci, &b);
1257 *ret_value &= ~flag;
1261 } /* }}} int cf_util_get_flag */
1263 /* Assures that the config option is a string or a number if the correct range
1264 * of 1-65535. The string is then converted to a port number using
1265 * `service_name_to_port_number' and returned.
1266 * Returns the port number in the range [1-65535] or less than zero upon
1268 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1272 if ((ci->values_num != 1)
1273 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1274 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1276 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1277 "exactly one string argument.", ci->key);
1281 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1282 return (service_name_to_port_number (ci->values[0].value.string));
1284 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1285 tmp = (int) (ci->values[0].value.number + 0.5);
1286 if ((tmp < 1) || (tmp > 65535))
1288 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1289 "a service name or a port number. The number "
1290 "you specified, %i, is not in the valid "
1291 "range of 1-65535.",
1297 } /* }}} int cf_util_get_port_number */
1299 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1305 if (ci->values_num != 1)
1307 ERROR ("cf_util_get_service: The %s option requires exactly "
1308 "one argument.", ci->key);
1312 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1313 return (cf_util_get_string (ci, ret_string));
1314 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1316 ERROR ("cf_util_get_service: The %s option requires "
1317 "exactly one string or numeric argument.",
1322 status = cf_util_get_int (ci, &port);
1325 else if ((port < 1) || (port > 65535))
1327 ERROR ("cf_util_get_service: The port number given "
1328 "for the %s option is out of "
1329 "range (%i).", ci->key, port);
1333 service = malloc (6);
1334 if (service == NULL)
1336 ERROR ("cf_util_get_service: Out of memory.");
1339 ssnprintf (service, 6, "%i", port);
1341 sfree (*ret_string);
1342 *ret_string = service;
1345 } /* }}} int cf_util_get_service */
1347 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1349 if ((ci == NULL) || (ret_value == NULL))
1352 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1354 ERROR ("cf_util_get_cdtime: The %s option requires "
1355 "exactly one numeric argument.", ci->key);
1359 if (ci->values[0].value.number < 0.0)
1361 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1362 "option must not be negative.", ci->key);
1366 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1369 } /* }}} int cf_util_get_cdtime */