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 cf_util_get_cdtime (child, &ctx.interval);
301 else if (strcasecmp ("FlushInterval", child->key) == 0)
302 cf_util_get_cdtime (child, &ctx.flush_interval);
303 else if (strcasecmp ("FlushTimeout", child->key) == 0)
304 cf_util_get_cdtime (child, &ctx.flush_timeout);
306 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
308 child->key, ci->values[0].value.string);
312 old_ctx = plugin_set_ctx (ctx);
313 ret_val = plugin_load (name, (uint32_t) flags);
314 /* reset to the "global" context */
315 plugin_set_ctx (old_ctx);
318 } /* int dispatch_value_loadplugin */
320 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
328 buffer_free = sizeof (buffer);
330 for (i = 0; i < ci->values_num; i++)
334 if (ci->values[i].type == OCONFIG_TYPE_STRING)
335 status = ssnprintf (buffer_ptr, buffer_free, " %s",
336 ci->values[i].value.string);
337 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
338 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
339 ci->values[i].value.number);
340 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
341 status = ssnprintf (buffer_ptr, buffer_free, " %s",
342 ci->values[i].value.boolean
345 if ((status < 0) || (status >= buffer_free))
347 buffer_free -= status;
348 buffer_ptr += status;
350 /* skip the initial space */
351 buffer_ptr = buffer + 1;
353 return (cf_dispatch (plugin, ci->key, buffer_ptr));
354 } /* int dispatch_value_plugin */
356 static int dispatch_value (const oconfig_item_t *ci)
361 for (i = 0; i < cf_value_map_num; i++)
362 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
364 ret = cf_value_map[i].func (ci);
368 for (i = 0; i < cf_global_options_num; i++)
369 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
371 ret = dispatch_global_option (ci);
376 } /* int dispatch_value */
378 static int dispatch_block_plugin (oconfig_item_t *ci)
383 cf_complex_callback_t *cb;
385 if (strcasecmp (ci->key, "Plugin") != 0)
387 if (ci->values_num < 1)
389 if (ci->values[0].type != OCONFIG_TYPE_STRING)
392 name = ci->values[0].value.string;
393 if (strcmp ("libvirt", name) == 0)
395 /* TODO(octo): Remove this legacy. */
396 WARNING ("The \"libvirt\" plugin has been renamed to \"virt\" to avoid problems with the build system. "
397 "Your configuration is still using the old name. "
398 "Please change it to use \"virt\" as soon as possible. "
399 "This compatibility code will go away eventually.");
403 if (IS_TRUE (global_option_get ("AutoLoadPlugin")))
407 status = plugin_load (name, /* flags = */ 0);
410 ERROR ("Automatically loading plugin \"%s\" failed "
411 "with status %i.", name, status);
416 /* Check for a complex callback first */
417 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
419 if (strcasecmp (name, cb->type) == 0)
421 plugin_ctx_t old_ctx;
424 old_ctx = plugin_set_ctx (cb->ctx);
425 ret_val = (cb->callback (ci));
426 plugin_set_ctx (old_ctx);
431 /* Hm, no complex plugin found. Dispatch the values one by one */
432 for (i = 0; i < ci->children_num; i++)
434 if (ci->children[i].children == NULL)
435 dispatch_value_plugin (name, ci->children + i);
438 WARNING ("There is a `%s' block within the "
439 "configuration for the %s plugin. "
440 "The plugin either only expects "
441 "\"simple\" configuration statements "
442 "or wasn't loaded using `LoadPlugin'."
443 " Please check your configuration.",
444 ci->children[i].key, name);
452 static int dispatch_block (oconfig_item_t *ci)
454 if (strcasecmp (ci->key, "LoadPlugin") == 0)
455 return (dispatch_loadplugin (ci));
456 else if (strcasecmp (ci->key, "Plugin") == 0)
457 return (dispatch_block_plugin (ci));
458 else if (strcasecmp (ci->key, "Chain") == 0)
459 return (fc_configure (ci));
464 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
467 oconfig_item_t *temp;
470 assert (offset >= 0);
471 assert (dst->children_num > offset);
473 /* Free the memory used by the replaced child. Usually that's the
474 * `Include "blah"' statement. */
475 temp = dst->children + offset;
476 for (i = 0; i < temp->values_num; i++)
478 if (temp->values[i].type == OCONFIG_TYPE_STRING)
480 sfree (temp->values[i].value.string);
483 sfree (temp->values);
486 /* If (src->children_num == 0) the array size is decreased. If offset
487 * is _not_ the last element, (offset < (dst->children_num - 1)), then
488 * we need to move the trailing elements before resizing the array. */
489 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
491 int nmemb = dst->children_num - (offset + 1);
492 memmove (dst->children + offset, dst->children + offset + 1,
493 sizeof (oconfig_item_t) * nmemb);
496 /* Resize the memory containing the children to be big enough to hold
498 if (dst->children_num + src->children_num - 1 == 0)
500 dst->children_num = 0;
504 temp = (oconfig_item_t *) realloc (dst->children,
505 sizeof (oconfig_item_t)
506 * (dst->children_num + src->children_num - 1));
509 ERROR ("configfile: realloc failed.");
512 dst->children = temp;
514 /* If there are children behind the include statement, and they have
515 * not yet been moved because (src->children_num == 0), then move them
516 * to the end of the list, so that the new children have room before
518 if ((src->children_num > 0)
519 && ((dst->children_num - (offset + 1)) > 0))
521 int nmemb = dst->children_num - (offset + 1);
522 int old_offset = offset + 1;
523 int new_offset = offset + src->children_num;
525 memmove (dst->children + new_offset,
526 dst->children + old_offset,
527 sizeof (oconfig_item_t) * nmemb);
530 /* Last but not least: If there are new children, copy them to the
531 * memory reserved for them. */
532 if (src->children_num > 0)
534 memcpy (dst->children + offset,
536 sizeof (oconfig_item_t) * src->children_num);
539 /* Update the number of children. */
540 dst->children_num += (src->children_num - 1);
543 } /* int cf_ci_replace_child */
545 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
547 oconfig_item_t *temp;
549 if ((src == NULL) || (src->children_num == 0))
552 temp = (oconfig_item_t *) realloc (dst->children,
553 sizeof (oconfig_item_t)
554 * (dst->children_num + src->children_num));
557 ERROR ("configfile: realloc failed.");
560 dst->children = temp;
562 memcpy (dst->children + dst->children_num,
564 sizeof (oconfig_item_t)
565 * src->children_num);
566 dst->children_num += src->children_num;
569 } /* int cf_ci_append_children */
571 #define CF_MAX_DEPTH 8
572 static oconfig_item_t *cf_read_generic (const char *path,
573 const char *pattern, int depth);
575 static int cf_include_all (oconfig_item_t *root, int depth)
579 for (i = 0; i < root->children_num; i++)
584 char *pattern = NULL;
588 if (strcasecmp (root->children[i].key, "Include") != 0)
591 old = root->children + i;
593 if ((old->values_num != 1)
594 || (old->values[0].type != OCONFIG_TYPE_STRING))
596 ERROR ("configfile: `Include' needs exactly one string argument.");
600 for (j = 0; j < old->children_num; ++j)
602 oconfig_item_t *child = old->children + j;
604 if (strcasecmp (child->key, "Filter") == 0)
605 cf_util_get_string (child, &pattern);
607 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
611 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
617 /* Now replace the i'th child in `root' with `new'. */
618 if (cf_ci_replace_child (root, new, i) < 0)
621 /* ... and go back to the new i'th child. */
626 } /* for (i = 0; i < root->children_num; i++) */
629 } /* int cf_include_all */
631 static oconfig_item_t *cf_read_file (const char *file,
632 const char *pattern, int depth)
634 oconfig_item_t *root;
637 assert (depth < CF_MAX_DEPTH);
639 if (pattern != NULL) {
640 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
641 char *tmp = sstrdup (file);
642 char *filename = basename (tmp);
644 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
645 DEBUG ("configfile: Not including `%s' because it "
646 "does not match pattern `%s'.",
654 ERROR ("configfile: Cannot apply pattern filter '%s' "
655 "to file '%s': functions basename() and / or "
656 "fnmatch() not available.", pattern, file);
657 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
660 root = oconfig_parse_file (file);
663 ERROR ("configfile: Cannot read file `%s'.", file);
667 status = cf_include_all (root, depth);
675 } /* oconfig_item_t *cf_read_file */
677 static int cf_compare_string (const void *p1, const void *p2)
679 return strcmp (*(const char **) p1, *(const char **) p2);
682 static oconfig_item_t *cf_read_dir (const char *dir,
683 const char *pattern, int depth)
685 oconfig_item_t *root = NULL;
688 char **filenames = NULL;
689 int filenames_num = 0;
693 assert (depth < CF_MAX_DEPTH);
699 ERROR ("configfile: opendir failed: %s",
700 sstrerror (errno, errbuf, sizeof (errbuf)));
704 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
707 ERROR ("configfile: malloc failed.");
710 memset (root, 0, sizeof (oconfig_item_t));
712 while ((de = readdir (dh)) != NULL)
717 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
720 status = ssnprintf (name, sizeof (name), "%s/%s",
722 if ((status < 0) || ((size_t) status >= sizeof (name)))
724 ERROR ("configfile: Not including `%s/%s' because its"
725 " name is too long.",
727 for (i = 0; i < filenames_num; ++i)
735 tmp = (char **) realloc (filenames,
736 filenames_num * sizeof (*filenames));
738 ERROR ("configfile: realloc failed.");
739 for (i = 0; i < filenames_num - 1; ++i)
747 filenames[filenames_num - 1] = sstrdup (name);
750 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
753 for (i = 0; i < filenames_num; ++i)
755 oconfig_item_t *temp;
756 char *name = filenames[i];
758 temp = cf_read_generic (name, pattern, depth);
761 /* An error should already have been reported. */
766 cf_ci_append_children (root, temp);
767 sfree (temp->children);
775 } /* oconfig_item_t *cf_read_dir */
780 * Path is stat'ed and either cf_read_file or cf_read_dir is called
783 * There are two versions of this function: If `wordexp' exists shell wildcards
784 * will be expanded and the function will include all matches found. If
785 * `wordexp' (or, more precisely, it's header file) is not available the
786 * simpler function is used which does not do any such expansion.
789 static oconfig_item_t *cf_read_generic (const char *path,
790 const char *pattern, int depth)
792 oconfig_item_t *root = NULL;
794 const char *path_ptr;
798 if (depth >= CF_MAX_DEPTH)
800 ERROR ("configfile: Not including `%s' because the maximum "
801 "nesting depth has been reached.", path);
805 status = wordexp (path, &we, WRDE_NOCMD);
808 ERROR ("configfile: wordexp (%s) failed.", path);
812 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
815 ERROR ("configfile: malloc failed.");
818 memset (root, '\0', sizeof (oconfig_item_t));
820 /* wordexp() might return a sorted list already. That's not
821 * documented though, so let's make sure we get what we want. */
822 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
825 for (i = 0; i < we.we_wordc; i++)
827 oconfig_item_t *temp;
830 path_ptr = we.we_wordv[i];
832 status = stat (path_ptr, &statbuf);
836 WARNING ("configfile: stat (%s) failed: %s",
838 sstrerror (errno, errbuf, sizeof (errbuf)));
842 if (S_ISREG (statbuf.st_mode))
843 temp = cf_read_file (path_ptr, pattern, depth);
844 else if (S_ISDIR (statbuf.st_mode))
845 temp = cf_read_dir (path_ptr, pattern, depth);
848 WARNING ("configfile: %s is neither a file nor a "
858 cf_ci_append_children (root, temp);
859 sfree (temp->children);
866 } /* oconfig_item_t *cf_read_generic */
867 /* #endif HAVE_WORDEXP_H */
869 #else /* if !HAVE_WORDEXP_H */
870 static oconfig_item_t *cf_read_generic (const char *path,
871 const char *pattern, int depth)
876 if (depth >= CF_MAX_DEPTH)
878 ERROR ("configfile: Not including `%s' because the maximum "
879 "nesting depth has been reached.", path);
883 status = stat (path, &statbuf);
887 ERROR ("configfile: stat (%s) failed: %s",
889 sstrerror (errno, errbuf, sizeof (errbuf)));
893 if (S_ISREG (statbuf.st_mode))
894 return (cf_read_file (path, pattern, depth));
895 else if (S_ISDIR (statbuf.st_mode))
896 return (cf_read_dir (path, pattern, depth));
898 ERROR ("configfile: %s is neither a file nor a directory.", path);
900 } /* oconfig_item_t *cf_read_generic */
901 #endif /* !HAVE_WORDEXP_H */
906 int global_option_set (const char *option, const char *value)
910 DEBUG ("option = %s; value = %s;", option, value);
912 for (i = 0; i < cf_global_options_num; i++)
913 if (strcasecmp (cf_global_options[i].key, option) == 0)
916 if (i >= cf_global_options_num)
919 if (strcasecmp (option, "PIDFile") == 0 && pidfile_from_cli == 1)
921 DEBUG ("Configfile: Ignoring `PIDFILE' option because "
922 "command-line option `-P' take precedence.");
926 sfree (cf_global_options[i].value);
929 cf_global_options[i].value = strdup (value);
931 cf_global_options[i].value = NULL;
936 const char *global_option_get (const char *option)
940 for (i = 0; i < cf_global_options_num; i++)
941 if (strcasecmp (cf_global_options[i].key, option) == 0)
944 if (i >= cf_global_options_num)
947 return ((cf_global_options[i].value != NULL)
948 ? cf_global_options[i].value
949 : cf_global_options[i].def);
950 } /* char *global_option_get */
952 long global_option_get_long (const char *option, long default_value)
957 str = global_option_get (option);
959 return (default_value);
962 value = strtol (str, /* endptr = */ NULL, /* base = */ 0);
964 return (default_value);
967 } /* char *global_option_get_long */
969 cdtime_t global_option_get_time (const char *name, cdtime_t def) /* {{{ */
975 optstr = global_option_get (name);
980 v = strtod (optstr, &endptr);
981 if ((endptr == NULL) || (*endptr != 0) || (errno != 0))
986 return (DOUBLE_TO_CDTIME_T (v));
987 } /* }}} cdtime_t global_option_get_time */
989 cdtime_t cf_get_default_interval (void)
991 return (global_option_get_time ("Interval",
992 DOUBLE_TO_CDTIME_T (COLLECTD_DEFAULT_INTERVAL)));
995 void cf_unregister (const char *type)
997 cf_callback_t *this, *prev;
999 for (prev = NULL, this = first_callback;
1001 prev = this, this = this->next)
1002 if (strcasecmp (this->type, type) == 0)
1005 first_callback = this->next;
1007 prev->next = this->next;
1012 } /* void cf_unregister */
1014 void cf_unregister_complex (const char *type)
1016 cf_complex_callback_t *this, *prev;
1018 for (prev = NULL, this = complex_callback_head;
1020 prev = this, this = this->next)
1021 if (strcasecmp (this->type, type) == 0)
1024 complex_callback_head = this->next;
1026 prev->next = this->next;
1032 } /* void cf_unregister */
1034 void cf_register (const char *type,
1035 int (*callback) (const char *, const char *),
1036 const char **keys, int keys_num)
1038 cf_callback_t *cf_cb;
1040 /* Remove this module from the list, if it already exists */
1041 cf_unregister (type);
1043 /* This pointer will be free'd in `cf_unregister' */
1044 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
1048 cf_cb->callback = callback;
1050 cf_cb->keys_num = keys_num;
1051 cf_cb->ctx = plugin_get_ctx ();
1053 cf_cb->next = first_callback;
1054 first_callback = cf_cb;
1055 } /* void cf_register */
1057 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1059 cf_complex_callback_t *new;
1061 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
1065 new->type = strdup (type);
1066 if (new->type == NULL)
1072 new->callback = callback;
1075 new->ctx = plugin_get_ctx ();
1077 if (complex_callback_head == NULL)
1079 complex_callback_head = new;
1083 cf_complex_callback_t *last = complex_callback_head;
1084 while (last->next != NULL)
1090 } /* int cf_register_complex */
1092 int cf_read (char *filename)
1094 oconfig_item_t *conf;
1097 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1100 ERROR ("Unable to read config file %s.", filename);
1103 else if (conf->children_num == 0)
1105 ERROR ("Configuration file %s is empty.", filename);
1106 oconfig_free (conf);
1110 for (i = 0; i < conf->children_num; i++)
1112 if (conf->children[i].children == NULL)
1113 dispatch_value (conf->children + i);
1115 dispatch_block (conf->children + i);
1118 oconfig_free (conf);
1120 /* Read the default types.db if no `TypesDB' option was given. */
1121 if (cf_default_typesdb)
1122 read_types_list (PKGDATADIR"/types.db");
1127 /* Assures the config option is a string, duplicates it and returns the copy in
1128 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1130 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1134 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1136 ERROR ("cf_util_get_string: The %s option requires "
1137 "exactly one string argument.", ci->key);
1141 string = strdup (ci->values[0].value.string);
1145 if (*ret_string != NULL)
1146 sfree (*ret_string);
1147 *ret_string = string;
1150 } /* }}} int cf_util_get_string */
1152 /* Assures the config option is a string and copies it to the provided buffer.
1153 * Assures null-termination. */
1154 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1157 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1160 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1162 ERROR ("cf_util_get_string_buffer: The %s option requires "
1163 "exactly one string argument.", ci->key);
1167 strncpy (buffer, ci->values[0].value.string, buffer_size);
1168 buffer[buffer_size - 1] = 0;
1171 } /* }}} int cf_util_get_string_buffer */
1173 /* Assures the config option is a number and returns it as an int. */
1174 int cf_util_get_int (const oconfig_item_t *ci, int *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_int: The %s option requires "
1182 "exactly one numeric argument.", ci->key);
1186 *ret_value = (int) ci->values[0].value.number;
1189 } /* }}} int cf_util_get_int */
1191 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1193 if ((ci == NULL) || (ret_value == NULL))
1196 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1198 ERROR ("cf_util_get_double: The %s option requires "
1199 "exactly one numeric argument.", ci->key);
1203 *ret_value = ci->values[0].value.number;
1206 } /* }}} int cf_util_get_double */
1208 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1210 if ((ci == NULL) || (ret_bool == NULL))
1213 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1215 ERROR ("cf_util_get_boolean: The %s option requires "
1216 "exactly one boolean argument.", ci->key);
1220 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1223 } /* }}} int cf_util_get_boolean */
1225 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1226 unsigned int *ret_value, unsigned int flag)
1231 if (ret_value == NULL)
1235 status = cf_util_get_boolean (ci, &b);
1245 *ret_value &= ~flag;
1249 } /* }}} int cf_util_get_flag */
1251 /* Assures that the config option is a string or a number if the correct range
1252 * of 1-65535. The string is then converted to a port number using
1253 * `service_name_to_port_number' and returned.
1254 * Returns the port number in the range [1-65535] or less than zero upon
1256 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1260 if ((ci->values_num != 1)
1261 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1262 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1264 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1265 "exactly one string argument.", ci->key);
1269 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1270 return (service_name_to_port_number (ci->values[0].value.string));
1272 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1273 tmp = (int) (ci->values[0].value.number + 0.5);
1274 if ((tmp < 1) || (tmp > 65535))
1276 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1277 "a service name or a port number. The number "
1278 "you specified, %i, is not in the valid "
1279 "range of 1-65535.",
1285 } /* }}} int cf_util_get_port_number */
1287 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1293 if (ci->values_num != 1)
1295 ERROR ("cf_util_get_service: The %s option requires exactly "
1296 "one argument.", ci->key);
1300 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1301 return (cf_util_get_string (ci, ret_string));
1302 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1304 ERROR ("cf_util_get_service: The %s option requires "
1305 "exactly one string or numeric argument.",
1310 status = cf_util_get_int (ci, &port);
1313 else if ((port < 1) || (port > 65535))
1315 ERROR ("cf_util_get_service: The port number given "
1316 "for the %s option is out of "
1317 "range (%i).", ci->key, port);
1321 service = malloc (6);
1322 if (service == NULL)
1324 ERROR ("cf_util_get_service: Out of memory.");
1327 ssnprintf (service, 6, "%i", port);
1329 sfree (*ret_string);
1330 *ret_string = service;
1333 } /* }}} int cf_util_get_service */
1335 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1337 if ((ci == NULL) || (ret_value == NULL))
1340 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1342 ERROR ("cf_util_get_cdtime: The %s option requires "
1343 "exactly one numeric argument.", ci->key);
1347 if (ci->values[0].value.number < 0.0)
1349 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1350 "option must not be negative.", ci->key);
1354 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1357 } /* }}} int cf_util_get_cdtime */