1 /**
2 * collectd - src/configfile.c
3 * Copyright (C) 2005,2006 Florian octo Forster
4 *
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.
9 *
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.
14 *
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
18 *
19 * Authors:
20 * Florian octo Forster <octo at verplant.org>
21 **/
23 #include "collectd.h"
25 #include "liboconfig/oconfig.h"
27 #include "common.h"
28 #include "plugin.h"
29 #include "configfile.h"
31 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
33 /*
34 * Private types
35 */
36 typedef struct cf_callback
37 {
38 const char *type;
39 int (*callback) (const char *, const char *);
40 const char **keys;
41 int keys_num;
42 struct cf_callback *next;
43 } cf_callback_t;
45 typedef struct cf_complex_callback_s
46 {
47 char *type;
48 int (*callback) (oconfig_item_t *);
49 struct cf_complex_callback_s *next;
50 } cf_complex_callback_t;
52 typedef struct cf_value_map_s
53 {
54 char *key;
55 int (*func) (const oconfig_item_t *);
56 } cf_value_map_t;
58 typedef struct cf_global_option_s
59 {
60 char *key;
61 char *value;
62 char *def;
63 } cf_global_option_t;
65 /*
66 * Prototypes of callback functions
67 */
68 static int dispatch_value_plugindir (const oconfig_item_t *ci);
69 static int dispatch_value_loadplugin (const oconfig_item_t *ci);
71 /*
72 * Private variables
73 */
74 static cf_callback_t *first_callback = NULL;
75 static cf_complex_callback_t *complex_callback_head = NULL;
77 static cf_value_map_t cf_value_map[] =
78 {
79 {"PluginDir", dispatch_value_plugindir},
80 {"LoadPlugin", dispatch_value_loadplugin}
81 };
82 static int cf_value_map_num = STATIC_ARRAY_LEN (cf_value_map);
84 static cf_global_option_t cf_global_options[] =
85 {
86 {"BaseDir", NULL, PKGLOCALSTATEDIR},
87 {"PIDFile", NULL, PIDFILE},
88 {"Hostname", NULL, NULL},
89 {"Interval", NULL, "10"},
90 {"ReadThreads", NULL, "5"},
91 {"TypesDB", NULL, PLUGINDIR"/types.db"} /* FIXME: Configure path */
92 };
93 static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
95 /*
96 * Functions to handle register/unregister, search, and other plugin related
97 * stuff
98 */
99 static cf_callback_t *cf_search (const char *type)
100 {
101 cf_callback_t *cf_cb;
103 if (type == NULL)
104 return (NULL);
106 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
107 if (strcasecmp (cf_cb->type, type) == 0)
108 break;
110 return (cf_cb);
111 }
113 static int cf_dispatch (const char *type, const char *orig_key,
114 const char *orig_value)
115 {
116 cf_callback_t *cf_cb;
117 char *key;
118 char *value;
119 int ret;
120 int i;
122 DEBUG ("type = %s, key = %s, value = %s",
123 ESCAPE_NULL(type),
124 ESCAPE_NULL(orig_key),
125 ESCAPE_NULL(orig_value));
127 if ((cf_cb = cf_search (type)) == NULL)
128 {
129 WARNING ("Plugin `%s' did not register a callback.", type);
130 return (-1);
131 }
133 if ((key = strdup (orig_key)) == NULL)
134 return (1);
135 if ((value = strdup (orig_value)) == NULL)
136 {
137 free (key);
138 return (2);
139 }
141 ret = -1;
143 for (i = 0; i < cf_cb->keys_num; i++)
144 {
145 if (strcasecmp (cf_cb->keys[i], key) == 0)
146 {
147 ret = (*cf_cb->callback) (key, value);
148 break;
149 }
150 }
152 if (i >= cf_cb->keys_num)
153 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
155 free (key);
156 free (value);
158 DEBUG ("return (%i)", ret);
160 return (ret);
161 } /* int cf_dispatch */
163 static int dispatch_global_option (const oconfig_item_t *ci)
164 {
165 if (ci->values_num != 1)
166 return (-1);
167 if (ci->values[0].type == OCONFIG_TYPE_STRING)
168 return (global_option_set (ci->key, ci->values[0].value.string));
169 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
170 {
171 char tmp[128];
172 snprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
173 tmp[127] = '\0';
174 return (global_option_set (ci->key, tmp));
175 }
177 return (-1);
178 } /* int dispatch_global_option */
180 static int dispatch_value_plugindir (const oconfig_item_t *ci)
181 {
182 assert (strcasecmp (ci->key, "PluginDir") == 0);
184 if (ci->values_num != 1)
185 return (-1);
186 if (ci->values[0].type != OCONFIG_TYPE_STRING)
187 return (-1);
189 plugin_set_dir (ci->values[0].value.string);
190 return (0);
191 }
193 static int dispatch_value_loadplugin (const oconfig_item_t *ci)
194 {
195 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
197 if (ci->values_num != 1)
198 return (-1);
199 if (ci->values[0].type != OCONFIG_TYPE_STRING)
200 return (-1);
202 return (plugin_load (ci->values[0].value.string));
203 } /* int dispatch_value_loadplugin */
205 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
206 {
207 char buffer[4096];
208 char *buffer_ptr;
209 int buffer_free;
210 int i;
212 buffer_ptr = buffer;
213 buffer_free = sizeof (buffer);
215 for (i = 0; i < ci->values_num; i++)
216 {
217 int status = -1;
219 if (ci->values[i].type == OCONFIG_TYPE_STRING)
220 status = snprintf (buffer_ptr, buffer_free, " %s",
221 ci->values[i].value.string);
222 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
223 status = snprintf (buffer_ptr, buffer_free, " %lf",
224 ci->values[i].value.number);
225 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
226 status = snprintf (buffer_ptr, buffer_free, " %s",
227 ci->values[i].value.boolean
228 ? "true" : "false");
230 if ((status < 0) || (status >= buffer_free))
231 return (-1);
232 buffer_free -= status;
233 buffer_ptr += status;
234 }
235 /* skip the initial space */
236 buffer_ptr = buffer + 1;
238 return (cf_dispatch (plugin, ci->key, buffer_ptr));
239 } /* int plugin_conf_dispatch */
241 static int dispatch_value (const oconfig_item_t *ci)
242 {
243 int ret = -2;
244 int i;
246 for (i = 0; i < cf_value_map_num; i++)
247 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
248 {
249 ret = cf_value_map[i].func (ci);
250 break;
251 }
253 for (i = 0; i < cf_global_options_num; i++)
254 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
255 {
256 ret = dispatch_global_option (ci);
257 break;
258 }
260 return (ret);
261 } /* int dispatch_value */
263 static int dispatch_block_plugin (oconfig_item_t *ci)
264 {
265 int i;
266 char *name;
268 cf_complex_callback_t *cb;
270 if (strcasecmp (ci->key, "Plugin") != 0)
271 return (-1);
272 if (ci->values_num < 1)
273 return (-1);
274 if (ci->values[0].type != OCONFIG_TYPE_STRING)
275 return (-1);
277 name = ci->values[0].value.string;
279 /* Check for a complex callback first */
280 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
281 if (strcasecmp (name, cb->type) == 0)
282 return (cb->callback (ci));
284 /* Hm, no complex plugin found. Dispatch the values one by one */
285 for (i = 0; i < ci->children_num; i++)
286 {
287 if (ci->children[i].children == NULL)
288 dispatch_value_plugin (name, ci->children + i);
289 else
290 {DEBUG ("No nested config blocks allow for this plugin.");}
291 }
293 return (0);
294 }
297 static int dispatch_block (oconfig_item_t *ci)
298 {
299 if (strcasecmp (ci->key, "Plugin") == 0)
300 return (dispatch_block_plugin (ci));
302 return (0);
303 }
305 /*
306 * Public functions
307 */
308 int global_option_set (const char *option, const char *value)
309 {
310 int i;
312 DEBUG ("option = %s; value = %s;", option, value);
314 for (i = 0; i < cf_global_options_num; i++)
315 if (strcasecmp (cf_global_options[i].key, option) == 0)
316 break;
318 if (i >= cf_global_options_num)
319 return (-1);
321 sfree (cf_global_options[i].value);
323 if (value != NULL)
324 cf_global_options[i].value = strdup (value);
325 else
326 cf_global_options[i].value = NULL;
328 return (0);
329 }
331 const char *global_option_get (const char *option)
332 {
333 int i;
335 for (i = 0; i < cf_global_options_num; i++)
336 if (strcasecmp (cf_global_options[i].key, option) == 0)
337 break;
339 if (i >= cf_global_options_num)
340 return (NULL);
342 return ((cf_global_options[i].value != NULL)
343 ? cf_global_options[i].value
344 : cf_global_options[i].def);
345 } /* char *global_option_get */
347 void cf_unregister (const char *type)
348 {
349 cf_callback_t *this, *prev;
351 for (prev = NULL, this = first_callback;
352 this != NULL;
353 prev = this, this = this->next)
354 if (strcasecmp (this->type, type) == 0)
355 {
356 if (prev == NULL)
357 first_callback = this->next;
358 else
359 prev->next = this->next;
361 free (this);
362 break;
363 }
364 } /* void cf_unregister */
366 void cf_unregister_complex (const char *type)
367 {
368 cf_complex_callback_t *this, *prev;
370 for (prev = NULL, this = complex_callback_head;
371 this != NULL;
372 prev = this, this = this->next)
373 if (strcasecmp (this->type, type) == 0)
374 {
375 if (prev == NULL)
376 complex_callback_head = this->next;
377 else
378 prev->next = this->next;
380 sfree (this->type);
381 sfree (this);
382 break;
383 }
384 } /* void cf_unregister */
386 void cf_register (const char *type,
387 int (*callback) (const char *, const char *),
388 const char **keys, int keys_num)
389 {
390 cf_callback_t *cf_cb;
392 /* Remove this module from the list, if it already exists */
393 cf_unregister (type);
395 /* This pointer will be free'd in `cf_unregister' */
396 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
397 return;
399 cf_cb->type = type;
400 cf_cb->callback = callback;
401 cf_cb->keys = keys;
402 cf_cb->keys_num = keys_num;
404 cf_cb->next = first_callback;
405 first_callback = cf_cb;
406 } /* void cf_register */
408 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
409 {
410 cf_complex_callback_t *new;
412 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
413 if (new == NULL)
414 return (-1);
416 new->type = strdup (type);
417 if (new->type == NULL)
418 {
419 sfree (new);
420 return (-1);
421 }
423 new->callback = callback;
424 new->next = NULL;
426 if (complex_callback_head == NULL)
427 {
428 complex_callback_head = new;
429 }
430 else
431 {
432 cf_complex_callback_t *last = complex_callback_head;
433 while (last->next != NULL)
434 last = last->next;
435 last->next = new;
436 }
438 return (0);
439 } /* int cf_register_complex */
441 int cf_read (char *filename)
442 {
443 oconfig_item_t *conf;
444 int i;
446 conf = oconfig_parse_file (filename);
447 if (conf == NULL)
448 {
449 ERROR ("Unable to read config file %s.", filename);
450 return (-1);
451 }
453 for (i = 0; i < conf->children_num; i++)
454 {
455 if (conf->children[i].children == NULL)
456 dispatch_value (conf->children + i);
457 else
458 dispatch_block (conf->children + i);
459 }
461 return (0);
462 } /* int cf_read */