plugins/check_game.c

   1 /*****************************************************************************
   2 *
   3 * Nagios check_game plugin
   4 *
   5 * License: GPL
   6 * Copyright (c) 2002-2007 Nagios Plugins Development Team
   7 *
   8 * Last Modified: $Date$
   9 *
  10 * Description:
  11 *
  12 * This file contains the check_game plugin
  13 *
  14 * This plugin tests game server connections with the specified host.
  15 * using the qstat program
  16 *
  17 *
  18 * This program is free software: you can redistribute it and/or modify
  19 * it under the terms of the GNU General Public License as published by
  20 * the Free Software Foundation, either version 3 of the License, or
  21 * (at your option) any later version.
  22 *
  23 * This program is distributed in the hope that it will be useful,
  24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26 * GNU General Public License for more details.
  27 *
  28 * You should have received a copy of the GNU General Public License
  29 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  30 *
  31 * $Id$
  32 *
  33 *****************************************************************************/
  34
  35 const char *progname = "check_game";
  36 const char *revision = "$Revision$";
  37 const char *copyright = "2002-2007";
  38 const char *email = "nagiosplug-devel@lists.sourceforge.net";
  39
  40 #include "common.h"
  41 #include "utils.h"
  42 #include "runcmd.h"
  43
  44 int process_arguments (int, char **);
  45 int validate_arguments (void);
  46 void print_help (void);
  47 void print_usage (void);
  48
  49 #define QSTAT_DATA_DELIMITER  ","
  50
  51 #define QSTAT_HOST_ERROR  "ERROR"
  52 #define QSTAT_HOST_DOWN   "DOWN"
  53 #define QSTAT_HOST_TIMEOUT  "TIMEOUT"
  54 #define QSTAT_MAX_RETURN_ARGS 12
  55
  56 char *server_ip;
  57 char *game_type;
  58 int port = 0;
  59
  60 int verbose;
  61
  62 int qstat_game_players_max = -1;
  63 int qstat_game_players = -1;
  64 int qstat_game_field = -1;
  65 int qstat_map_field = -1;
  66 int qstat_ping_field = -1;
  67
  68
  69 int
  70 main (int argc, char **argv)
  71 {
  72   char *command_line;
  73   int result = STATE_UNKNOWN;
  74   char *p, *ret[QSTAT_MAX_RETURN_ARGS];
  75   size_t i = 0;
  76   output chld_out;
  77
  78   setlocale (LC_ALL, "");
  79   bindtextdomain (PACKAGE, LOCALEDIR);
  80   textdomain (PACKAGE);
  81
  82   /* Parse extra opts if any */
  83   argv=np_extra_opts (&argc, argv, progname);
  84
  85   if (process_arguments (argc, argv) == ERROR)
  86     usage_va(_("Could not parse arguments"));
  87
  88   result = STATE_OK;
  89
  90   /* create the command line to execute */
  91   asprintf (&command_line, "%s -raw %s -%s %s",
  92             PATH_TO_QSTAT, QSTAT_DATA_DELIMITER, game_type, server_ip);
  93
  94   if (port)
  95     asprintf (&command_line, "%s:%-d", command_line, port);
  96
  97   if (verbose > 0)
  98     printf ("%s\n", command_line);
  99
 100   /* run the command. historically, this plugin ignores output on stderr,
 101    * as well as return status of the qstat program */
 102   (void)np_runcmd(command_line, &chld_out, NULL, 0);
 103
 104   /* sanity check */
 105   /* was thinking about running qstat without any options, capturing the
 106      -default line, parsing it & making an array of all know server types
 107      but thought this would be too much hassle considering this is a tool
 108      for intelligent sysadmins (ha). Could put a static array of known
 109      server types in a header file but then we'd be limiting ourselves
 110
 111      In the end, I figured I'd simply let an error occur & then trap it
 112    */
 113
 114   if (!strncmp (chld_out.line[0], "unknown option", 14)) {
 115     printf (_("CRITICAL - Host type parameter incorrect!\n"));
 116     result = STATE_CRITICAL;
 117     return result;
 118   }
 119
 120   p = (char *) strtok (chld_out.line[0], QSTAT_DATA_DELIMITER);
 121   while (p != NULL) {
 122     ret[i] = p;
 123     p = (char *) strtok (NULL, QSTAT_DATA_DELIMITER);
 124     i++;
 125     if (i >= QSTAT_MAX_RETURN_ARGS)
 126       break;
 127   }
 128
 129   if (strstr (ret[2], QSTAT_HOST_ERROR)) {
 130     printf (_("CRITICAL - Host not found\n"));
 131     result = STATE_CRITICAL;
 132   }
 133   else if (strstr (ret[2], QSTAT_HOST_DOWN)) {
 134     printf (_("CRITICAL - Game server down or unavailable\n"));
 135     result = STATE_CRITICAL;
 136   }
 137   else if (strstr (ret[2], QSTAT_HOST_TIMEOUT)) {
 138     printf (_("CRITICAL - Game server timeout\n"));
 139     result = STATE_CRITICAL;
 140   }
 141   else {
 142     printf ("OK: %s/%s %s (%s), Ping: %s ms|%s %s\n",
 143             ret[qstat_game_players],
 144             ret[qstat_game_players_max],
 145             ret[qstat_game_field],
 146             ret[qstat_map_field],
 147             ret[qstat_ping_field],
 148             perfdata ("players", atol(ret[qstat_game_players]), "",
 149                       FALSE, 0, FALSE, 0,
 150                       TRUE, 0, TRUE, atol(ret[qstat_game_players_max])),
 151             fperfdata ("ping", strtod(ret[qstat_ping_field], NULL), "",
 152                       FALSE, 0, FALSE, 0,
 153                       TRUE, 0, FALSE, 0));
 154   }
 155
 156   return result;
 157 }
 158
 159
 160 int
 161 process_arguments (int argc, char **argv)
 162 {
 163   int c;
 164
 165   int opt_index = 0;
 166   static struct option long_opts[] = {
 167     {"help", no_argument, 0, 'h'},
 168     {"version", no_argument, 0, 'V'},
 169     {"verbose", no_argument, 0, 'v'},
 170     {"timeout", required_argument, 0, 't'},
 171     {"hostname", required_argument, 0, 'H'},
 172     {"port", required_argument, 0, 'P'},
 173     {"game-type", required_argument, 0, 'G'},
 174     {"map-field", required_argument, 0, 'm'},
 175     {"ping-field", required_argument, 0, 'p'},
 176     {"game-field", required_argument, 0, 'g'},
 177     {"players-field", required_argument, 0, 129},
 178     {"max-players-field", required_argument, 0, 130},
 179     {0, 0, 0, 0}
 180   };
 181
 182   if (argc < 2)
 183     return ERROR;
 184
 185   for (c = 1; c < argc; c++) {
 186     if (strcmp ("-mf", argv[c]) == 0)
 187       strcpy (argv[c], "-m");
 188     else if (strcmp ("-pf", argv[c]) == 0)
 189       strcpy (argv[c], "-p");
 190     else if (strcmp ("-gf", argv[c]) == 0)
 191       strcpy (argv[c], "-g");
 192   }
 193
 194   while (1) {
 195     c = getopt_long (argc, argv, "hVvt:H:P:G:g:p:m:", long_opts, &opt_index);
 196
 197     if (c == -1 || c == EOF)
 198       break;
 199
 200     switch (c) {
 201     case 'h': /* help */
 202       print_help ();
 203       exit (STATE_OK);
 204     case 'V': /* version */
 205       print_revision (progname, revision);
 206       exit (STATE_OK);
 207     case 'v': /* version */
 208       verbose = TRUE;
 209       break;
 210     case 't': /* timeout period */
 211       timeout_interval = atoi (optarg);
 212       break;
 213     case 'H': /* hostname */
 214       if (strlen (optarg) >= MAX_HOST_ADDRESS_LENGTH)
 215         die (STATE_UNKNOWN, _("Input buffer overflow\n"));
 216       server_ip = optarg;
 217       break;
 218     case 'P': /* port */
 219       port = atoi (optarg);
 220       break;
 221     case 'G': /* hostname */
 222       if (strlen (optarg) >= MAX_INPUT_BUFFER)
 223         die (STATE_UNKNOWN, _("Input buffer overflow\n"));
 224       game_type = optarg;
 225       break;
 226     case 'p': /* index of ping field */
 227       qstat_ping_field = atoi (optarg);
 228       if (qstat_ping_field < 0 || qstat_ping_field > QSTAT_MAX_RETURN_ARGS)
 229         return ERROR;
 230       break;
 231     case 'm': /* index on map field */
 232       qstat_map_field = atoi (optarg);
 233       if (qstat_map_field < 0 || qstat_map_field > QSTAT_MAX_RETURN_ARGS)
 234         return ERROR;
 235       break;
 236     case 'g': /* index of game field */
 237       qstat_game_field = atoi (optarg);
 238       if (qstat_game_field < 0 || qstat_game_field > QSTAT_MAX_RETURN_ARGS)
 239         return ERROR;
 240       break;
 241     case 129: /* index of player count field */
 242       qstat_game_players = atoi (optarg);
 243       if (qstat_game_players_max == 0)
 244         qstat_game_players_max = qstat_game_players - 1;
 245       if (qstat_game_players < 0 || qstat_game_players > QSTAT_MAX_RETURN_ARGS)
 246         return ERROR;
 247       break;
 248     case 130: /* index of max players field */
 249       qstat_game_players_max = atoi (optarg);
 250       if (qstat_game_players_max < 0 || qstat_game_players_max > QSTAT_MAX_RETURN_ARGS)
 251         return ERROR;
 252       break;
 253     default: /* args not parsable */
 254       usage5();
 255     }
 256   }
 257
 258   c = optind;
 259   /* first option is the game type */
 260   if (!game_type && c<argc)
 261     game_type = strdup (argv[c++]);
 262
 263   /* Second option is the server name */
 264   if (!server_ip && c<argc)
 265     server_ip = strdup (argv[c++]);
 266
 267   return validate_arguments ();
 268 }
 269
 270
 271 int
 272 validate_arguments (void)
 273 {
 274   if (qstat_game_players_max < 0)
 275     qstat_game_players_max = 4;
 276
 277   if (qstat_game_players < 0)
 278     qstat_game_players = 5;
 279
 280   if (qstat_game_field < 0)
 281     qstat_game_field = 2;
 282
 283   if (qstat_map_field < 0)
 284     qstat_map_field = 3;
 285
 286   if (qstat_ping_field < 0)
 287     qstat_ping_field = 5;
 288
 289   return OK;
 290 }
 291
 292
 293 void
 294 print_help (void)
 295 {
 296   print_revision (progname, revision);
 297
 298   printf ("Copyright (c) 1999 Ian Cass, Knowledge Matters Limited\n");
 299   printf (COPYRIGHT, copyright, email);
 300
 301   printf (_("This plugin tests game server connections with the specified host."));
 302
 303   printf ("\n\n");
 304
 305   print_usage ();
 306
 307   printf (_(UT_HELP_VRSN));
 308   printf (_(UT_EXTRA_OPTS));
 309
 310   printf (" %s\n", "-p");
 311   printf ("    %s\n", _("Optional port of which to connect"));
 312   printf (" %s\n", "gf");
 313   printf ("    %s\n", _("Field number in raw qstat output that contains game name"));
 314   printf (" %s\n", "-mf");
 315   printf ("    %s\n", _("Field number in raw qstat output that contains map name"));
 316   printf (" %s\n", "-pf");
 317   printf ("    %s\n", _("Field number in raw qstat output that contains ping time"));
 318
 319   printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
 320
 321   printf ("\n");
 322   printf ("%s\n", _("Notes:"));
 323   printf (" %s\n", _("This plugin uses the 'qstat' command, the popular game server status query tool."));
 324   printf (" %s\n", _("If you don't have the package installed, you will need to download it from"));
 325   printf (" %s\n", _("http://www.activesw.com/people/steve/qstat.html before you can use this plugin."));
 326 #ifdef NP_EXTRA_OPTS
 327   printf ("\n");
 328   printf (_(UT_EXTRA_OPTS_NOTES));
 329 #endif
 330
 331   printf (_(UT_SUPPORT));
 332 }
 333
 334
 335
 336 void
 337 print_usage (void)
 338 {
 339   printf (_("Usage:"));
 340   printf (" %s <game> <ip_address> [-p port] [-gf game_field] [-mf map_field] [-pf ping_field]\n", progname);
 341 }
 342
 343 /******************************************************************************
 344  *
 345  * Test Cases:
 346  *
 347  * ./check_game --players 7 -p 8 --map 5 qs 67.20.190.61 26000
 348  *
 349  * qstat -raw , -qs 67.20.190.61
 350  *  ==> QS,67.20.190.61,Nightmare.fintek.ca,67.20.190.61:26000,3,e2m1,6,0,83,0
 351  *
 352  * qstat -qs 67.20.190.61
 353  *  ==> ADDRESS           PLAYERS      MAP   RESPONSE TIME    NAME
 354  *  ==> 67.20.190.61            0/ 6     e2m1     79 / 0   Nightmare.fintek.ca
 355  *
 356  ******************************************************************************/