solaris-fixes branch: Fix the debugging output in `configfile.c'.
[collectd.git] / src / configfile.c
index e3341dd..3926586 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * collectd - src/configfile.c
- * Copyright (C) 2005  Florian octo Forster
+ * Copyright (C) 2005,2006  Florian octo Forster
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
 
 #include "libconfig/libconfig.h"
 
+#include "common.h"
 #include "plugin.h"
 #include "configfile.h"
+#include "network.h"
 #include "utils_debug.h"
 
 #define SHORTOPT_NONE 0
 #define ERR_NEEDS_ARG "Section `%s' needs an argument.\n"
 #define ERR_NEEDS_SECTION "`%s' can only be used within a section.\n"
 
-#ifdef HAVE_LIBRRD
+#define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
+
+#define DEBUG_CALLBACK(shortvar, var, arguments, value) \
+       DBG("shortvar = %s, var = %s, arguments = %s, value = %s, ...", \
+                       ESCAPE_NULL(shortvar), \
+                       ESCAPE_NULL(var), \
+                       ESCAPE_NULL(arguments), \
+                       ESCAPE_NULL(value))
+
 extern int operating_mode;
-#else
-static int operating_mode = MODE_CLIENT;
-#endif
 
 typedef struct cf_callback
 {
@@ -61,14 +68,13 @@ typedef struct cf_mode_item
 
 /* TODO
  * - LogFile
- * - DontFork
  */
 static cf_mode_item_t cf_mode_list[] =
 {
-       {"Server",      NULL,             MODE_CLIENT                           },
-       {"Port",        NULL,             MODE_CLIENT | MODE_SERVER             },
-       {"PIDFile",     PIDFILE,          MODE_CLIENT | MODE_SERVER | MODE_LOCAL},
-       {"DataDir",     PKGLOCALSTATEDIR, MODE_SERVER |               MODE_LOCAL}
+       {"TimeToLive",  NULL, MODE_CLIENT                           },
+       {"PIDFile",     NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL | MODE_LOG },
+       {"DataDir",     NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL | MODE_LOG },
+       {"LogFile",     NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL | MODE_LOG }
 };
 static int cf_mode_num = 4;
 
@@ -76,14 +82,14 @@ static int nesting_depth = 0;
 static char *current_module = NULL;
 
 /* `cf_register' needs this prototype */
-int cf_callback_plugin_dispatch (const char *, const char *, const char *,
-               const char *, lc_flags_t, void *);
+static int cf_callback_plugin_dispatch (const char *, const char *,
+               const char *, const char *, lc_flags_t, void *);
 
 /*
  * Functions to handle register/unregister, search, and other plugin related
  * stuff
  */
-cf_callback_t *cf_search (char *type)
+static cf_callback_t *cf_search (char *type)
 {
        cf_callback_t *cf_cb;
 
@@ -97,7 +103,7 @@ cf_callback_t *cf_search (char *type)
        return (cf_cb);
 }
 
-int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
+static int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
 {
        cf_callback_t *cf_cb;
        char *key;
@@ -105,11 +111,14 @@ int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
        int ret;
        int i;
 
-       DBG ("type = %s, key = %s, value = %s", type, orig_key, orig_value);
+       DBG ("type = %s, key = %s, value = %s",
+                       ESCAPE_NULL(type),
+                       ESCAPE_NULL(orig_key),
+                       ESCAPE_NULL(orig_value));
 
        if ((cf_cb = cf_search (type)) == NULL)
        {
-               syslog (LOG_WARNING, "Plugin `%s' did not register a callback.\n", type);
+               syslog (LOG_WARNING, "Plugin `%s' did not register a callback.", type);
                return (-1);
        }
 
@@ -133,11 +142,13 @@ int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
        }
 
        if (i >= cf_cb->keys_num)
-               syslog (LOG_WARNING, "Plugin `%s' did not register for value `%s'.\n", type, key);
+               syslog (LOG_WARNING, "Plugin `%s' did not register for value `%s'.", type, key);
 
        free (key);
        free (value);
 
+       DBG ("return (%i)", ret);
+
        return (ret);
 }
 
