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) (const oconfig_item_t *);
75 typedef struct cf_global_option_s
83 * Prototypes of callback functions
85 static int dispatch_value_typesdb (const oconfig_item_t *ci);
86 static int dispatch_value_plugindir (const oconfig_item_t *ci);
87 static int dispatch_loadplugin (const oconfig_item_t *ci);
92 static cf_callback_t *first_callback = NULL;
93 static cf_complex_callback_t *complex_callback_head = NULL;
95 static cf_value_map_t cf_value_map[] =
97 {"TypesDB", dispatch_value_typesdb},
98 {"PluginDir", dispatch_value_plugindir},
99 {"LoadPlugin", dispatch_loadplugin}
101 static int cf_value_map_num = STATIC_ARRAY_SIZE (cf_value_map);
103 static cf_global_option_t cf_global_options[] =
105 {"BaseDir", NULL, PKGLOCALSTATEDIR},
106 {"PIDFile", NULL, PIDFILE},
107 {"Hostname", NULL, NULL},
108 {"FQDNLookup", NULL, "true"},
109 {"Interval", NULL, NULL},
110 {"ReadThreads", NULL, "5"},
111 {"WriteThreads", NULL, "5"},
112 {"Timeout", NULL, "2"},
113 {"AutoLoadPlugin", NULL, "false"},
114 {"PreCacheChain", NULL, "PreCache"},
115 {"PostCacheChain", NULL, "PostCache"}
117 static int cf_global_options_num = STATIC_ARRAY_SIZE (cf_global_options);
119 static int cf_default_typesdb = 1;
122 * Functions to handle register/unregister, search, and other plugin related
125 static cf_callback_t *cf_search (const char *type)
127 cf_callback_t *cf_cb;
132 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
133 if (strcasecmp (cf_cb->type, type) == 0)
139 static int cf_dispatch (const char *type, const char *orig_key,
140 const char *orig_value)
142 cf_callback_t *cf_cb;
143 plugin_ctx_t old_ctx;
149 DEBUG ("type = %s, key = %s, value = %s",
151 ESCAPE_NULL(orig_key),
152 ESCAPE_NULL(orig_value));
154 if ((cf_cb = cf_search (type)) == NULL)
156 WARNING ("Found a configuration for the `%s' plugin, but "
157 "the plugin isn't loaded or didn't register "
158 "a configuration callback.", type);
162 if ((key = strdup (orig_key)) == NULL)
164 if ((value = strdup (orig_value)) == NULL)
172 old_ctx = plugin_set_ctx (cf_cb->ctx);
174 for (i = 0; i < cf_cb->keys_num; i++)
176 if ((cf_cb->keys[i] != NULL)
177 && (strcasecmp (cf_cb->keys[i], key) == 0))
179 ret = (*cf_cb->callback) (key, value);
184 plugin_set_ctx (old_ctx);
186 if (i >= cf_cb->keys_num)
187 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
192 DEBUG ("cf_dispatch: return (%i)", ret);
195 } /* int cf_dispatch */
197 static int dispatch_global_option (const oconfig_item_t *ci)
199 if (ci->values_num != 1)
201 if (ci->values[0].type == OCONFIG_TYPE_STRING)
202 return (global_option_set (ci->key, ci->values[0].value.string));
203 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
206 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
207 return (global_option_set (ci->key, tmp));
209 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
211 if (ci->values[0].value.boolean)
212 return (global_option_set (ci->key, "true"));
214 return (global_option_set (ci->key, "false"));
218 } /* int dispatch_global_option */
220 static int dispatch_value_typesdb (const oconfig_item_t *ci)
224 assert (strcasecmp (ci->key, "TypesDB") == 0);
226 cf_default_typesdb = 0;
228 if (ci->values_num < 1) {
229 ERROR ("configfile: `TypesDB' needs at least one argument.");
233 for (i = 0; i < ci->values_num; ++i)
235 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
236 WARNING ("configfile: TypesDB: Skipping %i. argument which "
237 "is not a string.", i + 1);
241 read_types_list (ci->values[i].value.string);
244 } /* int dispatch_value_typesdb */
246 static int dispatch_value_plugindir (const oconfig_item_t *ci)
248 assert (strcasecmp (ci->key, "PluginDir") == 0);
250 if (ci->values_num != 1)
252 if (ci->values[0].type != OCONFIG_TYPE_STRING)
255 plugin_set_dir (ci->values[0].value.string);
259 static int dispatch_loadplugin (const oconfig_item_t *ci)
263 unsigned int flags = 0;
265 plugin_ctx_t old_ctx;
268 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
270 if (ci->values_num != 1)
272 if (ci->values[0].type != OCONFIG_TYPE_STRING)
275 name = ci->values[0].value.string;
277 /* default to the global interval set before loading this plugin */
278 memset (&ctx, 0, sizeof (ctx));
279 ctx.interval = cf_get_default_interval ();
281 for (i = 0; i < ci->children_num; ++i) {
282 if (strcasecmp("Globals", ci->children[i].key) == 0)
283 cf_util_get_flag (ci->children + i, &flags, PLUGIN_FLAGS_GLOBAL);
284 else if (strcasecmp ("Interval", ci->children[i].key) == 0) {
285 double interval = 0.0;
287 if (cf_util_get_double (ci->children + i, &interval) != 0) {
288 /* cf_util_get_double will log an error */
292 ctx.interval = DOUBLE_TO_CDTIME_T (interval);
295 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
297 ci->children[i].key, ci->values[0].value.string);
301 old_ctx = plugin_set_ctx (ctx);
302 ret_val = plugin_load (name, (uint32_t) flags);
303 /* reset to the "global" context */
304 plugin_set_ctx (old_ctx);
307 } /* int dispatch_value_loadplugin */
309 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
317 buffer_free = sizeof (buffer);
319 for (i = 0; i < ci->values_num; i++)
323 if (ci->values[i].type == OCONFIG_TYPE_STRING)
324 status = ssnprintf (buffer_ptr, buffer_free, " %s",
325 ci->values[i].value.string);
326 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
327 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
328 ci->values[i].value.number);
329 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
330 status = ssnprintf (buffer_ptr, buffer_free, " %s",
331 ci->values[i].value.boolean
334 if ((status < 0) || (status >= buffer_free))
336 buffer_free -= status;
337 buffer_ptr += status;
339 /* skip the initial space */
340 buffer_ptr = buffer + 1;
342 return (cf_dispatch (plugin, ci->key, buffer_ptr));
343 } /* int dispatch_value_plugin */
345 static int dispatch_value (const oconfig_item_t *ci)
350 for (i = 0; i < cf_value_map_num; i++)
351 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
353 ret = cf_value_map[i].func (ci);
357 for (i = 0; i < cf_global_options_num; i++)
358 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
360 ret = dispatch_global_option (ci);
365 } /* int dispatch_value */
367 static int dispatch_block_plugin (oconfig_item_t *ci)
372 cf_complex_callback_t *cb;
374 if (strcasecmp (ci->key, "Plugin") != 0)
376 if (ci->values_num < 1)
378 if (ci->values[0].type != OCONFIG_TYPE_STRING)
381 name = ci->values[0].value.string;
383 if (IS_TRUE (global_option_get ("AutoLoadPlugin")))
387 status = plugin_load (name, /* flags = */ 0);
390 ERROR ("Automatically loading plugin \"%s\" failed "
391 "with status %i.", name, status);
396 /* Check for a complex callback first */
397 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
399 if (strcasecmp (name, cb->type) == 0)
401 plugin_ctx_t old_ctx;
404 old_ctx = plugin_set_ctx (cb->ctx);
405 ret_val = (cb->callback (ci));
406 plugin_set_ctx (old_ctx);
411 /* Hm, no complex plugin found. Dispatch the values one by one */
412 for (i = 0; i < ci->children_num; i++)
414 if (ci->children[i].children == NULL)
415 dispatch_value_plugin (name, ci->children + i);
418 WARNING ("There is a `%s' block within the "
419 "configuration for the %s plugin. "
420 "The plugin either only expects "
421 "\"simple\" configuration statements "
422 "or wasn't loaded using `LoadPlugin'."
423 " Please check your configuration.",
424 ci->children[i].key, name);
432 static int dispatch_block (oconfig_item_t *ci)
434 if (strcasecmp (ci->key, "LoadPlugin") == 0)
435 return (dispatch_loadplugin (ci));
436 else if (strcasecmp (ci->key, "Plugin") == 0)
437 return (dispatch_block_plugin (ci));
438 else if (strcasecmp (ci->key, "Chain") == 0)
439 return (fc_configure (ci));
444 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
447 oconfig_item_t *temp;
450 assert (offset >= 0);
451 assert (dst->children_num > offset);
453 /* Free the memory used by the replaced child. Usually that's the
454 * `Include "blah"' statement. */
455 temp = dst->children + offset;
456 for (i = 0; i < temp->values_num; i++)
458 if (temp->values[i].type == OCONFIG_TYPE_STRING)
460 sfree (temp->values[i].value.string);
463 sfree (temp->values);
466 /* If (src->children_num == 0) the array size is decreased. If offset
467 * is _not_ the last element, (offset < (dst->children_num - 1)), then
468 * we need to move the trailing elements before resizing the array. */
469 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
471 int nmemb = dst->children_num - (offset + 1);
472 memmove (dst->children + offset, dst->children + offset + 1,
473 sizeof (oconfig_item_t) * nmemb);
476 /* Resize the memory containing the children to be big enough to hold
478 temp = (oconfig_item_t *) realloc (dst->children,
479 sizeof (oconfig_item_t)
480 * (dst->children_num + src->children_num - 1));
483 ERROR ("configfile: realloc failed.");
486 dst->children = temp;
488 /* If there are children behind the include statement, and they have
489 * not yet been moved because (src->children_num == 0), then move them
490 * to the end of the list, so that the new children have room before
492 if ((src->children_num > 0)
493 && ((dst->children_num - (offset + 1)) > 0))
495 int nmemb = dst->children_num - (offset + 1);
496 int old_offset = offset + 1;
497 int new_offset = offset + src->children_num;
499 memmove (dst->children + new_offset,
500 dst->children + old_offset,
501 sizeof (oconfig_item_t) * nmemb);
504 /* Last but not least: If there are new children, copy them to the
505 * memory reserved for them. */
506 if (src->children_num > 0)
508 memcpy (dst->children + offset,
510 sizeof (oconfig_item_t) * src->children_num);
513 /* Update the number of children. */
514 dst->children_num += (src->children_num - 1);
517 } /* int cf_ci_replace_child */
519 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
521 oconfig_item_t *temp;
523 if ((src == NULL) || (src->children_num == 0))
526 temp = (oconfig_item_t *) realloc (dst->children,
527 sizeof (oconfig_item_t)
528 * (dst->children_num + src->children_num));
531 ERROR ("configfile: realloc failed.");
534 dst->children = temp;
536 memcpy (dst->children + dst->children_num,
538 sizeof (oconfig_item_t)
539 * src->children_num);
540 dst->children_num += src->children_num;
543 } /* int cf_ci_append_children */
545 #define CF_MAX_DEPTH 8
546 static oconfig_item_t *cf_read_generic (const char *path,
547 const char *pattern, int depth);
549 static int cf_include_all (oconfig_item_t *root, int depth)
553 for (i = 0; i < root->children_num; i++)
558 char *pattern = NULL;
562 if (strcasecmp (root->children[i].key, "Include") != 0)
565 old = root->children + i;
567 if ((old->values_num != 1)
568 || (old->values[0].type != OCONFIG_TYPE_STRING))
570 ERROR ("configfile: `Include' needs exactly one string argument.");
574 for (j = 0; j < old->children_num; ++j)
576 oconfig_item_t *child = old->children + j;
578 if (strcasecmp (child->key, "Filter") == 0)
579 cf_util_get_string (child, &pattern);
581 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
585 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
591 /* Now replace the i'th child in `root' with `new'. */
592 cf_ci_replace_child (root, new, i);
594 /* ... and go back to the new i'th child. */
599 } /* for (i = 0; i < root->children_num; i++) */
602 } /* int cf_include_all */
604 static oconfig_item_t *cf_read_file (const char *file,
605 const char *pattern, int depth)
607 oconfig_item_t *root;
609 assert (depth < CF_MAX_DEPTH);
611 if (pattern != NULL) {
612 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
613 char *tmp = sstrdup (file);
614 char *filename = basename (tmp);
616 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
617 DEBUG ("configfile: Not including `%s' because it "
618 "does not match pattern `%s'.",
626 ERROR ("configfile: Cannot apply pattern filter '%s' "
627 "to file '%s': functions basename() and / or "
628 "fnmatch() not available.", pattern, file);
629 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
632 root = oconfig_parse_file (file);
635 ERROR ("configfile: Cannot read file `%s'.", file);
639 cf_include_all (root, depth);
642 } /* oconfig_item_t *cf_read_file */
644 static int cf_compare_string (const void *p1, const void *p2)
646 return strcmp (*(const char **) p1, *(const char **) p2);
649 static oconfig_item_t *cf_read_dir (const char *dir,
650 const char *pattern, int depth)
652 oconfig_item_t *root = NULL;
655 char **filenames = NULL;
656 int filenames_num = 0;
660 assert (depth < CF_MAX_DEPTH);
666 ERROR ("configfile: opendir failed: %s",
667 sstrerror (errno, errbuf, sizeof (errbuf)));
671 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
674 ERROR ("configfile: malloc failed.");
677 memset (root, 0, sizeof (oconfig_item_t));
679 while ((de = readdir (dh)) != NULL)
684 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
687 status = ssnprintf (name, sizeof (name), "%s/%s",
689 if ((status < 0) || ((size_t) status >= sizeof (name)))
691 ERROR ("configfile: Not including `%s/%s' because its"
692 " name is too long.",
694 for (i = 0; i < filenames_num; ++i)
702 tmp = (char **) realloc (filenames,
703 filenames_num * sizeof (*filenames));
705 ERROR ("configfile: realloc failed.");
706 for (i = 0; i < filenames_num - 1; ++i)
714 filenames[filenames_num - 1] = sstrdup (name);
717 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
720 for (i = 0; i < filenames_num; ++i)
722 oconfig_item_t *temp;
723 char *name = filenames[i];
725 temp = cf_read_generic (name, pattern, depth);
728 /* An error should already have been reported. */
733 cf_ci_append_children (root, temp);
734 sfree (temp->children);
742 } /* oconfig_item_t *cf_read_dir */
747 * Path is stat'ed and either cf_read_file or cf_read_dir is called
750 * There are two versions of this function: If `wordexp' exists shell wildcards
751 * will be expanded and the function will include all matches found. If
752 * `wordexp' (or, more precisely, it's header file) is not available the
753 * simpler function is used which does not do any such expansion.
756 static oconfig_item_t *cf_read_generic (const char *path,
757 const char *pattern, int depth)
759 oconfig_item_t *root = NULL;
761 const char *path_ptr;
765 if (depth >= CF_MAX_DEPTH)
767 ERROR ("configfile: Not including `%s' because the maximum "
768 "nesting depth has been reached.", path);
772 status = wordexp (path, &we, WRDE_NOCMD);
775 ERROR ("configfile: wordexp (%s) failed.", path);
779 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
782 ERROR ("configfile: malloc failed.");
785 memset (root, '\0', sizeof (oconfig_item_t));
787 /* wordexp() might return a sorted list already. That's not
788 * documented though, so let's make sure we get what we want. */
789 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
792 for (i = 0; i < we.we_wordc; i++)
794 oconfig_item_t *temp;
797 path_ptr = we.we_wordv[i];
799 status = stat (path_ptr, &statbuf);
803 WARNING ("configfile: stat (%s) failed: %s",
805 sstrerror (errno, errbuf, sizeof (errbuf)));
809 if (S_ISREG (statbuf.st_mode))
810 temp = cf_read_file (path_ptr, pattern, depth);
811 else if (S_ISDIR (statbuf.st_mode))
812 temp = cf_read_dir (path_ptr, pattern, depth);
815 WARNING ("configfile: %s is neither a file nor a "
825 cf_ci_append_children (root, temp);
826 sfree (temp->children);
832 if (root->children == NULL)
839 } /* oconfig_item_t *cf_read_generic */
840 /* #endif HAVE_WORDEXP_H */
842 #else /* if !HAVE_WORDEXP_H */
843 static oconfig_item_t *cf_read_generic (const char *path,
844 const char *pattern, int depth)
849 if (depth >= CF_MAX_DEPTH)
851 ERROR ("configfile: Not including `%s' because the maximum "
852 "nesting depth has been reached.", path);
856 status = stat (path, &statbuf);
860 ERROR ("configfile: stat (%s) failed: %s",
862 sstrerror (errno, errbuf, sizeof (errbuf)));
866 if (S_ISREG (statbuf.st_mode))
867 return (cf_read_file (path, pattern, depth));
868 else if (S_ISDIR (statbuf.st_mode))
869 return (cf_read_dir (path, pattern, depth));
871 ERROR ("configfile: %s is neither a file nor a directory.", path);
873 } /* oconfig_item_t *cf_read_generic */
874 #endif /* !HAVE_WORDEXP_H */
879 int global_option_set (const char *option, const char *value)
883 DEBUG ("option = %s; value = %s;", option, value);
885 for (i = 0; i < cf_global_options_num; i++)
886 if (strcasecmp (cf_global_options[i].key, option) == 0)
889 if (i >= cf_global_options_num)
892 sfree (cf_global_options[i].value);
895 cf_global_options[i].value = strdup (value);
897 cf_global_options[i].value = NULL;
902 const char *global_option_get (const char *option)
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 return ((cf_global_options[i].value != NULL)
914 ? cf_global_options[i].value
915 : cf_global_options[i].def);
916 } /* char *global_option_get */
918 cdtime_t cf_get_default_interval (void)
920 char const *str = global_option_get ("Interval");
921 double interval_double = COLLECTD_DEFAULT_INTERVAL;
926 double tmp = strtod (str, &endptr);
928 if ((endptr == NULL) || (endptr == str) || (*endptr != 0))
929 ERROR ("cf_get_default_interval: Unable to parse string \"%s\" "
932 ERROR ("cf_get_default_interval: Interval must be a positive number. "
933 "The current number is %g.", tmp);
935 interval_double = tmp;
938 return (DOUBLE_TO_CDTIME_T (interval_double));
939 } /* }}} cdtime_t cf_get_default_interval */
941 void cf_unregister (const char *type)
943 cf_callback_t *this, *prev;
945 for (prev = NULL, this = first_callback;
947 prev = this, this = this->next)
948 if (strcasecmp (this->type, type) == 0)
951 first_callback = this->next;
953 prev->next = this->next;
958 } /* void cf_unregister */
960 void cf_unregister_complex (const char *type)
962 cf_complex_callback_t *this, *prev;
964 for (prev = NULL, this = complex_callback_head;
966 prev = this, this = this->next)
967 if (strcasecmp (this->type, type) == 0)
970 complex_callback_head = this->next;
972 prev->next = this->next;
978 } /* void cf_unregister */
980 void cf_register (const char *type,
981 int (*callback) (const char *, const char *),
982 const char **keys, int keys_num)
984 cf_callback_t *cf_cb;
986 /* Remove this module from the list, if it already exists */
987 cf_unregister (type);
989 /* This pointer will be free'd in `cf_unregister' */
990 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
994 cf_cb->callback = callback;
996 cf_cb->keys_num = keys_num;
997 cf_cb->ctx = plugin_get_ctx ();
999 cf_cb->next = first_callback;
1000 first_callback = cf_cb;
1001 } /* void cf_register */
1003 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
1005 cf_complex_callback_t *new;
1007 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
1011 new->type = strdup (type);
1012 if (new->type == NULL)
1018 new->callback = callback;
1021 new->ctx = plugin_get_ctx ();
1023 if (complex_callback_head == NULL)
1025 complex_callback_head = new;
1029 cf_complex_callback_t *last = complex_callback_head;
1030 while (last->next != NULL)
1036 } /* int cf_register_complex */
1038 int cf_read (char *filename)
1040 oconfig_item_t *conf;
1043 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1046 ERROR ("Unable to read config file %s.", filename);
1050 for (i = 0; i < conf->children_num; i++)
1052 if (conf->children[i].children == NULL)
1053 dispatch_value (conf->children + i);
1055 dispatch_block (conf->children + i);
1058 oconfig_free (conf);
1060 /* Read the default types.db if no `TypesDB' option was given. */
1061 if (cf_default_typesdb)
1062 read_types_list (PKGDATADIR"/types.db");
1067 /* Assures the config option is a string, duplicates it and returns the copy in
1068 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1070 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1074 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1076 ERROR ("cf_util_get_string: The %s option requires "
1077 "exactly one string argument.", ci->key);
1081 string = strdup (ci->values[0].value.string);
1085 if (*ret_string != NULL)
1086 sfree (*ret_string);
1087 *ret_string = string;
1090 } /* }}} int cf_util_get_string */
1092 /* Assures the config option is a string and copies it to the provided buffer.
1093 * Assures null-termination. */
1094 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1097 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1100 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1102 ERROR ("cf_util_get_string_buffer: The %s option requires "
1103 "exactly one string argument.", ci->key);
1107 strncpy (buffer, ci->values[0].value.string, buffer_size);
1108 buffer[buffer_size - 1] = 0;
1111 } /* }}} int cf_util_get_string_buffer */
1113 /* Assures the config option is a number and returns it as an int. */
1114 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1116 if ((ci == NULL) || (ret_value == NULL))
1119 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1121 ERROR ("cf_util_get_int: The %s option requires "
1122 "exactly one numeric argument.", ci->key);
1126 *ret_value = (int) ci->values[0].value.number;
1129 } /* }}} int cf_util_get_int */
1131 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1133 if ((ci == NULL) || (ret_value == NULL))
1136 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1138 ERROR ("cf_util_get_double: The %s option requires "
1139 "exactly one numeric argument.", ci->key);
1143 *ret_value = ci->values[0].value.number;
1146 } /* }}} int cf_util_get_double */
1148 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1150 if ((ci == NULL) || (ret_bool == NULL))
1153 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1155 ERROR ("cf_util_get_boolean: The %s option requires "
1156 "exactly one boolean argument.", ci->key);
1160 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1163 } /* }}} int cf_util_get_boolean */
1165 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1166 unsigned int *ret_value, unsigned int flag)
1171 if (ret_value == NULL)
1175 status = cf_util_get_boolean (ci, &b);
1185 *ret_value &= ~flag;
1189 } /* }}} int cf_util_get_flag */
1191 /* Assures that the config option is a string or a number if the correct range
1192 * of 1-65535. The string is then converted to a port number using
1193 * `service_name_to_port_number' and returned.
1194 * Returns the port number in the range [1-65535] or less than zero upon
1196 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1200 if ((ci->values_num != 1)
1201 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1202 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1204 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1205 "exactly one string argument.", ci->key);
1209 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1210 return (service_name_to_port_number (ci->values[0].value.string));
1212 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1213 tmp = (int) (ci->values[0].value.number + 0.5);
1214 if ((tmp < 1) || (tmp > 65535))
1216 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1217 "a service name or a port number. The number "
1218 "you specified, %i, is not in the valid "
1219 "range of 1-65535.",
1225 } /* }}} int cf_util_get_port_number */
1227 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1233 if (ci->values_num != 1)
1235 ERROR ("cf_util_get_service: The %s option requires exactly "
1236 "one argument.", ci->key);
1240 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1241 return (cf_util_get_string (ci, ret_string));
1242 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1244 ERROR ("cf_util_get_service: The %s option requires "
1245 "exactly one string or numeric argument.",
1250 status = cf_util_get_int (ci, &port);
1253 else if ((port < 1) || (port > 65535))
1255 ERROR ("cf_util_get_service: The port number given "
1256 "for the %s option is out of "
1257 "range (%i).", ci->key, port);
1261 service = malloc (6);
1262 if (service == NULL)
1264 ERROR ("cf_util_get_service: Out of memory.");
1267 ssnprintf (service, 6, "%i", port);
1269 sfree (*ret_string);
1270 *ret_string = service;
1273 } /* }}} int cf_util_get_service */
1275 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1277 if ((ci == NULL) || (ret_value == NULL))
1280 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1282 ERROR ("cf_util_get_cdtime: The %s option requires "
1283 "exactly one numeric argument.", ci->key);
1287 if (ci->values[0].value.number < 0.0)
1289 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1290 "option must not be negative.", ci->key);
1294 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1297 } /* }}} int cf_util_get_cdtime */