2 * collectd - src/configfile.c
3 * Copyright (C) 2005 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 verplant.org>
25 #include "libconfig/libconfig.h"
29 #include "configfile.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"
41 extern int operating_mode;
43 static int operating_mode = MODE_CLIENT;
46 typedef struct cf_callback
49 int (*callback) (char *, char *);
52 struct cf_callback *next;
55 static cf_callback_t *first_callback = NULL;
57 typedef struct cf_mode_item
67 static cf_mode_item_t cf_mode_list[] =
69 {"TimeToLive", NULL, MODE_CLIENT },
70 {"PIDFile", NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL},
71 {"DataDir", NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL},
72 {"LogFile", NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL}
74 static int cf_mode_num = 4;
76 static int nesting_depth = 0;
77 static char *current_module = NULL;
79 /* `cf_register' needs this prototype */
80 static int cf_callback_plugin_dispatch (const char *, const char *,
81 const char *, const char *, lc_flags_t, void *);
84 * Functions to handle register/unregister, search, and other plugin related
87 static cf_callback_t *cf_search (char *type)
94 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
95 if (strcasecmp (cf_cb->type, type) == 0)
101 static int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
103 cf_callback_t *cf_cb;
109 DBG ("type = %s, key = %s, value = %s", type, orig_key, orig_value);
111 if ((cf_cb = cf_search (type)) == NULL)
113 syslog (LOG_WARNING, "Plugin `%s' did not register a callback.\n", type);
117 if ((key = strdup (orig_key)) == NULL)
119 if ((value = strdup (orig_value)) == NULL)
127 for (i = 0; i < cf_cb->keys_num; i++)
129 if (strcasecmp (cf_cb->keys[i], key) == 0)
131 ret = (*cf_cb->callback) (key, value);
136 if (i >= cf_cb->keys_num)
137 syslog (LOG_WARNING, "Plugin `%s' did not register for value `%s'.\n", type, key);
145 void cf_unregister (char *type)
147 cf_callback_t *this, *prev;
149 for (prev = NULL, this = first_callback;
151 prev = this, this = this->next)
152 if (strcasecmp (this->type, type) == 0)
155 first_callback = this->next;
157 prev->next = this->next;
164 void cf_register (char *type,
165 int (*callback) (char *, char *),
166 char **keys, int keys_num)
168 cf_callback_t *cf_cb;
172 /* Remove this module from the list, if it already exists */
173 cf_unregister (type);
175 /* This pointer will be free'd in `cf_unregister' */
176 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
180 cf_cb->callback = callback;
182 cf_cb->keys_num = keys_num;
184 cf_cb->next = first_callback;
185 first_callback = cf_cb;
187 for (i = 0; i < keys_num; i++)
189 if (snprintf (buf, 64, "Plugin.%s", keys[i]) < 64)
191 /* This may be called multiple times for the same
192 * `key', but apparently `lc_register_*' can handle
194 lc_register_callback (buf, SHORTOPT_NONE,
195 LC_VAR_STRING, cf_callback_plugin_dispatch,
200 DBG ("Key was truncated: `%s'", keys[i]);
206 * Other query functions
208 char *cf_get_option (const char *key, char *def)
212 for (i = 0; i < cf_mode_num; i++)
214 if ((cf_mode_list[i].mode & operating_mode) == 0)
217 if (strcasecmp (cf_mode_list[i].key, key) != 0)
220 if (cf_mode_list[i].value != NULL)
221 return (cf_mode_list[i].value);
228 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
229 * Functions for the actual parsing *
230 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
234 * Chose the `operating_mode'
238 static int cf_callback_mode (const char *shortvar, const char *var,
239 const char *arguments, const char *value, lc_flags_t flags,
242 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
243 shortvar, var, arguments, value);
245 if (strcasecmp (value, "Client") == 0)
246 operating_mode = MODE_CLIENT;
247 else if (strcasecmp (value, "Server") == 0)
248 operating_mode = MODE_SERVER;
249 else if (strcasecmp (value, "Local") == 0)
250 operating_mode = MODE_LOCAL;
253 syslog (LOG_ERR, "Invalid value for config option `Mode': `%s'", value);
254 return (LC_CBRET_ERROR);
257 return (LC_CBRET_OKAY);
261 * `cf_callback_mode_plugindir'
262 * Change the plugin directory
268 static int cf_callback_mode_plugindir (const char *shortvar, const char *var,
269 const char *arguments, const char *value, lc_flags_t flags,
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);
280 static int cf_callback_mode_option (const char *shortvar, const char *var,
281 const char *arguments, const char *value, lc_flags_t flags,
284 cf_mode_item_t *item;
286 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
287 shortvar, var, arguments, value);
291 fprintf (stderr, "No extra..?\n");
292 return (LC_CBRET_ERROR);
295 item = (cf_mode_item_t *) extra;
297 if (strcasecmp (item->key, shortvar))
299 fprintf (stderr, "Wrong extra..\n");
300 return (LC_CBRET_ERROR);
303 if ((operating_mode & item->mode) == 0)
305 fprintf (stderr, "Option `%s' is not valid in this mode!\n", shortvar);
306 return (LC_CBRET_ERROR);
309 if (item->value != NULL)
315 if ((item->value = strdup (value)) == NULL)
318 return (LC_CBRET_ERROR);
321 return (LC_CBRET_OKAY);
325 * `cf_callback_mode_loadmodule':
332 static int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
333 const char *arguments, const char *value, lc_flags_t flags,
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
344 return (LC_CBRET_OKAY);
347 static int cf_callback_socket (const char *shortvar, const char *var,
348 const char *arguments, const char *value, lc_flags_t flags,
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);
364 return (LC_CBRET_ERROR);
366 numfields = strsplit (buffer, fields, 3);
368 if ((numfields != 1) && (numfields != 2))
370 syslog (LOG_ERR, "Invalid number of arguments to `%s'",
373 return (LC_CBRET_ERROR);
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",
387 return (LC_CBRET_OKAY);
391 * `cf_callback_plugin'
392 * Start/end section `plugin'
394 * <Plugin `arguments'>
398 static int cf_callback_plugin (const char *shortvar, const char *var,
399 const char *arguments, const char *value, lc_flags_t flags,
402 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
403 shortvar, var, arguments, value);
405 if (flags == LC_FLAGS_SECTIONSTART)
407 if (nesting_depth != 0)
409 fprintf (stderr, ERR_NOT_NESTED);
410 return (LC_CBRET_ERROR);
413 if (arguments == NULL)
415 fprintf (stderr, ERR_NEEDS_ARG, shortvar);
416 return (LC_CBRET_ERROR);
419 if ((current_module = strdup (arguments)) == NULL)
422 return (LC_CBRET_ERROR);
427 if (cf_search (current_module) != NULL)
428 return (LC_CBRET_OKAY);
430 return (LC_CBRET_IGNORESECTION);
432 else if (flags == LC_FLAGS_SECTIONEND)
434 if (current_module != NULL)
436 free (current_module);
437 current_module = NULL;
442 return (LC_CBRET_OKAY);
446 fprintf (stderr, ERR_SECTION_ONLY, shortvar);
447 return (LC_CBRET_ERROR);
452 * `cf_callback_plugin_dispatch'
453 * Send options within `plugin' sections to the plugin that requests it.
455 * <Plugin `current_module'>
459 static int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
460 const char *arguments, const char *value, lc_flags_t flags,
463 DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
464 shortvar, var, arguments, value);
466 if ((nesting_depth == 0) || (current_module == NULL))
468 fprintf (stderr, ERR_NEEDS_SECTION, shortvar);
469 return (LC_CBRET_ERROR);
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);
479 static void cf_init (void)
481 static int run_once = 0;
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++)
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);
514 int cf_read (char *filename)
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))
526 syslog (LOG_ERR, "lc_process_file (%s): %s", filename, lc_geterrstr ());
530 DBG ("Done parsing file `%s'", filename);
532 /* free memory and stuff */