2 * collectd - src/ascent.c
3 * Copyright (C) 2008 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
27 #include <curl/curl.h>
28 #include <libxml/parser.h>
30 static char *races_list[] = /* {{{ */
45 #define RACES_LIST_LENGTH STATIC_ARRAY_SIZE (races_list)
47 static char *classes_list[] = /* {{{ */
62 #define CLASSES_LIST_LENGTH STATIC_ARRAY_SIZE (classes_list)
64 static char *genders_list[] = /* {{{ */
69 #define GENDERS_LIST_LENGTH STATIC_ARRAY_SIZE (genders_list)
73 int races[RACES_LIST_LENGTH];
74 int classes[CLASSES_LIST_LENGTH];
75 int genders[GENDERS_LIST_LENGTH];
81 typedef struct player_stats_s player_stats_t;
91 typedef struct player_info_s player_info_t;
92 #define PLAYER_INFO_STATIC_INIT { -1, -1, -1, -1, -1 }
94 static char *url = NULL;
95 static char *user = NULL;
96 static char *pass = NULL;
97 static char *cacert = NULL;
99 static CURL *curl = NULL;
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];
106 static const char *config_keys[] =
113 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
115 static int ascent_submit_gauge (const char *plugin_instance, /* {{{ */
116 const char *type, const char *type_instance, gauge_t value)
119 value_list_t vl = VALUE_LIST_INIT;
121 values[0].gauge = value;
125 vl.time = time (NULL);
126 strcpy (vl.host, hostname_g);
127 strcpy (vl.plugin, "ascent");
129 if (plugin_instance != NULL)
130 sstrncpy (vl.plugin_instance, plugin_instance,
131 sizeof (vl.plugin_instance));
133 if (type_instance != NULL)
134 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
136 plugin_dispatch_values (type, &vl);
138 } /* }}} int ascent_submit_gauge */
140 static size_t ascent_curl_callback (void *buf, size_t size, size_t nmemb, /* {{{ */
143 size_t len = size * nmemb;
148 if ((ascent_buffer_fill + len) >= ascent_buffer_size)
152 temp = (char *) realloc (ascent_buffer,
153 ascent_buffer_fill + len + 1);
156 ERROR ("ascent plugin: realloc failed.");
159 ascent_buffer = temp;
160 ascent_buffer_size = ascent_buffer_fill + len + 1;
163 memcpy (ascent_buffer + ascent_buffer_fill, (char *) buf, len);
164 ascent_buffer_fill += len;
165 ascent_buffer[ascent_buffer_fill] = 0;
168 } /* }}} size_t ascent_curl_callback */
170 static int ascent_submit_players (player_stats_t *ps) /* {{{ */
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]);
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]);
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]);
190 if (ps->level_num <= 0)
193 value = ((double) ps->level_sum) / ((double) ps->level_num);
194 ascent_submit_gauge (NULL, "gauge", "avg-level", value);
196 if (ps->latency_num <= 0)
199 value = ((double) ps->latency_sum) / ((double) ps->latency_num);
200 ascent_submit_gauge (NULL, "gauge", "avg-latency", value);
203 } /* }}} int ascent_submit_players */
205 static int ascent_account_player (player_stats_t *ps, /* {{{ */
210 if ((pi->race >= RACES_LIST_LENGTH)
211 || (races_list[pi->race] == NULL))
212 ERROR ("ascent plugin: Ignoring invalid numeric race %i.", pi->race);
214 ps->races[pi->race]++;
219 if ((pi->class >= CLASSES_LIST_LENGTH)
220 || (classes_list[pi->class] == NULL))
221 ERROR ("ascent plugin: Ignoring invalid numeric class %i.", pi->class);
223 ps->classes[pi->class]++;
228 if ((pi->gender >= GENDERS_LIST_LENGTH)
229 || (genders_list[pi->gender] == NULL))
230 ERROR ("ascent plugin: Ignoring invalid numeric gender %i.",
233 ps->genders[pi->gender]++;
239 ps->level_sum += pi->level;
243 if (pi->latency >= 0)
245 ps->latency_sum += pi->latency;
250 } /* }}} int ascent_account_player */
252 static int ascent_xml_submit_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
253 const char *plugin_instance, const char *type, const char *type_instance)
258 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
261 ERROR ("ascent plugin: ascent_xml_submit_gauge: xmlNodeListGetString failed.");
265 if (strcasecmp ("N/A", str_ptr) == 0)
269 char *end_ptr = NULL;
270 value = strtod (str_ptr, &end_ptr);
271 if (str_ptr == end_ptr)
273 ERROR ("ascent plugin: ascent_xml_submit_gauge: strtod failed.");
278 return (ascent_submit_gauge (plugin_instance, type, type_instance, value));
279 } /* }}} int ascent_xml_submit_gauge */
281 static int ascent_xml_read_int (xmlDoc *doc, xmlNode *node, /* {{{ */
287 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
290 ERROR ("ascent plugin: ascent_xml_read_int: xmlNodeListGetString failed.");
294 if (strcasecmp ("N/A", str_ptr) == 0)
298 char *end_ptr = NULL;
299 value = strtol (str_ptr, &end_ptr, 0);
300 if (str_ptr == end_ptr)
302 ERROR ("ascent plugin: ascent_xml_read_int: strtol failed.");
309 } /* }}} int ascent_xml_read_int */
311 static int ascent_xml_sessions_plr (xmlDoc *doc, xmlNode *node, /* {{{ */
316 for (child = node->xmlChildrenNode; child != NULL; child = child->next)
318 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
319 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
321 else if (xmlStrcmp ((const xmlChar *) "race", child->name) == 0)
322 ascent_xml_read_int (doc, child, &pi->race);
323 else if (xmlStrcmp ((const xmlChar *) "class", child->name) == 0)
324 ascent_xml_read_int (doc, child, &pi->class);
325 else if (xmlStrcmp ((const xmlChar *) "gender", child->name) == 0)
326 ascent_xml_read_int (doc, child, &pi->gender);
327 else if (xmlStrcmp ((const xmlChar *) "level", child->name) == 0)
328 ascent_xml_read_int (doc, child, &pi->level);
329 else if (xmlStrcmp ((const xmlChar *) "latency", child->name) == 0)
330 ascent_xml_read_int (doc, child, &pi->latency);
331 else if ((xmlStrcmp ((const xmlChar *) "name", child->name) == 0)
332 || (xmlStrcmp ((const xmlChar *) "pvprank", child->name) == 0)
333 || (xmlStrcmp ((const xmlChar *) "map", child->name) == 0)
334 || (xmlStrcmp ((const xmlChar *) "areaid", child->name) == 0)
335 || (xmlStrcmp ((const xmlChar *) "xpos", child->name) == 0)
336 || (xmlStrcmp ((const xmlChar *) "ypos", child->name) == 0)
337 || (xmlStrcmp ((const xmlChar *) "onime", child->name) == 0))
341 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
346 } /* }}} int ascent_xml_sessions_plr */
348 static int ascent_xml_sessions (xmlDoc *doc, xmlNode *node) /* {{{ */
353 memset (&ps, 0, sizeof (ps));
355 for (child = node->xmlChildrenNode; child != NULL; child = child->next)
357 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
358 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
360 else if (xmlStrcmp ((const xmlChar *) "plr", child->name) == 0)
363 player_info_t pi = PLAYER_INFO_STATIC_INIT;
365 status = ascent_xml_sessions_plr (doc, child, &pi);
367 ascent_account_player (&ps, &pi);
371 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
375 ascent_submit_players (&ps);
378 } /* }}} int ascent_xml_sessions */
380 static int ascent_xml_status (xmlDoc *doc, xmlNode *node) /* {{{ */
384 for (child = node->xmlChildrenNode; child != NULL; child = child->next)
386 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
387 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
389 else if (xmlStrcmp ((const xmlChar *) "alliance", child->name) == 0)
390 ascent_xml_submit_gauge (doc, child, NULL, "players", "alliance");
391 else if (xmlStrcmp ((const xmlChar *) "horde", child->name) == 0)
392 ascent_xml_submit_gauge (doc, child, NULL, "players", "horde");
393 else if (xmlStrcmp ((const xmlChar *) "qplayers", child->name) == 0)
394 ascent_xml_submit_gauge (doc, child, NULL, "players", "queued");
395 else if ((xmlStrcmp ((const xmlChar *) "acceptedconns", child->name) == 0)
396 || (xmlStrcmp ((const xmlChar *) "avglat", child->name) == 0)
397 || (xmlStrcmp ((const xmlChar *) "cdbquerysize", child->name) == 0)
398 || (xmlStrcmp ((const xmlChar *) "cpu", child->name) == 0)
399 || (xmlStrcmp ((const xmlChar *) "fthreads", child->name) == 0)
400 || (xmlStrcmp ((const xmlChar *) "gmcount", child->name) == 0)
401 || (xmlStrcmp ((const xmlChar *) "lastupdate", child->name) == 0)
402 || (xmlStrcmp ((const xmlChar *) "ontime", child->name) == 0)
403 || (xmlStrcmp ((const xmlChar *) "oplayers", child->name) == 0)
404 || (xmlStrcmp ((const xmlChar *) "peakcount", child->name) == 0)
405 || (xmlStrcmp ((const xmlChar *) "platform", child->name) == 0)
406 || (xmlStrcmp ((const xmlChar *) "ram", child->name) == 0)
407 || (xmlStrcmp ((const xmlChar *) "threads", child->name) == 0)
408 || (xmlStrcmp ((const xmlChar *) "uptime", child->name) == 0)
409 || (xmlStrcmp ((const xmlChar *) "wdbquerysize", child->name) == 0))
413 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
418 } /* }}} int ascent_xml_status */
420 static int ascent_xml (const char *data) /* {{{ */
427 doc = xmlParseMemory (data, strlen (data),
428 /* URL = */ "ascent.xml",
429 /* encoding = */ NULL,
432 doc = xmlParseMemory (data, strlen (data));
436 ERROR ("ascent plugin: xmlParseMemory failed.");
440 cur = xmlDocGetRootElement (doc);
443 ERROR ("ascent plugin: XML document is empty.");
448 if (xmlStrcmp ((const xmlChar *) "serverpage", cur->name) != 0)
450 ERROR ("ascent plugin: XML root element is not \"serverpage\".");
455 for (child = cur->xmlChildrenNode; child != NULL; child = child->next)
457 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
458 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
460 else if (xmlStrcmp ((const xmlChar *) "status", child->name) == 0)
461 ascent_xml_status (doc, child);
462 else if (xmlStrcmp ((const xmlChar *) "instances", child->name) == 0)
463 /* ignore for now */;
464 else if (xmlStrcmp ((const xmlChar *) "gms", child->name) == 0)
465 /* ignore for now */;
466 else if (xmlStrcmp ((const xmlChar *) "sessions", child->name) == 0)
467 ascent_xml_sessions (doc, child);
470 WARNING ("ascent plugin: ascent_xml: Unknown tag: %s", child->name);
476 } /* }}} int ascent_xml */
478 static int config_set (char **var, const char *value) /* {{{ */
486 if ((*var = strdup (value)) == NULL)
490 } /* }}} int config_set */
492 static int ascent_config (const char *key, const char *value) /* {{{ */
494 if (strcasecmp (key, "URL") == 0)
495 return (config_set (&url, value));
496 else if (strcasecmp (key, "User") == 0)
497 return (config_set (&user, value));
498 else if (strcasecmp (key, "Password") == 0)
499 return (config_set (&pass, value));
500 else if (strcasecmp (key, "CACert") == 0)
501 return (config_set (&cacert, value));
504 } /* }}} int ascent_config */
506 static int ascent_init (void) /* {{{ */
508 static char credentials[1024];
512 WARNING ("ascent plugin: ascent_init: No URL configured, "
513 "returning an error.");
519 curl_easy_cleanup (curl);
522 if ((curl = curl_easy_init ()) == NULL)
524 ERROR ("ascent plugin: ascent_init: curl_easy_init failed.");
528 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, ascent_curl_callback);
529 curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
530 curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, ascent_curl_error);
536 status = snprintf (credentials, sizeof (credentials), "%s:%s",
537 user, (pass == NULL) ? "" : pass);
538 if (status >= sizeof (credentials))
540 ERROR ("ascent plugin: ascent_init: Returning an error because the "
541 "credentials have been truncated.");
544 credentials[sizeof (credentials) - 1] = '\0';
546 curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
549 curl_easy_setopt (curl, CURLOPT_URL, url);
552 curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
555 } /* }}} int ascent_init */
557 static int ascent_read (void) /* {{{ */
563 ERROR ("ascent plugin: I don't have a CURL object.");
569 ERROR ("ascent plugin: No URL has been configured.");
573 ascent_buffer_fill = 0;
574 if (curl_easy_perform (curl) != 0)
576 ERROR ("ascent plugin: curl_easy_perform failed: %s",
581 status = ascent_xml (ascent_buffer);
586 } /* }}} int ascent_read */
588 void module_register (void)
590 plugin_register_config ("ascent", ascent_config, config_keys, config_keys_num);
591 plugin_register_init ("ascent", ascent_init);
592 plugin_register_read ("ascent", ascent_read);
593 } /* void module_register */
595 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */