diff --git a/plugins/check_game.c b/plugins/check_game.c
index 8cf1bf4290ab9e469dc1152150afef5ba73184e2..235be65ca6125b9ddb97ad93f9e53d81e35fc757 100644 (file)
--- a/plugins/check_game.c
+++ b/plugins/check_game.c
-/******************************************************************************
- *
- * CHECK_GAME.C
- *
- * Program: GAME plugin for Nagios
- * License: GPL
- * Copyright (c) 1999 Ian Cass (ian@knowledge.com)
- *
- * Last Modified: $Date$
- *
- * Mod History
- *
- * 25-8-99 Ethan Galstad <nagios@nagios.org>
- * Integrated with common plugin code, minor cleanup stuff
- *
- * 17-8-99 version 1.1b
- *
- * 17-8-99 make port a separate argument so we can use something like
- * check_game q2s!27910 with the probe set up as
- * check_game $ARG1$ $HOSTADDRESS$ $ARG2$
- *
- * 17-8-99 Put in sanity check for ppl who enter the wrong server type
- *
- * 17-8-99 Release version 1.0b
- *
- * Command line: CHECK_GAME <server type> <ip_address> [port]
- *
- * server type = a server type that qstat understands (type qstat & look at the -default line)
- * ip_address = either a dotted address or a FQD name
- * port = defaults game default port
- *
- *
- * Description:
- *
- * Needed to explore writing my own probes for nagios. It looked
- * pretty simple so I thought I'd write one for monitoring the status
- * of game servers. It uses qstat to do the actual monitoring and
- * analyses the result. Doing it this way means I can support all the
- * servers that qstat does and will do in the future.
- *
- *
- * Dependencies:
- *
- * This plugin uses the 'qstat' command If you don't
- * have the package installed you will need to download it from
- * http://www.activesw.com/people/steve/qstat.html or any popular files archive
- * before you can use this plugin.
- *
- * License Information:
- *
- * 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.
- *
- *****************************************************************************/
+/*****************************************************************************
+*
+* Nagios check_game plugin
+*
+* License: GPL
+* Copyright (c) 2002-2007 Nagios Plugins Development Team
+*
+* Description:
+*
+* This file contains the check_game plugin
+*
+* This plugin tests game server connections with the specified host.
+* using the qstat program
+*
+*
+* 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 = "check_game";
+const char *copyright = "2002-2007";
+const char *email = "nagiosplug-devel@lists.sourceforge.net";
-#include "config.h"
#include "common.h"
#include "utils.h"
+#include "runcmd.h"
int process_arguments (int, char **);
-const char *progname = "check_game";
+int validate_arguments (void);
+void print_help (void);
+void print_usage (void);
-#define QSTAT_DATA_DELIMITER ","
+#define QSTAT_DATA_DELIMITER ","
-#define QSTAT_HOST_ERROR "ERROR"
-#define QSTAT_HOST_DOWN "DOWN"
-#define QSTAT_HOST_TIMEOUT "TIMEOUT"
-#define QSTAT_MAX_RETURN_ARGS 12
+#define QSTAT_HOST_ERROR "ERROR"
+#define QSTAT_HOST_DOWN "DOWN"
+#define QSTAT_HOST_TIMEOUT "TIMEOUT"
+#define QSTAT_MAX_RETURN_ARGS 12
-char server_ip[MAX_HOST_ADDRESS_LENGTH];
-char game_type[MAX_INPUT_BUFFER];
-char port[MAX_INPUT_BUFFER];
+char *server_ip;
+char *game_type;
+int port = 0;
-int qstat_game_players_max = 4;
-int qstat_game_players = 5;
-int qstat_game_field = 2;
-int qstat_map_field = 3;
-int qstat_ping_field = 5;
+int verbose;
+
+int qstat_game_players_max = -1;
+int qstat_game_players = -1;
+int qstat_game_field = -1;
+int qstat_map_field = -1;
+int qstat_ping_field = -1;
int
main (int argc, char **argv)
{
- char command_line[MAX_INPUT_BUFFER];
- int result;
- FILE *fp;
- char input_buffer[MAX_INPUT_BUFFER];
- char response[MAX_INPUT_BUFFER];
- char *temp_ptr;
- int found;
- char *p, *ret[QSTAT_MAX_RETURN_ARGS];
- int i;
-
- result = process_arguments (argc, argv);
-
- if (result != OK) {
- printf ("Incorrect arguments supplied\n");
- printf ("\n");
- print_revision (argv[0], "$Revision$");
- printf ("Copyright (c) 1999 Ian Cass, Knowledge Matters Limited\n");
- printf ("License: GPL\n");
- printf ("\n");
- printf
- ("Usage: %s <game> <ip_address> [-p port] [-gf game_field] [-mf map_field] [-pf ping_field]\n",
- argv[0]);
- printf ("\n");
- printf ("Options:\n");
- printf
- (" <game> = Game type that is recognised by qstat (without the leading dash)\n");
- printf
- (" <ip_address> = The IP address of the device you wish to query\n");
- printf (" [port] = Optional port of which to connect\n");
- printf
- (" [game_field] = Field number in raw qstat output that contains game name\n");
- printf
- (" [map_field] = Field number in raw qstat output that contains map name\n");
- printf
- (" [ping_field] = Field number in raw qstat output that contains ping time\n");
- printf ("\n");
- printf ("Notes:\n");
- printf
- ("- This plugin uses the 'qstat' command, the popular game server status query tool .\n");
- printf
- (" If you don't have the package installed, you will need to download it from\n");
- printf
- (" http://www.activesw.com/people/steve/qstat.html before you can use this plugin.\n");
- printf ("\n");
- return STATE_UNKNOWN;
- }
-
- result = STATE_OK;
-
- /* create the command line to execute */
- snprintf (command_line, sizeof (command_line) - 1, "%s -raw %s -%s %s%s",
- PATH_TO_QSTAT, QSTAT_DATA_DELIMITER, game_type, server_ip, port);
- command_line[sizeof (command_line) - 1] = 0;
-
- /* run the command */
- fp = popen (command_line, "r");
- if (fp == NULL) {
- printf ("Error - Could not open pipe: %s\n", command_line);
- return STATE_UNKNOWN;
- }
-
- found = 0;
- fgets (input_buffer, MAX_INPUT_BUFFER - 1, fp); /* Only interested in the first line */
-
- /* strip the newline character from the end of the input */
- input_buffer[strlen (input_buffer) - 1] = 0;
-
- /* sanity check */
- /* was thinking about running qstat without any options, capturing the
- -default line, parsing it & making an array of all know server types
- but thought this would be too much hassle considering this is a tool
- for intelligent sysadmins (ha). Could put a static array of known
- server types in a header file but then we'd be limiting ourselves
-
- In the end, I figured I'd simply let an error occur & then trap it
- */
-
- if (!strncmp (input_buffer, "unknown option", 14)) {
- printf ("ERROR: Host type parameter incorrect!\n");
- result = STATE_CRITICAL;
- return result;
- }
-
- /* initialize the returned data buffer */
- for (i = 0; i < QSTAT_MAX_RETURN_ARGS; i++)
- ret[i] = "";
-
- i = 0;
- p = (char *) strtok (input_buffer, QSTAT_DATA_DELIMITER);
- while (p != NULL) {
- ret[i] = p;
- p = (char *) strtok (NULL, QSTAT_DATA_DELIMITER);
- i++;
- if (i >= QSTAT_MAX_RETURN_ARGS)
- break;
- }
-
- if (strstr (ret[2], QSTAT_HOST_ERROR)) {
- printf ("ERROR: Host not found\n");
- result = STATE_CRITICAL;
- }
- else if (strstr (ret[2], QSTAT_HOST_DOWN)) {
- printf ("ERROR: Game server down or unavailable\n");
- result = STATE_CRITICAL;
- }
- else if (strstr (ret[2], QSTAT_HOST_TIMEOUT)) {
- printf ("ERROR: Game server timeout\n");
- result = STATE_CRITICAL;
- }
- else {
- printf ("OK: %s/%s %s (%s), Ping: %s ms\n",
- ret[qstat_game_players_max],
- ret[qstat_game_players],
- ret[qstat_game_field],
- ret[qstat_map_field],
- ret[qstat_ping_field]);
- }
-
- /* close the pipe */
- pclose (fp);
-
- return result;
+ char *command_line;
+ int result = STATE_UNKNOWN;
+ char *p, *ret[QSTAT_MAX_RETURN_ARGS];
+ size_t i = 0;
+ output chld_out;
+
+ setlocale (LC_ALL, "");
+ bindtextdomain (PACKAGE, LOCALEDIR);
+ textdomain (PACKAGE);
+
+ /* Parse extra opts if any */
+ argv=np_extra_opts (&argc, argv, progname);
+
+ if (process_arguments (argc, argv) == ERROR)
+ usage_va(_("Could not parse arguments"));
+
+ result = STATE_OK;
+
+ /* create the command line to execute */
+ asprintf (&command_line, "%s -raw %s -%s %s",
+ PATH_TO_QSTAT, QSTAT_DATA_DELIMITER, game_type, server_ip);
+
+ if (port)
+ asprintf (&command_line, "%s:%-d", command_line, port);
+
+ if (verbose > 0)
+ printf ("%s\n", command_line);
+
+ /* run the command. historically, this plugin ignores output on stderr,
+ * as well as return status of the qstat program */
+ (void)np_runcmd(command_line, &chld_out, NULL, 0);
+
+ /* sanity check */
+ /* was thinking about running qstat without any options, capturing the
+ -default line, parsing it & making an array of all know server types
+ but thought this would be too much hassle considering this is a tool
+ for intelligent sysadmins (ha). Could put a static array of known
+ server types in a header file but then we'd be limiting ourselves
+
+ In the end, I figured I'd simply let an error occur & then trap it
+ */
+
+ if (!strncmp (chld_out.line[0], "unknown option", 14)) {
+ printf (_("CRITICAL - Host type parameter incorrect!\n"));
+ result = STATE_CRITICAL;
+ return result;
+ }
+
+ p = (char *) strtok (chld_out.line[0], QSTAT_DATA_DELIMITER);
+ while (p != NULL) {
+ ret[i] = p;
+ p = (char *) strtok (NULL, QSTAT_DATA_DELIMITER);
+ i++;
+ if (i >= QSTAT_MAX_RETURN_ARGS)
+ break;
+ }
+
+ if (strstr (ret[2], QSTAT_HOST_ERROR)) {
+ printf (_("CRITICAL - Host not found\n"));
+ result = STATE_CRITICAL;
+ }
+ else if (strstr (ret[2], QSTAT_HOST_DOWN)) {
+ printf (_("CRITICAL - Game server down or unavailable\n"));
+ result = STATE_CRITICAL;
+ }
+ else if (strstr (ret[2], QSTAT_HOST_TIMEOUT)) {
+ printf (_("CRITICAL - Game server timeout\n"));
+ result = STATE_CRITICAL;
+ }
+ else {
+ printf ("OK: %s/%s %s (%s), Ping: %s ms|%s %s\n",
+ ret[qstat_game_players],
+ ret[qstat_game_players_max],
+ ret[qstat_game_field],
+ ret[qstat_map_field],
+ ret[qstat_ping_field],
+ perfdata ("players", atol(ret[qstat_game_players]), "",
+ FALSE, 0, FALSE, 0,
+ TRUE, 0, TRUE, atol(ret[qstat_game_players_max])),
+ fperfdata ("ping", strtod(ret[qstat_ping_field], NULL), "",
+ FALSE, 0, FALSE, 0,
+ TRUE, 0, FALSE, 0));
+ }
+
+ return result;
}
-
int
process_arguments (int argc, char **argv)
{
- int x;
-
- /* not enough options were supplied */
- if (argc < 3)
- return ERROR;
-
- /* first option is always the game type */
- strncpy (game_type, argv[1], sizeof (game_type) - 1);
- game_type[sizeof (game_type) - 1] = 0;
-
- /* Second option is always the server name */
- strncpy (server_ip, argv[2], sizeof (server_ip) - 1);
- server_ip[sizeof (server_ip) - 1] = 0;
-
- /* process all remaining arguments */
- for (x = 4; x <= argc; x++) {
-
- /* we got the port number to connect to */
- if (!strcmp (argv[x - 1], "-p")) {
- if (x < argc) {
- snprintf (port, sizeof (port) - 2, ":%s", argv[x]);
- port[sizeof (port) - 1] = 0;
- x++;
- }
- else
- return ERROR;
- }
-
- /* we got the game field */
- else if (!strcmp (argv[x - 1], "-gf")) {
- if (x < argc) {
- qstat_game_field = atoi (argv[x]);
- if (qstat_game_field < 0 || qstat_game_field > QSTAT_MAX_RETURN_ARGS)
- return ERROR;
- x++;
- }
- else
- return ERROR;
- }
-
- /* we got the map field */
- else if (!strcmp (argv[x - 1], "-mf")) {
- if (x < argc) {
- qstat_map_field = atoi (argv[x]);
- if (qstat_map_field < 0 || qstat_map_field > QSTAT_MAX_RETURN_ARGS)
- return ERROR;
- x++;
- }
- else
- return ERROR;
- }
-
- /* we got the ping field */
- else if (!strcmp (argv[x - 1], "-pf")) {
- if (x < argc) {
- qstat_ping_field = atoi (argv[x]);
- if (qstat_ping_field < 0 || qstat_ping_field > QSTAT_MAX_RETURN_ARGS)
- return ERROR;
- x++;
- }
- else
- return ERROR;
- }
-
- /* else we got something else... */
- else
- return ERROR;
- }
-
- return OK;
+ int c;
+
+ int opt_index = 0;
+ static struct option long_opts[] = {
+ {"help", no_argument, 0, 'h'},
+ {"version", no_argument, 0, 'V'},
+ {"verbose", no_argument, 0, 'v'},
+ {"timeout", required_argument, 0, 't'},
+ {"hostname", required_argument, 0, 'H'},
+ {"port", required_argument, 0, 'P'},
+ {"game-type", required_argument, 0, 'G'},
+ {"map-field", required_argument, 0, 'm'},
+ {"ping-field", required_argument, 0, 'p'},
+ {"game-field", required_argument, 0, 'g'},
+ {"players-field", required_argument, 0, 129},
+ {"max-players-field", required_argument, 0, 130},
+ {0, 0, 0, 0}
+ };
+
+ if (argc < 2)
+ return ERROR;
+
+ for (c = 1; c < argc; c++) {
+ if (strcmp ("-mf", argv[c]) == 0)
+ strcpy (argv[c], "-m");
+ else if (strcmp ("-pf", argv[c]) == 0)
+ strcpy (argv[c], "-p");
+ else if (strcmp ("-gf", argv[c]) == 0)
+ strcpy (argv[c], "-g");
+ }
+
+ while (1) {
+ c = getopt_long (argc, argv, "hVvt:H:P:G:g:p:m:", long_opts, &opt_index);
+
+ if (c == -1 || c == EOF)
+ break;
+
+ switch (c) {
+ case 'h': /* help */
+ print_help ();
+ exit (STATE_OK);
+ case 'V': /* version */
+ print_revision (progname, NP_VERSION);
+ exit (STATE_OK);
+ case 'v': /* version */
+ verbose = TRUE;
+ break;
+ case 't': /* timeout period */
+ timeout_interval = atoi (optarg);
+ break;
+ case 'H': /* hostname */
+ if (strlen (optarg) >= MAX_HOST_ADDRESS_LENGTH)
+ die (STATE_UNKNOWN, _("Input buffer overflow\n"));
+ server_ip = optarg;
+ break;
+ case 'P': /* port */
+ port = atoi (optarg);
+ break;
+ case 'G': /* hostname */
+ if (strlen (optarg) >= MAX_INPUT_BUFFER)
+ die (STATE_UNKNOWN, _("Input buffer overflow\n"));
+ game_type = optarg;
+ break;
+ case 'p': /* index of ping field */
+ qstat_ping_field = atoi (optarg);
+ if (qstat_ping_field < 0 || qstat_ping_field > QSTAT_MAX_RETURN_ARGS)
+ return ERROR;
+ break;
+ case 'm': /* index on map field */
+ qstat_map_field = atoi (optarg);
+ if (qstat_map_field < 0 || qstat_map_field > QSTAT_MAX_RETURN_ARGS)
+ return ERROR;
+ break;
+ case 'g': /* index of game field */
+ qstat_game_field = atoi (optarg);
+ if (qstat_game_field < 0 || qstat_game_field > QSTAT_MAX_RETURN_ARGS)
+ return ERROR;
+ break;
+ case 129: /* index of player count field */
+ qstat_game_players = atoi (optarg);
+ if (qstat_game_players_max == 0)
+ qstat_game_players_max = qstat_game_players - 1;
+ if (qstat_game_players < 0 || qstat_game_players > QSTAT_MAX_RETURN_ARGS)
+ return ERROR;
+ break;
+ case 130: /* index of max players field */
+ qstat_game_players_max = atoi (optarg);
+ if (qstat_game_players_max < 0 || qstat_game_players_max > QSTAT_MAX_RETURN_ARGS)
+ return ERROR;
+ break;
+ default: /* args not parsable */
+ usage5();
+ }
+ }
+
+ c = optind;
+ /* first option is the game type */
+ if (!game_type && c<argc)
+ game_type = strdup (argv[c++]);
+
+ /* Second option is the server name */
+ if (!server_ip && c<argc)
+ server_ip = strdup (argv[c++]);
+
+ return validate_arguments ();
+}
+
+
+int
+validate_arguments (void)
+{
+ if (qstat_game_players_max < 0)
+ qstat_game_players_max = 4;
+
+ if (qstat_game_players < 0)
+ qstat_game_players = 5;
+
+ if (qstat_game_field < 0)
+ qstat_game_field = 2;
+
+ if (qstat_map_field < 0)
+ qstat_map_field = 3;
+
+ if (qstat_ping_field < 0)
+ qstat_ping_field = 5;
+
+ return OK;
}
-void print_usage (void)
+
+void
+print_help (void)
{
- return STATE_OK;
+ print_revision (progname, NP_VERSION);
+
+ printf ("Copyright (c) 1999 Ian Cass, Knowledge Matters Limited\n");
+ printf (COPYRIGHT, copyright, email);
+
+ printf (_("This plugin tests game server connections with the specified host."));
+
+ printf ("\n\n");
+
+ print_usage ();
+
+ printf (_(UT_HELP_VRSN));
+ printf (_(UT_EXTRA_OPTS));
+
+ printf (" %s\n", "-p");
+ printf (" %s\n", _("Optional port of which to connect"));
+ printf (" %s\n", "gf");
+ printf (" %s\n", _("Field number in raw qstat output that contains game name"));
+ printf (" %s\n", "-mf");
+ printf (" %s\n", _("Field number in raw qstat output that contains map name"));
+ printf (" %s\n", "-pf");
+ printf (" %s\n", _("Field number in raw qstat output that contains ping time"));
+
+ printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
+
+ printf ("\n");
+ printf ("%s\n", _("Notes:"));
+ printf (" %s\n", _("This plugin uses the 'qstat' command, the popular game server status query tool."));
+ printf (" %s\n", _("If you don't have the package installed, you will need to download it from"));
+ printf (" %s\n", _("http://www.activesw.com/people/steve/qstat.html before you can use this plugin."));
+#ifdef NP_EXTRA_OPTS
+ printf ("\n");
+ printf (_(UT_EXTRA_OPTS_NOTES));
+#endif
+
+ printf (_(UT_SUPPORT));
+}
+
+
+
+void
+print_usage (void)
+{
+ printf (_("Usage:"));
+ printf (" %s <game> <ip_address> [-p port] [-gf game_field] [-mf map_field] [-pf ping_field]\n", progname);
}
+
+/******************************************************************************
+ *
+ * Test Cases:
+ *
+ * ./check_game --players 7 -p 8 --map 5 qs 67.20.190.61 26000
+ *
+ * qstat -raw , -qs 67.20.190.61
+ * ==> QS,67.20.190.61,Nightmare.fintek.ca,67.20.190.61:26000,3,e2m1,6,0,83,0
+ *
+ * qstat -qs 67.20.190.61
+ * ==> ADDRESS PLAYERS MAP RESPONSE TIME NAME
+ * ==> 67.20.190.61 0/ 6 e2m1 79 / 0 Nightmare.fintek.ca
+ *
+ ******************************************************************************/