diff --git a/plugins/utils.c b/plugins/utils.c
index bf1d20479d034c3ee979d5ad386ec2877de11e17..45373909560552b462ccbb11ecdcc51c1a7a2ca8 100644 (file)
--- a/plugins/utils.c
+++ b/plugins/utils.c
/*****************************************************************************
- *
- * utils.c
- *
- * Library of useful functions for plugins
- *
- * Copyright (c) 2000 Karl DeBisschop (karl@debisschop.net)
- * License: GPL
- *
- * $Revision$
- * $Date$
- ****************************************************************************/
+*
+* Library of useful functions for plugins
+*
+* License: GPL
+* Copyright (c) 2000 Karl DeBisschop (karl@debisschop.net)
+* Copyright (c) 2002-2007 Nagios Plugin Development Team
+*
+* 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/>.
+*
+*
+*****************************************************************************/
+
+#define LOCAL_TIMEOUT_ALARM_HANDLER
-#include "config.h"
#include "common.h"
-#include "version.h"
+#include "utils.h"
+#include "utils_base.h"
#include <stdarg.h>
#include <limits.h>
-extern int timeout_interval;
-
-char *my_basename (char *);
-void support (void);
-char *clean_revstring (const char *);
-void print_revision (char *, const char *);
-void terminate (int, const char *fmt, ...);
-RETSIGTYPE timeout_alarm_handler (int);
-
-int is_host (char *);
-int is_dotted_quad (char *);
-int is_hostname (char *);
+#include <arpa/inet.h>
-int is_integer (char *);
-int is_intpos (char *);
-int is_intneg (char *);
-int is_intnonneg (char *);
-int is_intpercent (char *);
+extern void print_usage (void);
+extern const char *progname;
-int is_numeric (char *);
-int is_positive (char *);
-int is_negative (char *);
-int is_nonnegative (char *);
-int is_percentage (char *);
-
-int is_option (char *str);
-
-double delta_time (struct timeval tv);
-
-void strip (char *);
-char *strscpy (char *dest, const char *src);
-char *strscat (char *dest, const char *src);
-char *strnl (char *str);
-char *ssprintf (char *str, const char *fmt, ...);
-char *strpcpy (char *dest, const char *src, const char *str);
-char *strpcat (char *dest, const char *src, const char *str);
-
-#define LABELLEN 63
#define STRLEN 64
#define TXTBLK 128
-#define max(a,b) ((a)>(b))?(a):(b)
-
/* **************************************************************************
- * max_state(result, STATE_x)
- * compares STATE_x to result and returns result if STATE_x is less than a based on the following
+ * max_state(STATE_x, STATE_y)
+ * compares STATE_x to STATE_y and returns result based on the following
* STATE_UNKNOWN < STATE_OK < STATE_WARNING < STATE_CRITICAL
*
* Note that numerically the above does not hold
****************************************************************************/
int
-max_state(int a, int b)
+max_state (int a, int b)
{
- if(a == STATE_CRITICAL){
- return a;
- }
- else if (a == STATE_WARNING) {
-
- if (b == STATE_CRITICAL){
- return b;
- }else {
- return a;
- }
- }
- else if (a == STATE_OK) {
-
- if ( b== STATE_CRITICAL || b == STATE_WARNING) {
- return b;
- }else{
- return a;
- }
- }
- else {
- /* a == UNKNOWN */
- return b;
- }
-
-
+ if (a == STATE_CRITICAL || b == STATE_CRITICAL)
+ return STATE_CRITICAL;
+ else if (a == STATE_WARNING || b == STATE_WARNING)
+ return STATE_WARNING;
+ else if (a == STATE_OK || b == STATE_OK)
+ return STATE_OK;
+ else if (a == STATE_UNKNOWN || b == STATE_UNKNOWN)
+ return STATE_UNKNOWN;
+ else if (a == STATE_DEPENDENT || b == STATE_DEPENDENT)
+ return STATE_DEPENDENT;
+ else
+ return max (a, b);
}
-char *
-my_basename (char *path)
+/* **************************************************************************
+ * max_state_alt(STATE_x, STATE_y)
+ * compares STATE_x to STATE_y and returns result based on the following
+ * STATE_OK < STATE_DEPENDENT < STATE_UNKNOWN < STATE_WARNING < STATE_CRITICAL
+ *
+ * The main difference between max_state_alt and max_state it that it doesn't
+ * allow setting a default to UNKNOWN. It will instead prioritixe any valid
+ * non-OK state.
+ ****************************************************************************/
+
+int
+max_state_alt (int a, int b)
{
- if (!strstr (path, "/"))
- return path;
+ if (a == STATE_CRITICAL || b == STATE_CRITICAL)
+ return STATE_CRITICAL;
+ else if (a == STATE_WARNING || b == STATE_WARNING)
+ return STATE_WARNING;
+ else if (a == STATE_UNKNOWN || b == STATE_UNKNOWN)
+ return STATE_UNKNOWN;
+ else if (a == STATE_DEPENDENT || b == STATE_DEPENDENT)
+ return STATE_DEPENDENT;
+ else if (a == STATE_OK || b == STATE_OK)
+ return STATE_OK;
else
- return 1 + strrchr (path, '/');
+ return max (a, b);
}
-
-void
-support (void)
+void usage (const char *msg)
{
- printf
- ("Send email to nagios-users@lists.sourceforge.net if you have questions\n"
- "regarding use of this software. To submit patches or suggest improvements,\n"
- "send email to nagiosplug-devel@lists.sourceforge.net\n");
+ printf ("%s\n", msg);
+ print_usage ();
+ exit (STATE_UNKNOWN);
}
-
-char *
-clean_revstring (const char *revstring)
+void usage_va (const char *fmt, ...)
{
- char plugin_revision[STRLEN];
- if (sscanf (revstring,"$Revision: %[0-9.]",plugin_revision) == 1)
- return strscpy (NULL, plugin_revision);
- else
- return strscpy (NULL, "N/A");
+ va_list ap;
+ printf("%s: ", progname);
+ va_start(ap, fmt);
+ vprintf(fmt, ap);
+ va_end(ap);
+ printf("\n");
+ exit (STATE_UNKNOWN);
}
-void
-print_revision (char *command_name, const char *revision_string)
+void usage2(const char *msg, const char *arg)
{
- char plugin_revision[STRLEN];
-
- if (sscanf (revision_string, "$Revision: %[0-9.]", plugin_revision) != 1)
- strncpy (plugin_revision, "N/A", STRLEN);
- printf ("%s (nagios-plugins %s) %s\n",
- my_basename (command_name), VERSION, plugin_revision);
- printf
- ("The nagios plugins come with ABSOLUTELY NO WARRANTY. You may redistribute\n"
- "copies of the plugins under the terms of the GNU General Public License.\n"
- "For more information about these matters, see the file named COPYING.\n");
-
+ printf ("%s: %s - %s\n", progname, msg, arg?arg:"(null)" );
+ print_usage ();
+ exit (STATE_UNKNOWN);
}
-
void
-terminate (int result, const char *fmt, ...)
+usage3 (const char *msg, int arg)
{
- va_list ap;
- va_start (ap, fmt);
- vprintf (fmt, ap);
- va_end (ap);
- exit (result);
+ printf ("%s: %s - %c\n", progname, msg, arg);
+ print_usage();
+ exit (STATE_UNKNOWN);
}
void
-timeout_alarm_handler (int signo)
+usage4 (const char *msg)
{
- if (signo == SIGALRM) {
- printf ("CRITICAL - Plugin timed out after %d seconds\n",
- timeout_interval);
- exit (STATE_CRITICAL);
- }
+ printf ("%s: %s\n", progname, msg);
+ print_usage();
+ exit (STATE_UNKNOWN);
}
-int
-is_host (char *address)
+void
+usage5 (void)
{
- if (is_dotted_quad (address) || is_hostname (address))
- return (TRUE);
- return (FALSE);
+ print_usage();
+ exit (STATE_UNKNOWN);
}
-int
-is_dotted_quad (char *address)
+void
+print_revision (const char *command_name, const char *revision)
{
- int o1, o2, o3, o4;
- char c[1];
+ char plugin_revision[STRLEN];
- if (sscanf (address, "%d.%d.%d.%d%c", &o1, &o2, &o3, &o4, c) != 4)
- return FALSE;
- else if (o1 > 255 || o2 > 255 || o3 > 255 || o4 > 255)
- return FALSE;
- else if (o1 < 0 || o2 < 0 || o3 < 0 || o4 < 0)
- return FALSE;
- else
- return TRUE;
+ printf ("%s v%s (%s %s)\n",
+ command_name, revision, PACKAGE, VERSION);
}
-/* from RFC-1035
- *
- * The labels must follow the rules for ARPANET host names. They must
- * start with a letter, end with a letter or digit, and have as interior
- * characters only letters, digits, and hyphen. There are also some
- * restrictions on the length. Labels must be 63 characters or less. */
+const char *
+state_text (int result)
+{
+ switch (result) {
+ case STATE_OK:
+ return "OK";
+ case STATE_WARNING:
+ return "WARNING";
+ case STATE_CRITICAL:
+ return "CRITICAL";
+ case STATE_DEPENDENT:
+ return "DEPENDENT";
+ default:
+ return "UNKNOWN";
+ }
+}
-int
-is_hostname (char *s1)
+void
+timeout_alarm_handler (int signo)
{
- if (strlen (s1) > 63)
- return FALSE;
- if (strcspn
- (s1,
- "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUWVXYZ0123456789-.") !=
- 0) return FALSE;
- if (strspn (s1, "0123456789-.") == 1)
- return FALSE;
- while ((s1 = index (s1, '.'))) {
- s1++;
- if (strspn (s1, "0123456789-.") == 1) {
- printf ("%s\n", s1);
- return FALSE;
- }
+ if (signo == SIGALRM) {
+ printf (_("%s - Plugin timed out after %d seconds\n"),
+ state_text(timeout_state), timeout_interval);
+ exit (timeout_state);
}
- return TRUE;
}
int
{
char tmp[1];
float x;
- if (sscanf (number, "%f%c", &x, tmp) == 1)
- return (TRUE);
- return (FALSE);
+
+ if (!number)
+ return FALSE;
+ else if (sscanf (number, "%f%c", &x, tmp) == 1)
+ return TRUE;
+ else
+ return FALSE;
}
int
is_positive (char *number)
{
if (is_numeric (number) && atof (number) > 0.0)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
is_negative (char *number)
{
if (is_numeric (number) && atof (number) < 0.0)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
is_nonnegative (char *number)
{
if (is_numeric (number) && atof (number) >= 0.0)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
{
int x;
if (is_numeric (number) && (x = atof (number)) >= 0 && x <= 100)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
{
long int n;
- if (strspn (number, "-0123456789 ") != strlen (number))
- return (FALSE);
+ if (!number || (strspn (number, "-0123456789 ") != strlen (number)))
+ return FALSE;
n = strtol (number, NULL, 10);
+
if (errno != ERANGE && n >= INT_MIN && n <= INT_MAX)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
is_intpos (char *number)
{
if (is_integer (number) && atoi (number) > 0)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
is_intneg (char *number)
{
if (is_integer (number) && atoi (number) < 0)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
is_intnonneg (char *number)
{
if (is_integer (number) && atoi (number) >= 0)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
{
int i;
if (is_integer (number) && (i = atoi (number)) >= 0 && i <= 100)
- return (TRUE);
- return (FALSE);
+ return TRUE;
+ else
+ return FALSE;
}
int
is_option (char *str)
{
- if (strspn (str, "-") == 1 || strspn (str, "-") == 2)
+ if (!str)
+ return FALSE;
+ else if (strspn (str, "-") == 1 || strspn (str, "-") == 2)
return TRUE;
- return FALSE;
+ else
+ return FALSE;
}
-
-
-#ifndef HAVE_GETTIMEOFDAY
+#ifdef NEED_GETTIMEOFDAY
int
gettimeofday (struct timeval *tv, struct timezone *tz)
{
+long
+deltime (struct timeval tv)
+{
+ struct timeval now;
+ gettimeofday (&now, NULL);
+ return (now.tv_sec - tv.tv_sec)*1000000 + now.tv_usec - tv.tv_usec;
+}
+
+
+
void
strip (char *buffer)
}
-
-
-
/******************************************************************************
*
* Copies one string to another. Any previously existing data in
-
-
-/******************************************************************************
- *
- * Concatenates one string to the end of another
- *
- * Given a pointer destination string, which may or may not already
- * hold some text, and a source string with additional text (possibly
- * NULL or empty), returns a pointer to a string that is the first
- * string with the second concatenated to it. Uses realloc to free
- * memory held by the dest argument if new storage space is required.
- *
- * Example:
- *
- * char *str=NULL;
- * str = strscpy("This is a line of text with no trailing newline");
- * str = strscat(str,"\n");
- *
- *****************************************************************************/
-
-char *
-strscat (char *dest, const char *src)
-{
-
- if (dest == NULL)
- return src;
- if (src != NULL)
- asprintf (&dest, "%s%s", dest, src);
-
- return dest;
-}
-
-
-
-
-
/******************************************************************************
*
* Returns a pointer to the next line of a multiline string buffer
}
-
-
-
-/******************************************************************************
- *
- * Does a formatted print to a string variable
- *
- * Given a pointer destination string, which may or may not already
- * hold some text, and a source string with additional text (possibly
- * NULL or empty), returns a pointer to a string that cntains the
- * results of the specified formatted print
- *
- * Example:
- *
- * char *str=NULL;
- * str = ssprintf(str,"%d %s",1,"string");
- *
- *****************************************************************************/
-
-char *
-ssprintf (char *ptr, const char *fmt, ...)
-{
- va_list ap;
- int nchars;
- size_t size;
- char *str = NULL;
-
- if (str == NULL) {
- str = malloc (TXTBLK);
- if (str == NULL)
- terminate (STATE_UNKNOWN, "malloc failed in ssprintf");
- size = TXTBLK;
- }
- else
- size = max (strlen (str), TXTBLK);
-
- va_start (ap, fmt);
-
- while (1) {
-
- nchars = vsnprintf (str, size, fmt, ap);
-
- if (nchars > -1)
- if (nchars < (int) size) {
- va_end (ap);
- str[nchars] = '\0';
- if (ptr)
- free (ptr);
- return str;
- }
- else {
- size = (size_t) (nchars + 1);
- }
-
- else
- size *= 2;
-
- str = realloc (str, size);
-
- if (str == NULL)
- terminate (STATE_UNKNOWN, "realloc failed in ssprintf");
- }
-
-}
-
-
-
-
-
/******************************************************************************
*
* Like strscpy, except only the portion of the source string up to
if (dest == NULL || strlen (dest) < len)
dest = realloc (dest, len + 1);
if (dest == NULL)
- terminate (STATE_UNKNOWN, "failed realloc in strpcpy\n");
+ die (STATE_UNKNOWN, _("failed realloc in strpcpy\n"));
strncpy (dest, src, len);
dest[len] = '\0';
-
-
/******************************************************************************
*
* Like strscat, except only the portion of the source string up to
dest = realloc (dest, len + l2 + 1);
if (dest == NULL)
- terminate (STATE_UNKNOWN, "failed malloc in strscat\n");
+ die (STATE_UNKNOWN, _("failed malloc in strscat\n"));
strncpy (dest + len, src, l2);
dest[len + l2] = '\0';
return dest;
}
+
+/******************************************************************************
+ *
+ * Print perfdata in a standard format
+ *
+ ******************************************************************************/
+
+char *perfdata (const char *label,
+ long int val,
+ const char *uom,
+ int warnp,
+ long int warn,
+ int critp,
+ long int crit,
+ int minp,
+ long int minv,
+ int maxp,
+ long int maxv)
+{
+ char *data = NULL;
+
+ if (strpbrk (label, "'= "))
+ asprintf (&data, "'%s'=%ld%s;", label, val, uom);
+ else
+ asprintf (&data, "%s=%ld%s;", label, val, uom);
+
+ if (warnp)
+ asprintf (&data, "%s%ld;", data, warn);
+ else
+ asprintf (&data, "%s;", data);
+
+ if (critp)
+ asprintf (&data, "%s%ld;", data, crit);
+ else
+ asprintf (&data, "%s;", data);
+
+ if (minp)
+ asprintf (&data, "%s%ld", data, minv);
+
+ if (maxp)
+ asprintf (&data, "%s;%ld", data, maxv);
+
+ return data;
+}
+
+
+char *fperfdata (const char *label,
+ double val,
+ const char *uom,
+ int warnp,
+ double warn,
+ int critp,
+ double crit,
+ int minp,
+ double minv,
+ int maxp,
+ double maxv)
+{
+ char *data = NULL;
+
+ if (strpbrk (label, "'= "))
+ asprintf (&data, "'%s'=", label);
+ else
+ asprintf (&data, "%s=", label);
+
+ asprintf (&data, "%s%f", data, val);
+ asprintf (&data, "%s%s;", data, uom);
+
+ if (warnp)
+ asprintf (&data, "%s%f", data, warn);
+
+ asprintf (&data, "%s;", data);
+
+ if (critp)
+ asprintf (&data, "%s%f", data, crit);
+
+ asprintf (&data, "%s;", data);
+
+ if (minp)
+ asprintf (&data, "%s%f", data, minv);
+
+ if (maxp) {
+ asprintf (&data, "%s;", data);
+ asprintf (&data, "%s%f", data, maxv);
+ }
+
+ return data;
+}