@@ -196,7 +207,7 @@ void cf_register (char *type,
                }
                else
                {
-                       DBG ("Key was truncated: `%s'", keys[i]);
+                       DBG ("Key was truncated: `%s'", ESCAPE_NULL(keys[i]));
                }
        }
 }
@@ -204,7 +215,7 @@ void cf_register (char *type,
 /*
  * Other query functions
  */
-char *cf_get_mode_option (const char *key)
+char *cf_get_option (const char *key, char *def)
 {
        int i;
 
@@ -213,115 +224,50 @@ char *cf_get_mode_option (const char *key)
                if ((cf_mode_list[i].mode & operating_mode) == 0)
                        continue;
 
-               if (strcasecmp (cf_mode_list[i].key, key) == 0)
+               if (strcasecmp (cf_mode_list[i].key, key) != 0)
+                       continue;
+
+               if (cf_mode_list[i].value != NULL)
                        return (cf_mode_list[i].value);
+               return (def);
        }
 
        return (NULL);
 }
 
-int cf_callback_usage (const char *shortvar, const char *var,
-               const char *arguments, const char *value, lc_flags_t flags,
-               void *extra)
-{
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
-
-       printf ("Usage: "PACKAGE" [OPTIONS]\n\n"
-                       
-                       "Available options:\n"
-#if COLLECT_DAEMON
-                       "    -P <file>       PID file.\n"
-                       "                    Default: "PIDFILE"\n"
-#endif
-                       "    -M <dir>        Module/Plugin directory.\n"
-                       "                    Default: "PLUGINDIR"\n"
-                       "    -D <dir>        Data storage directory.\n"
-                       "                    Default: "PKGLOCALSTATEDIR"\n"
-#if COLLECT_DEBUG
-                       "    -L <file>       Log file.\n"
-                       "                    Default: "LOGFILE"\n"
-#endif
-#if COLLECT_DAEMON
-                       "    -f              Don't fork to the background.\n"
-#endif
-#if HAVE_LIBRRD
-                       "    -l              Start in local mode (no network).\n"
-                       "    -c              Start in client (sender) mode.\n"
-                       "    -s              Start in server (listener) mode.\n"
-#endif /* HAVE_LIBRRD */
-#if COLLECT_PING
-                       "  Ping:\n"
-                       "    -p <host>       Host to ping periodically, may be repeated to ping\n"
-                       "                    more than one host.\n"
-#endif /* COLLECT_PING */
-                       "\n"PACKAGE" "VERSION", http://verplant.org/collectd/\n"
-                       "by Florian octo Forster <octo@verplant.org>\n"
-                       "for contributions see `AUTHORS'\n");
-       exit (0);
-} /* exit_usage */
-
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Functions for the actual parsing                                    *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 /*
  * `cf_callback_mode'
- *   Start/end the `mode' section
+ *   Chose the `operating_mode'
  *
- * <Mode `arguments'>
- *   ...
- * </Mode>
+ * Mode `value'
  */
