1 /**
2 * collectd - src/configfile.c
3 * Copyright (C) 2005 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.\n", 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'.\n", type, key);
135 free (key);
136 free (value);
138 return (ret);
139 }
141 void cf_unregister (char *type)
142 {
143 cf_callback_t *this, *prev;
145 for (prev = NULL, this = first_callback;
146 this != NULL;
147 prev = this, this = this->next)
148 if (strcasecmp (this->type, type) == 0)
149 {
150 if (prev == NULL)
151 first_callback = this->next;
152 else
153 prev->next = this->next;
155 free (this);
156 break;
157 }
158 }
160 void cf_register (char *type,
161 int (*callback) (char *, char *),
162 char **keys, int keys_num)
163 {
164 cf_callback_t *cf_cb;
165 char buf[64];
166 int i;
168 /* Remove this module from the list, if it already exists */
169 cf_unregister (type);
171 /* This pointer will be free'd in `cf_unregister' */
172 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
173 return;
175 cf_cb->type = type;
176 cf_cb->callback = callback;
177 cf_cb->keys = keys;
178 cf_cb->keys_num = keys_num;
180 cf_cb->next = first_callback;
181 first_callback = cf_cb;
183 for (i = 0; i < keys_num; i++)
184 {
185 if (snprintf (buf, 64, "Plugin.%s", keys[i]) < 64)
186 {
187 /* This may be called multiple times for the same
188 * `key', but apparently `lc_register_*' can handle
189 * it.. */
190 lc_register_callback (buf, SHORTOPT_NONE,
191 LC_VAR_STRING, cf_callback_plugin_dispatch,
192 NULL);
193 }
194 else
195 {
196 DBG ("Key was truncated: `%s'", keys[i]);
197 }
198 }
199 }
201 /*
202 * Other query functions
203 */
204 char *cf_get_option (const char *key, char *def)
205 {
206 int i;
208 for (i = 0; i < cf_mode_num; i++)
209 {
210 if ((cf_mode_list[i].mode & operating_mode) == 0)
211 continue;
213 if (strcasecmp (cf_mode_list[i].key, key) != 0)
214 continue;
216 if (cf_mode_list[i].value != NULL)
217 return (cf_mode_list[i].value);
218 return (def);
219 }
221 return (NULL);
222 }
224 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
225 * Functions for the actual parsing *
226 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
228 /*
229 * `cf_callback_mode'
230 * Chose the `operating_mode'
231 *
232 * Mode `value'
233 */
234 static int cf_callback_mode (const char *shortvar, const char *var,
235 const char *arguments, const char *value, lc_flags_t flags,
236 void *extra)
237 {
238 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
239 shortvar, var, arguments, value);
241 if (strcasecmp (value, "Client") == 0)
242 operating_mode = MODE_CLIENT;
243 #if HAVE_LIBRRD
244 else if (strcasecmp (value, "Server") == 0)
245 operating_mode = MODE_SERVER;
246 else if (strcasecmp (value, "Local") == 0)
247 operating_mode = MODE_LOCAL;
248 #endif
249 else if (strcasecmp (value, "Log") == 0)
250 operating_mode = MODE_LOG;
251 else
252 {
253 syslog (LOG_ERR, "Invalid value for config option `Mode': `%s'", value);
254 return (LC_CBRET_ERROR);
255 }
257 return (LC_CBRET_OKAY);
258 }
260 /*
261 * `cf_callback_mode_plugindir'
262 * Change the plugin directory
263 *
264 * <Mode xxx>
265 * PluginDir `value'
266 * </Mode>
267 */
268 static int cf_callback_mode_plugindir (const char *shortvar, const char *var,
269 const char *arguments, const char *value, lc_flags_t flags,
270 void *extra)
271 {
272 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
273 shortvar, var, arguments, value);
275 plugin_set_dir (value);
277 return (LC_CBRET_OKAY);
278 }
280 static int cf_callback_mode_option (const char *shortvar, const char *var,
281 const char *arguments, const char *value, lc_flags_t flags,
282 void *extra)
283 {
284 cf_mode_item_t *item;
286 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
287 shortvar, var, arguments, value);
289 if (extra == NULL)
290 {
291 fprintf (stderr, "No extra..?\n");
292 return (LC_CBRET_ERROR);
293 }
295 item = (cf_mode_item_t *) extra;
297 if (strcasecmp (item->key, shortvar))
298 {
299 fprintf (stderr, "Wrong extra..\n");
300 return (LC_CBRET_ERROR);
301 }
303 if ((operating_mode & item->mode) == 0)
304 {
305 fprintf (stderr, "Option `%s' is not valid in this mode!\n", shortvar);
306 return (LC_CBRET_ERROR);
307 }
309 if (item->value != NULL)
310 {
311 free (item->value);
312 item->value = NULL;
313 }
315 if ((item->value = strdup (value)) == NULL)
316 {
317 perror ("strdup");
318 return (LC_CBRET_ERROR);
319 }
321 return (LC_CBRET_OKAY);
322 }
324 /*
325 * `cf_callback_mode_loadmodule':
326 * Load a plugin.
327 *
328 * <Mode xxx>
329 * LoadPlugin `value'
330 * </Mode>
331 */
332 static int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
333 const char *arguments, const char *value, lc_flags_t flags,
334 void *extra)
335 {
336 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
337 shortvar, var, arguments, value);
339 if (plugin_load (value))
340 syslog (LOG_ERR, "plugin_load (%s): failed to load plugin", value);
342 /* Return `okay' even if there was an error, because it's not a syntax
343 * problem.. */
344 return (LC_CBRET_OKAY);
345 }
347 static int cf_callback_socket (const char *shortvar, const char *var,
348 const char *arguments, const char *value, lc_flags_t flags,
349 void *extra)
350 {
351 char *buffer;
353 char *fields[3];
354 int numfields;
356 char *node;
357 char *service = NET_DEFAULT_PORT;
359 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
360 shortvar, var, arguments, value);
362 buffer = strdup (value);
363 if (buffer == NULL)
364 return (LC_CBRET_ERROR);
366 numfields = strsplit (buffer, fields, 3);
368 if ((numfields != 1) && (numfields != 2))
369 {
370 syslog (LOG_ERR, "Invalid number of arguments to `%s'",
371 shortvar);
372 free (buffer);
373 return (LC_CBRET_ERROR);
374 }
376 node = fields[0];
377 if (numfields == 2)
378 service = fields[1];
380 /* Still return `LC_CBRET_OKAY' because this is not an syntax error */
381 if (network_create_socket (node, service) < 1)
382 syslog (LOG_ERR, "network_create_socket (%s, %s) failed",
383 node, service);
385 free (buffer);
387 return (LC_CBRET_OKAY);
388 }
390 /*
391 * `cf_callback_plugin'
392 * Start/end section `plugin'
393 *
394 * <Plugin `arguments'>
395 * ...
396 * </Plugin>
397 */
398 static int cf_callback_plugin (const char *shortvar, const char *var,
399 const char *arguments, const char *value, lc_flags_t flags,
400 void *extra)
401 {
402 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
403 shortvar, var, arguments, value);
405 if (flags == LC_FLAGS_SECTIONSTART)
406 {
407 if (nesting_depth != 0)
408 {
409 fprintf (stderr, ERR_NOT_NESTED);
410 return (LC_CBRET_ERROR);
411 }
413 if (arguments == NULL)
414 {
415 fprintf (stderr, ERR_NEEDS_ARG, shortvar);
416 return (LC_CBRET_ERROR);
417 }
419 if ((current_module = strdup (arguments)) == NULL)
420 {
421 perror ("strdup");
422 return (LC_CBRET_ERROR);
423 }
425 nesting_depth++;
427 if (cf_search (current_module) != NULL)
428 return (LC_CBRET_OKAY);
429 else
430 return (LC_CBRET_IGNORESECTION);
431 }
432 else if (flags == LC_FLAGS_SECTIONEND)
433 {
434 if (current_module != NULL)
435 {
436 free (current_module);
437 current_module = NULL;
438 }
440 nesting_depth--;
442 return (LC_CBRET_OKAY);
443 }
444 else
445 {
446 fprintf (stderr, ERR_SECTION_ONLY, shortvar);
447 return (LC_CBRET_ERROR);
448 }
449 }
451 /*
452 * `cf_callback_plugin_dispatch'
453 * Send options within `plugin' sections to the plugin that requests it.
454 *
455 * <Plugin `current_module'>
456 * `var' `value'
457 * </Plugin>
458 */
459 static int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
460 const char *arguments, const char *value, lc_flags_t flags,
461 void *extra)
462 {
463 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
464 shortvar, var, arguments, value);
466 if ((nesting_depth == 0) || (current_module == NULL))
467 {
468 fprintf (stderr, ERR_NEEDS_SECTION, shortvar);
469 return (LC_CBRET_ERROR);
470 }
472 /* Send the data to the plugin */
473 if (cf_dispatch (current_module, shortvar, value) < 0)
474 return (LC_CBRET_ERROR);
476 return (LC_CBRET_OKAY);
477 }
479 static void cf_init (void)
480 {
481 static int run_once = 0;
482 int i;
484 if (run_once != 0)
485 return;
486 run_once = 1;
488 lc_register_callback ("Mode", SHORTOPT_NONE, LC_VAR_STRING,
489 cf_callback_mode, NULL);
490 lc_register_callback ("Plugin", SHORTOPT_NONE, LC_VAR_SECTION,
491 cf_callback_plugin, NULL);
493 lc_register_callback ("PluginDir", SHORTOPT_NONE,
494 LC_VAR_STRING, cf_callback_mode_plugindir, NULL);
495 lc_register_callback ("LoadPlugin", SHORTOPT_NONE,
496 LC_VAR_STRING, cf_callback_mode_loadmodule, NULL);
498 lc_register_callback ("Listen", SHORTOPT_NONE,
499 LC_VAR_STRING, cf_callback_socket, NULL);
500 lc_register_callback ("Server", SHORTOPT_NONE,
501 LC_VAR_STRING, cf_callback_socket, NULL);
503 for (i = 0; i < cf_mode_num; i++)
504 {
505 cf_mode_item_t *item;
507 item = &cf_mode_list[i];
509 lc_register_callback (item->key, SHORTOPT_NONE, LC_VAR_STRING,
510 cf_callback_mode_option, (void *) item);
511 }
512 }
514 int cf_read (char *filename)
515 {
516 cf_init ();
518 if (filename == NULL)
519 filename = CONFIGFILE;
521 DBG ("Starting to parse file `%s'", filename);
523 /* int lc_process_file(const char *appname, const char *pathname, lc_conf_type_t type); */
524 if (lc_process_file ("collectd", filename, LC_CONF_APACHE))
525 {
526 syslog (LOG_ERR, "lc_process_file (%s): %s", filename, lc_geterrstr ());
527 return (-1);
528 }
530 DBG ("Done parsing file `%s'", filename);
532 /* free memory and stuff */
533 lc_cleanup ();
535 return (0);
536 }