477d8816e84b8e32267bedfa71569d6d1304940b
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 "libconfig/libconfig.h"
27 #include "common.h"
28 #include "plugin.h"
29 #include "configfile.h"
30 #include "network.h"
31 #include "utils_debug.h"
33 #define SHORTOPT_NONE 0
35 #define ERR_NOT_NESTED "Sections cannot be nested.\n"
36 #define ERR_SECTION_ONLY "`%s' can only be used as section.\n"
37 #define ERR_NEEDS_ARG "Section `%s' needs an argument.\n"
38 #define ERR_NEEDS_SECTION "`%s' can only be used within a section.\n"
40 extern int operating_mode;
42 typedef struct cf_callback
43 {
44 char *type;
45 int (*callback) (char *, char *);
46 char **keys;
47 int keys_num;
48 struct cf_callback *next;
49 } cf_callback_t;
51 static cf_callback_t *first_callback = NULL;
53 typedef struct cf_mode_item
54 {
55 char *key;
56 char *value;
57 int mode;
58 } cf_mode_item_t;
60 /* TODO
61 * - LogFile
62 */
63 static cf_mode_item_t cf_mode_list[] =
64 {
65 {"TimeToLive", NULL, MODE_CLIENT },
66 {"PIDFile", NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL | MODE_LOG },
67 {"DataDir", NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL | MODE_LOG },
68 {"LogFile", NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL | MODE_LOG }
69 };
70 static int cf_mode_num = 4;
72 static int nesting_depth = 0;
73 static char *current_module = NULL;
75 /* `cf_register' needs this prototype */
76 static int cf_callback_plugin_dispatch (const char *, const char *,
77 const char *, const char *, lc_flags_t, void *);
79 /*
80 * Functions to handle register/unregister, search, and other plugin related
81 * stuff
82 */
83 static cf_callback_t *cf_search (char *type)
84 {
85 cf_callback_t *cf_cb;
87 if (type == NULL)
88 return (NULL);
90 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
91 if (strcasecmp (cf_cb->type, type) == 0)
92 break;
94 return (cf_cb);
95 }
97 static int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
98 {
99 cf_callback_t *cf_cb;
100 char *key;
101 char *value;
102 int ret;
103 int i;
105 DBG ("type = %s, key = %s, value = %s", type, orig_key, orig_value);
107 if ((cf_cb = cf_search (type)) == NULL)
108 {
109 syslog (LOG_WARNING, "Plugin `%s' did not register a callback.", type);
110 return (-1);
111 }
113 if ((key = strdup (orig_key)) == NULL)
114 return (1);
115 if ((value = strdup (orig_value)) == NULL)
116 {
117 free (key);
118 return (2);
119 }
121 ret = -1;
123 for (i = 0; i < cf_cb->keys_num; i++)
124 {
125 if (strcasecmp (cf_cb->keys[i], key) == 0)
126 {
127 ret = (*cf_cb->callback) (key, value);
128 break;
129 }
130 }
132 if (i >= cf_cb->keys_num)
133 syslog (LOG_WARNING, "Plugin `%s' did not register for value `%s'.", type, key);
135 free (key);
136 free (value);
138 DBG ("return (%i)", ret);
140 return (ret);
141 }
143 void cf_unregister (char *type)
144 {
145 cf_callback_t *this, *prev;
147 for (prev = NULL, this = first_callback;
148 this != NULL;
149 prev = this, this = this->next)
150 if (strcasecmp (this->type, type) == 0)
151 {
152 if (prev == NULL)
153 first_callback = this->next;
154 else
155 prev->next = this->next;
157 free (this);
158 break;
159 }
160 }
162 void cf_register (char *type,
163 int (*callback) (char *, char *),
164 char **keys, int keys_num)
165 {
166 cf_callback_t *cf_cb;
167 char buf[64];
168 int i;
170 /* Remove this module from the list, if it already exists */
171 cf_unregister (type);
173 /* This pointer will be free'd in `cf_unregister' */
174 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
175 return;
177 cf_cb->type = type;
178 cf_cb->callback = callback;
179 cf_cb->keys = keys;
180 cf_cb->keys_num = keys_num;
182 cf_cb->next = first_callback;
183 first_callback = cf_cb;
185 for (i = 0; i < keys_num; i++)
186 {
187 if (snprintf (buf, 64, "Plugin.%s", keys[i]) < 64)
188 {
189 /* This may be called multiple times for the same
190 * `key', but apparently `lc_register_*' can handle
191 * it.. */
192 lc_register_callback (buf, SHORTOPT_NONE,
193 LC_VAR_STRING, cf_callback_plugin_dispatch,
194 NULL);
195 }
196 else
197 {
198 DBG ("Key was truncated: `%s'", keys[i]);
199 }
200 }
201 }
203 /*
204 * Other query functions
205 */
206 char *cf_get_option (const char *key, char *def)
207 {
208 int i;
210 for (i = 0; i < cf_mode_num; i++)
211 {
212 if ((cf_mode_list[i].mode & operating_mode) == 0)
213 continue;
215 if (strcasecmp (cf_mode_list[i].key, key) != 0)
216 continue;
218 if (cf_mode_list[i].value != NULL)
219 return (cf_mode_list[i].value);
220 return (def);
221 }
223 return (NULL);
224 }
226 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
227 * Functions for the actual parsing *
228 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
230 /*
231 * `cf_callback_mode'
232 * Chose the `operating_mode'
233 *
234 * Mode `value'
235 */
236 static int cf_callback_mode (const char *shortvar, const char *var,
237 const char *arguments, const char *value, lc_flags_t flags,
238 void *extra)
239 {
240 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
241 shortvar, var, arguments, value);
243 if (strcasecmp (value, "Client") == 0)
244 operating_mode = MODE_CLIENT;
245 #if HAVE_LIBRRD
246 else if (strcasecmp (value, "Server") == 0)
247 operating_mode = MODE_SERVER;
248 else if (strcasecmp (value, "Local") == 0)
249 operating_mode = MODE_LOCAL;
250 #endif
251 else if (strcasecmp (value, "Log") == 0)
252 operating_mode = MODE_LOG;
253 else
254 {
255 syslog (LOG_ERR, "Invalid value for config option `Mode': `%s'", value);
256 return (LC_CBRET_ERROR);
257 }
259 return (LC_CBRET_OKAY);
260 }
262 /*
263 * `cf_callback_mode_plugindir'
264 * Change the plugin directory
265 *
266 * <Mode xxx>
267 * PluginDir `value'
268 * </Mode>
269 */
270 static int cf_callback_mode_plugindir (const char *shortvar, const char *var,
271 const char *arguments, const char *value, lc_flags_t flags,
272 void *extra)
273 {
274 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
275 shortvar, var, arguments, value);
277 plugin_set_dir (value);
279 return (LC_CBRET_OKAY);
280 }
282 static int cf_callback_mode_option (const char *shortvar, const char *var,
283 const char *arguments, const char *value, lc_flags_t flags,
284 void *extra)
285 {
286 cf_mode_item_t *item;
288 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
289 shortvar, var, arguments, value);
291 if (extra == NULL)
292 {
293 fprintf (stderr, "No extra..?\n");
294 return (LC_CBRET_ERROR);
295 }
297 item = (cf_mode_item_t *) extra;
299 if (strcasecmp (item->key, shortvar))
300 {
301 fprintf (stderr, "Wrong extra..\n");
302 return (LC_CBRET_ERROR);
303 }
305 if ((operating_mode & item->mode) == 0)
306 {
307 fprintf (stderr, "Option `%s' is not valid in this mode!\n", shortvar);
308 return (LC_CBRET_ERROR);
309 }
311 if (item->value != NULL)
312 {
313 free (item->value);
314 item->value = NULL;
315 }
317 if ((item->value = strdup (value)) == NULL)
318 {
319 perror ("strdup");
320 return (LC_CBRET_ERROR);
321 }
323 return (LC_CBRET_OKAY);
324 }
326 /*
327 * `cf_callback_mode_loadmodule':
328 * Load a plugin.
329 *
330 * <Mode xxx>
331 * LoadPlugin `value'
332 * </Mode>
333 */
334 static int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
335 const char *arguments, const char *value, lc_flags_t flags,
336 void *extra)
337 {
338 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
339 shortvar, var, arguments, value);
341 if (plugin_load (value))
342 syslog (LOG_ERR, "plugin_load (%s): failed to load plugin", value);
344 /* Return `okay' even if there was an error, because it's not a syntax
345 * problem.. */
346 return (LC_CBRET_OKAY);
347 }
349 static int cf_callback_socket (const char *shortvar, const char *var,
350 const char *arguments, const char *value, lc_flags_t flags,
351 void *extra)
352 {
353 char *buffer;
355 char *fields[3];
356 int numfields;
358 char *node;
359 char *service = NET_DEFAULT_PORT;
361 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
362 shortvar, var, arguments, value);
364 buffer = strdup (value);
365 if (buffer == NULL)
366 return (LC_CBRET_ERROR);
368 numfields = strsplit (buffer, fields, 3);
370 if ((numfields != 1) && (numfields != 2))
371 {
372 syslog (LOG_ERR, "Invalid number of arguments to `%s'",
373 shortvar);
374 free (buffer);
375 return (LC_CBRET_ERROR);
376 }
378 node = fields[0];
379 if (numfields == 2)
380 service = fields[1];
382 /* Still return `LC_CBRET_OKAY' because this is not an syntax error */
383 if (network_create_socket (node, service) < 1)
384 syslog (LOG_ERR, "network_create_socket (%s, %s) failed",
385 node, service);
387 free (buffer);
389 return (LC_CBRET_OKAY);
390 }
392 /*
393 * `cf_callback_plugin'
394 * Start/end section `plugin'
395 *
396 * <Plugin `arguments'>
397 * ...
398 * </Plugin>
399 */
400 static int cf_callback_plugin (const char *shortvar, const char *var,
401 const char *arguments, const char *value, lc_flags_t flags,
402 void *extra)
403 {
404 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
405 shortvar, var, arguments, value);
407 if (flags == LC_FLAGS_SECTIONSTART)
408 {
409 if (nesting_depth != 0)
410 {
411 fprintf (stderr, ERR_NOT_NESTED);
412 return (LC_CBRET_ERROR);
413 }
415 if (arguments == NULL)
416 {
417 fprintf (stderr, ERR_NEEDS_ARG, shortvar);
418 return (LC_CBRET_ERROR);
419 }
421 if ((current_module = strdup (arguments)) == NULL)
422 {
423 perror ("strdup");
424 return (LC_CBRET_ERROR);
425 }
427 nesting_depth++;
429 if (cf_search (current_module) != NULL)
430 return (LC_CBRET_OKAY);
431 else
432 return (LC_CBRET_IGNORESECTION);
433 }
434 else if (flags == LC_FLAGS_SECTIONEND)
435 {
436 if (current_module != NULL)
437 {
438 free (current_module);
439 current_module = NULL;
440 }
442 nesting_depth--;
444 return (LC_CBRET_OKAY);
445 }
446 else
447 {
448 fprintf (stderr, ERR_SECTION_ONLY, shortvar);
449 return (LC_CBRET_ERROR);
450 }
451 }
453 /*
454 * `cf_callback_plugin_dispatch'
455 * Send options within `plugin' sections to the plugin that requests it.
456 *
457 * <Plugin `current_module'>
458 * `var' `value'
459 * </Plugin>
460 */
461 static int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
462 const char *arguments, const char *value, lc_flags_t flags,
463 void *extra)
464 {
465 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
466 shortvar, var, arguments, value);
468 if ((nesting_depth == 0) || (current_module == NULL))
469 {
470 fprintf (stderr, ERR_NEEDS_SECTION, shortvar);
471 return (LC_CBRET_ERROR);
472 }
474 /* Send the data to the plugin */
475 if (cf_dispatch (current_module, shortvar, value) < 0)
476 return (LC_CBRET_ERROR);
478 return (LC_CBRET_OKAY);
479 }
481 static void cf_init (void)
482 {
483 static int run_once = 0;
484 int i;
486 if (run_once != 0)
487 return;
488 run_once = 1;
490 lc_register_callback ("Mode", SHORTOPT_NONE, LC_VAR_STRING,
491 cf_callback_mode, NULL);
492 lc_register_callback ("Plugin", SHORTOPT_NONE, LC_VAR_SECTION,
493 cf_callback_plugin, NULL);
495 lc_register_callback ("PluginDir", SHORTOPT_NONE,
496 LC_VAR_STRING, cf_callback_mode_plugindir, NULL);
497 lc_register_callback ("LoadPlugin", SHORTOPT_NONE,
498 LC_VAR_STRING, cf_callback_mode_loadmodule, NULL);
500 lc_register_callback ("Listen", SHORTOPT_NONE,
501 LC_VAR_STRING, cf_callback_socket, NULL);
502 lc_register_callback ("Server", SHORTOPT_NONE,
503 LC_VAR_STRING, cf_callback_socket, NULL);
505 for (i = 0; i < cf_mode_num; i++)
506 {
507 cf_mode_item_t *item;
509 item = &cf_mode_list[i];
511 lc_register_callback (item->key, SHORTOPT_NONE, LC_VAR_STRING,
512 cf_callback_mode_option, (void *) item);
513 }
514 }
516 int cf_read (char *filename)
517 {
518 cf_init ();
520 if (filename == NULL)
521 filename = CONFIGFILE;
523 DBG ("Starting to parse file `%s'", filename);
525 /* int lc_process_file(const char *appname, const char *pathname, lc_conf_type_t type); */
526 if (lc_process_file ("collectd", filename, LC_CONF_APACHE))
527 {
528 syslog (LOG_ERR, "lc_process_file (%s): %s", filename, lc_geterrstr ());
529 return (-1);
530 }
532 DBG ("Done parsing file `%s'", filename);
534 /* free memory and stuff */
535 lc_cleanup ();
537 return (0);
538 }