Imported Upstream version 1.4.5

plugins/utils.h

@@ -0,0 +1,184 @@
+#ifndef NP_UTILS_H
+#define NP_UTILS_H
+/* Header file for nagios plugins utils.c */
+
+/* This file should be included in all plugins */
+
+/* The purpose of this package is to provide safer alternatives to C
+functions that might otherwise be vulnerable to hacking. This
+currently includes a standard suite of validation routines to be sure
+that an string argument acually converts to its intended type and a
+suite of string handling routine that do their own memory management
+in order to resist overflow attacks. In addition, a few functions are
+provided to standardize version and error reporting across the entire
+suite of plugins. */
+
+/* now some functions etc are being defined in ../lib/utils_base.c */
+#include "utils_base.h"
+
+/* Standardize version information, termination */
+
+/* $Id: utils.h,v 1.32 2006/09/02 20:41:18 seanius Exp $ */
+
+void support (void);
+char *clean_revstring (const char *);
+void print_revision (const char *, const char *);
+
+/* Handle timeouts */
+
+#ifdef LOCAL_TIMEOUT_ALARM_HANDLER
+extern unsigned int timeout_interval;
+RETSIGTYPE timeout_alarm_handler (int);
+#else
+unsigned int timeout_interval = DEFAULT_SOCKET_TIMEOUT;
+extern RETSIGTYPE timeout_alarm_handler (int);
+#endif
+
+time_t start_time, end_time;
+
+/* Test input types */
+
+int is_integer (char *);
+int is_intpos (char *);
+int is_intneg (char *);
+int is_intnonneg (char *);
+int is_intpercent (char *);
+
+int is_numeric (char *);
+int is_positive (char *);
+int is_negative (char *);
+int is_nonnegative (char *);
+int is_percentage (char *);
+
+int is_option (char *);
+
+/* Generalized timer that will do milliseconds if available */
+#ifndef HAVE_STRUCT_TIMEVAL
+struct timeval {
+	long tv_sec;        /* seconds */
+	long tv_usec;  /* microseconds */
+};
+#endif
+
+#ifndef HAVE_GETTIMEOFDAY
+int gettimeofday(struct timeval *, struct timezone *);
+#endif
+
+double delta_time (struct timeval tv);
+long deltime (struct timeval tv);
+
+/* Handle strings safely */
+
+void strip (char *);
+char *strscpy (char *, const char *);
+char *strnl (char *);
+char *strpcpy (char *, const char *, const char *);
+char *strpcat (char *, const char *, const char *);
+
+int max_state (int a, int b);
+
+void usage (const char *) __attribute__((noreturn));
+void usage2(const char *, const char *) __attribute__((noreturn));
+void usage3(const char *, int) __attribute__((noreturn));
+void usage4(const char *);
+void usage_va(const char *fmt, ...);
+
+const char *state_text (int);
+
+#define max(a,b) (((a)>(b))?(a):(b))
+#define min(a,b) (((a)<(b))?(a):(b))
+
+char *perfdata (const char *,
+ long int,
+ const char *,
+ int,
+ long int,
+ int,
+ long int,
+ int,
+ long int,
+ int,
+ long int);
+
+char *fperfdata (const char *,
+ double,
+ const char *,
+ int,
+ double,
+ int,
+ double,
+ int,
+ double,
+ int,
+ double);
+
+/* The idea here is that, although not every plugin will use all of these, 
+   most will or should.  Therefore, for consistency, these very common 
+   options should have only these meanings throughout the overall suite */
+
+#define STD_LONG_OPTS \
+{"version",no_argument,0,'V'},\
+{"verbose",no_argument,0,'v'},\
+{"help",no_argument,0,'h'},\
+{"timeout",required_argument,0,'t'},\
+{"critical",required_argument,0,'c'},\
+{"warning",required_argument,0,'w'},\
+{"hostname",required_argument,0,'H'}
+
+#define COPYRIGHT "Copyright (c) %s Nagios Plugin Development Team\n\
+\t<%s>\n\n"
+
+#define UT_HLP_VRS "\
+       %s (-h | --help) for detailed help\n\
+       %s (-V | --version) for version information\n"
+
+#define UT_HELP_VRSN "\
+\nOptions:\n\
+ -h, --help\n\
+    Print detailed help screen\n\
+ -V, --version\n\
+    Print version information\n"
+
+#define UT_HOST_PORT "\
+ -H, --hostname=ADDRESS\n\
+    Host name, IP Address, or unix socket (must be an absolute path)\n\
+ -%c, --port=INTEGER\n\
+    Port number (default: %s)\n"
+
+#define UT_IPv46 "\
+ -4, --use-ipv4\n\
+    Use IPv4 connection\n\
+ -6, --use-ipv6\n\
+    Use IPv6 connection\n"
+
+#define UT_VERBOSE "\
+ -v, --verbose\n\
+    Show details for command-line debugging (Nagios may truncate output)\n"
+
+#define UT_WARN_CRIT "\
+ -w, --warning=DOUBLE\n\
+    Response time to result in warning status (seconds)\n\
+ -c, --critical=DOUBLE\n\
+    Response time to result in critical status (seconds)\n"
+
+#define UT_WARN_CRIT_RANGE "\
+ -w, --warning=RANGE\n\
+    Warning range (format: start:end). Alert if outside this range\n\
+ -c, --critical=RANGE\n\
+    Critical range\n"
+
+#define UT_TIMEOUT "\
+ -t, --timeout=INTEGER\n\
+    Seconds before connection times out (default: %d)\n"
+
+#define UT_SUPPORT "\n\
+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"
+
+#define UT_NOWARRANTY "\n\
+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"
+
+#endif /* NP_UTILS_H */