2 * collectd - src/configfile.c
3 * Copyright (C) 2005-2011 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian octo Forster <octo at collectd.org>
21 * Sebastian tokkee Harl <sh at tokkee.org>
26 #include "liboconfig/oconfig.h"
30 #include "configfile.h"
31 #include "types_list.h"
32 #include "filter_chain.h"
36 #endif /* HAVE_WORDEXP_H */
40 #endif /* HAVE_FNMATCH_H */
44 #endif /* HAVE_LIBGEN_H */
46 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
51 typedef struct cf_callback
54 int (*callback) (const char *, const char *);
58 struct cf_callback *next;
61 typedef struct cf_complex_callback_s
64 int (*callback) (oconfig_item_t *);
66 struct cf_complex_callback_s *next;
67 } cf_complex_callback_t;
69 typedef struct cf_value_map_s
72 int (*func) (oconfig_item_t *);
75 typedef struct cf_global_option_s
83 * Prototypes of callback functions
85 static int dispatch_value_typesdb (oconfig_item_t *ci);
86 static int dispatch_value_plugindir (oconfig_item_t *ci);
87 static int dispatch_loadplugin (oconfig_item_t *ci);
88 static int dispatch_block_plugin (oconfig_item_t *ci);
93 static cf_callback_t *first_callback = NULL;
94 static cf_complex_callback_t *complex_callback_head = NULL;
96 static cf_value_map_t cf_value_map[] =
98 {"TypesDB", dispatch_value_typesdb},
99 {"PluginDir", dispatch_value_plugindir},
100 {"LoadPlugin", dispatch_loadplugin},
101 {"Plugin", dispatch_block_plugin}
103 static int cf_value_map_num = STATIC_ARRAY_SIZE (cf_value_map);
105 static cf_global_option_t cf_global_options[] =
107 {"BaseDir", NULL, PKGLOCALSTATEDIR},
108 {"PIDFile", NULL, PIDFILE},
109 {"Hostname", NULL, NULL},
110 {"FQDNLookup", NULL, "true"},
111 {"Interval", NULL, NULL},
112 {"ReadThreads", NULL, "5"},
113 {"WriteThreads", NULL, "5"},
114 {"WriteQueueLimitHigh", NULL, NULL},
115 {"WriteQueueLimitLow", NULL, NULL},
116 {"Timeout", NULL, "2"},
117 {"AutoLoadPlugin", NULL, "false"},
118 {"PreCacheChain", NULL, "PreCache"},
119 {"PostCacheChain", NULL, "PostCache"}
121 static int cf_global_options_num = STATIC_ARRAY_SIZE (cf_global_options);
123 static int cf_default_typesdb = 1;
126 * Functions to handle register/unregister, search, and other plugin related
129 static cf_callback_t *cf_search (const char *type)
131 cf_callback_t *cf_cb;
136 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
137 if (strcasecmp (cf_cb->type, type) == 0)
143 static int cf_dispatch (const char *type, const char *orig_key,
144 const char *orig_value)
146 cf_callback_t *cf_cb;
147 plugin_ctx_t old_ctx;
153 DEBUG ("type = %s, key = %s, value = %s",
155 ESCAPE_NULL(orig_key),
156 ESCAPE_NULL(orig_value));
158 if ((cf_cb = cf_search (type)) == NULL)
160 WARNING ("Found a configuration for the `%s' plugin, but "
161 "the plugin isn't loaded or didn't register "
162 "a configuration callback.", type);
166 if ((key = strdup (orig_key)) == NULL)
168 if ((value = strdup (orig_value)) == NULL)
176 old_ctx = plugin_set_ctx (cf_cb->ctx);
178 for (i = 0; i < cf_cb->keys_num; i++)
180 if ((cf_cb->keys[i] != NULL)
181 && (strcasecmp (cf_cb->keys[i], key) == 0))
183 ret = (*cf_cb->callback) (key, value);
188 plugin_set_ctx (old_ctx);
190 if (i >= cf_cb->keys_num)
191 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
196 DEBUG ("cf_dispatch: return (%i)", ret);
199 } /* int cf_dispatch */
201 static int dispatch_global_option (const oconfig_item_t *ci)
203 if (ci->values_num != 1)
205 if (ci->values[0].type == OCONFIG_TYPE_STRING)
206 return (global_option_set (ci->key, ci->values[0].value.string));
207 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
210 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
211 return (global_option_set (ci->key, tmp));
213 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
215 if (ci->values[0].value.boolean)
216 return (global_option_set (ci->key, "true"));
218 return (global_option_set (ci->key, "false"));
222 } /* int dispatch_global_option */
224 static int dispatch_value_typesdb (oconfig_item_t *ci)
228 assert (strcasecmp (ci->key, "TypesDB") == 0);
230 cf_default_typesdb = 0;
232 if (ci->values_num < 1) {
233 ERROR ("configfile: `TypesDB' needs at least one argument.");
237 for (i = 0; i < ci->values_num; ++i)
239 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
240 WARNING ("configfile: TypesDB: Skipping %i. argument which "
241 "is not a string.", i + 1);
245 read_types_list (ci->values[i].value.string);
248 } /* int dispatch_value_typesdb */
250 static int dispatch_value_plugindir (oconfig_item_t *ci)
252 assert (strcasecmp (ci->key, "PluginDir") == 0);
254 if (ci->values_num != 1)
256 if (ci->values[0].type != OCONFIG_TYPE_STRING)
259 plugin_set_dir (ci->values[0].value.string);
263 static int dispatch_loadplugin (oconfig_item_t *ci)
267 unsigned int flags = 0;
269 plugin_ctx_t old_ctx;
272 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
274 if (ci->values_num != 1)
276 if (ci->values[0].type != OCONFIG_TYPE_STRING)
279 name = ci->values[0].value.string;
281 /* default to the global interval set before loading this plugin */
282 memset (&ctx, 0, sizeof (ctx));
283 ctx.interval = cf_get_default_interval ();
285 for (i = 0; i < ci->children_num; ++i) {
286 if (strcasecmp("Globals", ci->children[i].key) == 0)
287 cf_util_get_flag (ci->children + i, &flags, PLUGIN_FLAGS_GLOBAL);
288 else if (strcasecmp ("Interval", ci->children[i].key) == 0) {
289 double interval = 0.0;
291 if (cf_util_get_double (ci->children + i, &interval) != 0) {
292 /* cf_util_get_double will log an error */
296 ctx.interval = DOUBLE_TO_CDTIME_T (interval);
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 (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")))
390 plugin_ctx_t old_ctx;
393 /* default to the global interval set before loading this plugin */
394 memset (&ctx, 0, sizeof (ctx));
395 ctx.interval = cf_get_default_interval ();
397 old_ctx = plugin_set_ctx (ctx);
398 status = plugin_load (name, /* flags = */ 0);
399 /* reset to the "global" context */
400 plugin_set_ctx (old_ctx);
404 ERROR ("Automatically loading plugin \"%s\" failed "
405 "with status %i.", name, status);
410 /* Check for a complex callback first */
411 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
413 if (strcasecmp (name, cb->type) == 0)
415 plugin_ctx_t old_ctx;
418 old_ctx = plugin_set_ctx (cb->ctx);
419 ret_val = (cb->callback (ci));
420 plugin_set_ctx (old_ctx);
425 /* Hm, no complex plugin found. Dispatch the values one by one */
426 for (i = 0; i < ci->children_num; i++)
428 if (ci->children[i].children == NULL)
429 dispatch_value_plugin (name, ci->children + i);
432 WARNING ("There is a `%s' block within the "
433 "configuration for the %s plugin. "
434 "The plugin either only expects "
435 "\"simple\" configuration statements "
436 "or wasn't loaded using `LoadPlugin'."
437 " Please check your configuration.",
438 ci->children[i].key, name);
446 static int dispatch_block (oconfig_item_t *ci)
448 if (strcasecmp (ci->key, "LoadPlugin") == 0)
449 return (dispatch_loadplugin (ci));
450 else if (strcasecmp (ci->key, "Plugin") == 0)
451 return (dispatch_block_plugin (ci));
452 else if (strcasecmp (ci->key, "Chain") == 0)
453 return (fc_configure (ci));
458 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
461 oconfig_item_t *temp;
464 assert (offset >= 0);
465 assert (dst->children_num > offset);
467 /* Free the memory used by the replaced child. Usually that's the
468 * `Include "blah"' statement. */
469 temp = dst->children + offset;
470 for (i = 0; i < temp->values_num; i++)
472 if (temp->values[i].type == OCONFIG_TYPE_STRING)
474 sfree (temp->values[i].value.string);
477 sfree (temp->values);
480 /* If (src->children_num == 0) the array size is decreased. If offset
481 * is _not_ the last element, (offset < (dst->children_num - 1)), then
482 * we need to move the trailing elements before resizing the array. */
483 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
485 int nmemb = dst->children_num - (offset + 1);
486 memmove (dst->children + offset, dst->children + offset + 1,
487 sizeof (oconfig_item_t) * nmemb);
490 /* Resize the memory containing the children to be big enough to hold
492 if (dst->children_num + src->children_num - 1 == 0)
494 dst->children_num = 0;
498 temp = (oconfig_item_t *) realloc (dst->children,
499 sizeof (oconfig_item_t)
500 * (dst->children_num + src->children_num - 1));
503 ERROR ("configfile: realloc failed.");
506 dst->children = temp;
508 /* If there are children behind the include statement, and they have
509 * not yet been moved because (src->children_num == 0), then move them
510 * to the end of the list, so that the new children have room before
512 if ((src->children_num > 0)
513 && ((dst->children_num - (offset + 1)) > 0))
515 int nmemb = dst->children_num - (offset + 1);
516 int old_offset = offset + 1;
517 int new_offset = offset + src->children_num;
519 memmove (dst->children + new_offset,
520 dst->children + old_offset,
521 sizeof (oconfig_item_t) * nmemb);
524 /* Last but not least: If there are new children, copy them to the
525 * memory reserved for them. */
526 if (src->children_num > 0)
528 memcpy (dst->children + offset,
530 sizeof (oconfig_item_t) * src->children_num);
533 /* Update the number of children. */
534 dst->children_num += (src->children_num - 1);
537 } /* int cf_ci_replace_child */
539 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
541 oconfig_item_t *temp;
543 if ((src == NULL) || (src->children_num == 0))
546 temp = (oconfig_item_t *) realloc (dst->children,
547 sizeof (oconfig_item_t)
548 * (dst->children_num + src->children_num));
551 ERROR ("configfile: realloc failed.");
554 dst->children = temp;
556 memcpy (dst->children + dst->children_num,
558 sizeof (oconfig_item_t)
559 * src->children_num);
560 dst->children_num += src->children_num;
563 } /* int cf_ci_append_children */
565 #define CF_MAX_DEPTH 8
566 static oconfig_item_t *cf_read_generic (const char *path,
567 const char *pattern, int depth);
569 static int cf_include_all (oconfig_item_t *root, int depth)
573 for (i = 0; i < root->children_num; i++)
578 char *pattern = NULL;
582 if (strcasecmp (root->children[i].key, "Include") != 0)
585 old = root->children + i;
587 if ((old->values_num != 1)
588 || (old->values[0].type != OCONFIG_TYPE_STRING))
590 ERROR ("configfile: `Include' needs exactly one string argument.");
594 for (j = 0; j < old->children_num; ++j)
596 oconfig_item_t *child = old->children + j;
598 if (strcasecmp (child->key, "Filter") == 0)
599 cf_util_get_string (child, &pattern);
601 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
605 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
611 /* Now replace the i'th child in `root' with `new'. */
612 if (cf_ci_replace_child (root, new, i) < 0)
615 /* ... and go back to the new i'th child. */
620 } /* for (i = 0; i < root->children_num; i++) */
623 } /* int cf_include_all */
625 static oconfig_item_t *cf_read_file (const char *file,
626 const char *pattern, int depth)
628 oconfig_item_t *root;
631 assert (depth < CF_MAX_DEPTH);
633 if (pattern != NULL) {
634 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
635 char *tmp = sstrdup (file);
636 char *filename = basename (tmp);
638 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
639 DEBUG ("configfile: Not including `%s' because it "
640 "does not match pattern `%s'.",
648 ERROR ("configfile: Cannot apply pattern filter '%s' "
649 "to file '%s': functions basename() and / or "
650 "fnmatch() not available.", pattern, file);
651 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
654 root = oconfig_parse_file (file);
657 ERROR ("configfile: Cannot read file `%s'.", file);
661 status = cf_include_all (root, depth);
669 } /* oconfig_item_t *cf_read_file */
671 static int cf_compare_string (const void *p1, const void *p2)
673 return strcmp (*(const char **) p1, *(const char **) p2);
676 static oconfig_item_t *cf_read_dir (const char *dir,
677 const char *pattern, int depth)
679 oconfig_item_t *root = NULL;
682 char **filenames = NULL;
683 int filenames_num = 0;
687 assert (depth < CF_MAX_DEPTH);
693 ERROR ("configfile: opendir failed: %s",
694 sstrerror (errno, errbuf, sizeof (errbuf)));
698 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
701 ERROR ("configfile: malloc failed.");
704 memset (root, 0, sizeof (oconfig_item_t));
706 while ((de = readdir (dh)) != NULL)
711 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
714 status = ssnprintf (name, sizeof (name), "%s/%s",
716 if ((status < 0) || ((size_t) status >= sizeof (name)))
718 ERROR ("configfile: Not including `%s/%s' because its"
719 " name is too long.",
721 for (i = 0; i < filenames_num; ++i)
729 tmp = (char **) realloc (filenames,
730 filenames_num * sizeof (*filenames));
732 ERROR ("configfile: realloc failed.");
733 for (i = 0; i < filenames_num - 1; ++i)
741 filenames[filenames_num - 1] = sstrdup (name);
744 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
747 for (i = 0; i < filenames_num; ++i)
749 oconfig_item_t *temp;
750 char *name = filenames[i];
752 temp = cf_read_generic (name, pattern, depth);
755 /* An error should already have been reported. */
760 cf_ci_append_children (root, temp);
761 sfree (temp->children);
769 } /* oconfig_item_t *cf_read_dir */
774 * Path is stat'ed and either cf_read_file or cf_read_dir is called
777 * There are two versions of this function: If `wordexp' exists shell wildcards
778 * will be expanded and the function will include all matches found. If
779 * `wordexp' (or, more precisely, it's header file) is not available the
780 * simpler function is used which does not do any such expansion.
783 static oconfig_item_t *cf_read_generic (const char *path,
784 const char *pattern, int depth)
786 oconfig_item_t *root = NULL;
788 const char *path_ptr;
792 if (depth >= CF_MAX_DEPTH)
794 ERROR ("configfile: Not including `%s' because the maximum "
795 "nesting depth has been reached.", path);
799 status = wordexp (path, &we, WRDE_NOCMD);
802 ERROR ("configfile: wordexp (%s) failed.", path);
806 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
809 ERROR ("configfile: malloc failed.");
812 memset (root, '\0', sizeof (oconfig_item_t));
814 /* wordexp() might return a sorted list already. That's not
815 * documented though, so let's make sure we get what we want. */
816 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
819 for (i = 0; i < we.we_wordc; i++)
821 oconfig_item_t *temp;
824 path_ptr = we.we_wordv[i];
826 status = stat (path_ptr, &statbuf);
830 WARNING ("configfile: stat (%s) failed: %s",
832 sstrerror (errno, errbuf, sizeof (errbuf)));
836 if (S_ISREG (statbuf.st_mode))
837 temp = cf_read_file (path_ptr, pattern, depth);
838 else if (S_ISDIR (statbuf.st_mode))
839 temp = cf_read_dir (path_ptr, pattern, depth);
842 WARNING ("configfile: %s is neither a file nor a "
852 cf_ci_append_children (root, temp);
853 sfree (temp->children);
860 } /* oconfig_item_t *cf_read_generic */
861 /* #endif HAVE_WORDEXP_H */
863 #else /* if !HAVE_WORDEXP_H */
864 static oconfig_item_t *cf_read_generic (const char *path,
865 const char *pattern, int depth)
870 if (depth >= CF_MAX_DEPTH)
872 ERROR ("configfile: Not including `%s' because the maximum "
873 "nesting depth has been reached.", path);
877 status = stat (path, &statbuf);
881 ERROR ("configfile: stat (%s) failed: %s",
883 sstrerror (errno, errbuf, sizeof (errbuf)));
887 if (S_ISREG (statbuf.st_mode))
888 return (cf_read_file (path, pattern, depth));
889 else if (S_ISDIR (statbuf.st_mode))
890 return (cf_read_dir (path, pattern, depth));
892 ERROR ("configfile: %s is neither a file nor a directory.", path);
894 } /* oconfig_item_t *cf_read_generic */
895 #endif /* !HAVE_WORDEXP_H */
900 int global_option_set (const char *option, const char *value)
904 DEBUG ("option = %s; value = %s;", option, value);
906 for (i = 0; i < cf_global_options_num; i++)
907 if (strcasecmp (cf_global_options[i].key, option) == 0)
910 if (i >= cf_global_options_num)
913 sfree (cf_global_options[i].value);
916 cf_global_options[i].value = strdup (value);
918 cf_global_options[i].value = NULL;
923 const char *global_option_get (const char *option)
927 for (i = 0; i < cf_global_options_num; i++)
928 if (strcasecmp (cf_global_options[i].key, option) == 0)
931 if (i >= cf_global_options_num)
934 return ((cf_global_options[i].value != NULL)
935 ? cf_global_options[i].value
936 : cf_global_options[i].def);
937 } /* char *global_option_get */
939 long global_option_get_long (const char *option, long default_value)
944 str = global_option_get (option);
946 return (default_value);
949 value = strtol (str, /* endptr = */ NULL, /* base = */ 0);
951 return (default_value);
954 } /* char *global_option_get_long */
956 cdtime_t cf_get_default_interval (void)
958 char const *str = global_option_get ("Interval");
959 double interval_double = COLLECTD_DEFAULT_INTERVAL;
964 double tmp = strtod (str, &endptr);
966 if ((endptr == NULL) || (endptr == str) || (*endptr != 0))
967 ERROR ("cf_get_default_interval: Unable to parse string \"%s\" "
970 ERROR ("cf_get_default_interval: Interval must be a positive number. "
971 "The current number is %g.", tmp);
973 interval_double = tmp;
976 return (DOUBLE_TO_CDTIME_T (interval_double));
977 } /* }}} cdtime_t cf_get_default_interval */
979 void cf_unregister (const char *type)
981 cf_callback_t *this, *prev;
983 for (prev = NULL, this = first_callback;
985 prev = this, this = this->next)
986 if (strcasecmp (this->type, type) == 0)
989 first_callback = this->next;
991 prev->next = this->next;
996 } /* void cf_unregister */
998 void cf_unregister_complex (const char *type)
1000 cf_complex_callback_t *this, *prev;
1002 for (prev = NULL, this = complex_callback_head;
1004 prev = this, this = this->next)
1005 if (strcasecmp (this->type, type) == 0)
1008 complex_callback_head = this->next;
1010 prev->next = this->next;
1016 } /* void cf_unregister */
1018 void cf_register (const char *type,
1019 int (*callback) (const char *, const char *),
1020 const char **keys, int keys_num)
1022 cf_callback_t *cf_cb;
1024 /* Remove this module from the list, if it already exists */
1025 cf_unregister (type);
1027 /* This pointer will be free'd in `cf_unregister' */
1028 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
1032 cf_cb->callback = callback;
1034 cf_cb->keys_num = keys_num;
1035 cf_cb->ctx = plugin_get_ctx ();
1037 cf_cb->next = first_callback;
1038 first_callback = cf_cb;
1039 } /* void cf_register */
1041 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1043 cf_complex_callback_t *new;
1045 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
1049 new->type = strdup (type);
1050 if (new->type == NULL)
1056 new->callback = callback;
1059 new->ctx = plugin_get_ctx ();
1061 if (complex_callback_head == NULL)
1063 complex_callback_head = new;
1067 cf_complex_callback_t *last = complex_callback_head;
1068 while (last->next != NULL)
1074 } /* int cf_register_complex */
1076 int cf_read (char *filename)
1078 oconfig_item_t *conf;
1081 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1084 ERROR ("Unable to read config file %s.", filename);
1087 else if (conf->children_num == 0)
1089 ERROR ("Configuration file %s is empty.", filename);
1090 oconfig_free (conf);
1094 for (i = 0; i < conf->children_num; i++)
1096 if (conf->children[i].children == NULL)
1097 dispatch_value (conf->children + i);
1099 dispatch_block (conf->children + i);
1102 oconfig_free (conf);
1104 /* Read the default types.db if no `TypesDB' option was given. */
1105 if (cf_default_typesdb)
1106 read_types_list (PKGDATADIR"/types.db");
1111 /* Assures the config option is a string, duplicates it and returns the copy in
1112 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1114 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1118 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1120 ERROR ("cf_util_get_string: The %s option requires "
1121 "exactly one string argument.", ci->key);
1125 string = strdup (ci->values[0].value.string);
1129 if (*ret_string != NULL)
1130 sfree (*ret_string);
1131 *ret_string = string;
1134 } /* }}} int cf_util_get_string */
1136 /* Assures the config option is a string and copies it to the provided buffer.
1137 * Assures null-termination. */
1138 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1141 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1144 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1146 ERROR ("cf_util_get_string_buffer: The %s option requires "
1147 "exactly one string argument.", ci->key);
1151 strncpy (buffer, ci->values[0].value.string, buffer_size);
1152 buffer[buffer_size - 1] = 0;
1155 } /* }}} int cf_util_get_string_buffer */
1157 /* Assures the config option is a number and returns it as an int. */
1158 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1160 if ((ci == NULL) || (ret_value == NULL))
1163 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1165 ERROR ("cf_util_get_int: The %s option requires "
1166 "exactly one numeric argument.", ci->key);
1170 *ret_value = (int) ci->values[0].value.number;
1173 } /* }}} int cf_util_get_int */
1175 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1177 if ((ci == NULL) || (ret_value == NULL))
1180 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1182 ERROR ("cf_util_get_double: The %s option requires "
1183 "exactly one numeric argument.", ci->key);
1187 *ret_value = ci->values[0].value.number;
1190 } /* }}} int cf_util_get_double */
1192 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1194 if ((ci == NULL) || (ret_bool == NULL))
1197 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1199 ERROR ("cf_util_get_boolean: The %s option requires "
1200 "exactly one boolean argument.", ci->key);
1204 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1207 } /* }}} int cf_util_get_boolean */
1209 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1210 unsigned int *ret_value, unsigned int flag)
1215 if (ret_value == NULL)
1219 status = cf_util_get_boolean (ci, &b);
1229 *ret_value &= ~flag;
1233 } /* }}} int cf_util_get_flag */
1235 /* Assures that the config option is a string or a number if the correct range
1236 * of 1-65535. The string is then converted to a port number using
1237 * `service_name_to_port_number' and returned.
1238 * Returns the port number in the range [1-65535] or less than zero upon
1240 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1244 if ((ci->values_num != 1)
1245 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1246 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1248 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1249 "exactly one string argument.", ci->key);
1253 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1254 return (service_name_to_port_number (ci->values[0].value.string));
1256 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1257 tmp = (int) (ci->values[0].value.number + 0.5);
1258 if ((tmp < 1) || (tmp > 65535))
1260 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1261 "a service name or a port number. The number "
1262 "you specified, %i, is not in the valid "
1263 "range of 1-65535.",
1269 } /* }}} int cf_util_get_port_number */
1271 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1277 if (ci->values_num != 1)
1279 ERROR ("cf_util_get_service: The %s option requires exactly "
1280 "one argument.", ci->key);
1284 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1285 return (cf_util_get_string (ci, ret_string));
1286 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1288 ERROR ("cf_util_get_service: The %s option requires "
1289 "exactly one string or numeric argument.",
1294 status = cf_util_get_int (ci, &port);
1297 else if ((port < 1) || (port > 65535))
1299 ERROR ("cf_util_get_service: The port number given "
1300 "for the %s option is out of "
1301 "range (%i).", ci->key, port);
1305 service = malloc (6);
1306 if (service == NULL)
1308 ERROR ("cf_util_get_service: Out of memory.");
1311 ssnprintf (service, 6, "%i", port);
1313 sfree (*ret_string);
1314 *ret_string = service;
1317 } /* }}} int cf_util_get_service */
1319 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1321 if ((ci == NULL) || (ret_value == NULL))
1324 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1326 ERROR ("cf_util_get_cdtime: The %s option requires "
1327 "exactly one numeric argument.", ci->key);
1331 if (ci->values[0].value.number < 0.0)
1333 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1334 "option must not be negative.", ci->key);
1338 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1341 } /* }}} int cf_util_get_cdtime */