Code

Update french translation (fix all fuzzy's)
[nagiosplug.git] / plugins / negate.c
index 874aea14ff6c2958ea701b20ae7a3238cb077cef..8eac722023d2e28f6b7e670dc5e99843b3ede19d 100644 (file)
@@ -1,86 +1,75 @@
-/******************************************************************************
-
- 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 Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-@@-<article>
-
-<sect1>
-<title>Quick Reference</title>
-<refentry>
-<refmeta><manvolnum>5<manvolnum></refmeta>
-<refnamdiv>
-<refname>&progname;</refname>
-<refpurpose>&SUMMARY;</refpurpose>
-</refnamdiv>
-</refentry>
-</sect1>
-
-<sect1>
-<title>FAQ</title>
-</sect1>
-
-<sect1>
-<title>Theory, Installation, and Operation</title>
-
-<sect2>
-<title>General Description</title>
-<para>
-&DESCRIPTION;
-</para>
-</sect2>
-
-<sect2>
-<title>Future Enhancements</title>
-<para>ToDo List</para>
-<itemizedlist>
-<listitem>Add option to do regex substitution in output text</listitem>
-</itemizedlist>
-</sect2>-@@
-
-******************************************************************************/
+/*****************************************************************************
+* 
+* Nagios negate plugin
+* 
+* License: GPL
+* Copyright (c) 2002-2008 Nagios Plugins Development Team
+* 
+* Description:
+* 
+* This file contains the negate plugin
+* 
+* Negates the status of a plugin (returns OK for CRITICAL, and vice-versa).
+* Can also perform custom state switching.
+* 
+* 
+* 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 Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+* 
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+* 
+* You should have received a copy of the GNU General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+* 
+* 
+*****************************************************************************/
 
 const char *progname = "negate";
-const char *revision = "$Revision$";
-const char *copyright = "2002-2003";
+const char *copyright = "2002-2008";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
-#define DEFAULT_TIMEOUT 9
+#define DEFAULT_TIMEOUT 11
 
 #include "common.h"
 #include "utils.h"
-#include "popen.h"
+#include "utils_cmd.h"
 
-char *command_line;
+/* char *command_line; */
 
-int process_arguments (int, char **);
-int validate_arguments (void);
+static const char **process_arguments (int, char **);
+int validate_arguments (char **);
 void print_help (void);
 void print_usage (void);
+int subst_text = FALSE;
+
+static int state[4] = {
+       STATE_OK,
+       STATE_WARNING,
+       STATE_CRITICAL,
+       STATE_UNKNOWN,
+};
 
 int
 main (int argc, char **argv)
 {
        int found = 0, result = STATE_UNKNOWN;
-       char *buf;
+       char *buf, *sub;
+       char **command_line;
+       output chld_out, chld_err;
+       int i;
 
        setlocale (LC_ALL, "");
        bindtextdomain (PACKAGE, LOCALEDIR);
        textdomain (PACKAGE);
 
-       if (process_arguments (argc, argv) == ERROR)
-               usage (_("Could not parse arguments\n"));
+       timeout_interval = DEFAULT_TIMEOUT;
+
+       command_line = (char **) process_arguments (argc, argv);
 
        /* Set signal handling and alarm */
        if (signal (SIGALRM, timeout_alarm_handler) == SIG_ERR)
@@ -88,189 +77,218 @@ main (int argc, char **argv)
 
        (void) alarm ((unsigned) timeout_interval);
 
-       child_process = spopen (command_line);
-       if (child_process == NULL)
-               die (STATE_UNKNOWN, _("Could not open pipe: %s\n"), command_line);
-
-       child_stderr = fdopen (child_stderr_array[fileno (child_process)], "r");
-       if (child_stderr == NULL) {
-               printf (_("Could not open stderr for %s\n"), command_line);
+       /* catch when the command is quoted */
+       if(command_line[1] == NULL) {
+               result = cmd_run (command_line[0], &chld_out, &chld_err, 0);
+       } else {
+               result = cmd_run_array (command_line, &chld_out, &chld_err, 0);
        }
-
-       buf = malloc(MAX_INPUT_BUFFER);
-       while (fgets (buf, MAX_INPUT_BUFFER - 1, child_process)) {
-               found++;
-               printf ("%s", buf);
+       if (chld_err.lines > 0) {
+               printf ("Error output from command:\n");
+               for (i = 0; i < chld_err.lines; i++) {
+                       printf ("%s\n", chld_err.line[i]);
+               }
+               exit (STATE_WARNING);
        }
 
-       if (!found)
-               die (STATE_UNKNOWN,
-                    _("%s problem - No data recieved from host\nCMD: %s\n"),\
-                    argv[0], command_line);
-
-       /* close the pipe */
-       result = spclose (child_process);
-
-       /* WARNING if output found on stderr */
-       if (fgets (buf, MAX_INPUT_BUFFER - 1, child_stderr))
-               result = max_state (result, STATE_WARNING);
-
-       /* close stderr */
-       (void) fclose (child_stderr);
+       /* Return UNKNOWN or worse if no output is returned */
+       if (chld_out.lines == 0)
+               die (max_state_alt (result, STATE_UNKNOWN), _("No data returned from command\n"));
+
+       for (i = 0; i < chld_out.lines; i++) {
+               if (subst_text && result != state[result] &&
+                   result >= 0 && result <= 4) {
+                       /* Loop over each match found */
+                       while ((sub = strstr (chld_out.line[i], state_text (result)))) {
+                               /* Terminate the first part and skip over the string we'll substitute */
+                               *sub = '\0';
+                               sub += strlen (state_text (result));
+                               /* then put everything back together */
+                               asprintf (&chld_out.line[i], "%s%s%s", chld_out.line[i], state_text (state[result]), sub);
+                       }
+               }
+               printf ("%s\n", chld_out.line[i]);
+       }
 
-       if (result == STATE_OK)
-               exit (STATE_CRITICAL);
-       else if (result == STATE_CRITICAL)
-               exit (EXIT_SUCCESS);
-       else
+       if (result >= 0 && result <= 4) {
+               exit (state[result]);
+       } else {
                exit (result);
+       }
 }
-\f
-
-
-/******************************************************************************
-@@-
-<sect2>
-<title>Functions</title>
-
-<sect3>
-<title>process_arguments</title>
-
-<para>This function parses the command line into the needed
-variables.</para>
 
-<para>Aside from the standard 'help' and 'version' options, there
-is a only a 'timeout' option.</para>
-
-</sect3>
--@@
-******************************************************************************/
 
 /* process command-line arguments */
-int
+static const char **
 process_arguments (int argc, char **argv)
 {
        int c;
+       int permute = TRUE;
 
        int option = 0;
        static struct option longopts[] = {
                {"help", no_argument, 0, 'h'},
                {"version", no_argument, 0, 'V'},
                {"timeout", required_argument, 0, 't'},
+               {"timeout-result", required_argument, 0, 'T'},
+               {"ok", required_argument, 0, 'o'},
+               {"warning", required_argument, 0, 'w'},
+               {"critical", required_argument, 0, 'c'},
+               {"unknown", required_argument, 0, 'u'},
+               {"substitute", no_argument, 0, 's'},
                {0, 0, 0, 0}
        };
 
        while (1) {
-               c = getopt_long (argc, argv, "+hVt:",
-                                longopts, &option);
+               c = getopt_long (argc, argv, "+hVt:T:o:w:c:u:s", longopts, &option);
 
                if (c == -1 || c == EOF)
                        break;
 
                switch (c) {
                case '?':     /* help */
-                       usage3 (_("Unknown argument"), optopt);
+                       usage5 ();
                        break;
                case 'h':     /* help */
                        print_help ();
                        exit (EXIT_SUCCESS);
                        break;
                case 'V':     /* version */
-                       print_revision (progname, revision);
+                       print_revision (progname, NP_VERSION);
                        exit (EXIT_SUCCESS);
                case 't':     /* timeout period */
                        if (!is_integer (optarg))
-                               usage2 (_("Timeout Interval must be an integer"), optarg);
+                               usage2 (_("Timeout interval must be a positive integer"), optarg);
                        else
                                timeout_interval = atoi (optarg);
                        break;
+               case 'T':     /* Result to return on timeouts */
+                       if ((timeout_state = translate_state(optarg)) == ERROR)
+                               usage4 (_("Timeout result must be a valid state name (OK, WARNING, CRITICAL, UNKNOWN) or integer (0-3)."));
+                       break;
+               case 'o':     /* replacement for OK */
+                       if ((state[STATE_OK] = translate_state(optarg)) == ERROR)
+                               usage4 (_("Ok must be a valid state name (OK, WARNING, CRITICAL, UNKNOWN) or integer (0-3)."));
+                       permute = FALSE;
+                       break;
+
+               case 'w':     /* replacement for WARNING */
+                       if ((state[STATE_WARNING] = translate_state(optarg)) == ERROR)
+                               usage4 (_("Warning must be a valid state name (OK, WARNING, CRITICAL, UNKNOWN) or integer (0-3)."));
+                       permute = FALSE;
+                       break;
+               case 'c':     /* replacement for CRITICAL */
+                       if ((state[STATE_CRITICAL] = translate_state(optarg)) == ERROR)
+                               usage4 (_("Critical must be a valid state name (OK, WARNING, CRITICAL, UNKNOWN) or integer (0-3)."));
+                       permute = FALSE;
+                       break;
+               case 'u':     /* replacement for UNKNOWN */
+                       if ((state[STATE_UNKNOWN] = translate_state(optarg)) == ERROR)
+                               usage4 (_("Unknown must be a valid state name (OK, WARNING, CRITICAL, UNKNOWN) or integer (0-3)."));
+                       permute = FALSE;
+                       break;
+               case 's':     /* Substitute status text */
+                       subst_text = TRUE;
+                       break;
                }
        }
 
-       asprintf (&command_line, "%s", argv[optind]);
-       for (c = optind+1; c < argc; c++) {
-               asprintf (&command_line, "%s %s", command_line, argv[c]);
+       validate_arguments (&argv[optind]);
+
+       if (permute) { /* No [owcu] switch specified, default to this */
+               state[STATE_OK] = STATE_CRITICAL;
+               state[STATE_CRITICAL] = STATE_OK;
        }
 
-       return validate_arguments ();
+       return (const char **) &argv[optind];
 }
 
 
-/******************************************************************************
-@@-
-<sect3>
-<title>validate_arguments</title>
+int
+validate_arguments (char **command_line)
+{
+       if (command_line[0] == NULL)
+               usage4 (_("Could not parse arguments"));
 
-<para>No validation is currently done.</para>
+       if (strncmp(command_line[0],"/",1) != 0 && strncmp(command_line[0],"./",2) != 0)
+               usage4 (_("Require path to command"));
+}
 
-</sect3>
--@@
-******************************************************************************/
 
 int
-validate_arguments ()
+translate_state (char *state_text)
 {
-       if (command_line == NULL)
-               return ERROR;
-       return STATE_OK;
+       char *temp_ptr;
+       for (temp_ptr = state_text; *temp_ptr; temp_ptr++) {
+               *temp_ptr = toupper(*temp_ptr);
+       }
+       if (!strcmp(state_text,"OK") || !strcmp(state_text,"0"))
+               return STATE_OK;
+       if (!strcmp(state_text,"WARNING") || !strcmp(state_text,"1"))
+               return STATE_WARNING;
+       if (!strcmp(state_text,"CRITICAL") || !strcmp(state_text,"2"))
+               return STATE_CRITICAL;
+       if (!strcmp(state_text,"UNKNOWN") || !strcmp(state_text,"3"))
+               return STATE_UNKNOWN;
+       return ERROR;
 }
 
-/******************************************************************************
-@@-
-</sect2> 
-</sect1>
-</article>
--@@
-******************************************************************************/
-
-
-
-
-
-\f
 void
 print_help (void)
 {
-       print_revision (progname, revision);
+       print_revision (progname, NP_VERSION);
+
+       printf (COPYRIGHT, copyright, email);
 
-       printf (_(COPYRIGHT), copyright, email);
+       printf ("%s\n", _("Negates the status of a plugin (returns OK for CRITICAL and vice-versa)."));
+       printf ("%s\n", _("Additional switches can be used to control which state becomes what."));
 
-       printf (_("\
-Negates the status of a plugin (returns OK for CRITICAL, and vice-versa).\n\
-\n"));
+       printf ("\n\n");
 
        print_usage ();
 
        printf (_(UT_HELP_VRSN));
 
-       printf (_(UT_TIMEOUT), DEFAULT_TIMEOUT);
-
-       printf (_("\
-     [keep timeout than the plugin timeout to retain CRITICAL status]\n"));
-
-       printf (_("\
-  negate \"/usr/local/nagios/libexec/check_ping -H host\"\n\
-    Run check_ping and invert result. Must use full path to plugin\n\
-  negate \"/usr/local/nagios/libexec/check_procs -a 'vi negate.c'\"\n\
-    Use single quotes if you need to retain spaces\n"));
-
-       printf (_("\
-This plugin is a wrapper to take the output of another plugin and invert it.\n\
-If the wrapped plugin returns STATE_OK, the wrapper will return STATE_CRITICAL.\n\
-If the wrapped plugin returns STATE_CRITICAL, the wrapper will return STATE_OK.\n\
-Otherwise, the output state of the wrapped plugin is unchanged.\n"));
+       printf (_(UT_TIMEOUT), timeout_interval);
+       printf ("    %s\n", _("Keep timeout longer than the plugin timeout to retain CRITICAL status."));
+       printf (" -T, --timeout-result=STATUS\n");
+       printf ("    %s\n", _("Custom result on Negate timeouts; see below for STATUS definition\n"));
+
+       printf(" -o, --ok=STATUS\n");
+       printf(" -w, --warning=STATUS\n");
+       printf(" -c, --critical=STATUS\n");
+       printf(" -u, --unknown=STATUS\n");
+       printf(_("    STATUS can be 'OK', 'WARNING', 'CRITICAL' or 'UNKNOWN' without single\n"));
+       printf(_("    quotes. Numeric values are accepted. If nothing is specified, permutes\n"));
+       printf(_("    OK and CRITICAL.\n"));
+       printf(" -s, --substitute\n");
+       printf(_("    Substitute output text as well. Will only substitute text in CAPITALS\n"));
+
+       printf ("\n");
+       printf ("%s\n", _("Examples:"));
+       printf (" %s\n", "negate /usr/local/nagios/libexec/check_ping -H host");
+       printf ("    %s\n", _("Run check_ping and invert result. Must use full path to plugin"));
+       printf (" %s\n", "negate -w OK -c UNKNOWN /usr/local/nagios/libexec/check_procs -a 'vi negate.c'");
+       printf ("    %s\n", _("This will return OK instead of WARNING and UNKNOWN instead of CRITICAL"));
+       printf ("\n");
+       printf ("%s\n", _("Notes:"));
+       printf (" %s\n", _("This plugin is a wrapper to take the output of another plugin and invert it."));
+       printf (" %s\n", _("The full path of the plugin must be provided."));
+       printf (" %s\n", _("If the wrapped plugin returns OK, the wrapper will return CRITICAL."));
+       printf (" %s\n", _("If the wrapped plugin returns CRITICAL, the wrapper will return OK."));
+       printf (" %s\n", _("Otherwise, the output state of the wrapped plugin is unchanged."));
+       printf ("\n");
+       printf (" %s\n", _("Using timeout-result, it is possible to override the timeout behaviour or a"));
+       printf (" %s\n", _("plugin by setting the negate timeout a bit lower."));
 
        printf (_(UT_SUPPORT));
 }
 
 
 
-
-
 void
 print_usage (void)
 {
-       printf (_("Usage: %s [-t timeout] <definition of wrapped plugin>\n"),
-               progname);
-       printf (_(UT_HLP_VRS), progname, progname);
+       printf (_("Usage:"));
+       printf ("%s [-t timeout] [-Towcu STATE] [-s] <definition of wrapped plugin>\n", progname);
 }