1 /**
2 * collectd - src/configfile.c
3 * Copyright (C) 2005-2011 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian tokkee Harl <sh at tokkee.org>
26 **/
28 #include "collectd.h"
30 #include "liboconfig/oconfig.h"
32 #include "common.h"
33 #include "configfile.h"
34 #include "filter_chain.h"
35 #include "plugin.h"
36 #include "types_list.h"
38 #if HAVE_WORDEXP_H
39 #include <wordexp.h>
40 #endif /* HAVE_WORDEXP_H */
42 #if HAVE_FNMATCH_H
43 #include <fnmatch.h>
44 #endif /* HAVE_FNMATCH_H */
46 #if HAVE_LIBGEN_H
47 #include <libgen.h>
48 #endif /* HAVE_LIBGEN_H */
50 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
52 /*
53 * Private types
54 */
55 typedef struct cf_callback {
56 const char *type;
57 int (*callback)(const char *, const char *);
58 const char **keys;
59 int keys_num;
60 plugin_ctx_t ctx;
61 struct cf_callback *next;
62 } cf_callback_t;
64 typedef struct cf_complex_callback_s {
65 char *type;
66 int (*callback)(oconfig_item_t *);
67 plugin_ctx_t ctx;
68 struct cf_complex_callback_s *next;
69 } cf_complex_callback_t;
71 typedef struct cf_value_map_s {
72 const char *key;
73 int (*func)(oconfig_item_t *);
74 } cf_value_map_t;
76 typedef struct cf_global_option_s {
77 const char *key;
78 char *value;
79 _Bool from_cli; /* value set from CLI */
80 const char *def;
81 } cf_global_option_t;
83 /*
84 * Prototypes of callback functions
85 */
86 static int dispatch_value_typesdb(oconfig_item_t *ci);
87 static int dispatch_value_plugindir(oconfig_item_t *ci);
88 static int dispatch_loadplugin(oconfig_item_t *ci);
89 static int dispatch_block_plugin(oconfig_item_t *ci);
91 /*
92 * Private variables
93 */
94 static cf_callback_t *first_callback = NULL;
95 static cf_complex_callback_t *complex_callback_head = NULL;
97 static cf_value_map_t cf_value_map[] = {{"TypesDB", dispatch_value_typesdb},
98 {"PluginDir", dispatch_value_plugindir},
99 {"LoadPlugin", dispatch_loadplugin},
100 {"Plugin", dispatch_block_plugin}};
101 static int cf_value_map_num = STATIC_ARRAY_SIZE(cf_value_map);
103 static cf_global_option_t cf_global_options[] = {
104 {"BaseDir", NULL, 0, PKGLOCALSTATEDIR},
105 {"PIDFile", NULL, 0, PIDFILE},
106 {"Hostname", NULL, 0, NULL},
107 {"FQDNLookup", NULL, 0, "true"},
108 {"Interval", NULL, 0, NULL},
109 {"ReadThreads", NULL, 0, "5"},
110 {"WriteThreads", NULL, 0, "5"},
111 {"WriteQueueLimitHigh", NULL, 0, NULL},
112 {"WriteQueueLimitLow", NULL, 0, NULL},
113 {"Timeout", NULL, 0, "2"},
114 {"AutoLoadPlugin", NULL, 0, "false"},
115 {"CollectInternalStats", NULL, 0, "false"},
116 {"PreCacheChain", NULL, 0, "PreCache"},
117 {"PostCacheChain", NULL, 0, "PostCache"},
118 {"MaxReadInterval", NULL, 0, "86400"}};
119 static int cf_global_options_num = STATIC_ARRAY_SIZE(cf_global_options);
121 static int cf_default_typesdb = 1;
123 /*
124 * Functions to handle register/unregister, search, and other plugin related
125 * stuff
126 */
127 static cf_callback_t *cf_search(const char *type) {
128 cf_callback_t *cf_cb;
130 if (type == NULL)
131 return NULL;
133 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
134 if (strcasecmp(cf_cb->type, type) == 0)
135 break;
137 return cf_cb;
138 }
140 static int cf_dispatch(const char *type, const char *orig_key,
141 const char *orig_value) {
142 cf_callback_t *cf_cb;
143 plugin_ctx_t old_ctx;
144 char *key;
145 char *value;
146 int ret;
147 int i = 0;
149 if (orig_key == NULL)
150 return EINVAL;
152 DEBUG("type = %s, key = %s, value = %s", ESCAPE_NULL(type), orig_key,
153 ESCAPE_NULL(orig_value));
155 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.",
159 type);
160 return -1;
161 }
163 if ((key = strdup(orig_key)) == NULL)
164 return 1;
165 if ((value = strdup(orig_value)) == NULL) {
166 free(key);
167 return 2;
168 }
170 ret = -1;
172 old_ctx = plugin_set_ctx(cf_cb->ctx);
174 for (i = 0; i < cf_cb->keys_num; i++) {
175 if ((cf_cb->keys[i] != NULL) && (strcasecmp(cf_cb->keys[i], key) == 0)) {
176 ret = (*cf_cb->callback)(key, value);
177 break;
178 }
179 }
181 plugin_set_ctx(old_ctx);
183 if (i >= cf_cb->keys_num)
184 WARNING("Plugin `%s' did not register for value `%s'.", type, key);
186 free(key);
187 free(value);
189 return ret;
190 } /* int cf_dispatch */
192 static int dispatch_global_option(const oconfig_item_t *ci) {
193 if (ci->values_num != 1)
194 return -1;
195 if (ci->values[0].type == OCONFIG_TYPE_STRING)
196 return global_option_set(ci->key, ci->values[0].value.string, 0);
197 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER) {
198 char tmp[128];
199 snprintf(tmp, sizeof(tmp), "%lf", ci->values[0].value.number);
200 return global_option_set(ci->key, tmp, 0);
201 } else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN) {
202 if (ci->values[0].value.boolean)
203 return global_option_set(ci->key, "true", 0);
204 else
205 return global_option_set(ci->key, "false", 0);
206 }
208 return -1;
209 } /* int dispatch_global_option */
211 static int dispatch_value_typesdb(oconfig_item_t *ci) {
212 assert(strcasecmp(ci->key, "TypesDB") == 0);
214 cf_default_typesdb = 0;
216 if (ci->values_num < 1) {
217 ERROR("configfile: `TypesDB' needs at least one argument.");
218 return -1;
219 }
221 for (int i = 0; i < ci->values_num; ++i) {
222 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
223 WARNING("configfile: TypesDB: Skipping %i. argument which "
224 "is not a string.",
225 i + 1);
226 continue;
227 }
229 read_types_list(ci->values[i].value.string);
230 }
231 return 0;
232 } /* int dispatch_value_typesdb */
234 static int dispatch_value_plugindir(oconfig_item_t *ci) {
235 assert(strcasecmp(ci->key, "PluginDir") == 0);
237 if (ci->values_num != 1)
238 return -1;
239 if (ci->values[0].type != OCONFIG_TYPE_STRING)
240 return -1;
242 plugin_set_dir(ci->values[0].value.string);
243 return 0;
244 }
246 static int dispatch_loadplugin(oconfig_item_t *ci) {
247 const char *name;
248 _Bool global = 0;
249 plugin_ctx_t ctx = {0};
250 plugin_ctx_t old_ctx;
251 int ret_val;
253 assert(strcasecmp(ci->key, "LoadPlugin") == 0);
255 if (ci->values_num != 1)
256 return -1;
257 if (ci->values[0].type != OCONFIG_TYPE_STRING)
258 return -1;
260 name = ci->values[0].value.string;
261 if (strcmp("libvirt", name) == 0)
262 name = "virt";
264 /* default to the global interval set before loading this plugin */
265 ctx.interval = cf_get_default_interval();
266 ctx.flush_interval = 0;
267 ctx.flush_timeout = 0;
269 for (int i = 0; i < ci->children_num; ++i) {
270 oconfig_item_t *child = ci->children + i;
272 if (strcasecmp("Globals", child->key) == 0)
273 cf_util_get_boolean(child, &global);
274 else if (strcasecmp("Interval", child->key) == 0)
275 cf_util_get_cdtime(child, &ctx.interval);
276 else if (strcasecmp("FlushInterval", child->key) == 0)
277 cf_util_get_cdtime(child, &ctx.flush_interval);
278 else if (strcasecmp("FlushTimeout", child->key) == 0)
279 cf_util_get_cdtime(child, &ctx.flush_timeout);
280 else {
281 WARNING("Ignoring unknown LoadPlugin option \"%s\" "
282 "for plugin \"%s\"",
283 child->key, ci->values[0].value.string);
284 }
285 }
287 old_ctx = plugin_set_ctx(ctx);
288 ret_val = plugin_load(name, global);
289 /* reset to the "global" context */
290 plugin_set_ctx(old_ctx);
292 return ret_val;
293 } /* int dispatch_value_loadplugin */
295 static int dispatch_value_plugin(const char *plugin, oconfig_item_t *ci) {
296 char buffer[4096];
297 char *buffer_ptr;
298 int buffer_free;
300 buffer_ptr = buffer;
301 buffer_free = sizeof(buffer);
303 for (int i = 0; i < ci->values_num; i++) {
304 int status = -1;
306 if (ci->values[i].type == OCONFIG_TYPE_STRING)
307 status =
308 snprintf(buffer_ptr, buffer_free, " %s", ci->values[i].value.string);
309 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
310 status =
311 snprintf(buffer_ptr, buffer_free, " %lf", ci->values[i].value.number);
312 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
313 status = snprintf(buffer_ptr, buffer_free, " %s",
314 ci->values[i].value.boolean ? "true" : "false");
316 if ((status < 0) || (status >= buffer_free))
317 return -1;
318 buffer_free -= status;
319 buffer_ptr += status;
320 }
321 /* skip the initial space */
322 buffer_ptr = buffer + 1;
324 return cf_dispatch(plugin, ci->key, buffer_ptr);
325 } /* int dispatch_value_plugin */
327 static int dispatch_value(oconfig_item_t *ci) {
328 int ret = 0;
330 for (int i = 0; i < cf_value_map_num; i++)
331 if (strcasecmp(cf_value_map[i].key, ci->key) == 0) {
332 ret = cf_value_map[i].func(ci);
333 break;
334 }
336 for (int i = 0; i < cf_global_options_num; i++)
337 if (strcasecmp(cf_global_options[i].key, ci->key) == 0) {
338 ret = dispatch_global_option(ci);
339 break;
340 }
342 return ret;
343 } /* int dispatch_value */
345 static int dispatch_block_plugin(oconfig_item_t *ci) {
346 const char *name;
348 if (strcasecmp(ci->key, "Plugin") != 0)
349 return -1;
350 if (ci->values_num < 1)
351 return -1;
352 if (ci->values[0].type != OCONFIG_TYPE_STRING)
353 return -1;
355 name = ci->values[0].value.string;
356 if (strcmp("libvirt", name) == 0) {
357 /* TODO(octo): Remove this legacy. */
358 WARNING("The \"libvirt\" plugin has been renamed to \"virt\" to avoid "
359 "problems with the build system. "
360 "Your configuration is still using the old name. "
361 "Please change it to use \"virt\" as soon as possible. "
362 "This compatibility code will go away eventually.");
363 name = "virt";
364 }
366 if (IS_TRUE(global_option_get("AutoLoadPlugin"))) {
367 plugin_ctx_t ctx = {0};
368 plugin_ctx_t old_ctx;
369 int status;
371 /* default to the global interval set before loading this plugin */
372 ctx.interval = cf_get_default_interval();
374 old_ctx = plugin_set_ctx(ctx);
375 status = plugin_load(name, /* flags = */ 0);
376 /* reset to the "global" context */
377 plugin_set_ctx(old_ctx);
379 if (status != 0) {
380 ERROR("Automatically loading plugin \"%s\" failed "
381 "with status %i.",
382 name, status);
383 return status;
384 }
385 }
387 /* Check for a complex callback first */
388 for (cf_complex_callback_t *cb = complex_callback_head; cb != NULL;
389 cb = cb->next) {
390 if (strcasecmp(name, cb->type) == 0) {
391 plugin_ctx_t old_ctx;
392 int ret_val;
394 old_ctx = plugin_set_ctx(cb->ctx);
395 ret_val = (cb->callback(ci));
396 plugin_set_ctx(old_ctx);
397 return ret_val;
398 }
399 }
401 /* Hm, no complex plugin found. Dispatch the values one by one */
402 for (int i = 0; i < ci->children_num; i++) {
403 if (ci->children[i].children == NULL)
404 dispatch_value_plugin(name, ci->children + i);
405 else {
406 WARNING("There is a `%s' block within the "
407 "configuration for the %s plugin. "
408 "The plugin either only expects "
409 "\"simple\" configuration statements "
410 "or wasn't loaded using `LoadPlugin'."
411 " Please check your configuration.",
412 ci->children[i].key, name);
413 }
414 }
416 return 0;
417 }
419 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);
427 return 0;
428 }
430 static int cf_ci_replace_child(oconfig_item_t *dst, oconfig_item_t *src,
431 int offset) {
432 oconfig_item_t *temp;
434 assert(offset >= 0);
435 assert(dst->children_num > offset);
437 /* Free the memory used by the replaced child. Usually that's the
438 * `Include "blah"' statement. */
439 temp = dst->children + offset;
440 for (int i = 0; i < temp->values_num; i++) {
441 if (temp->values[i].type == OCONFIG_TYPE_STRING) {
442 sfree(temp->values[i].value.string);
443 }
444 }
445 sfree(temp->values);
446 temp = NULL;
448 /* If (src->children_num == 0) the array size is decreased. If offset
449 * is _not_ the last element, (offset < (dst->children_num - 1)), then
450 * we need to move the trailing elements before resizing the array. */
451 if ((src->children_num == 0) && (offset < (dst->children_num - 1))) {
452 int nmemb = dst->children_num - (offset + 1);
453 memmove(dst->children + offset, dst->children + offset + 1,
454 sizeof(oconfig_item_t) * nmemb);
455 }
457 /* Resize the memory containing the children to be big enough to hold
458 * all children. */
459 if (dst->children_num + src->children_num - 1 == 0) {
460 dst->children_num = 0;
461 return 0;
462 }
464 temp = realloc(dst->children,
465 sizeof(oconfig_item_t) *
466 (dst->children_num + src->children_num - 1));
467 if (temp == NULL) {
468 ERROR("configfile: realloc failed.");
469 return -1;
470 }
471 dst->children = temp;
473 /* If there are children behind the include statement, and they have
474 * not yet been moved because (src->children_num == 0), then move them
475 * to the end of the list, so that the new children have room before
476 * them. */
477 if ((src->children_num > 0) && ((dst->children_num - (offset + 1)) > 0)) {
478 int nmemb = dst->children_num - (offset + 1);
479 int old_offset = offset + 1;
480 int new_offset = offset + src->children_num;
482 memmove(dst->children + new_offset, dst->children + old_offset,
483 sizeof(oconfig_item_t) * nmemb);
484 }
486 /* Last but not least: If there are new children, copy them to the
487 * memory reserved for them. */
488 if (src->children_num > 0) {
489 memcpy(dst->children + offset, src->children,
490 sizeof(oconfig_item_t) * src->children_num);
491 }
493 /* Update the number of children. */
494 dst->children_num += (src->children_num - 1);
496 return 0;
497 } /* int cf_ci_replace_child */
499 static int cf_ci_append_children(oconfig_item_t *dst, oconfig_item_t *src) {
500 oconfig_item_t *temp;
502 if ((src == NULL) || (src->children_num == 0))
503 return 0;
505 temp =
506 realloc(dst->children,
507 sizeof(oconfig_item_t) * (dst->children_num + src->children_num));
508 if (temp == NULL) {
509 ERROR("configfile: realloc failed.");
510 return -1;
511 }
512 dst->children = temp;
514 memcpy(dst->children + dst->children_num, src->children,
515 sizeof(oconfig_item_t) * src->children_num);
516 dst->children_num += src->children_num;
518 return 0;
519 } /* int cf_ci_append_children */
521 #define CF_MAX_DEPTH 8
522 static oconfig_item_t *cf_read_generic(const char *path, const char *pattern,
523 int depth);
525 static int cf_include_all(oconfig_item_t *root, int depth) {
526 for (int i = 0; i < root->children_num; i++) {
527 oconfig_item_t *new;
528 oconfig_item_t *old;
530 char *pattern = NULL;
532 if (strcasecmp(root->children[i].key, "Include") != 0)
533 continue;
535 old = root->children + i;
537 if ((old->values_num != 1) ||
538 (old->values[0].type != OCONFIG_TYPE_STRING)) {
539 ERROR("configfile: `Include' needs exactly one string argument.");
540 continue;
541 }
543 for (int j = 0; j < old->children_num; ++j) {
544 oconfig_item_t *child = old->children + j;
546 if (strcasecmp(child->key, "Filter") == 0)
547 cf_util_get_string(child, &pattern);
548 else
549 ERROR("configfile: Option `%s' not allowed in <Include> block.",
550 child->key);
551 }
553 new = cf_read_generic(old->values[0].value.string, pattern, depth + 1);
554 sfree(pattern);
556 if (new == NULL)
557 return -1;
559 /* Now replace the i'th child in `root' with `new'. */
560 if (cf_ci_replace_child(root, new, i) < 0) {
561 sfree(new->values);
562 sfree(new);
563 return -1;
564 }
566 /* ... and go back to the new i'th child. */
567 --i;
569 sfree(new->values);
570 sfree(new);
571 } /* for (i = 0; i < root->children_num; i++) */
573 return 0;
574 } /* int cf_include_all */
576 static oconfig_item_t *cf_read_file(const char *file, const char *pattern,
577 int depth) {
578 oconfig_item_t *root;
579 int status;
581 assert(depth < CF_MAX_DEPTH);
583 if (pattern != NULL) {
584 #if HAVE_FNMATCH_H && HAVE_LIBGEN_H
585 char *tmp = sstrdup(file);
586 char *filename = basename(tmp);
588 if ((filename != NULL) && (fnmatch(pattern, filename, 0) != 0)) {
589 DEBUG("configfile: Not including `%s' because it "
590 "does not match pattern `%s'.",
591 filename, pattern);
592 free(tmp);
593 return NULL;
594 }
596 free(tmp);
597 #else
598 ERROR("configfile: Cannot apply pattern filter '%s' "
599 "to file '%s': functions basename() and / or "
600 "fnmatch() not available.",
601 pattern, file);
602 #endif /* HAVE_FNMATCH_H && HAVE_LIBGEN_H */
603 }
605 root = oconfig_parse_file(file);
606 if (root == NULL) {
607 ERROR("configfile: Cannot read file `%s'.", file);
608 return NULL;
609 }
611 status = cf_include_all(root, depth);
612 if (status != 0) {
613 oconfig_free(root);
614 return NULL;
615 }
617 return root;
618 } /* oconfig_item_t *cf_read_file */
620 static int cf_compare_string(const void *p1, const void *p2) {
621 return strcmp(*(const char **)p1, *(const char **)p2);
622 }
624 static oconfig_item_t *cf_read_dir(const char *dir, const char *pattern,
625 int depth) {
626 oconfig_item_t *root = NULL;
627 DIR *dh;
628 struct dirent *de;
629 char **filenames = NULL;
630 int filenames_num = 0;
631 int status;
633 assert(depth < CF_MAX_DEPTH);
635 dh = opendir(dir);
636 if (dh == NULL) {
637 char errbuf[1024];
638 ERROR("configfile: opendir failed: %s",
639 sstrerror(errno, errbuf, sizeof(errbuf)));
640 return NULL;
641 }
643 root = calloc(1, sizeof(*root));
644 if (root == NULL) {
645 ERROR("configfile: calloc failed.");
646 closedir(dh);
647 return NULL;
648 }
650 while ((de = readdir(dh)) != NULL) {
651 char name[1024];
652 char **tmp;
654 if ((de->d_name[0] == '.') || (de->d_name[0] == 0))
655 continue;
657 status = snprintf(name, sizeof(name), "%s/%s", dir, de->d_name);
658 if ((status < 0) || ((size_t)status >= sizeof(name))) {
659 ERROR("configfile: Not including `%s/%s' because its"
660 " name is too long.",
661 dir, de->d_name);
662 closedir(dh);
663 for (int i = 0; i < filenames_num; ++i)
664 free(filenames[i]);
665 free(filenames);
666 free(root);
667 return NULL;
668 }
670 ++filenames_num;
671 tmp = realloc(filenames, filenames_num * sizeof(*filenames));
672 if (tmp == NULL) {
673 ERROR("configfile: realloc failed.");
674 closedir(dh);
675 for (int i = 0; i < filenames_num - 1; ++i)
676 free(filenames[i]);
677 free(filenames);
678 free(root);
679 return NULL;
680 }
681 filenames = tmp;
683 filenames[filenames_num - 1] = sstrdup(name);
684 }
686 if (filenames == NULL) {
687 closedir(dh);
688 return root;
689 }
691 qsort((void *)filenames, filenames_num, sizeof(*filenames),
692 cf_compare_string);
694 for (int i = 0; i < filenames_num; ++i) {
695 oconfig_item_t *temp;
696 char *name = filenames[i];
698 temp = cf_read_generic(name, pattern, depth);
699 if (temp == NULL) {
700 /* An error should already have been reported. */
701 sfree(name);
702 continue;
703 }
705 cf_ci_append_children(root, temp);
706 sfree(temp->children);
707 sfree(temp);
709 free(name);
710 }
712 closedir(dh);
713 free(filenames);
714 return root;
715 } /* oconfig_item_t *cf_read_dir */
717 /*
718 * cf_read_generic
719 *
720 * Path is stat'ed and either cf_read_file or cf_read_dir is called
721 * accordingly.
722 *
723 * There are two versions of this function: If `wordexp' exists shell wildcards
724 * will be expanded and the function will include all matches found. If
725 * `wordexp' (or, more precisely, its header file) is not available the
726 * simpler function is used which does not do any such expansion.
727 */
728 #if HAVE_WORDEXP_H
729 static oconfig_item_t *cf_read_generic(const char *path, const char *pattern,
730 int depth) {
731 oconfig_item_t *root = NULL;
732 int status;
733 const char *path_ptr;
734 wordexp_t we;
736 if (depth >= CF_MAX_DEPTH) {
737 ERROR("configfile: Not including `%s' because the maximum "
738 "nesting depth has been reached.",
739 path);
740 return NULL;
741 }
743 status = wordexp(path, &we, WRDE_NOCMD);
744 if (status != 0) {
745 ERROR("configfile: wordexp (%s) failed.", path);
746 return NULL;
747 }
749 root = calloc(1, sizeof(*root));
750 if (root == NULL) {
751 ERROR("configfile: calloc failed.");
752 return NULL;
753 }
755 /* wordexp() might return a sorted list already. That's not
756 * documented though, so let's make sure we get what we want. */
757 qsort((void *)we.we_wordv, we.we_wordc, sizeof(*we.we_wordv),
758 cf_compare_string);
760 for (size_t i = 0; i < we.we_wordc; i++) {
761 oconfig_item_t *temp;
762 struct stat statbuf;
764 path_ptr = we.we_wordv[i];
766 status = stat(path_ptr, &statbuf);
767 if (status != 0) {
768 char errbuf[1024];
769 WARNING("configfile: stat (%s) failed: %s", path_ptr,
770 sstrerror(errno, errbuf, sizeof(errbuf)));
771 continue;
772 }
774 if (S_ISREG(statbuf.st_mode))
775 temp = cf_read_file(path_ptr, pattern, depth);
776 else if (S_ISDIR(statbuf.st_mode))
777 temp = cf_read_dir(path_ptr, pattern, depth);
778 else {
779 WARNING("configfile: %s is neither a file nor a "
780 "directory.",
781 path);
782 continue;
783 }
785 if (temp == NULL) {
786 oconfig_free(root);
787 return NULL;
788 }
790 cf_ci_append_children(root, temp);
791 sfree(temp->children);
792 sfree(temp);
793 }
795 wordfree(&we);
797 return root;
798 } /* oconfig_item_t *cf_read_generic */
799 /* #endif HAVE_WORDEXP_H */
801 #else /* if !HAVE_WORDEXP_H */
802 static oconfig_item_t *cf_read_generic(const char *path, const char *pattern,
803 int depth) {
804 struct stat statbuf;
805 int status;
807 if (depth >= CF_MAX_DEPTH) {
808 ERROR("configfile: Not including `%s' because the maximum "
809 "nesting depth has been reached.",
810 path);
811 return NULL;
812 }
814 status = stat(path, &statbuf);
815 if (status != 0) {
816 char errbuf[1024];
817 ERROR("configfile: stat (%s) failed: %s", path,
818 sstrerror(errno, errbuf, sizeof(errbuf)));
819 return NULL;
820 }
822 if (S_ISREG(statbuf.st_mode))
823 return cf_read_file(path, pattern, depth);
824 else if (S_ISDIR(statbuf.st_mode))
825 return cf_read_dir(path, pattern, depth);
827 ERROR("configfile: %s is neither a file nor a directory.", path);
828 return NULL;
829 } /* oconfig_item_t *cf_read_generic */
830 #endif /* !HAVE_WORDEXP_H */
832 /*
833 * Public functions
834 */
835 int global_option_set(const char *option, const char *value, _Bool from_cli) {
836 int i;
837 DEBUG("option = %s; value = %s;", option, value);
839 for (i = 0; i < cf_global_options_num; i++)
840 if (strcasecmp(cf_global_options[i].key, option) == 0)
841 break;
843 if (i >= cf_global_options_num) {
844 ERROR("configfile: Cannot set unknown global option `%s'.", option);
845 return -1;
846 }
848 if (cf_global_options[i].from_cli && (!from_cli)) {
849 DEBUG("configfile: Ignoring %s `%s' option because "
850 "it was overriden by a command-line option.",
851 option, value);
852 return 0;
853 }
855 sfree(cf_global_options[i].value);
857 if (value != NULL)
858 cf_global_options[i].value = strdup(value);
859 else
860 cf_global_options[i].value = NULL;
862 cf_global_options[i].from_cli = from_cli;
864 return 0;
865 }
867 const char *global_option_get(const char *option) {
868 int i;
869 for (i = 0; i < cf_global_options_num; i++)
870 if (strcasecmp(cf_global_options[i].key, option) == 0)
871 break;
873 if (i >= cf_global_options_num) {
874 ERROR("configfile: Cannot get unknown global option `%s'.", option);
875 return NULL;
876 }
878 return (cf_global_options[i].value != NULL) ? cf_global_options[i].value
879 : cf_global_options[i].def;
880 } /* char *global_option_get */
882 long global_option_get_long(const char *option, long default_value) {
883 const char *str;
884 long value;
886 str = global_option_get(option);
887 if (NULL == str)
888 return default_value;
890 errno = 0;
891 value = strtol(str, /* endptr = */ NULL, /* base = */ 0);
892 if (errno != 0)
893 return default_value;
895 return value;
896 } /* char *global_option_get_long */
898 cdtime_t global_option_get_time(const char *name, cdtime_t def) /* {{{ */
899 {
900 char const *optstr;
901 char *endptr = NULL;
902 double v;
904 optstr = global_option_get(name);
905 if (optstr == NULL)
906 return def;
908 errno = 0;
909 v = strtod(optstr, &endptr);
910 if ((endptr == NULL) || (*endptr != 0) || (errno != 0))
911 return def;
912 else if (v <= 0.0)
913 return def;
915 return DOUBLE_TO_CDTIME_T(v);
916 } /* }}} cdtime_t global_option_get_time */
918 cdtime_t cf_get_default_interval(void) {
919 return global_option_get_time("Interval",
920 DOUBLE_TO_CDTIME_T(COLLECTD_DEFAULT_INTERVAL));
921 }
923 void cf_unregister(const char *type) {
924 for (cf_callback_t *prev = NULL, *this = first_callback; this != NULL;
925 prev = this, this = this->next)
926 if (strcasecmp(this->type, type) == 0) {
927 if (prev == NULL)
928 first_callback = this->next;
929 else
930 prev->next = this->next;
932 free(this);
933 break;
934 }
935 } /* void cf_unregister */
937 void cf_unregister_complex(const char *type) {
938 for (cf_complex_callback_t *prev = NULL, *this = complex_callback_head;
939 this != NULL; prev = this, this = this->next)
940 if (strcasecmp(this->type, type) == 0) {
941 if (prev == NULL)
942 complex_callback_head = this->next;
943 else
944 prev->next = this->next;
946 sfree(this->type);
947 sfree(this);
948 break;
949 }
950 } /* void cf_unregister */
952 void cf_register(const char *type, int (*callback)(const char *, const char *),
953 const char **keys, int keys_num) {
954 cf_callback_t *cf_cb;
956 /* Remove this module from the list, if it already exists */
957 cf_unregister(type);
959 /* This pointer will be free'd in `cf_unregister' */
960 if ((cf_cb = malloc(sizeof(*cf_cb))) == NULL)
961 return;
963 cf_cb->type = type;
964 cf_cb->callback = callback;
965 cf_cb->keys = keys;
966 cf_cb->keys_num = keys_num;
967 cf_cb->ctx = plugin_get_ctx();
969 cf_cb->next = first_callback;
970 first_callback = cf_cb;
971 } /* void cf_register */
973 int cf_register_complex(const char *type, int (*callback)(oconfig_item_t *)) {
974 cf_complex_callback_t *new;
976 new = malloc(sizeof(*new));
977 if (new == NULL)
978 return -1;
980 new->type = strdup(type);
981 if (new->type == NULL) {
982 sfree(new);
983 return -1;
984 }
986 new->callback = callback;
987 new->next = NULL;
989 new->ctx = plugin_get_ctx();
991 if (complex_callback_head == NULL) {
992 complex_callback_head = new;
993 } else {
994 cf_complex_callback_t *last = complex_callback_head;
995 while (last->next != NULL)
996 last = last->next;
997 last->next = new;
998 }
1000 return 0;
1001 } /* int cf_register_complex */
1003 int cf_read(const char *filename) {
1004 oconfig_item_t *conf;
1005 int ret = 0;
1007 conf = cf_read_generic(filename, /* pattern = */ NULL, /* depth = */ 0);
1008 if (conf == NULL) {
1009 ERROR("Unable to read config file %s.", filename);
1010 return -1;
1011 } else if (conf->children_num == 0) {
1012 ERROR("Configuration file %s is empty.", filename);
1013 oconfig_free(conf);
1014 return -1;
1015 }
1017 for (int i = 0; i < conf->children_num; i++) {
1018 if (conf->children[i].children == NULL) {
1019 if (dispatch_value(conf->children + i) != 0)
1020 ret = -1;
1021 } else {
1022 if (dispatch_block(conf->children + i) != 0)
1023 ret = -1;
1024 }
1025 }
1027 oconfig_free(conf);
1029 /* Read the default types.db if no `TypesDB' option was given. */
1030 if (cf_default_typesdb) {
1031 if (read_types_list(PKGDATADIR "/types.db") != 0)
1032 ret = -1;
1033 }
1035 return ret;
1037 } /* int cf_read */
1039 /* Assures the config option is a string, duplicates it and returns the copy in
1040 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
1041 * success. */
1042 int cf_util_get_string(const oconfig_item_t *ci, char **ret_string) /* {{{ */
1043 {
1044 char *string;
1046 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1047 ERROR("cf_util_get_string: The %s option requires "
1048 "exactly one string argument.",
1049 ci->key);
1050 return -1;
1051 }
1053 string = strdup(ci->values[0].value.string);
1054 if (string == NULL)
1055 return -1;
1057 if (*ret_string != NULL)
1058 sfree(*ret_string);
1059 *ret_string = string;
1061 return 0;
1062 } /* }}} int cf_util_get_string */
1064 /* Assures the config option is a string and copies it to the provided buffer.
1065 * Assures null-termination. */
1066 int cf_util_get_string_buffer(const oconfig_item_t *ci, char *buffer, /* {{{ */
1067 size_t buffer_size) {
1068 if ((ci == NULL) || (buffer == NULL) || (buffer_size < 1))
1069 return EINVAL;
1071 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1072 ERROR("cf_util_get_string_buffer: The %s option requires "
1073 "exactly one string argument.",
1074 ci->key);
1075 return -1;
1076 }
1078 strncpy(buffer, ci->values[0].value.string, buffer_size);
1079 buffer[buffer_size - 1] = 0;
1081 return 0;
1082 } /* }}} int cf_util_get_string_buffer */
1084 /* Assures the config option is a number and returns it as an int. */
1085 int cf_util_get_int(const oconfig_item_t *ci, int *ret_value) /* {{{ */
1086 {
1087 if ((ci == NULL) || (ret_value == NULL))
1088 return EINVAL;
1090 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
1091 ERROR("cf_util_get_int: The %s option requires "
1092 "exactly one numeric argument.",
1093 ci->key);
1094 return -1;
1095 }
1097 *ret_value = (int)ci->values[0].value.number;
1099 return 0;
1100 } /* }}} int cf_util_get_int */
1102 int cf_util_get_double(const oconfig_item_t *ci, double *ret_value) /* {{{ */
1103 {
1104 if ((ci == NULL) || (ret_value == NULL))
1105 return EINVAL;
1107 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
1108 ERROR("cf_util_get_double: The %s option requires "
1109 "exactly one numeric argument.",
1110 ci->key);
1111 return -1;
1112 }
1114 *ret_value = ci->values[0].value.number;
1116 return 0;
1117 } /* }}} int cf_util_get_double */
1119 int cf_util_get_boolean(const oconfig_item_t *ci, _Bool *ret_bool) /* {{{ */
1120 {
1121 if ((ci == NULL) || (ret_bool == NULL))
1122 return EINVAL;
1124 if ((ci->values_num != 1) || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN) &&
1125 (ci->values[0].type != OCONFIG_TYPE_STRING))) {
1126 ERROR("cf_util_get_boolean: The %s option requires "
1127 "exactly one boolean argument.",
1128 ci->key);
1129 return -1;
1130 }
1132 switch (ci->values[0].type) {
1133 case OCONFIG_TYPE_BOOLEAN:
1134 *ret_bool = ci->values[0].value.boolean ? 1 : 0;
1135 break;
1136 case OCONFIG_TYPE_STRING:
1137 WARNING("cf_util_get_boolean: Using string value `%s' for boolean option "
1138 "`%s' is deprecated and will be removed in future releases. "
1139 "Use unquoted true or false instead.",
1140 ci->values[0].value.string, ci->key);
1142 if (IS_TRUE(ci->values[0].value.string))
1143 *ret_bool = 1;
1144 else if (IS_FALSE(ci->values[0].value.string))
1145 *ret_bool = 0;
1146 else {
1147 ERROR("cf_util_get_boolean: Cannot parse string value `%s' of the `%s' "
1148 "option as a boolean value.",
1149 ci->values[0].value.string, ci->key);
1150 return -1;
1151 }
1152 break;
1153 }
1155 return 0;
1156 } /* }}} int cf_util_get_boolean */
1158 int cf_util_get_flag(const oconfig_item_t *ci, /* {{{ */
1159 unsigned int *ret_value, unsigned int flag) {
1160 int status;
1161 _Bool b;
1163 if (ret_value == NULL)
1164 return EINVAL;
1166 b = 0;
1167 status = cf_util_get_boolean(ci, &b);
1168 if (status != 0)
1169 return status;
1171 if (b) {
1172 *ret_value |= flag;
1173 } else {
1174 *ret_value &= ~flag;
1175 }
1177 return 0;
1178 } /* }}} int cf_util_get_flag */
1180 /* Assures that the config option is a string or a number if the correct range
1181 * of 1-65535. The string is then converted to a port number using
1182 * `service_name_to_port_number' and returned.
1183 * Returns the port number in the range [1-65535] or less than zero upon
1184 * failure. */
1185 int cf_util_get_port_number(const oconfig_item_t *ci) /* {{{ */
1186 {
1187 int tmp;
1189 if ((ci->values_num != 1) || ((ci->values[0].type != OCONFIG_TYPE_STRING) &&
1190 (ci->values[0].type != OCONFIG_TYPE_NUMBER))) {
1191 ERROR("cf_util_get_port_number: The \"%s\" option requires "
1192 "exactly one string argument.",
1193 ci->key);
1194 return -1;
1195 }
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)) {
1203 ERROR("cf_util_get_port_number: The \"%s\" option requires "
1204 "a service name or a port number. The number "
1205 "you specified, %i, is not in the valid "
1206 "range of 1-65535.",
1207 ci->key, tmp);
1208 return -1;
1209 }
1211 return tmp;
1212 } /* }}} int cf_util_get_port_number */
1214 int cf_util_get_service(const oconfig_item_t *ci, char **ret_string) /* {{{ */
1215 {
1216 int port;
1217 char *service;
1218 int status;
1220 if (ci->values_num != 1) {
1221 ERROR("cf_util_get_service: The %s option requires exactly "
1222 "one argument.",
1223 ci->key);
1224 return -1;
1225 }
1227 if (ci->values[0].type == OCONFIG_TYPE_STRING)
1228 return cf_util_get_string(ci, ret_string);
1229 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.",
1232 ci->key);
1233 }
1235 port = 0;
1236 status = cf_util_get_int(ci, &port);
1237 if (status != 0)
1238 return status;
1239 else if ((port < 1) || (port > 65535)) {
1240 ERROR("cf_util_get_service: The port number given "
1241 "for the %s option is out of "
1242 "range (%i).",
1243 ci->key, port);
1244 return -1;
1245 }
1247 service = malloc(6);
1248 if (service == NULL) {
1249 ERROR("cf_util_get_service: Out of memory.");
1250 return -1;
1251 }
1252 snprintf(service, 6, "%i", port);
1254 sfree(*ret_string);
1255 *ret_string = service;
1257 return 0;
1258 } /* }}} int cf_util_get_service */
1260 int cf_util_get_cdtime(const oconfig_item_t *ci, cdtime_t *ret_value) /* {{{ */
1261 {
1262 if ((ci == NULL) || (ret_value == NULL))
1263 return EINVAL;
1265 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
1266 ERROR("cf_util_get_cdtime: The %s option requires "
1267 "exactly one numeric argument.",
1268 ci->key);
1269 return -1;
1270 }
1272 if (ci->values[0].value.number < 0.0) {
1273 ERROR("cf_util_get_cdtime: The numeric argument of the %s "
1274 "option must not be negative.",
1275 ci->key);
1276 return -1;
1277 }
1279 *ret_value = DOUBLE_TO_CDTIME_T(ci->values[0].value.number);
1281 return 0;
1282 } /* }}} int cf_util_get_cdtime */