2 * collectd - src/ascent.c
3 * Copyright (C) 2008 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
32 #include <curl/curl.h>
33 #include <libxml/parser.h>
35 static const char *races_list[] = /* {{{ */
50 #define RACES_LIST_LENGTH STATIC_ARRAY_SIZE (races_list)
52 static const char *classes_list[] = /* {{{ */
67 #define CLASSES_LIST_LENGTH STATIC_ARRAY_SIZE (classes_list)
69 static const char *genders_list[] = /* {{{ */
74 #define GENDERS_LIST_LENGTH STATIC_ARRAY_SIZE (genders_list)
78 int races[RACES_LIST_LENGTH];
79 int classes[CLASSES_LIST_LENGTH];
80 int genders[GENDERS_LIST_LENGTH];
86 typedef struct player_stats_s player_stats_t;
96 typedef struct player_info_s player_info_t;
97 #define PLAYER_INFO_STATIC_INIT { -1, -1, -1, -1, -1 }
99 static char *url = NULL;
100 static char *user = NULL;
101 static char *pass = NULL;
102 static char *verify_peer = NULL;
103 static char *verify_host = NULL;
104 static char *cacert = NULL;
105 static char *timeout = NULL;
107 static CURL *curl = NULL;
109 static char *ascent_buffer = NULL;
110 static size_t ascent_buffer_size = 0;
111 static size_t ascent_buffer_fill = 0;
112 static char ascent_curl_error[CURL_ERROR_SIZE];
114 static const char *config_keys[] =
124 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
126 static int ascent_submit_gauge (const char *plugin_instance, /* {{{ */
127 const char *type, const char *type_instance, gauge_t value)
129 value_list_t vl = VALUE_LIST_INIT;
131 vl.values = &(value_t) { .gauge = value };
133 sstrncpy (vl.plugin, "ascent", sizeof (vl.plugin));
135 if (plugin_instance != NULL)
136 sstrncpy (vl.plugin_instance, plugin_instance,
137 sizeof (vl.plugin_instance));
139 sstrncpy (vl.type, type, sizeof (vl.type));
141 if (type_instance != NULL)
142 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
144 plugin_dispatch_values (&vl);
146 } /* }}} int ascent_submit_gauge */
148 static size_t ascent_curl_callback (void *buf, size_t size, size_t nmemb, /* {{{ */
149 void __attribute__((unused)) *stream)
151 size_t len = size * nmemb;
156 if ((ascent_buffer_fill + len) >= ascent_buffer_size)
160 temp = realloc (ascent_buffer,
161 ascent_buffer_fill + len + 1);
164 ERROR ("ascent plugin: realloc failed.");
167 ascent_buffer = temp;
168 ascent_buffer_size = ascent_buffer_fill + len + 1;
171 memcpy (ascent_buffer + ascent_buffer_fill, (char *) buf, len);
172 ascent_buffer_fill += len;
173 ascent_buffer[ascent_buffer_fill] = 0;
176 } /* }}} size_t ascent_curl_callback */
178 static int ascent_submit_players (player_stats_t *ps) /* {{{ */
182 for (size_t i = 0; i < RACES_LIST_LENGTH; i++)
183 if (races_list[i] != NULL)
184 ascent_submit_gauge ("by-race", "players", races_list[i],
185 (gauge_t) ps->races[i]);
187 for (size_t i = 0; i < CLASSES_LIST_LENGTH; i++)
188 if (classes_list[i] != NULL)
189 ascent_submit_gauge ("by-class", "players", classes_list[i],
190 (gauge_t) ps->classes[i]);
192 for (size_t i = 0; i < GENDERS_LIST_LENGTH; i++)
193 if (genders_list[i] != NULL)
194 ascent_submit_gauge ("by-gender", "players", genders_list[i],
195 (gauge_t) ps->genders[i]);
197 if (ps->level_num <= 0)
200 value = ((double) ps->level_sum) / ((double) ps->level_num);
201 ascent_submit_gauge (NULL, "gauge", "avg-level", value);
203 /* Latency is in ms, but we store seconds. */
204 if (ps->latency_num <= 0)
207 value = ((double) ps->latency_sum) / (1000.0 * ((double) ps->latency_num));
208 ascent_submit_gauge (NULL, "latency", "average", value);
211 } /* }}} int ascent_submit_players */
213 static int ascent_account_player (player_stats_t *ps, /* {{{ */
218 if (((size_t) pi->race >= RACES_LIST_LENGTH)
219 || (races_list[pi->race] == NULL))
220 ERROR ("ascent plugin: Ignoring invalid numeric race %i.", pi->race);
222 ps->races[pi->race]++;
227 if (((size_t) pi->class >= CLASSES_LIST_LENGTH)
228 || (classes_list[pi->class] == NULL))
229 ERROR ("ascent plugin: Ignoring invalid numeric class %i.", pi->class);
231 ps->classes[pi->class]++;
236 if (((size_t) pi->gender >= GENDERS_LIST_LENGTH)
237 || (genders_list[pi->gender] == NULL))
238 ERROR ("ascent plugin: Ignoring invalid numeric gender %i.",
241 ps->genders[pi->gender]++;
247 ps->level_sum += pi->level;
251 if (pi->latency >= 0)
253 ps->latency_sum += pi->latency;
258 } /* }}} int ascent_account_player */
260 static int ascent_xml_submit_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
261 const char *plugin_instance, const char *type, const char *type_instance)
266 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
269 ERROR ("ascent plugin: ascent_xml_submit_gauge: xmlNodeListGetString failed.");
273 if (strcasecmp ("N/A", str_ptr) == 0)
277 char *end_ptr = NULL;
278 value = strtod (str_ptr, &end_ptr);
279 if (str_ptr == end_ptr)
282 ERROR ("ascent plugin: ascent_xml_submit_gauge: strtod failed.");
288 return (ascent_submit_gauge (plugin_instance, type, type_instance, value));
289 } /* }}} int ascent_xml_submit_gauge */
291 static int ascent_xml_read_int (xmlDoc *doc, xmlNode *node, /* {{{ */
297 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
300 ERROR ("ascent plugin: ascent_xml_read_int: xmlNodeListGetString failed.");
304 if (strcasecmp ("N/A", str_ptr) == 0)
308 char *end_ptr = NULL;
309 value = strtol (str_ptr, &end_ptr, 0);
310 if (str_ptr == end_ptr)
313 ERROR ("ascent plugin: ascent_xml_read_int: strtol failed.");
321 } /* }}} int ascent_xml_read_int */
323 static int ascent_xml_sessions_plr (xmlDoc *doc, xmlNode *node, /* {{{ */
326 for (xmlNode *child = node->xmlChildrenNode; child != NULL; child = child->next)
328 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
329 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
331 else if (xmlStrcmp ((const xmlChar *) "race", child->name) == 0)
332 ascent_xml_read_int (doc, child, &pi->race);
333 else if (xmlStrcmp ((const xmlChar *) "class", child->name) == 0)
334 ascent_xml_read_int (doc, child, &pi->class);
335 else if (xmlStrcmp ((const xmlChar *) "gender", child->name) == 0)
336 ascent_xml_read_int (doc, child, &pi->gender);
337 else if (xmlStrcmp ((const xmlChar *) "level", child->name) == 0)
338 ascent_xml_read_int (doc, child, &pi->level);
339 else if (xmlStrcmp ((const xmlChar *) "latency", child->name) == 0)
340 ascent_xml_read_int (doc, child, &pi->latency);
341 else if ((xmlStrcmp ((const xmlChar *) "name", child->name) == 0)
342 || (xmlStrcmp ((const xmlChar *) "pvprank", child->name) == 0)
343 || (xmlStrcmp ((const xmlChar *) "map", child->name) == 0)
344 || (xmlStrcmp ((const xmlChar *) "areaid", child->name) == 0)
345 || (xmlStrcmp ((const xmlChar *) "xpos", child->name) == 0)
346 || (xmlStrcmp ((const xmlChar *) "ypos", child->name) == 0)
347 || (xmlStrcmp ((const xmlChar *) "onime", child->name) == 0))
351 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
356 } /* }}} int ascent_xml_sessions_plr */
358 static int ascent_xml_sessions (xmlDoc *doc, xmlNode *node) /* {{{ */
360 player_stats_t ps = {
364 for (xmlNode *child = node->xmlChildrenNode; child != NULL; child = child->next)
366 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
367 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
369 else if (xmlStrcmp ((const xmlChar *) "plr", child->name) == 0)
372 player_info_t pi = PLAYER_INFO_STATIC_INIT;
374 status = ascent_xml_sessions_plr (doc, child, &pi);
376 ascent_account_player (&ps, &pi);
380 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
384 ascent_submit_players (&ps);
387 } /* }}} int ascent_xml_sessions */
389 static int ascent_xml_status (xmlDoc *doc, xmlNode *node) /* {{{ */
391 for (xmlNode *child = node->xmlChildrenNode; child != NULL; child = child->next)
393 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
394 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
396 else if (xmlStrcmp ((const xmlChar *) "alliance", child->name) == 0)
397 ascent_xml_submit_gauge (doc, child, NULL, "players", "alliance");
398 else if (xmlStrcmp ((const xmlChar *) "horde", child->name) == 0)
399 ascent_xml_submit_gauge (doc, child, NULL, "players", "horde");
400 else if (xmlStrcmp ((const xmlChar *) "qplayers", child->name) == 0)
401 ascent_xml_submit_gauge (doc, child, NULL, "players", "queued");
402 else if ((xmlStrcmp ((const xmlChar *) "acceptedconns", child->name) == 0)
403 || (xmlStrcmp ((const xmlChar *) "avglat", child->name) == 0)
404 || (xmlStrcmp ((const xmlChar *) "cdbquerysize", child->name) == 0)
405 || (xmlStrcmp ((const xmlChar *) "cpu", child->name) == 0)
406 || (xmlStrcmp ((const xmlChar *) "fthreads", child->name) == 0)
407 || (xmlStrcmp ((const xmlChar *) "gmcount", child->name) == 0)
408 || (xmlStrcmp ((const xmlChar *) "lastupdate", child->name) == 0)
409 || (xmlStrcmp ((const xmlChar *) "ontime", child->name) == 0)
410 || (xmlStrcmp ((const xmlChar *) "oplayers", child->name) == 0)
411 || (xmlStrcmp ((const xmlChar *) "peakcount", child->name) == 0)
412 || (xmlStrcmp ((const xmlChar *) "platform", child->name) == 0)
413 || (xmlStrcmp ((const xmlChar *) "ram", child->name) == 0)
414 || (xmlStrcmp ((const xmlChar *) "threads", child->name) == 0)
415 || (xmlStrcmp ((const xmlChar *) "uptime", child->name) == 0)
416 || (xmlStrcmp ((const xmlChar *) "wdbquerysize", child->name) == 0))
420 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
425 } /* }}} int ascent_xml_status */
427 static int ascent_xml (const char *data) /* {{{ */
433 doc = xmlParseMemory (data, strlen (data),
434 /* URL = */ "ascent.xml",
435 /* encoding = */ NULL,
438 doc = xmlParseMemory (data, strlen (data));
442 ERROR ("ascent plugin: xmlParseMemory failed.");
446 cur = xmlDocGetRootElement (doc);
449 ERROR ("ascent plugin: XML document is empty.");
454 if (xmlStrcmp ((const xmlChar *) "serverpage", cur->name) != 0)
456 ERROR ("ascent plugin: XML root element is not \"serverpage\".");
461 for (xmlNode *child = cur->xmlChildrenNode; child != NULL; child = child->next)
463 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
464 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
466 else if (xmlStrcmp ((const xmlChar *) "status", child->name) == 0)
467 ascent_xml_status (doc, child);
468 else if (xmlStrcmp ((const xmlChar *) "instances", child->name) == 0)
469 /* ignore for now */;
470 else if (xmlStrcmp ((const xmlChar *) "gms", child->name) == 0)
471 /* ignore for now */;
472 else if (xmlStrcmp ((const xmlChar *) "sessions", child->name) == 0)
473 ascent_xml_sessions (doc, child);
476 WARNING ("ascent plugin: ascent_xml: Unknown tag: %s", child->name);
482 } /* }}} int ascent_xml */
484 static int config_set (char **var, const char *value) /* {{{ */
492 if ((*var = strdup (value)) == NULL)
496 } /* }}} int config_set */
498 static int ascent_config (const char *key, const char *value) /* {{{ */
500 if (strcasecmp (key, "URL") == 0)
501 return (config_set (&url, value));
502 else if (strcasecmp (key, "User") == 0)
503 return (config_set (&user, value));
504 else if (strcasecmp (key, "Password") == 0)
505 return (config_set (&pass, value));
506 else if (strcasecmp (key, "VerifyPeer") == 0)
507 return (config_set (&verify_peer, value));
508 else if (strcasecmp (key, "VerifyHost") == 0)
509 return (config_set (&verify_host, value));
510 else if (strcasecmp (key, "CACert") == 0)
511 return (config_set (&cacert, value));
512 else if (strcasecmp (key, "Timeout") == 0)
513 return (config_set (&timeout, value));
516 } /* }}} int ascent_config */
518 static int ascent_init (void) /* {{{ */
522 WARNING ("ascent plugin: ascent_init: No URL configured, "
523 "returning an error.");
529 curl_easy_cleanup (curl);
532 if ((curl = curl_easy_init ()) == NULL)
534 ERROR ("ascent plugin: ascent_init: curl_easy_init failed.");
538 curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1L);
539 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, ascent_curl_callback);
540 curl_easy_setopt (curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
541 curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, ascent_curl_error);
545 #ifdef HAVE_CURLOPT_USERNAME
546 curl_easy_setopt (curl, CURLOPT_USERNAME, user);
547 curl_easy_setopt (curl, CURLOPT_PASSWORD, (pass == NULL) ? "" : pass);
549 static char credentials[1024];
552 status = ssnprintf (credentials, sizeof (credentials), "%s:%s",
553 user, (pass == NULL) ? "" : pass);
554 if ((status < 0) || ((size_t) status >= sizeof (credentials)))
556 ERROR ("ascent plugin: ascent_init: Returning an error because the "
557 "credentials have been truncated.");
561 curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
565 curl_easy_setopt (curl, CURLOPT_URL, url);
566 curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
567 curl_easy_setopt (curl, CURLOPT_MAXREDIRS, 50L);
569 if ((verify_peer == NULL) || IS_TRUE (verify_peer))
570 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 1L);
572 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 0L);
574 if ((verify_host == NULL) || IS_TRUE (verify_host))
575 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 2L);
577 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 0L);
580 curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
582 #ifdef HAVE_CURLOPT_TIMEOUT_MS
584 curl_easy_setopt (curl, CURLOPT_TIMEOUT_MS, atol(timeout));
586 curl_easy_setopt (curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
590 } /* }}} int ascent_init */
592 static int ascent_read (void) /* {{{ */
598 ERROR ("ascent plugin: I don't have a CURL object.");
604 ERROR ("ascent plugin: No URL has been configured.");
608 ascent_buffer_fill = 0;
609 if (curl_easy_perform (curl) != CURLE_OK)
611 ERROR ("ascent plugin: curl_easy_perform failed: %s",
616 status = ascent_xml (ascent_buffer);
621 } /* }}} int ascent_read */
623 void module_register (void)
625 plugin_register_config ("ascent", ascent_config, config_keys, config_keys_num);
626 plugin_register_init ("ascent", ascent_init);
627 plugin_register_read ("ascent", ascent_read);
628 } /* void module_register */
630 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */