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_LEN (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 {"Timeout", NULL, "2"},
112 {"PreCacheChain", NULL, "PreCache"},
113 {"PostCacheChain", NULL, "PostCache"}
115 static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
117 static int cf_default_typesdb = 1;
120 * Functions to handle register/unregister, search, and other plugin related
123 static cf_callback_t *cf_search (const char *type)
125 cf_callback_t *cf_cb;
130 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
131 if (strcasecmp (cf_cb->type, type) == 0)
137 static int cf_dispatch (const char *type, const char *orig_key,
138 const char *orig_value)
140 cf_callback_t *cf_cb;
141 plugin_ctx_t old_ctx;
147 DEBUG ("type = %s, key = %s, value = %s",
149 ESCAPE_NULL(orig_key),
150 ESCAPE_NULL(orig_value));
152 if ((cf_cb = cf_search (type)) == NULL)
154 WARNING ("Found a configuration for the `%s' plugin, but "
155 "the plugin isn't loaded or didn't register "
156 "a configuration callback.", type);
160 if ((key = strdup (orig_key)) == NULL)
162 if ((value = strdup (orig_value)) == NULL)
170 old_ctx = plugin_set_ctx (cf_cb->ctx);
172 for (i = 0; i < cf_cb->keys_num; i++)
174 if ((cf_cb->keys[i] != NULL)
175 && (strcasecmp (cf_cb->keys[i], key) == 0))
177 ret = (*cf_cb->callback) (key, value);
182 plugin_set_ctx (old_ctx);
184 if (i >= cf_cb->keys_num)
185 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
190 DEBUG ("cf_dispatch: return (%i)", ret);
193 } /* int cf_dispatch */
195 static int dispatch_global_option (const oconfig_item_t *ci)
197 if (ci->values_num != 1)
199 if (ci->values[0].type == OCONFIG_TYPE_STRING)
200 return (global_option_set (ci->key, ci->values[0].value.string));
201 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
204 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
205 return (global_option_set (ci->key, tmp));
207 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
209 if (ci->values[0].value.boolean)
210 return (global_option_set (ci->key, "true"));
212 return (global_option_set (ci->key, "false"));
216 } /* int dispatch_global_option */
218 static int dispatch_value_typesdb (const oconfig_item_t *ci)
222 assert (strcasecmp (ci->key, "TypesDB") == 0);
224 cf_default_typesdb = 0;
226 if (ci->values_num < 1) {
227 ERROR ("configfile: `TypesDB' needs at least one argument.");
231 for (i = 0; i < ci->values_num; ++i)
233 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
234 WARNING ("configfile: TypesDB: Skipping %i. argument which "
235 "is not a string.", i + 1);
239 read_types_list (ci->values[i].value.string);
242 } /* int dispatch_value_typesdb */
244 static int dispatch_value_plugindir (const oconfig_item_t *ci)
246 assert (strcasecmp (ci->key, "PluginDir") == 0);
248 if (ci->values_num != 1)
250 if (ci->values[0].type != OCONFIG_TYPE_STRING)
253 plugin_set_dir (ci->values[0].value.string);
257 static int dispatch_loadplugin (const oconfig_item_t *ci)
261 unsigned int flags = 0;
263 plugin_ctx_t old_ctx;
266 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
268 if (ci->values_num != 1)
270 if (ci->values[0].type != OCONFIG_TYPE_STRING)
273 name = ci->values[0].value.string;
275 /* default to the global interval set before loading this plugin */
276 memset (&ctx, 0, sizeof (ctx));
277 ctx.interval = cf_get_default_interval ();
280 * XXX: Magic at work:
282 * Some of the language bindings, for example the Python and Perl
283 * plugins, need to be able to export symbols to the scripts they run.
284 * For this to happen, the "Globals" flag needs to be set.
285 * Unfortunately, this technical detail is hard to explain to the
286 * average user and she shouldn't have to worry about this, ideally.
287 * So in order to save everyone's sanity use a different default for a
288 * handful of special plugins. --octo
290 if ((strcasecmp ("Perl", name) == 0)
291 || (strcasecmp ("Python", name) == 0))
292 flags |= PLUGIN_FLAGS_GLOBAL;
294 for (i = 0; i < ci->children_num; ++i) {
295 if (strcasecmp("Globals", ci->children[i].key) == 0)
296 cf_util_get_flag (ci->children + i, &flags, PLUGIN_FLAGS_GLOBAL);
297 else if (strcasecmp ("Interval", ci->children[i].key) == 0) {
298 double interval = 0.0;
300 if (cf_util_get_double (ci->children + i, &interval) != 0) {
301 /* cf_util_get_double will log an error */
305 ctx.interval = DOUBLE_TO_CDTIME_T (interval);
308 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
310 ci->children[i].key, ci->values[0].value.string);
314 old_ctx = plugin_set_ctx (ctx);
315 ret_val = plugin_load (name, (uint32_t) flags);
316 /* reset to the "global" context */
317 plugin_set_ctx (old_ctx);
320 } /* int dispatch_value_loadplugin */
322 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
330 buffer_free = sizeof (buffer);
332 for (i = 0; i < ci->values_num; i++)
336 if (ci->values[i].type == OCONFIG_TYPE_STRING)
337 status = ssnprintf (buffer_ptr, buffer_free, " %s",
338 ci->values[i].value.string);
339 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
340 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
341 ci->values[i].value.number);
342 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
343 status = ssnprintf (buffer_ptr, buffer_free, " %s",
344 ci->values[i].value.boolean
347 if ((status < 0) || (status >= buffer_free))
349 buffer_free -= status;
350 buffer_ptr += status;
352 /* skip the initial space */
353 buffer_ptr = buffer + 1;
355 return (cf_dispatch (plugin, ci->key, buffer_ptr));
356 } /* int dispatch_value_plugin */
358 static int dispatch_value (const oconfig_item_t *ci)
363 for (i = 0; i < cf_value_map_num; i++)
364 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
366 ret = cf_value_map[i].func (ci);
370 for (i = 0; i < cf_global_options_num; i++)
371 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
373 ret = dispatch_global_option (ci);
378 } /* int dispatch_value */
380 static int dispatch_block_plugin (oconfig_item_t *ci)
385 cf_complex_callback_t *cb;
387 if (strcasecmp (ci->key, "Plugin") != 0)
389 if (ci->values_num < 1)
391 if (ci->values[0].type != OCONFIG_TYPE_STRING)
394 name = ci->values[0].value.string;
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 /* Ignore all blocks, including `Include' blocks. */
559 if (root->children[i].children_num != 0)
562 if (strcasecmp (root->children[i].key, "Include") != 0)
565 old = root->children + i;
567 if ((old->values_num < 1) || (old->values_num > 2)
568 || (old->values[0].type != OCONFIG_TYPE_STRING)
569 || ((old->values_num == 2)
570 && (old->values[1].type != OCONFIG_TYPE_STRING)))
572 ERROR ("configfile: `Include' needs exactly one or two string argument.");
576 new = cf_read_generic (old->values[0].value.string,
577 (old->values_num == 2) ? old->values[1].value.string : NULL,
582 /* Now replace the i'th child in `root' with `new'. */
583 cf_ci_replace_child (root, new, i);
585 /* ... and go back to the new i'th child. */
590 } /* for (i = 0; i < root->children_num; i++) */
593 } /* int cf_include_all */
595 static oconfig_item_t *cf_read_file (const char *file,
596 const char *pattern, int depth)
598 oconfig_item_t *root;
600 assert (depth < CF_MAX_DEPTH);
602 if (pattern != NULL) {
603 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
604 char *tmp = sstrdup (file);
605 char *filename = basename (tmp);
607 if ((filename != NULL) && (fnmatch (pattern, filename, 0) != 0)) {
614 ERROR ("configfile: Cannot apply pattern filter '%s' "
615 "to file '%s': functions basename() and / or "
616 "fnmatch() not available.", pattern, file);
617 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
620 root = oconfig_parse_file (file);
623 ERROR ("configfile: Cannot read file `%s'.", file);
627 cf_include_all (root, depth);
630 } /* oconfig_item_t *cf_read_file */
632 static int cf_compare_string (const void *p1, const void *p2)
634 return strcmp (*(const char **) p1, *(const char **) p2);
637 static oconfig_item_t *cf_read_dir (const char *dir,
638 const char *pattern, int depth)
640 oconfig_item_t *root = NULL;
643 char **filenames = NULL;
644 int filenames_num = 0;
648 assert (depth < CF_MAX_DEPTH);
654 ERROR ("configfile: opendir failed: %s",
655 sstrerror (errno, errbuf, sizeof (errbuf)));
659 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
662 ERROR ("configfile: malloc failed.");
665 memset (root, 0, sizeof (oconfig_item_t));
667 while ((de = readdir (dh)) != NULL)
672 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
675 status = ssnprintf (name, sizeof (name), "%s/%s",
677 if ((status < 0) || ((size_t) status >= sizeof (name)))
679 ERROR ("configfile: Not including `%s/%s' because its"
680 " name is too long.",
682 for (i = 0; i < filenames_num; ++i)
690 tmp = (char **) realloc (filenames,
691 filenames_num * sizeof (*filenames));
693 ERROR ("configfile: realloc failed.");
694 for (i = 0; i < filenames_num - 1; ++i)
702 filenames[filenames_num - 1] = sstrdup (name);
705 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
708 for (i = 0; i < filenames_num; ++i)
710 oconfig_item_t *temp;
711 char *name = filenames[i];
713 temp = cf_read_generic (name, pattern, depth);
716 /* An error should already have been reported. */
721 cf_ci_append_children (root, temp);
722 sfree (temp->children);
730 } /* oconfig_item_t *cf_read_dir */
735 * Path is stat'ed and either cf_read_file or cf_read_dir is called
738 * There are two versions of this function: If `wordexp' exists shell wildcards
739 * will be expanded and the function will include all matches found. If
740 * `wordexp' (or, more precisely, it's header file) is not available the
741 * simpler function is used which does not do any such expansion.
744 static oconfig_item_t *cf_read_generic (const char *path,
745 const char *pattern, int depth)
747 oconfig_item_t *root = NULL;
749 const char *path_ptr;
753 if (depth >= CF_MAX_DEPTH)
755 ERROR ("configfile: Not including `%s' because the maximum "
756 "nesting depth has been reached.", path);
760 status = wordexp (path, &we, WRDE_NOCMD);
763 ERROR ("configfile: wordexp (%s) failed.", path);
767 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
770 ERROR ("configfile: malloc failed.");
773 memset (root, '\0', sizeof (oconfig_item_t));
775 /* wordexp() might return a sorted list already. That's not
776 * documented though, so let's make sure we get what we want. */
777 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
780 for (i = 0; i < we.we_wordc; i++)
782 oconfig_item_t *temp;
785 path_ptr = we.we_wordv[i];
787 status = stat (path_ptr, &statbuf);
791 WARNING ("configfile: stat (%s) failed: %s",
793 sstrerror (errno, errbuf, sizeof (errbuf)));
797 if (S_ISREG (statbuf.st_mode))
798 temp = cf_read_file (path_ptr, pattern, depth);
799 else if (S_ISDIR (statbuf.st_mode))
800 temp = cf_read_dir (path_ptr, pattern, depth);
803 WARNING ("configfile: %s is neither a file nor a "
813 cf_ci_append_children (root, temp);
814 sfree (temp->children);
820 if (root->children == NULL)
827 } /* oconfig_item_t *cf_read_generic */
828 /* #endif HAVE_WORDEXP_H */
830 #else /* if !HAVE_WORDEXP_H */
831 static oconfig_item_t *cf_read_generic (const char *path,
832 const char *pattern, int depth)
837 if (depth >= CF_MAX_DEPTH)
839 ERROR ("configfile: Not including `%s' because the maximum "
840 "nesting depth has been reached.", path);
844 status = stat (path, &statbuf);
848 ERROR ("configfile: stat (%s) failed: %s",
850 sstrerror (errno, errbuf, sizeof (errbuf)));
854 if (S_ISREG (statbuf.st_mode))
855 return (cf_read_file (path, pattern, depth));
856 else if (S_ISDIR (statbuf.st_mode))
857 return (cf_read_dir (path, pattern, depth));
859 ERROR ("configfile: %s is neither a file nor a directory.", path);
861 } /* oconfig_item_t *cf_read_generic */
862 #endif /* !HAVE_WORDEXP_H */
867 int global_option_set (const char *option, const char *value)
871 DEBUG ("option = %s; value = %s;", option, value);
873 for (i = 0; i < cf_global_options_num; i++)
874 if (strcasecmp (cf_global_options[i].key, option) == 0)
877 if (i >= cf_global_options_num)
880 sfree (cf_global_options[i].value);
883 cf_global_options[i].value = strdup (value);
885 cf_global_options[i].value = NULL;
890 const char *global_option_get (const char *option)
894 for (i = 0; i < cf_global_options_num; i++)
895 if (strcasecmp (cf_global_options[i].key, option) == 0)
898 if (i >= cf_global_options_num)
901 return ((cf_global_options[i].value != NULL)
902 ? cf_global_options[i].value
903 : cf_global_options[i].def);
904 } /* char *global_option_get */
906 cdtime_t cf_get_default_interval (void)
908 char const *str = global_option_get ("Interval");
909 double interval_double = COLLECTD_DEFAULT_INTERVAL;
914 double tmp = strtod (str, &endptr);
916 if ((endptr == NULL) || (endptr == str) || (*endptr != 0))
917 ERROR ("cf_get_default_interval: Unable to parse string \"%s\" "
920 ERROR ("cf_get_default_interval: Interval must be a positive number. "
921 "The current number is %g.", tmp);
923 interval_double = tmp;
926 return (DOUBLE_TO_CDTIME_T (interval_double));
927 } /* }}} cdtime_t cf_get_default_interval */
929 void cf_unregister (const char *type)
931 cf_callback_t *this, *prev;
933 for (prev = NULL, this = first_callback;
935 prev = this, this = this->next)
936 if (strcasecmp (this->type, type) == 0)
939 first_callback = this->next;
941 prev->next = this->next;
946 } /* void cf_unregister */
948 void cf_unregister_complex (const char *type)
950 cf_complex_callback_t *this, *prev;
952 for (prev = NULL, this = complex_callback_head;
954 prev = this, this = this->next)
955 if (strcasecmp (this->type, type) == 0)
958 complex_callback_head = this->next;
960 prev->next = this->next;
966 } /* void cf_unregister */
968 void cf_register (const char *type,
969 int (*callback) (const char *, const char *),
970 const char **keys, int keys_num)
972 cf_callback_t *cf_cb;
974 /* Remove this module from the list, if it already exists */
975 cf_unregister (type);
977 /* This pointer will be free'd in `cf_unregister' */
978 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
982 cf_cb->callback = callback;
984 cf_cb->keys_num = keys_num;
985 cf_cb->ctx = plugin_get_ctx ();
987 cf_cb->next = first_callback;
988 first_callback = cf_cb;
989 } /* void cf_register */
991 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
993 cf_complex_callback_t *new;
995 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
999 new->type = strdup (type);
1000 if (new->type == NULL)
1006 new->callback = callback;
1009 new->ctx = plugin_get_ctx ();
1011 if (complex_callback_head == NULL)
1013 complex_callback_head = new;
1017 cf_complex_callback_t *last = complex_callback_head;
1018 while (last->next != NULL)
1024 } /* int cf_register_complex */
1026 int cf_read (char *filename)
1028 oconfig_item_t *conf;
1031 conf = cf_read_generic (filename, /* pattern = */ NULL, /* depth = */ 0);
1034 ERROR ("Unable to read config file %s.", filename);
1038 for (i = 0; i < conf->children_num; i++)
1040 if (conf->children[i].children == NULL)
1041 dispatch_value (conf->children + i);
1043 dispatch_block (conf->children + i);
1046 oconfig_free (conf);
1048 /* Read the default types.db if no `TypesDB' option was given. */
1049 if (cf_default_typesdb)
1050 read_types_list (PKGDATADIR"/types.db");
1055 /* Assures the config option is a string, duplicates it and returns the copy in
1056 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1058 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1062 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1064 ERROR ("cf_util_get_string: The %s option requires "
1065 "exactly one string argument.", ci->key);
1069 string = strdup (ci->values[0].value.string);
1073 if (*ret_string != NULL)
1074 sfree (*ret_string);
1075 *ret_string = string;
1078 } /* }}} int cf_util_get_string */
1080 /* Assures the config option is a string and copies it to the provided buffer.
1081 * Assures null-termination. */
1082 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer, /* {{{ */
1085 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1088 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1090 ERROR ("cf_util_get_string_buffer: The %s option requires "
1091 "exactly one string argument.", ci->key);
1095 strncpy (buffer, ci->values[0].value.string, buffer_size);
1096 buffer[buffer_size - 1] = 0;
1099 } /* }}} int cf_util_get_string_buffer */
1101 /* Assures the config option is a number and returns it as an int. */
1102 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value) /* {{{ */
1104 if ((ci == NULL) || (ret_value == NULL))
1107 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1109 ERROR ("cf_util_get_int: The %s option requires "
1110 "exactly one numeric argument.", ci->key);
1114 *ret_value = (int) ci->values[0].value.number;
1117 } /* }}} int cf_util_get_int */
1119 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value) /* {{{ */
1121 if ((ci == NULL) || (ret_value == NULL))
1124 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1126 ERROR ("cf_util_get_double: The %s option requires "
1127 "exactly one numeric argument.", ci->key);
1131 *ret_value = ci->values[0].value.number;
1134 } /* }}} int cf_util_get_double */
1136 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1138 if ((ci == NULL) || (ret_bool == NULL))
1141 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1143 ERROR ("cf_util_get_boolean: The %s option requires "
1144 "exactly one boolean argument.", ci->key);
1148 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1151 } /* }}} int cf_util_get_boolean */
1153 int cf_util_get_flag (const oconfig_item_t *ci, /* {{{ */
1154 unsigned int *ret_value, unsigned int flag)
1159 if (ret_value == NULL)
1163 status = cf_util_get_boolean (ci, &b);
1173 *ret_value &= ~flag;
1177 } /* }}} int cf_util_get_flag */
1179 /* Assures that the config option is a string or a number if the correct range
1180 * of 1-65535. The string is then converted to a port number using
1181 * `service_name_to_port_number' and returned.
1182 * Returns the port number in the range [1-65535] or less than zero upon
1184 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
1188 if ((ci->values_num != 1)
1189 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
1190 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
1192 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1193 "exactly one string argument.", ci->key);
1197 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1198 return (service_name_to_port_number (ci->values[0].value.string));
1200 assert (ci->values[0].type == OCONFIG_TYPE_NUMBER);
1201 tmp = (int) (ci->values[0].value.number + 0.5);
1202 if ((tmp < 1) || (tmp > 65535))
1204 ERROR ("cf_util_get_port_number: The \"%s\" option requires "
1205 "a service name or a port number. The number "
1206 "you specified, %i, is not in the valid "
1207 "range of 1-65535.",
1213 } /* }}} int cf_util_get_port_number */
1215 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string) /* {{{ */
1221 if (ci->values_num != 1)
1223 ERROR ("cf_util_get_service: The %s option requires exactly "
1224 "one argument.", ci->key);
1228 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1229 return (cf_util_get_string (ci, ret_string));
1230 if (ci->values[0].type != OCONFIG_TYPE_NUMBER)
1232 ERROR ("cf_util_get_service: The %s option requires "
1233 "exactly one string or numeric argument.",
1238 status = cf_util_get_int (ci, &port);
1241 else if ((port < 1) || (port > 65535))
1243 ERROR ("cf_util_get_service: The port number given "
1244 "for the %s option is out of "
1245 "range (%i).", ci->key, port);
1249 service = malloc (6);
1250 if (service == NULL)
1252 ERROR ("cf_util_get_service: Out of memory.");
1255 ssnprintf (service, 6, "%i", port);
1257 sfree (*ret_string);
1258 *ret_string = service;
1261 } /* }}} int cf_util_get_service */
1263 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1265 if ((ci == NULL) || (ret_value == NULL))
1268 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
1270 ERROR ("cf_util_get_cdtime: The %s option requires "
1271 "exactly one numeric argument.", ci->key);
1275 if (ci->values[0].value.number < 0.0)
1277 ERROR ("cf_util_get_cdtime: The numeric argument of the %s "
1278 "option must not be negative.", ci->key);
1282 *ret_value = DOUBLE_TO_CDTIME_T (ci->values[0].value.number);
1285 } /* }}} int cf_util_get_cdtime */