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 **/
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
25 #include "configfile.h"
27 #include <curl/curl.h>
28 #include <libxml/parser.h>
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)
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)
64 static char *genders_list[] = /* {{{ */
65 {
66 "Male",
67 "Female"
68 }; /* }}} */
69 #define GENDERS_LIST_LENGTH STATIC_ARRAY_SIZE (genders_list)
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;
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 }
94 static char *url = NULL;
95 static char *user = NULL;
96 static char *pass = NULL;
97 static char *verify_peer = NULL;
98 static char *verify_host = NULL;
99 static char *cacert = NULL;
101 static CURL *curl = NULL;
103 static char *ascent_buffer = NULL;
104 static size_t ascent_buffer_size = 0;
105 static size_t ascent_buffer_fill = 0;
106 static char ascent_curl_error[CURL_ERROR_SIZE];
108 static const char *config_keys[] =
109 {
110 "URL",
111 "User",
112 "Password",
113 "VerifyPeer",
114 "VerifyHost",
115 "CACert"
116 };
117 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
119 static int ascent_submit_gauge (const char *plugin_instance, /* {{{ */
120 const char *type, const char *type_instance, gauge_t value)
121 {
122 value_t values[1];
123 value_list_t vl = VALUE_LIST_INIT;
125 values[0].gauge = value;
127 vl.values = values;
128 vl.values_len = 1;
129 vl.time = time (NULL);
130 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
131 sstrncpy (vl.plugin, "ascent", sizeof (vl.plugin));
133 if (plugin_instance != NULL)
134 sstrncpy (vl.plugin_instance, plugin_instance,
135 sizeof (vl.plugin_instance));
137 sstrncpy (vl.type, type, sizeof (vl.type));
139 if (type_instance != NULL)
140 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
142 plugin_dispatch_values (&vl);
143 return (0);
144 } /* }}} int ascent_submit_gauge */
146 static size_t ascent_curl_callback (void *buf, size_t size, size_t nmemb, /* {{{ */
147 void *stream)
148 {
149 size_t len = size * nmemb;
151 if (len <= 0)
152 return (len);
154 if ((ascent_buffer_fill + len) >= ascent_buffer_size)
155 {
156 char *temp;
158 temp = (char *) realloc (ascent_buffer,
159 ascent_buffer_fill + len + 1);
160 if (temp == NULL)
161 {
162 ERROR ("ascent plugin: realloc failed.");
163 return (0);
164 }
165 ascent_buffer = temp;
166 ascent_buffer_size = ascent_buffer_fill + len + 1;
167 }
169 memcpy (ascent_buffer + ascent_buffer_fill, (char *) buf, len);
170 ascent_buffer_fill += len;
171 ascent_buffer[ascent_buffer_fill] = 0;
173 return (len);
174 } /* }}} size_t ascent_curl_callback */
176 static int ascent_submit_players (player_stats_t *ps) /* {{{ */
177 {
178 int i;
179 gauge_t value;
181 for (i = 0; i < RACES_LIST_LENGTH; i++)
182 if (races_list[i] != NULL)
183 ascent_submit_gauge ("by-race", "players", races_list[i],
184 (gauge_t) ps->races[i]);
186 for (i = 0; i < CLASSES_LIST_LENGTH; i++)
187 if (classes_list[i] != NULL)
188 ascent_submit_gauge ("by-class", "players", classes_list[i],
189 (gauge_t) ps->classes[i]);
191 for (i = 0; i < GENDERS_LIST_LENGTH; i++)
192 if (genders_list[i] != NULL)
193 ascent_submit_gauge ("by-gender", "players", genders_list[i],
194 (gauge_t) ps->genders[i]);
196 if (ps->level_num <= 0)
197 value = NAN;
198 else
199 value = ((double) ps->level_sum) / ((double) ps->level_num);
200 ascent_submit_gauge (NULL, "gauge", "avg-level", value);
202 /* Latency is in ms, but we store seconds. */
203 if (ps->latency_num <= 0)
204 value = NAN;
205 else
206 value = ((double) ps->latency_sum) / (1000.0 * ((double) ps->latency_num));
207 ascent_submit_gauge (NULL, "latency", "average", value);
209 return (0);
210 } /* }}} int ascent_submit_players */
212 static int ascent_account_player (player_stats_t *ps, /* {{{ */
213 player_info_t *pi)
214 {
215 if (pi->race >= 0)
216 {
217 if ((pi->race >= RACES_LIST_LENGTH)
218 || (races_list[pi->race] == NULL))
219 ERROR ("ascent plugin: Ignoring invalid numeric race %i.", pi->race);
220 else
221 ps->races[pi->race]++;
222 }
224 if (pi->class >= 0)
225 {
226 if ((pi->class >= CLASSES_LIST_LENGTH)
227 || (classes_list[pi->class] == NULL))
228 ERROR ("ascent plugin: Ignoring invalid numeric class %i.", pi->class);
229 else
230 ps->classes[pi->class]++;
231 }
233 if (pi->gender >= 0)
234 {
235 if ((pi->gender >= GENDERS_LIST_LENGTH)
236 || (genders_list[pi->gender] == NULL))
237 ERROR ("ascent plugin: Ignoring invalid numeric gender %i.",
238 pi->gender);
239 else
240 ps->genders[pi->gender]++;
241 }
244 if (pi->level > 0)
245 {
246 ps->level_sum += pi->level;
247 ps->level_num++;
248 }
250 if (pi->latency >= 0)
251 {
252 ps->latency_sum += pi->latency;
253 ps->latency_num++;
254 }
256 return (0);
257 } /* }}} int ascent_account_player */
259 static int ascent_xml_submit_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
260 const char *plugin_instance, const char *type, const char *type_instance)
261 {
262 char *str_ptr;
263 gauge_t value;
265 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
266 if (str_ptr == NULL)
267 {
268 ERROR ("ascent plugin: ascent_xml_submit_gauge: xmlNodeListGetString failed.");
269 return (-1);
270 }
272 if (strcasecmp ("N/A", str_ptr) == 0)
273 value = NAN;
274 else
275 {
276 char *end_ptr = NULL;
277 value = strtod (str_ptr, &end_ptr);
278 if (str_ptr == end_ptr)
279 {
280 xmlFree(str_ptr);
281 ERROR ("ascent plugin: ascent_xml_submit_gauge: strtod failed.");
282 return (-1);
283 }
284 }
285 xmlFree(str_ptr);
287 return (ascent_submit_gauge (plugin_instance, type, type_instance, value));
288 } /* }}} int ascent_xml_submit_gauge */
290 static int ascent_xml_read_int (xmlDoc *doc, xmlNode *node, /* {{{ */
291 int *ret_value)
292 {
293 char *str_ptr;
294 int value;
296 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
297 if (str_ptr == NULL)
298 {
299 ERROR ("ascent plugin: ascent_xml_read_int: xmlNodeListGetString failed.");
300 return (-1);
301 }
303 if (strcasecmp ("N/A", str_ptr) == 0)
304 value = -1;
305 else
306 {
307 char *end_ptr = NULL;
308 value = strtol (str_ptr, &end_ptr, 0);
309 if (str_ptr == end_ptr)
310 {
311 xmlFree(str_ptr);
312 ERROR ("ascent plugin: ascent_xml_read_int: strtol failed.");
313 return (-1);
314 }
315 }
316 xmlFree(str_ptr);
318 *ret_value = value;
319 return (0);
320 } /* }}} int ascent_xml_read_int */
322 static int ascent_xml_sessions_plr (xmlDoc *doc, xmlNode *node, /* {{{ */
323 player_info_t *pi)
324 {
325 xmlNode *child;
327 for (child = node->xmlChildrenNode; child != NULL; child = child->next)
328 {
329 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
330 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
331 /* ignore */;
332 else if (xmlStrcmp ((const xmlChar *) "race", child->name) == 0)
333 ascent_xml_read_int (doc, child, &pi->race);
334 else if (xmlStrcmp ((const xmlChar *) "class", child->name) == 0)
335 ascent_xml_read_int (doc, child, &pi->class);
336 else if (xmlStrcmp ((const xmlChar *) "gender", child->name) == 0)
337 ascent_xml_read_int (doc, child, &pi->gender);
338 else if (xmlStrcmp ((const xmlChar *) "level", child->name) == 0)
339 ascent_xml_read_int (doc, child, &pi->level);
340 else if (xmlStrcmp ((const xmlChar *) "latency", child->name) == 0)
341 ascent_xml_read_int (doc, child, &pi->latency);
342 else if ((xmlStrcmp ((const xmlChar *) "name", child->name) == 0)
343 || (xmlStrcmp ((const xmlChar *) "pvprank", child->name) == 0)
344 || (xmlStrcmp ((const xmlChar *) "map", child->name) == 0)
345 || (xmlStrcmp ((const xmlChar *) "areaid", child->name) == 0)
346 || (xmlStrcmp ((const xmlChar *) "xpos", child->name) == 0)
347 || (xmlStrcmp ((const xmlChar *) "ypos", child->name) == 0)
348 || (xmlStrcmp ((const xmlChar *) "onime", child->name) == 0))
349 /* ignore */;
350 else
351 {
352 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
353 }
354 } /* for (child) */
356 return (0);
357 } /* }}} int ascent_xml_sessions_plr */
359 static int ascent_xml_sessions (xmlDoc *doc, xmlNode *node) /* {{{ */
360 {
361 xmlNode *child;
362 player_stats_t ps;
364 memset (&ps, 0, sizeof (ps));
366 for (child = node->xmlChildrenNode; child != NULL; child = child->next)
367 {
368 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
369 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
370 /* ignore */;
371 else if (xmlStrcmp ((const xmlChar *) "plr", child->name) == 0)
372 {
373 int status;
374 player_info_t pi = PLAYER_INFO_STATIC_INIT;
376 status = ascent_xml_sessions_plr (doc, child, &pi);
377 if (status == 0)
378 ascent_account_player (&ps, &pi);
379 }
380 else
381 {
382 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
383 }
384 } /* for (child) */
386 ascent_submit_players (&ps);
388 return (0);
389 } /* }}} int ascent_xml_sessions */
391 static int ascent_xml_status (xmlDoc *doc, xmlNode *node) /* {{{ */
392 {
393 xmlNode *child;
395 for (child = node->xmlChildrenNode; child != NULL; child = child->next)
396 {
397 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
398 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
399 /* ignore */;
400 else if (xmlStrcmp ((const xmlChar *) "alliance", child->name) == 0)
401 ascent_xml_submit_gauge (doc, child, NULL, "players", "alliance");
402 else if (xmlStrcmp ((const xmlChar *) "horde", child->name) == 0)
403 ascent_xml_submit_gauge (doc, child, NULL, "players", "horde");
404 else if (xmlStrcmp ((const xmlChar *) "qplayers", child->name) == 0)
405 ascent_xml_submit_gauge (doc, child, NULL, "players", "queued");
406 else if ((xmlStrcmp ((const xmlChar *) "acceptedconns", child->name) == 0)
407 || (xmlStrcmp ((const xmlChar *) "avglat", child->name) == 0)
408 || (xmlStrcmp ((const xmlChar *) "cdbquerysize", child->name) == 0)
409 || (xmlStrcmp ((const xmlChar *) "cpu", child->name) == 0)
410 || (xmlStrcmp ((const xmlChar *) "fthreads", child->name) == 0)
411 || (xmlStrcmp ((const xmlChar *) "gmcount", child->name) == 0)
412 || (xmlStrcmp ((const xmlChar *) "lastupdate", child->name) == 0)
413 || (xmlStrcmp ((const xmlChar *) "ontime", child->name) == 0)
414 || (xmlStrcmp ((const xmlChar *) "oplayers", child->name) == 0)
415 || (xmlStrcmp ((const xmlChar *) "peakcount", child->name) == 0)
416 || (xmlStrcmp ((const xmlChar *) "platform", child->name) == 0)
417 || (xmlStrcmp ((const xmlChar *) "ram", child->name) == 0)
418 || (xmlStrcmp ((const xmlChar *) "threads", child->name) == 0)
419 || (xmlStrcmp ((const xmlChar *) "uptime", child->name) == 0)
420 || (xmlStrcmp ((const xmlChar *) "wdbquerysize", child->name) == 0))
421 /* ignore */;
422 else
423 {
424 WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
425 }
426 } /* for (child) */
428 return (0);
429 } /* }}} int ascent_xml_status */
431 static int ascent_xml (const char *data) /* {{{ */
432 {
433 xmlDoc *doc;
434 xmlNode *cur;
435 xmlNode *child;
437 #if 0
438 doc = xmlParseMemory (data, strlen (data),
439 /* URL = */ "ascent.xml",
440 /* encoding = */ NULL,
441 /* options = */ 0);
442 #else
443 doc = xmlParseMemory (data, strlen (data));
444 #endif
445 if (doc == NULL)
446 {
447 ERROR ("ascent plugin: xmlParseMemory failed.");
448 return (-1);
449 }
451 cur = xmlDocGetRootElement (doc);
452 if (cur == NULL)
453 {
454 ERROR ("ascent plugin: XML document is empty.");
455 xmlFreeDoc (doc);
456 return (-1);
457 }
459 if (xmlStrcmp ((const xmlChar *) "serverpage", cur->name) != 0)
460 {
461 ERROR ("ascent plugin: XML root element is not \"serverpage\".");
462 xmlFreeDoc (doc);
463 return (-1);
464 }
466 for (child = cur->xmlChildrenNode; child != NULL; child = child->next)
467 {
468 if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
469 || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
470 /* ignore */;
471 else if (xmlStrcmp ((const xmlChar *) "status", child->name) == 0)
472 ascent_xml_status (doc, child);
473 else if (xmlStrcmp ((const xmlChar *) "instances", child->name) == 0)
474 /* ignore for now */;
475 else if (xmlStrcmp ((const xmlChar *) "gms", child->name) == 0)
476 /* ignore for now */;
477 else if (xmlStrcmp ((const xmlChar *) "sessions", child->name) == 0)
478 ascent_xml_sessions (doc, child);
479 else
480 {
481 WARNING ("ascent plugin: ascent_xml: Unknown tag: %s", child->name);
482 }
483 } /* for (child) */
485 xmlFreeDoc (doc);
486 return (0);
487 } /* }}} int ascent_xml */
489 static int config_set (char **var, const char *value) /* {{{ */
490 {
491 if (*var != NULL)
492 {
493 free (*var);
494 *var = NULL;
495 }
497 if ((*var = strdup (value)) == NULL)
498 return (1);
499 else
500 return (0);
501 } /* }}} int config_set */
503 static int ascent_config (const char *key, const char *value) /* {{{ */
504 {
505 if (strcasecmp (key, "URL") == 0)
506 return (config_set (&url, value));
507 else if (strcasecmp (key, "User") == 0)
508 return (config_set (&user, value));
509 else if (strcasecmp (key, "Password") == 0)
510 return (config_set (&pass, value));
511 else if (strcasecmp (key, "VerifyPeer") == 0)
512 return (config_set (&verify_peer, value));
513 else if (strcasecmp (key, "VerifyHost") == 0)
514 return (config_set (&verify_host, value));
515 else if (strcasecmp (key, "CACert") == 0)
516 return (config_set (&cacert, value));
517 else
518 return (-1);
519 } /* }}} int ascent_config */
521 static int ascent_init (void) /* {{{ */
522 {
523 static char credentials[1024];
525 if (url == NULL)
526 {
527 WARNING ("ascent plugin: ascent_init: No URL configured, "
528 "returning an error.");
529 return (-1);
530 }
532 if (curl != NULL)
533 {
534 curl_easy_cleanup (curl);
535 }
537 if ((curl = curl_easy_init ()) == NULL)
538 {
539 ERROR ("ascent plugin: ascent_init: curl_easy_init failed.");
540 return (-1);
541 }
543 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, ascent_curl_callback);
544 curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
545 curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, ascent_curl_error);
547 if (user != NULL)
548 {
549 int status;
551 status = ssnprintf (credentials, sizeof (credentials), "%s:%s",
552 user, (pass == NULL) ? "" : pass);
553 if (status >= sizeof (credentials))
554 {
555 ERROR ("ascent plugin: ascent_init: Returning an error because the "
556 "credentials have been truncated.");
557 return (-1);
558 }
560 curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
561 }
563 curl_easy_setopt (curl, CURLOPT_URL, url);
565 if ((verify_peer == NULL) || (strcmp (verify_peer, "true") == 0))
566 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 1);
567 else
568 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 0);
570 if ((verify_host == NULL) || (strcmp (verify_host, "true") == 0))
571 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 2);
572 else
573 curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 0);
575 if (cacert != NULL)
576 curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
578 return (0);
579 } /* }}} int ascent_init */
581 static int ascent_read (void) /* {{{ */
582 {
583 int status;
585 if (curl == NULL)
586 {
587 ERROR ("ascent plugin: I don't have a CURL object.");
588 return (-1);
589 }
591 if (url == NULL)
592 {
593 ERROR ("ascent plugin: No URL has been configured.");
594 return (-1);
595 }
597 ascent_buffer_fill = 0;
598 if (curl_easy_perform (curl) != 0)
599 {
600 ERROR ("ascent plugin: curl_easy_perform failed: %s",
601 ascent_curl_error);
602 return (-1);
603 }
605 status = ascent_xml (ascent_buffer);
606 if (status != 0)
607 return (-1);
608 else
609 return (0);
610 } /* }}} int ascent_read */
612 void module_register (void)
613 {
614 plugin_register_config ("ascent", ascent_config, config_keys, config_keys_num);
615 plugin_register_init ("ascent", ascent_init);
616 plugin_register_read ("ascent", ascent_read);
617 } /* void module_register */
619 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */