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 {"PreCacheChain", NULL, "PreCache"},
114 {"PostCacheChain", NULL, "PostCache"}
116 static int cf_global_options_num = STATIC_ARRAY_SIZE (cf_global_options);
118 static int cf_default_typesdb = 1;
121 * Functions to handle register/unregister, search, and other plugin related
124 static cf_callback_t *cf_search (const char *type)
126 cf_callback_t *cf_cb;
131 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
132 if (strcasecmp (cf_cb->type, type) == 0)
138 static int cf_dispatch (const char *type, const char *orig_key,
139 const char *orig_value)
141 cf_callback_t *cf_cb;
142 plugin_ctx_t old_ctx;
148 DEBUG ("type = %s, key = %s, value = %s",
150 ESCAPE_NULL(orig_key),
151 ESCAPE_NULL(orig_value));
153 if ((cf_cb = cf_search (type)) == NULL)
155 WARNING ("Found a configuration for the `%s' plugin, but "
156 "the plugin isn't loaded or didn't register "
157 "a configuration callback.", type);
161 if ((key = strdup (orig_key)) == NULL)
163 if ((value = strdup (orig_value)) == NULL)
171 old_ctx = plugin_set_ctx (cf_cb->ctx);
173 for (i = 0; i < cf_cb->keys_num; i++)
175 if ((cf_cb->keys[i] != NULL)
176 && (strcasecmp (cf_cb->keys[i], key) == 0))
178 ret = (*cf_cb->callback) (key, value);
183 plugin_set_ctx (old_ctx);
185 if (i >= cf_cb->keys_num)
186 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
191 DEBUG ("cf_dispatch: return (%i)", ret);
194 } /* int cf_dispatch */
196 static int dispatch_global_option (const oconfig_item_t *ci)
198 if (ci->values_num != 1)
200 if (ci->values[0].type == OCONFIG_TYPE_STRING)
201 return (global_option_set (ci->key, ci->values[0].value.string));
202 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
205 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
206 return (global_option_set (ci->key, tmp));
208 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
210 if (ci->values[0].value.boolean)
211 return (global_option_set (ci->key, "true"));
213 return (global_option_set (ci->key, "false"));
217 } /* int dispatch_global_option */
219 static int dispatch_value_typesdb (const oconfig_item_t *ci)
223 assert (strcasecmp (ci->key, "TypesDB") == 0);
225 cf_default_typesdb = 0;
227 if (ci->values_num < 1) {
228 ERROR ("configfile: `TypesDB' needs at least one argument.");
232 for (i = 0; i < ci->values_num; ++i)
234 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
235 WARNING ("configfile: TypesDB: Skipping %i. argument which "
236 "is not a string.", i + 1);
240 read_types_list (ci->values[i].value.string);
243 } /* int dispatch_value_typesdb */
245 static int dispatch_value_plugindir (const oconfig_item_t *ci)
247 assert (strcasecmp (ci->key, "PluginDir") == 0);
249 if (ci->values_num != 1)
251 if (ci->values[0].type != OCONFIG_TYPE_STRING)
254 plugin_set_dir (ci->values[0].value.string);
258 static int dispatch_loadplugin (const oconfig_item_t *ci)
262 unsigned int flags = 0;
264 plugin_ctx_t old_ctx;
267 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
269 if (ci->values_num != 1)
271 if (ci->values[0].type != OCONFIG_TYPE_STRING)
274 name = ci->values[0].value.string;
276 /* default to the global interval set before loading this plugin */
277 memset (&ctx, 0, sizeof (ctx));
278 ctx.interval = cf_get_default_interval ();
280 for (i = 0; i < ci->children_num; ++i) {
281 if (strcasecmp("Globals", ci->children[i].key) == 0)
282 cf_util_get_flag (ci->children + i, &flags, PLUGIN_FLAGS_GLOBAL);
283 else if (strcasecmp ("Interval", ci->children[i].key) == 0) {
284 double interval = 0.0;
286 if (cf_util_get_double (ci->children + i, &interval) != 0) {
287 /* cf_util_get_double will log an error */
291 ctx.interval = DOUBLE_TO_CDTIME_T (interval);
294 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
296 ci->children[i].key, ci->values[0].value.string);
300 old_ctx = plugin_set_ctx (ctx);
301 ret_val = plugin_load (name, (uint32_t) flags);
302 /* reset to the "global" context */
303 plugin_set_ctx (old_ctx);
306 } /* int dispatch_value_loadplugin */
308 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
316 buffer_free = sizeof (buffer);
318 for (i = 0; i < ci->values_num; i++)
322 if (ci->values[i].type == OCONFIG_TYPE_STRING)
323 status = ssnprintf (buffer_ptr, buffer_free, " %s",
324 ci->values[i].value.string);
325 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
326 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
327 ci->values[i].value.number);
328 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
329 status = ssnprintf (buffer_ptr, buffer_free, " %s",
330 ci->values[i].value.boolean
333 if ((status < 0) || (status >= buffer_free))
335 buffer_free -= status;
336 buffer_ptr += status;
338 /* skip the initial space */
339 buffer_ptr = buffer + 1;
341 return (cf_dispatch (plugin, ci->key, buffer_ptr));
342 } /* int dispatch_value_plugin */
344 static int dispatch_value (const oconfig_item_t *ci)
349 for (i = 0; i < cf_value_map_num; i++)
350 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
352 ret = cf_value_map[i].func (ci);
356 for (i = 0; i < cf_global_options_num; i++)
357 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
359 ret = dispatch_global_option (ci);
364 } /* int dispatch_value */
366 static int dispatch_block_plugin (oconfig_item_t *ci)
371 cf_complex_callback_t *cb;
373 if (strcasecmp (ci->key, "Plugin") != 0)
375 if (ci->values_num < 1)
377 if (ci->values[0].type != OCONFIG_TYPE_STRING)
380 name = ci->values[0].value.string;
382 /* Check for a complex callback first */
383 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
385 if (strcasecmp (name, cb->type) == 0)
387 plugin_ctx_t old_ctx;
390 old_ctx = plugin_set_ctx (cb->ctx);
391 ret_val = (cb->callback (ci));
392 plugin_set_ctx (old_ctx);
397 /* Hm, no complex plugin found. Dispatch the values one by one */
398 for (i = 0; i < ci->children_num; i++)
400 if (ci->children[i].children == NULL)
401 dispatch_value_plugin (name, ci->children + i);
404 WARNING ("There is a `%s' block within the "
405 "configuration for the %s plugin. "
406 "The plugin either only expects "
407 "\"simple\" configuration statements "
408 "or wasn't loaded using `LoadPlugin'."
409 " Please check your configuration.",
410 ci->children[i].key, name);
418 static int dispatch_block (oconfig_item_t *ci)
420 if (strcasecmp (ci->key, "LoadPlugin") == 0)
421 return (dispatch_loadplugin (ci));
422 else if (strcasecmp (ci->key, "Plugin") == 0)
423 return (dispatch_block_plugin (ci));
424 else if (strcasecmp (ci->key, "Chain") == 0)
425 return (fc_configure (ci));
430 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
433 oconfig_item_t *temp;
436 assert (offset >= 0);
437 assert (dst->children_num > offset);
439 /* Free the memory used by the replaced child. Usually that's the
440 * `Include "blah"' statement. */
441 temp = dst->children + offset;
442 for (i = 0; i < temp->values_num; i++)
444 if (temp->values[i].type == OCONFIG_TYPE_STRING)
446 sfree (temp->values[i].value.string);
449 sfree (temp->values);
452 /* If (src->children_num == 0) the array size is decreased. If offset
453 * is _not_ the last element, (offset < (dst->children_num - 1)), then
454 * we need to move the trailing elements before resizing the array. */
455 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
457 int nmemb = dst->children_num - (offset + 1);
458 memmove (dst->children + offset, dst->children + offset + 1,
459 sizeof (oconfig_item_t) * nmemb);
462 /* Resize the memory containing the children to be big enough to hold
464 temp = (oconfig_item_t *) realloc (dst->children,
465 sizeof (oconfig_item_t)
466 * (dst->children_num + src->children_num - 1));
469 ERROR ("configfile: realloc failed.");
472 dst->children = temp;
474 /* If there are children behind the include statement, and they have
475 * not yet been moved because (src->children_num == 0), then move them
476 * to the end of the list, so that the new children have room before
478 if ((src->children_num > 0)
479 && ((dst->children_num - (offset + 1)) > 0))
481 int nmemb = dst->children_num - (offset + 1);
482 int old_offset = offset + 1;
483 int new_offset = offset + src->children_num;
485 memmove (dst->children + new_offset,
486 dst->children + old_offset,
487 sizeof (oconfig_item_t) * nmemb);
490 /* Last but not least: If there are new children, copy them to the
491 * memory reserved for them. */
492 if (src->children_num > 0)
494 memcpy (dst->children + offset,
496 sizeof (oconfig_item_t) * src->children_num);
499 /* Update the number of children. */
500 dst->children_num += (src->children_num - 1);
503 } /* int cf_ci_replace_child */
505 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
507 oconfig_item_t *temp;
509 if ((src == NULL) || (src->children_num == 0))
512 temp = (oconfig_item_t *) realloc (dst->children,
513 sizeof (oconfig_item_t)
514 * (dst->children_num + src->children_num));
517 ERROR ("configfile: realloc failed.");
520 dst->children = temp;
522 memcpy (dst->children + dst->children_num,
524 sizeof (oconfig_item_t)
525 * src->children_num);
526 dst->children_num += src->children_num;
529 } /* int cf_ci_append_children */
531 #define CF_MAX_DEPTH 8
532 static oconfig_item_t *cf_read_generic (const char *path,
533 const char *pattern, int depth);
535 static int cf_include_all (oconfig_item_t *root, int depth)
539 for (i = 0; i < root->children_num; i++)
544 char *pattern = NULL;
548 if (strcasecmp (root->children[i].key, "Include") != 0)
551 old = root->children + i;
553 if ((old->values_num != 1)
554 || (old->values[0].type != OCONFIG_TYPE_STRING))
556 ERROR ("configfile: `Include' needs exactly one string argument.");
560 for (j = 0; j < old->children_num; ++j)
562 oconfig_item_t *child = old->children + j;
564 if (strcasecmp (child->key, "Filter") == 0)
565 cf_util_get_string (child, &pattern);
567 ERROR ("configfile: Option `%s' not allowed in <Include> block.",
571 new = cf_read_generic (old->values[0].value.string, pattern, depth + 1);
577 /* Now replace the i'th child in `root' with `new'. */
578 cf_ci_replace_child (root, new, i);
580 /* ... and go back to the new i'th child. */
585 } /* for (i = 0; i < root->children_num; i++) */
588 } /* int cf_include_all */
590 static oconfig_item_t *cf_read_file (const char *file,
591 const char *pattern, int depth)
593 oconfig_item_t *root;
595 assert (depth < CF_MAX_DEPTH);
597 if (pattern != NULL) {
598 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
599 char *tmp = sstrdup (file);
600 char *filename = basename (tmp);
602 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
603 DEBUG ("configfile: Not including `%s' because it "
604 "does not match pattern `%s'.",
612 ERROR ("configfile: Cannot apply pattern filter '%s' "
613 "to file '%s': functions basename() and / or "
614 "fnmatch() not available.", pattern, file);
615 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
618 root = oconfig_parse_file (file);
621 ERROR ("configfile: Cannot read file `%s'.", file);
625 cf_include_all (root, depth);
628 } /* oconfig_item_t *cf_read_file */
630 static int cf_compare_string (const void *p1, const void *p2)
632 return strcmp (*(const char **) p1, *(const char **) p2);
635 static oconfig_item_t *cf_read_dir (const char *dir,
636 const char *pattern, int depth)
638 oconfig_item_t *root = NULL;
641 char **filenames = NULL;
642 int filenames_num = 0;
646 assert (depth < CF_MAX_DEPTH);
652 ERROR ("configfile: opendir failed: %s",
653 sstrerror (errno, errbuf, sizeof (errbuf)));
657 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
660 ERROR ("configfile: malloc failed.");
663 memset (root, 0, sizeof (oconfig_item_t));
665 while ((de = readdir (dh)) != NULL)
670 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
673 status = ssnprintf (name, sizeof (name), "%s/%s",
675 if ((status < 0) || ((size_t) status >= sizeof (name)))
677 ERROR ("configfile: Not including `%s/%s' because its"
678 " name is too long.",
680 for (i = 0; i < filenames_num; ++i)
688 tmp = (char **) realloc (filenames,
689 filenames_num * sizeof (*filenames));
691 ERROR ("configfile: realloc failed.");
692 for (i = 0; i < filenames_num - 1; ++i)
700 filenames[filenames_num - 1] = sstrdup (name);
703 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
706 for (i = 0; i < filenames_num; ++i)
708 oconfig_item_t *temp;
709 char *name = filenames[i];
711 temp = cf_read_generic (name, pattern, depth);
714 /* An error should already have been reported. */
719 cf_ci_append_children (root, temp);
720 sfree (temp->children);
728 } /* oconfig_item_t *cf_read_dir */
733 * Path is stat'ed and either cf_read_file or cf_read_dir is called
736 * There are two versions of this function: If `wordexp' exists shell wildcards
737 * will be expanded and the function will include all matches found. If
738 * `wordexp' (or, more precisely, it's header file) is not available the
739 * simpler function is used which does not do any such expansion.
742 static oconfig_item_t *cf_read_generic (const char *path,
743 const char *pattern, int depth)
745 oconfig_item_t *root = NULL;
747 const char *path_ptr;
751 if (depth >= CF_MAX_DEPTH)
753 ERROR ("configfile: Not including `%s' because the maximum "
754 "nesting depth has been reached.", path);
758 status = wordexp (path, &we, WRDE_NOCMD);
761 ERROR ("configfile: wordexp (%s) failed.", path);
765 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
768 ERROR ("configfile: malloc failed.");
771 memset (root, '\0', sizeof (oconfig_item_t));
773 /* wordexp() might return a sorted list already. That's not
774 * documented though, so let's make sure we get what we want. */
775 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
778 for (i = 0; i < we.we_wordc; i++)
780 oconfig_item_t *temp;
783 path_ptr = we.we_wordv[i];
785 status = stat (path_ptr, &statbuf);
789 WARNING ("configfile: stat (%s) failed: %s",
791 sstrerror (errno, errbuf, sizeof (errbuf)));
795 if (S_ISREG (statbuf.st_mode))
796 temp = cf_read_file (path_ptr, pattern, depth);
797 else if (S_ISDIR (statbuf.st_mode))
798 temp = cf_read_dir (path_ptr, pattern, depth);
801 WARNING ("configfile: %s is neither a file nor a "
811 cf_ci_append_children (root, temp);
812 sfree (temp->children);
818 if (root->children == NULL)
825 } /* oconfig_item_t *cf_read_generic */
826 /* #endif HAVE_WORDEXP_H */
828 #else /* if !HAVE_WORDEXP_H */
829 static oconfig_item_t *cf_read_generic (const char *path,
830 const char *pattern, int depth)
835 if (depth >= CF_MAX_DEPTH)
837 ERROR ("configfile: Not including `%s' because the maximum "
838 "nesting depth has been reached.", path);
842 status = stat (path, &statbuf);
846 ERROR ("configfile: stat (%s) failed: %s",
848 sstrerror (errno, errbuf, sizeof (errbuf)));
852 if (S_ISREG (statbuf.st_mode))
853 return (cf_read_file (path, pattern, depth));
854 else if (S_ISDIR (statbuf.st_mode))
855 return (cf_read_dir (path, pattern, depth));
857 ERROR ("configfile: %s is neither a file nor a directory.", path);
859 } /* oconfig_item_t *cf_read_generic */
860 #endif /* !HAVE_WORDEXP_H */
865 int global_option_set (const char *option, const char *value)
869 DEBUG ("option = %s; value = %s;", option, value);
871 for (i = 0; i < cf_global_options_num; i++)
872 if (strcasecmp (cf_global_options[i].key, option) == 0)
875 if (i >= cf_global_options_num)
878 sfree (cf_global_options[i].value);
881 cf_global_options[i].value = strdup (value);
883 cf_global_options[i].value = NULL;
888 const char *global_option_get (const char *option)
892 for (i = 0; i < cf_global_options_num; i++)
893 if (strcasecmp (cf_global_options[i].key, option) == 0)
896 if (i >= cf_global_options_num)
899 return ((cf_global_options[i].value != NULL)
900 ? cf_global_options[i].value
901 : cf_global_options[i].def);
902 } /* char *global_option_get */
904 cdtime_t cf_get_default_interval (void)
906 char const *str = global_option_get ("Interval");
907 double interval_double = COLLECTD_DEFAULT_INTERVAL;
912 double tmp = strtod (str, &endptr);
914 if ((endptr == NULL) || (endptr == str) || (*endptr != 0))
915 ERROR ("cf_get_default_interval: Unable to parse string \"%s\" "
918 ERROR ("cf_get_default_interval: Interval must be a positive number. "
919 "The current number is %g.", tmp);
921 interval_double = tmp;
924 return (DOUBLE_TO_CDTIME_T (interval_double));
925 } /* }}} cdtime_t cf_get_default_interval */
927 void cf_unregister (const char *type)
929 cf_callback_t *this, *prev;
931 for (prev = NULL, this = first_callback;
933 prev = this, this = this->next)
934 if (strcasecmp (this->type, type) == 0)
937 first_callback = this->next;
939 prev->next = this->next;
944 } /* void cf_unregister */
946 void cf_unregister_complex (const char *type)
948 cf_complex_callback_t *this, *prev;
950 for (prev = NULL, this = complex_callback_head;
952 prev = this, this = this->next)
953 if (strcasecmp (this->type, type) == 0)
956 complex_callback_head = this->next;
958 prev->next = this->next;
964 } /* void cf_unregister */
966 void cf_register (const char *type,
967 int (*callback) (const char *, const char *),
968 const char **keys, int keys_num)
970 cf_callback_t *cf_cb;
972 /* Remove this module from the list, if it already exists */
973 cf_unregister (type);
975 /* This pointer will be free'd in `cf_unregister' */
976 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
980 cf_cb->callback = callback;
982 cf_cb->keys_num = keys_num;
983 cf_cb->ctx = plugin_get_ctx ();
985 cf_cb->next = first_callback;
986 first_callback = cf_cb;
987 } /* void cf_register */
989 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
991 cf_complex_callback_t *new;
993 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
997 new->type = strdup (type);
998 if (new->type == NULL)
1004 new->callback = callback;
1007 new->ctx = plugin_get_ctx ();
1009 if (complex_callback_head == NULL)
1011 complex_callback_head = new;
1015 cf_complex_callback_t *last = complex_callback_head;
1016 while (last->next != NULL)
1022 } /* int cf_register_complex */
1024 int cf_read (char *filename)
1026 oconfig_item_t *conf;
1029 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1032 ERROR ("Unable to read config file %s.", filename);
1036 for (i = 0; i < conf->children_num; i++)
1038 if (conf->children[i].children == NULL)
1039 dispatch_value (conf->children + i);
1041 dispatch_block (conf->children + i);
1044 oconfig_free (conf);
1046 /* Read the default types.db if no `TypesDB' option was given. */
1047 if (cf_default_typesdb)
1048 read_types_list (PKGDATADIR"/types.db");
1053 /* Assures the config option is a string, duplicates it and returns the copy in
1054 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1056 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1060 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1062 ERROR ("cf_util_get_string: The %s option requires "
1063 "exactly one string argument.", ci->key);
1067 string = strdup (ci->values[0].value.string);
1071 if (*ret_string != NULL)
1072 sfree (*ret_string);
1073 *ret_string = string;
1076 } /* }}} int cf_util_get_string */
1078 /* Assures the config option is a string and copies it to the provided buffer.
1079 * Assures null-termination. */
1080 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1083 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1086 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1088 ERROR ("cf_util_get_string_buffer: The %s option requires "
1089 "exactly one string argument.", ci->key);
1093 strncpy (buffer, ci->values[0].value.string, buffer_size);
1094 buffer[buffer_size - 1] = 0;
1097 } /* }}} int cf_util_get_string_buffer */
1099 /* Assures the config option is a number and returns it as an int. */
1100 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1102 if ((ci == NULL) || (ret_value == NULL))
1105 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1107 ERROR ("cf_util_get_int: The %s option requires "
1108 "exactly one numeric argument.", ci->key);
1112 *ret_value = (int) ci->values[0].value.number;
1115 } /* }}} int cf_util_get_int */
1117 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1119 if ((ci == NULL) || (ret_value == NULL))
1122 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1124 ERROR ("cf_util_get_double: The %s option requires "
1125 "exactly one numeric argument.", ci->key);
1129 *ret_value = ci->values[0].value.number;
1132 } /* }}} int cf_util_get_double */
1134 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1136 if ((ci == NULL) || (ret_bool == NULL))
1139 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1141 ERROR ("cf_util_get_boolean: The %s option requires "
1142 "exactly one boolean argument.", ci->key);
1146 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1149 } /* }}} int cf_util_get_boolean */
1151 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1152 unsigned int *ret_value, unsigned int flag)
1157 if (ret_value == NULL)
1161 status = cf_util_get_boolean (ci, &b);
1171 *ret_value &= ~flag;
1175 } /* }}} int cf_util_get_flag */
1177 /* Assures that the config option is a string or a number if the correct range
1178 * of 1-65535. The string is then converted to a port number using
1179 * `service_name_to_port_number' and returned.
1180 * Returns the port number in the range [1-65535] or less than zero upon
1182 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1186 if ((ci->values_num != 1)
1187 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1188 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1190 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1191 "exactly one string argument.", ci->key);
1195 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1196 return (service_name_to_port_number (ci->values[0].value.string));
1198 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1199 tmp = (int) (ci->values[0].value.number + 0.5);
1200 if ((tmp < 1) || (tmp > 65535))
1202 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1203 "a service name or a port number. The number "
1204 "you specified, %i, is not in the valid "
1205 "range of 1-65535.",
1211 } /* }}} int cf_util_get_port_number */
1213 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1219 if (ci->values_num != 1)
1221 ERROR ("cf_util_get_service: The %s option requires exactly "
1222 "one argument.", ci->key);
1226 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1227 return (cf_util_get_string (ci, ret_string));
1228 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1230 ERROR ("cf_util_get_service: The %s option requires "
1231 "exactly one string or numeric argument.",
1236 status = cf_util_get_int (ci, &port);
1239 else if ((port < 1) || (port > 65535))
1241 ERROR ("cf_util_get_service: The port number given "
1242 "for the %s option is out of "
1243 "range (%i).", ci->key, port);
1247 service = malloc (6);
1248 if (service == NULL)
1250 ERROR ("cf_util_get_service: Out of memory.");
1253 ssnprintf (service, 6, "%i", port);
1255 sfree (*ret_string);
1256 *ret_string = service;
1259 } /* }}} int cf_util_get_service */
1261 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1263 if ((ci == NULL) || (ret_value == NULL))
1266 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1268 ERROR ("cf_util_get_cdtime: The %s option requires "
1269 "exactly one numeric argument.", ci->key);
1273 if (ci->values[0].value.number < 0.0)
1275 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1276 "option must not be negative.", ci->key);
1280 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1283 } /* }}} int cf_util_get_cdtime */