-int cf_callback_mode (const char *shortvar, const char *var,
+static int cf_callback_mode (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
 
-       if (flags == LC_FLAGS_SECTIONSTART)
-       {
-               if (nesting_depth != 0)
-               {
-                       fprintf (stderr, ERR_NOT_NESTED);
-                       return (LC_CBRET_ERROR);
-               }
-
-               if (arguments == NULL)
-               {
-                       fprintf (stderr, ERR_NEEDS_ARG, shortvar);
-                       return (LC_CBRET_ERROR);
-               }
-
-               nesting_depth++;
-
-               if (((operating_mode == MODE_CLIENT)
-                                       && (strcasecmp (arguments, "Client") == 0))
-                               || ((operating_mode == MODE_SERVER)
-                                       && (strcasecmp (arguments, "Server") == 0))
-                               || ((operating_mode == MODE_LOCAL)
-                                       && (strcasecmp (arguments, "Local") == 0)))
-               {
-                       return (LC_CBRET_OKAY);
-               }
-               else
-               {
-                       return (LC_CBRET_IGNORESECTION);
-               }
-       }
-       else if (flags == LC_FLAGS_SECTIONEND)
-       {
-               nesting_depth--;
-
-               return (LC_CBRET_OKAY);
-       }
+       if (strcasecmp (value, "Client") == 0)
+               operating_mode = MODE_CLIENT;
+#if HAVE_LIBRRD
+       else if (strcasecmp (value, "Server") == 0)
+               operating_mode = MODE_SERVER;
+       else if (strcasecmp (value, "Local") == 0)
+               operating_mode = MODE_LOCAL;
+#endif
+       else if (strcasecmp (value, "Log") == 0)
+               operating_mode = MODE_LOG;
        else
        {
-               fprintf (stderr, ERR_SECTION_ONLY, shortvar);
+               syslog (LOG_ERR, "Invalid value for config option `Mode': `%s'", value);
                return (LC_CBRET_ERROR);
        }
 
+       return (LC_CBRET_OKAY);
 }
 
 /*
@@ -332,26 +278,24 @@ int cf_callback_mode (const char *shortvar, const char *var,
  *   PluginDir `value'
  * </Mode>
  */
-int cf_callback_mode_plugindir (const char *shortvar, const char *var,
+static int cf_callback_mode_plugindir (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
 
        plugin_set_dir (value);
 
        return (LC_CBRET_OKAY);
 }
 
-int cf_callback_mode_option (const char *shortvar, const char *var,
+static int cf_callback_mode_option (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
        cf_mode_item_t *item;
 
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
 
        if (extra == NULL)
        {
@@ -396,18 +340,11 @@ int cf_callback_mode_option (const char *shortvar, const char *var,
  *   LoadPlugin `value'
  * </Mode>
  */
-int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
+static int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
-
-       if (nesting_depth == 0)
-       {
-               fprintf (stderr, ERR_NEEDS_SECTION, shortvar);
-               return (LC_CBRET_ERROR);
-       }
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
 
        if (plugin_load (value))
                syslog (LOG_ERR, "plugin_load (%s): failed to load plugin", value);
@@ -417,33 +354,45 @@ int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
        return (LC_CBRET_OKAY);
 }
 
-/*
- * `cf_callback_mode_switch'
- *   Change the contents of the global variable `operating_mode'
- *
- *   This should be command line options. One *can* do this in the config
- *   files, but I will not document this. Don't whine abount it not working as
- *   you expect if you do it anyways.
- */
-int cf_callback_mode_switch (const char *shortvar, const char *var,
+static int cf_callback_socket (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
+       char *buffer;
 
-       if (strcasecmp (shortvar, "Client") == 0)
-               operating_mode = MODE_CLIENT;
-       else if (strcasecmp (shortvar, "Local") == 0)
-               operating_mode = MODE_LOCAL;
-       else if (strcasecmp (shortvar, "Server") == 0)
-               operating_mode = MODE_SERVER;
-       else
+       char *fields[3];
+       int   numfields;
+
+       char *node;
+       char *service = NET_DEFAULT_PORT;
+
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
+
+       buffer = strdup (value);
+       if (buffer == NULL)
+               return (LC_CBRET_ERROR);
+
+       numfields = strsplit (buffer, fields, 3);
+
+       if ((numfields != 1) && (numfields != 2))
        {
-               fprintf (stderr, "cf_callback_mode_switch: Wrong mode!\n");
+               syslog (LOG_ERR, "Invalid number of arguments to `%s'",
+                               shortvar);
+               free (buffer);
                return (LC_CBRET_ERROR);
        }
 
+       node = fields[0];
+       if (numfields == 2)
+               service = fields[1];
+
+       /* Still return `LC_CBRET_OKAY' because this is not an syntax error */
+       if (network_create_socket (node, service) < 1)
+               syslog (LOG_ERR, "network_create_socket (%s, %s) failed",
+                               node, service);
+
+       free (buffer);
+
        return (LC_CBRET_OKAY);
 }
 
@@ -455,12 +404,11 @@ int cf_callback_mode_switch (const char *shortvar, const char *var,
  *   ...
  * </Plugin>
  */
-int cf_callback_plugin (const char *shortvar, const char *var,
+static int cf_callback_plugin (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
 
        if (flags == LC_FLAGS_SECTIONSTART)
        {
@@ -516,12 +464,11 @@ int cf_callback_plugin (const char *shortvar, const char *var,
  *   `var' `value'
  * </Plugin>
  */
-int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
+static int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
                const char *arguments, const char *value, lc_flags_t flags,
                void *extra)
 {
-       DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
-                       shortvar, var, arguments, value);
+       DEBUG_CALLBACK (shortvar, var, arguments, value);
 
        if ((nesting_depth == 0) || (current_module == NULL))
        {
@@ -536,7 +483,7 @@ int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
        return (LC_CBRET_OKAY);
 }
 
-void cf_init (void)
+static void cf_init (void)
 {
        static int run_once = 0;
        int i;
@@ -545,54 +492,50 @@ void cf_init (void)
                return;
        run_once = 1;
 
-       lc_register_callback ("Help", 'h', LC_VAR_NONE,
-                       cf_callback_usage, NULL);
-
-       lc_register_callback ("Client", 'c', LC_VAR_NONE,
-                       cf_callback_mode_switch, NULL);
-       lc_register_callback ("Local", 'l', LC_VAR_NONE,
-                       cf_callback_mode_switch, NULL);
-       lc_register_callback ("Server", 's', LC_VAR_NONE,
-                       cf_callback_mode_switch, NULL);
-
-       lc_register_callback ("Mode", SHORTOPT_NONE, LC_VAR_SECTION,
+       lc_register_callback ("Mode", SHORTOPT_NONE, LC_VAR_STRING,
                        cf_callback_mode, NULL);
        lc_register_callback ("Plugin", SHORTOPT_NONE, LC_VAR_SECTION,
                        cf_callback_plugin, NULL);
 
-       lc_register_callback ("Mode.PluginDir", 'P',
+       lc_register_callback ("PluginDir", SHORTOPT_NONE,
                        LC_VAR_STRING, cf_callback_mode_plugindir, NULL);
-       lc_register_callback ("Mode.LoadPlugin", SHORTOPT_NONE,
+       lc_register_callback ("LoadPlugin", SHORTOPT_NONE,
                        LC_VAR_STRING, cf_callback_mode_loadmodule, NULL);
 
+       lc_register_callback ("Listen", SHORTOPT_NONE,
+                       LC_VAR_STRING, cf_callback_socket, NULL);
+       lc_register_callback ("Server", SHORTOPT_NONE,
+                       LC_VAR_STRING, cf_callback_socket, NULL);
+
        for (i = 0; i < cf_mode_num; i++)
        {
-               char            longvar[256];
                cf_mode_item_t *item;
 
                item = &cf_mode_list[i];
 
-               if (snprintf (longvar, 256, "Mode.%s", item->key) >= 256)
-                       continue;
-
-               lc_register_callback (longvar, SHORTOPT_NONE, LC_VAR_STRING,
+               lc_register_callback (item->key, SHORTOPT_NONE, LC_VAR_STRING,
                                cf_callback_mode_option, (void *) item);
        }
 }
 
-int cf_read (int argc, char **argv, char *filename)
+int cf_read (char *filename)
 {
        cf_init ();
 
        if (filename == NULL)
                filename = CONFIGFILE;
 
-       if (lc_process (argc, argv, "collectd", LC_CONF_APACHE, filename))
+       DBG ("Starting to parse file `%s'", filename);
+
+       /* int lc_process_file(const char *appname, const char *pathname, lc_conf_type_t type); */
+       if (lc_process_file ("collectd", filename, LC_CONF_APACHE))
        {
                syslog (LOG_ERR, "lc_process_file (%s): %s", filename, lc_geterrstr ());
                return (-1);
        }
 
+       DBG ("Done parsing file `%s'", filename);
+
        /* free memory and stuff */
        lc_cleanup ();