src/ascent.c

   1 /**
   2  * collectd - src/ascent.c
   3  * Copyright (C) 2008  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26
  27 #include <curl/curl.h>
  28 #include <libxml/parser.h>
  29
  30 static char *races_list[] = /* {{{ */
  31 {
  32   NULL,
  33   "Human",    /*  1 */
  34   "Orc",      /*  2 */
  35   "Dwarf",    /*  3 */
  36   "Nightelf", /*  4 */
  37   "Undead",   /*  5 */
  38   "Tauren",   /*  6 */
  39   "Gnome",    /*  7 */
  40   "Troll",    /*  8 */
  41   NULL,
  42   "Bloodelf", /* 10 */
  43   "Draenei"   /* 11 */
  44 }; /* }}} */
  45 #define RACES_LIST_LENGTH STATIC_ARRAY_SIZE (races_list)
  46
  47 static char *classes_list[] = /* {{{ */
  48 {
  49   NULL,
  50   "Warrior", /*  1 */
  51   "Paladin", /*  2 */
  52   "Hunter",  /*  3 */
  53   "Rogue",   /*  4 */
  54   "Priest",  /*  5 */
  55   NULL,
  56   "Shaman",  /*  7 */
  57   "Mage",    /*  8 */
  58   "Warlock", /*  9 */
  59   NULL,
  60   "Druid"    /* 11 */
  61 }; /* }}} */
  62 #define CLASSES_LIST_LENGTH STATIC_ARRAY_SIZE (classes_list)
  63
  64 static char *genders_list[] = /* {{{ */
  65 {
  66   "Male",
  67   "Female"
  68 }; /* }}} */
  69 #define GENDERS_LIST_LENGTH STATIC_ARRAY_SIZE (genders_list)
  70
  71 struct player_stats_s
  72 {
  73   int races[RACES_LIST_LENGTH];
  74   int classes[CLASSES_LIST_LENGTH];
  75   int genders[GENDERS_LIST_LENGTH];
  76   int level_sum;
  77   int level_num;
  78   int latency_sum;
  79   int latency_num;
  80 };
  81 typedef struct player_stats_s player_stats_t;
  82
  83 struct player_info_s
  84 {
  85   int race;
  86   int class;
  87   int gender;
  88   int level;
  89   int latency;
  90 };
  91 typedef struct player_info_s player_info_t;
  92 #define PLAYER_INFO_STATIC_INIT { -1, -1, -1, -1, -1 }
  93
  94 static char *url    = NULL;
  95 static char *user   = NULL;
  96 static char *pass   = NULL;
  97 static char *cacert = NULL;
  98
  99 static CURL *curl = NULL;
 100
 101 static char  *ascent_buffer = NULL;
 102 static size_t ascent_buffer_size = 0;
 103 static size_t ascent_buffer_fill = 0;
 104 static char   ascent_curl_error[CURL_ERROR_SIZE];
 105
 106 static const char *config_keys[] =
 107 {
 108   "URL",
 109   "User",
 110   "Password",
 111   "CACert"
 112 };
 113 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 114
 115 static int ascent_submit_gauge (const char *plugin_instance, /* {{{ */
 116     const char *type, const char *type_instance, gauge_t value)
 117 {
 118   value_t values[1];
 119   value_list_t vl = VALUE_LIST_INIT;
 120
 121   values[0].gauge = value;
 122
 123   vl.values = values;
 124   vl.values_len = 1;
 125   vl.time = time (NULL);
 126   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 127   sstrncpy (vl.plugin, "ascent", sizeof (vl.plugin));
 128
 129   if (plugin_instance != NULL)
 130     sstrncpy (vl.plugin_instance, plugin_instance,
 131         sizeof (vl.plugin_instance));
 132
 133   if (type_instance != NULL)
 134     sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 135
 136   plugin_dispatch_values (type, &vl);
 137   return (0);
 138 } /* }}} int ascent_submit_gauge */
 139
 140 static size_t ascent_curl_callback (void *buf, size_t size, size_t nmemb, /* {{{ */
 141     void *stream)
 142 {
 143   size_t len = size * nmemb;
 144
 145   if (len <= 0)
 146     return (len);
 147
 148   if ((ascent_buffer_fill + len) >= ascent_buffer_size)
 149   {
 150     char *temp;
 151
 152     temp = (char *) realloc (ascent_buffer,
 153         ascent_buffer_fill + len + 1);
 154     if (temp == NULL)
 155     {
 156       ERROR ("ascent plugin: realloc failed.");
 157       return (0);
 158     }
 159     ascent_buffer = temp;
 160     ascent_buffer_size = ascent_buffer_fill + len + 1;
 161   }
 162
 163   memcpy (ascent_buffer + ascent_buffer_fill, (char *) buf, len);
 164   ascent_buffer_fill += len;
 165   ascent_buffer[ascent_buffer_fill] = 0;
 166
 167   return (len);
 168 } /* }}} size_t ascent_curl_callback */
 169
 170 static int ascent_submit_players (player_stats_t *ps) /* {{{ */
 171 {
 172   int i;
 173   gauge_t value;
 174
 175   for (i = 0; i < RACES_LIST_LENGTH; i++)
 176     if (races_list[i] != NULL)
 177       ascent_submit_gauge ("by-race", "players", races_list[i],
 178           (gauge_t) ps->races[i]);
 179
 180   for (i = 0; i < CLASSES_LIST_LENGTH; i++)
 181     if (classes_list[i] != NULL)
 182       ascent_submit_gauge ("by-class", "players", classes_list[i],
 183           (gauge_t) ps->classes[i]);
 184
 185   for (i = 0; i < GENDERS_LIST_LENGTH; i++)
 186     if (genders_list[i] != NULL)
 187       ascent_submit_gauge ("by-gender", "players", genders_list[i],
 188           (gauge_t) ps->genders[i]);
 189
 190   if (ps->level_num <= 0)
 191     value = NAN;
 192   else
 193     value = ((double) ps->level_sum) / ((double) ps->level_num);
 194   ascent_submit_gauge (NULL, "gauge", "avg-level", value);
 195
 196   /* Latency is in ms, but we store seconds. */
 197   if (ps->latency_num <= 0)
 198     value = NAN;
 199   else
 200     value = ((double) ps->latency_sum) / (1000.0 * ((double) ps->latency_num));
 201   ascent_submit_gauge (NULL, "latency", "average", value);
 202
 203   return (0);
 204 } /* }}} int ascent_submit_players */
 205
 206 static int ascent_account_player (player_stats_t *ps, /* {{{ */
 207     player_info_t *pi)
 208 {
 209   if (pi->race >= 0)
 210   {
 211     if ((pi->race >= RACES_LIST_LENGTH)
 212         || (races_list[pi->race] == NULL))
 213       ERROR ("ascent plugin: Ignoring invalid numeric race %i.", pi->race);
 214     else
 215       ps->races[pi->race]++;
 216   }
 217
 218   if (pi->class >= 0)
 219   {
 220     if ((pi->class >= CLASSES_LIST_LENGTH)
 221         || (classes_list[pi->class] == NULL))
 222       ERROR ("ascent plugin: Ignoring invalid numeric class %i.", pi->class);
 223     else
 224       ps->classes[pi->class]++;
 225   }
 226
 227   if (pi->gender >= 0)
 228   {
 229     if ((pi->gender >= GENDERS_LIST_LENGTH)
 230         || (genders_list[pi->gender] == NULL))
 231       ERROR ("ascent plugin: Ignoring invalid numeric gender %i.",
 232           pi->gender);
 233     else
 234       ps->genders[pi->gender]++;
 235   }
 236
 237
 238   if (pi->level > 0)
 239   {
 240     ps->level_sum += pi->level;
 241     ps->level_num++;
 242   }
 243
 244   if (pi->latency >= 0)
 245   {
 246     ps->latency_sum += pi->latency;
 247     ps->latency_num++;
 248   }
 249
 250   return (0);
 251 } /* }}} int ascent_account_player */
 252
 253 static int ascent_xml_submit_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
 254     const char *plugin_instance, const char *type, const char *type_instance)
 255 {
 256   char *str_ptr;
 257   gauge_t value;
 258
 259   str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
 260   if (str_ptr == NULL)
 261   {
 262     ERROR ("ascent plugin: ascent_xml_submit_gauge: xmlNodeListGetString failed.");
 263     return (-1);
 264   }
 265
 266   if (strcasecmp ("N/A", str_ptr) == 0)
 267     value = NAN;
 268   else
 269   {
 270     char *end_ptr = NULL;
 271     value = strtod (str_ptr, &end_ptr);
 272     if (str_ptr == end_ptr)
 273     {
 274       xmlFree(str_ptr);
 275       ERROR ("ascent plugin: ascent_xml_submit_gauge: strtod failed.");
 276       return (-1);
 277     }
 278   }
 279   xmlFree(str_ptr);
 280
 281   return (ascent_submit_gauge (plugin_instance, type, type_instance, value));
 282 } /* }}} int ascent_xml_submit_gauge */
 283
 284 static int ascent_xml_read_int (xmlDoc *doc, xmlNode *node, /* {{{ */
 285     int *ret_value)
 286 {
 287   char *str_ptr;
 288   int value;
 289
 290   str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
 291   if (str_ptr == NULL)
 292   {
 293     ERROR ("ascent plugin: ascent_xml_read_int: xmlNodeListGetString failed.");
 294     return (-1);
 295   }
 296
 297   if (strcasecmp ("N/A", str_ptr) == 0)
 298     value = -1;
 299   else
 300   {
 301     char *end_ptr = NULL;
 302     value = strtol (str_ptr, &end_ptr, 0);
 303     if (str_ptr == end_ptr)
 304     {
 305       xmlFree(str_ptr);
 306       ERROR ("ascent plugin: ascent_xml_read_int: strtol failed.");
 307       return (-1);
 308     }
 309   }
 310   xmlFree(str_ptr);
 311
 312   *ret_value = value;
 313   return (0);
 314 } /* }}} int ascent_xml_read_int */
 315
 316 static int ascent_xml_sessions_plr (xmlDoc *doc, xmlNode *node, /* {{{ */
 317     player_info_t *pi)
 318 {
 319   xmlNode *child;
 320
 321   for (child = node->xmlChildrenNode; child != NULL; child = child->next)
 322   {
 323     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
 324         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
 325       /* ignore */;
 326     else if (xmlStrcmp ((const xmlChar *) "race", child->name) == 0)
 327       ascent_xml_read_int (doc, child, &pi->race);
 328     else if (xmlStrcmp ((const xmlChar *) "class", child->name) == 0)
 329       ascent_xml_read_int (doc, child, &pi->class);
 330     else if (xmlStrcmp ((const xmlChar *) "gender", child->name) == 0)
 331       ascent_xml_read_int (doc, child, &pi->gender);
 332     else if (xmlStrcmp ((const xmlChar *) "level", child->name) == 0)
 333       ascent_xml_read_int (doc, child, &pi->level);
 334     else if (xmlStrcmp ((const xmlChar *) "latency", child->name) == 0)
 335       ascent_xml_read_int (doc, child, &pi->latency);
 336     else if ((xmlStrcmp ((const xmlChar *) "name", child->name) == 0)
 337         || (xmlStrcmp ((const xmlChar *) "pvprank", child->name) == 0)
 338         || (xmlStrcmp ((const xmlChar *) "map", child->name) == 0)
 339         || (xmlStrcmp ((const xmlChar *) "areaid", child->name) == 0)
 340         || (xmlStrcmp ((const xmlChar *) "xpos", child->name) == 0)
 341         || (xmlStrcmp ((const xmlChar *) "ypos", child->name) == 0)
 342         || (xmlStrcmp ((const xmlChar *) "onime", child->name) == 0))
 343       /* ignore */;
 344     else
 345     {
 346       WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
 347     }
 348   } /* for (child) */
 349
 350   return (0);
 351 } /* }}} int ascent_xml_sessions_plr */
 352
 353 static int ascent_xml_sessions (xmlDoc *doc, xmlNode *node) /* {{{ */
 354 {
 355   xmlNode *child;
 356   player_stats_t ps;
 357
 358   memset (&ps, 0, sizeof (ps));
 359
 360   for (child = node->xmlChildrenNode; child != NULL; child = child->next)
 361   {
 362     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
 363         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
 364       /* ignore */;
 365     else if (xmlStrcmp ((const xmlChar *) "plr", child->name) == 0)
 366     {
 367       int status;
 368       player_info_t pi = PLAYER_INFO_STATIC_INIT;
 369
 370       status = ascent_xml_sessions_plr (doc, child, &pi);
 371       if (status == 0)
 372         ascent_account_player (&ps, &pi);
 373     }
 374     else
 375     {
 376       WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
 377     }
 378   } /* for (child) */
 379
 380   ascent_submit_players (&ps);
 381
 382   return (0);
 383 } /* }}} int ascent_xml_sessions */
 384
 385 static int ascent_xml_status (xmlDoc *doc, xmlNode *node) /* {{{ */
 386 {
 387   xmlNode *child;
 388
 389   for (child = node->xmlChildrenNode; child != NULL; child = child->next)
 390   {
 391     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
 392         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
 393       /* ignore */;
 394     else if (xmlStrcmp ((const xmlChar *) "alliance", child->name) == 0)
 395       ascent_xml_submit_gauge (doc, child, NULL, "players", "alliance");
 396     else if (xmlStrcmp ((const xmlChar *) "horde", child->name) == 0)
 397       ascent_xml_submit_gauge (doc, child, NULL, "players", "horde");
 398     else if (xmlStrcmp ((const xmlChar *) "qplayers", child->name) == 0)
 399       ascent_xml_submit_gauge (doc, child, NULL, "players", "queued");
 400     else if ((xmlStrcmp ((const xmlChar *) "acceptedconns", child->name) == 0)
 401         || (xmlStrcmp ((const xmlChar *) "avglat", child->name) == 0)
 402         || (xmlStrcmp ((const xmlChar *) "cdbquerysize", child->name) == 0)
 403         || (xmlStrcmp ((const xmlChar *) "cpu", child->name) == 0)
 404         || (xmlStrcmp ((const xmlChar *) "fthreads", child->name) == 0)
 405         || (xmlStrcmp ((const xmlChar *) "gmcount", child->name) == 0)
 406         || (xmlStrcmp ((const xmlChar *) "lastupdate", child->name) == 0)
 407         || (xmlStrcmp ((const xmlChar *) "ontime", child->name) == 0)
 408         || (xmlStrcmp ((const xmlChar *) "oplayers", child->name) == 0)
 409         || (xmlStrcmp ((const xmlChar *) "peakcount", child->name) == 0)
 410         || (xmlStrcmp ((const xmlChar *) "platform", child->name) == 0)
 411         || (xmlStrcmp ((const xmlChar *) "ram", child->name) == 0)
 412         || (xmlStrcmp ((const xmlChar *) "threads", child->name) == 0)
 413         || (xmlStrcmp ((const xmlChar *) "uptime", child->name) == 0)
 414         || (xmlStrcmp ((const xmlChar *) "wdbquerysize", child->name) == 0))
 415       /* ignore */;
 416     else
 417     {
 418       WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
 419     }
 420   } /* for (child) */
 421
 422   return (0);
 423 } /* }}} int ascent_xml_status */
 424
 425 static int ascent_xml (const char *data) /* {{{ */
 426 {
 427   xmlDoc *doc;
 428   xmlNode *cur;
 429   xmlNode *child;
 430
 431 #if 0
 432   doc = xmlParseMemory (data, strlen (data),
 433       /* URL = */ "ascent.xml",
 434       /* encoding = */ NULL,
 435       /* options = */ 0);
 436 #else
 437   doc = xmlParseMemory (data, strlen (data));
 438 #endif
 439   if (doc == NULL)
 440   {
 441     ERROR ("ascent plugin: xmlParseMemory failed.");
 442     return (-1);
 443   }
 444
 445   cur = xmlDocGetRootElement (doc);
 446   if (cur == NULL)
 447   {
 448     ERROR ("ascent plugin: XML document is empty.");
 449     xmlFreeDoc (doc);
 450     return (-1);
 451   }
 452
 453   if (xmlStrcmp ((const xmlChar *) "serverpage", cur->name) != 0)
 454   {
 455     ERROR ("ascent plugin: XML root element is not \"serverpage\".");
 456     xmlFreeDoc (doc);
 457     return (-1);
 458   }
 459
 460   for (child = cur->xmlChildrenNode; child != NULL; child = child->next)
 461   {
 462     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
 463         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
 464       /* ignore */;
 465     else if (xmlStrcmp ((const xmlChar *) "status", child->name) == 0)
 466       ascent_xml_status (doc, child);
 467     else if (xmlStrcmp ((const xmlChar *) "instances", child->name) == 0)
 468       /* ignore for now */;
 469     else if (xmlStrcmp ((const xmlChar *) "gms", child->name) == 0)
 470       /* ignore for now */;
 471     else if (xmlStrcmp ((const xmlChar *) "sessions", child->name) == 0)
 472       ascent_xml_sessions (doc, child);
 473     else
 474     {
 475       WARNING ("ascent plugin: ascent_xml: Unknown tag: %s", child->name);
 476     }
 477   } /* for (child) */
 478
 479   xmlFreeDoc (doc);
 480   return (0);
 481 } /* }}} int ascent_xml */
 482
 483 static int config_set (char **var, const char *value) /* {{{ */
 484 {
 485   if (*var != NULL)
 486   {
 487     free (*var);
 488     *var = NULL;
 489   }
 490
 491   if ((*var = strdup (value)) == NULL)
 492     return (1);
 493   else
 494     return (0);
 495 } /* }}} int config_set */
 496
 497 static int ascent_config (const char *key, const char *value) /* {{{ */
 498 {
 499   if (strcasecmp (key, "URL") == 0)
 500     return (config_set (&url, value));
 501   else if (strcasecmp (key, "User") == 0)
 502     return (config_set (&user, value));
 503   else if (strcasecmp (key, "Password") == 0)
 504     return (config_set (&pass, value));
 505   else if (strcasecmp (key, "CACert") == 0)
 506     return (config_set (&cacert, value));
 507   else
 508     return (-1);
 509 } /* }}} int ascent_config */
 510
 511 static int ascent_init (void) /* {{{ */
 512 {
 513   static char credentials[1024];
 514
 515   if (url == NULL)
 516   {
 517     WARNING ("ascent plugin: ascent_init: No URL configured, "
 518         "returning an error.");
 519     return (-1);
 520   }
 521
 522   if (curl != NULL)
 523   {
 524     curl_easy_cleanup (curl);
 525   }
 526
 527   if ((curl = curl_easy_init ()) == NULL)
 528   {
 529     ERROR ("ascent plugin: ascent_init: curl_easy_init failed.");
 530     return (-1);
 531   }
 532
 533   curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, ascent_curl_callback);
 534   curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
 535   curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, ascent_curl_error);
 536
 537   if (user != NULL)
 538   {
 539     int status;
 540
 541     status = snprintf (credentials, sizeof (credentials), "%s:%s",
 542         user, (pass == NULL) ? "" : pass);
 543     if (status >= sizeof (credentials))
 544     {
 545       ERROR ("ascent plugin: ascent_init: Returning an error because the "
 546           "credentials have been truncated.");
 547       return (-1);
 548     }
 549     credentials[sizeof (credentials) - 1] = '\0';
 550
 551     curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
 552   }
 553
 554   curl_easy_setopt (curl, CURLOPT_URL, url);
 555
 556   if (cacert != NULL)
 557     curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
 558
 559   return (0);
 560 } /* }}} int ascent_init */
 561
 562 static int ascent_read (void) /* {{{ */
 563 {
 564   int status;
 565
 566   if (curl == NULL)
 567   {
 568     ERROR ("ascent plugin: I don't have a CURL object.");
 569     return (-1);
 570   }
 571
 572   if (url == NULL)
 573   {
 574     ERROR ("ascent plugin: No URL has been configured.");
 575     return (-1);
 576   }
 577
 578   ascent_buffer_fill = 0;
 579   if (curl_easy_perform (curl) != 0)
 580   {
 581     ERROR ("ascent plugin: curl_easy_perform failed: %s",
 582         ascent_curl_error);
 583     return (-1);
 584   }
 585
 586   status = ascent_xml (ascent_buffer);
 587   if (status != 0)
 588     return (-1);
 589   else
 590     return (0);
 591 } /* }}} int ascent_read */
 592
 593 void module_register (void)
 594 {
 595   plugin_register_config ("ascent", ascent_config, config_keys, config_keys_num);
 596   plugin_register_init ("ascent", ascent_init);
 597   plugin_register_read ("ascent", ascent_read);
 598 } /* void module_register */
 599
 600 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */