Merge branch 'collectd-5.5'
[collectd.git] / src / ascent.c
1 /**
2  * collectd - src/ascent.c
3  * Copyright (C) 2008       Florian octo Forster
4  *
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:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
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.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at collectd.org>
25  **/
26
27 #include "collectd.h"
28
29 #include "common.h"
30 #include "plugin.h"
31 #include "configfile.h"
32
33 #include <curl/curl.h>
34 #include <libxml/parser.h>
35
36 static const char *races_list[] = /* {{{ */
37 {
38   NULL,
39   "Human",    /*  1 */
40   "Orc",      /*  2 */
41   "Dwarf",    /*  3 */
42   "Nightelf", /*  4 */
43   "Undead",   /*  5 */
44   "Tauren",   /*  6 */
45   "Gnome",    /*  7 */
46   "Troll",    /*  8 */
47   NULL,
48   "Bloodelf", /* 10 */
49   "Draenei"   /* 11 */
50 }; /* }}} */
51 #define RACES_LIST_LENGTH STATIC_ARRAY_SIZE (races_list)
52
53 static const char *classes_list[] = /* {{{ */
54 {
55   NULL,
56   "Warrior", /*  1 */
57   "Paladin", /*  2 */
58   "Hunter",  /*  3 */
59   "Rogue",   /*  4 */
60   "Priest",  /*  5 */
61   NULL,
62   "Shaman",  /*  7 */
63   "Mage",    /*  8 */
64   "Warlock", /*  9 */
65   NULL,
66   "Druid"    /* 11 */
67 }; /* }}} */
68 #define CLASSES_LIST_LENGTH STATIC_ARRAY_SIZE (classes_list)
69
70 static const char *genders_list[] = /* {{{ */
71 {
72   "Male",
73   "Female"
74 }; /* }}} */
75 #define GENDERS_LIST_LENGTH STATIC_ARRAY_SIZE (genders_list)
76
77 struct player_stats_s
78 {
79   int races[RACES_LIST_LENGTH];
80   int classes[CLASSES_LIST_LENGTH];
81   int genders[GENDERS_LIST_LENGTH];
82   int level_sum;
83   int level_num;
84   int latency_sum;
85   int latency_num;
86 };
87 typedef struct player_stats_s player_stats_t;
88
89 struct player_info_s
90 {
91   int race;
92   int class;
93   int gender;
94   int level;
95   int latency;
96 };
97 typedef struct player_info_s player_info_t;
98 #define PLAYER_INFO_STATIC_INIT { -1, -1, -1, -1, -1 }
99
100 static char *url         = NULL;
101 static char *user        = NULL;
102 static char *pass        = NULL;
103 static char *verify_peer = NULL;
104 static char *verify_host = NULL;
105 static char *cacert      = NULL;
106 static char *timeout     = NULL;
107
108 static CURL *curl = NULL;
109
110 static char  *ascent_buffer = NULL;
111 static size_t ascent_buffer_size = 0;
112 static size_t ascent_buffer_fill = 0;
113 static char   ascent_curl_error[CURL_ERROR_SIZE];
114
115 static const char *config_keys[] =
116 {
117   "URL",
118   "User",
119   "Password",
120   "VerifyPeer",
121   "VerifyHost",
122   "CACert",
123   "Timeout",
124 };
125 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
126
127 static int ascent_submit_gauge (const char *plugin_instance, /* {{{ */
128     const char *type, const char *type_instance, gauge_t value)
129 {
130   value_t values[1];
131   value_list_t vl = VALUE_LIST_INIT;
132
133   values[0].gauge = value;
134
135   vl.values = values;
136   vl.values_len = 1;
137   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
138   sstrncpy (vl.plugin, "ascent", sizeof (vl.plugin));
139
140   if (plugin_instance != NULL)
141     sstrncpy (vl.plugin_instance, plugin_instance,
142         sizeof (vl.plugin_instance));
143
144   sstrncpy (vl.type, type, sizeof (vl.type));
145
146   if (type_instance != NULL)
147     sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
148
149   plugin_dispatch_values (&vl);
150   return (0);
151 } /* }}} int ascent_submit_gauge */
152
153 static size_t ascent_curl_callback (void *buf, size_t size, size_t nmemb, /* {{{ */
154     void __attribute__((unused)) *stream)
155 {
156   size_t len = size * nmemb;
157
158   if (len == 0)
159     return (len);
160
161   if ((ascent_buffer_fill + len) >= ascent_buffer_size)
162   {
163     char *temp;
164
165     temp = realloc (ascent_buffer,
166         ascent_buffer_fill + len + 1);
167     if (temp == NULL)
168     {
169       ERROR ("ascent plugin: realloc failed.");
170       return (0);
171     }
172     ascent_buffer = temp;
173     ascent_buffer_size = ascent_buffer_fill + len + 1;
174   }
175
176   memcpy (ascent_buffer + ascent_buffer_fill, (char *) buf, len);
177   ascent_buffer_fill += len;
178   ascent_buffer[ascent_buffer_fill] = 0;
179
180   return (len);
181 } /* }}} size_t ascent_curl_callback */
182
183 static int ascent_submit_players (player_stats_t *ps) /* {{{ */
184 {
185   gauge_t value;
186
187   for (size_t i = 0; i < RACES_LIST_LENGTH; i++)
188     if (races_list[i] != NULL)
189       ascent_submit_gauge ("by-race", "players", races_list[i],
190           (gauge_t) ps->races[i]);
191
192   for (size_t i = 0; i < CLASSES_LIST_LENGTH; i++)
193     if (classes_list[i] != NULL)
194       ascent_submit_gauge ("by-class", "players", classes_list[i],
195           (gauge_t) ps->classes[i]);
196
197   for (size_t i = 0; i < GENDERS_LIST_LENGTH; i++)
198     if (genders_list[i] != NULL)
199       ascent_submit_gauge ("by-gender", "players", genders_list[i],
200           (gauge_t) ps->genders[i]);
201
202   if (ps->level_num <= 0)
203     value = NAN;
204   else
205     value = ((double) ps->level_sum) / ((double) ps->level_num);
206   ascent_submit_gauge (NULL, "gauge", "avg-level", value);
207
208   /* Latency is in ms, but we store seconds. */
209   if (ps->latency_num <= 0)
210     value = NAN;
211   else
212     value = ((double) ps->latency_sum) / (1000.0 * ((double) ps->latency_num));
213   ascent_submit_gauge (NULL, "latency", "average", value);
214
215   return (0);
216 } /* }}} int ascent_submit_players */
217
218 static int ascent_account_player (player_stats_t *ps, /* {{{ */
219     player_info_t *pi)
220 {
221   if (pi->race >= 0)
222   {
223     if (((size_t) pi->race >= RACES_LIST_LENGTH)
224         || (races_list[pi->race] == NULL))
225       ERROR ("ascent plugin: Ignoring invalid numeric race %i.", pi->race);
226     else
227       ps->races[pi->race]++;
228   }
229
230   if (pi->class >= 0)
231   {
232     if (((size_t) pi->class >= CLASSES_LIST_LENGTH)
233         || (classes_list[pi->class] == NULL))
234       ERROR ("ascent plugin: Ignoring invalid numeric class %i.", pi->class);
235     else
236       ps->classes[pi->class]++;
237   }
238
239   if (pi->gender >= 0)
240   {
241     if (((size_t) pi->gender >= GENDERS_LIST_LENGTH)
242         || (genders_list[pi->gender] == NULL))
243       ERROR ("ascent plugin: Ignoring invalid numeric gender %i.",
244           pi->gender);
245     else
246       ps->genders[pi->gender]++;
247   }
248
249
250   if (pi->level > 0)
251   {
252     ps->level_sum += pi->level;
253     ps->level_num++;
254   }
255
256   if (pi->latency >= 0)
257   {
258     ps->latency_sum += pi->latency;
259     ps->latency_num++;
260   }
261
262   return (0);
263 } /* }}} int ascent_account_player */
264
265 static int ascent_xml_submit_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
266     const char *plugin_instance, const char *type, const char *type_instance)
267 {
268   char *str_ptr;
269   gauge_t value;
270
271   str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
272   if (str_ptr == NULL)
273   {
274     ERROR ("ascent plugin: ascent_xml_submit_gauge: xmlNodeListGetString failed.");
275     return (-1);
276   }
277
278   if (strcasecmp ("N/A", str_ptr) == 0)
279     value = NAN;
280   else
281   {
282     char *end_ptr = NULL;
283     value = strtod (str_ptr, &end_ptr);
284     if (str_ptr == end_ptr)
285     {
286       xmlFree(str_ptr);
287       ERROR ("ascent plugin: ascent_xml_submit_gauge: strtod failed.");
288       return (-1);
289     }
290   }
291   xmlFree(str_ptr);
292
293   return (ascent_submit_gauge (plugin_instance, type, type_instance, value));
294 } /* }}} int ascent_xml_submit_gauge */
295
296 static int ascent_xml_read_int (xmlDoc *doc, xmlNode *node, /* {{{ */
297     int *ret_value)
298 {
299   char *str_ptr;
300   int value;
301
302   str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
303   if (str_ptr == NULL)
304   {
305     ERROR ("ascent plugin: ascent_xml_read_int: xmlNodeListGetString failed.");
306     return (-1);
307   }
308
309   if (strcasecmp ("N/A", str_ptr) == 0)
310     value = -1;
311   else
312   {
313     char *end_ptr = NULL;
314     value = strtol (str_ptr, &end_ptr, 0);
315     if (str_ptr == end_ptr)
316     {
317       xmlFree(str_ptr);
318       ERROR ("ascent plugin: ascent_xml_read_int: strtol failed.");
319       return (-1);
320     }
321   }
322   xmlFree(str_ptr);
323
324   *ret_value = value;
325   return (0);
326 } /* }}} int ascent_xml_read_int */
327
328 static int ascent_xml_sessions_plr (xmlDoc *doc, xmlNode *node, /* {{{ */
329     player_info_t *pi)
330 {
331   for (xmlNode *child = node->xmlChildrenNode; child != NULL; child = child->next)
332   {
333     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
334         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
335       /* ignore */;
336     else if (xmlStrcmp ((const xmlChar *) "race", child->name) == 0)
337       ascent_xml_read_int (doc, child, &pi->race);
338     else if (xmlStrcmp ((const xmlChar *) "class", child->name) == 0)
339       ascent_xml_read_int (doc, child, &pi->class);
340     else if (xmlStrcmp ((const xmlChar *) "gender", child->name) == 0)
341       ascent_xml_read_int (doc, child, &pi->gender);
342     else if (xmlStrcmp ((const xmlChar *) "level", child->name) == 0)
343       ascent_xml_read_int (doc, child, &pi->level);
344     else if (xmlStrcmp ((const xmlChar *) "latency", child->name) == 0)
345       ascent_xml_read_int (doc, child, &pi->latency);
346     else if ((xmlStrcmp ((const xmlChar *) "name", child->name) == 0)
347         || (xmlStrcmp ((const xmlChar *) "pvprank", child->name) == 0)
348         || (xmlStrcmp ((const xmlChar *) "map", child->name) == 0)
349         || (xmlStrcmp ((const xmlChar *) "areaid", child->name) == 0)
350         || (xmlStrcmp ((const xmlChar *) "xpos", child->name) == 0)
351         || (xmlStrcmp ((const xmlChar *) "ypos", child->name) == 0)
352         || (xmlStrcmp ((const xmlChar *) "onime", child->name) == 0))
353       /* ignore */;
354     else
355     {
356       WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
357     }
358   } /* for (child) */
359
360   return (0);
361 } /* }}} int ascent_xml_sessions_plr */
362
363 static int ascent_xml_sessions (xmlDoc *doc, xmlNode *node) /* {{{ */
364 {
365   player_stats_t ps = {
366     .level_sum = 0
367   };
368
369   for (xmlNode *child = node->xmlChildrenNode; child != NULL; child = child->next)
370   {
371     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
372         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
373       /* ignore */;
374     else if (xmlStrcmp ((const xmlChar *) "plr", child->name) == 0)
375     {
376       int status;
377       player_info_t pi = PLAYER_INFO_STATIC_INIT;
378
379       status = ascent_xml_sessions_plr (doc, child, &pi);
380       if (status == 0)
381         ascent_account_player (&ps, &pi);
382     }
383     else
384     {
385       WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
386     }
387   } /* for (child) */
388
389   ascent_submit_players (&ps);
390
391   return (0);
392 } /* }}} int ascent_xml_sessions */
393
394 static int ascent_xml_status (xmlDoc *doc, xmlNode *node) /* {{{ */
395 {
396   for (xmlNode *child = node->xmlChildrenNode; child != NULL; child = child->next)
397   {
398     if ((xmlStrcmp ((const xmlChar *) "comment", child->name) == 0)
399         || (xmlStrcmp ((const xmlChar *) "text", child->name) == 0))
400       /* ignore */;
401     else if (xmlStrcmp ((const xmlChar *) "alliance", child->name) == 0)
402       ascent_xml_submit_gauge (doc, child, NULL, "players", "alliance");
403     else if (xmlStrcmp ((const xmlChar *) "horde", child->name) == 0)
404       ascent_xml_submit_gauge (doc, child, NULL, "players", "horde");
405     else if (xmlStrcmp ((const xmlChar *) "qplayers", child->name) == 0)
406       ascent_xml_submit_gauge (doc, child, NULL, "players", "queued");
407     else if ((xmlStrcmp ((const xmlChar *) "acceptedconns", child->name) == 0)
408         || (xmlStrcmp ((const xmlChar *) "avglat", child->name) == 0)
409         || (xmlStrcmp ((const xmlChar *) "cdbquerysize", child->name) == 0)
410         || (xmlStrcmp ((const xmlChar *) "cpu", child->name) == 0)
411         || (xmlStrcmp ((const xmlChar *) "fthreads", child->name) == 0)
412         || (xmlStrcmp ((const xmlChar *) "gmcount", child->name) == 0)
413         || (xmlStrcmp ((const xmlChar *) "lastupdate", child->name) == 0)
414         || (xmlStrcmp ((const xmlChar *) "ontime", child->name) == 0)
415         || (xmlStrcmp ((const xmlChar *) "oplayers", child->name) == 0)
416         || (xmlStrcmp ((const xmlChar *) "peakcount", child->name) == 0)
417         || (xmlStrcmp ((const xmlChar *) "platform", child->name) == 0)
418         || (xmlStrcmp ((const xmlChar *) "ram", child->name) == 0)
419         || (xmlStrcmp ((const xmlChar *) "threads", child->name) == 0)
420         || (xmlStrcmp ((const xmlChar *) "uptime", child->name) == 0)
421         || (xmlStrcmp ((const xmlChar *) "wdbquerysize", child->name) == 0))
422       /* ignore */;
423     else
424     {
425       WARNING ("ascent plugin: ascent_xml_status: Unknown tag: %s", child->name);
426     }
427   } /* for (child) */
428
429   return (0);
430 } /* }}} int ascent_xml_status */
431
432 static int ascent_xml (const char *data) /* {{{ */
433 {
434   xmlDoc *doc;
435   xmlNode *cur;
436
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   }
450
451   cur = xmlDocGetRootElement (doc);
452   if (cur == NULL)
453   {
454     ERROR ("ascent plugin: XML document is empty.");
455     xmlFreeDoc (doc);
456     return (-1);
457   }
458
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   }
465
466   for (xmlNode *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) */
484
485   xmlFreeDoc (doc);
486   return (0);
487 } /* }}} int ascent_xml */
488
489 static int config_set (char **var, const char *value) /* {{{ */
490 {
491   if (*var != NULL)
492   {
493     free (*var);
494     *var = NULL;
495   }
496
497   if ((*var = strdup (value)) == NULL)
498     return (1);
499   else
500     return (0);
501 } /* }}} int config_set */
502
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 if (strcasecmp (key, "Timeout") == 0)
518     return (config_set (&timeout, value));
519   else
520     return (-1);
521 } /* }}} int ascent_config */
522
523 static int ascent_init (void) /* {{{ */
524 {
525   if (url == NULL)
526   {
527     WARNING ("ascent plugin: ascent_init: No URL configured, "
528         "returning an error.");
529     return (-1);
530   }
531
532   if (curl != NULL)
533   {
534     curl_easy_cleanup (curl);
535   }
536
537   if ((curl = curl_easy_init ()) == NULL)
538   {
539     ERROR ("ascent plugin: ascent_init: curl_easy_init failed.");
540     return (-1);
541   }
542
543   curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1L);
544   curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, ascent_curl_callback);
545   curl_easy_setopt (curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
546   curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, ascent_curl_error);
547
548   if (user != NULL)
549   {
550 #ifdef HAVE_CURLOPT_USERNAME
551     curl_easy_setopt (curl, CURLOPT_USERNAME, user);
552     curl_easy_setopt (curl, CURLOPT_PASSWORD, (pass == NULL) ? "" : pass);
553 #else
554     static char credentials[1024];
555     int status;
556
557     status = ssnprintf (credentials, sizeof (credentials), "%s:%s",
558         user, (pass == NULL) ? "" : pass);
559     if ((status < 0) || ((size_t) status >= sizeof (credentials)))
560     {
561       ERROR ("ascent plugin: ascent_init: Returning an error because the "
562           "credentials have been truncated.");
563       return (-1);
564     }
565
566     curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
567 #endif
568   }
569
570   curl_easy_setopt (curl, CURLOPT_URL, url);
571   curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
572   curl_easy_setopt (curl, CURLOPT_MAXREDIRS, 50L);
573
574   if ((verify_peer == NULL) || IS_TRUE (verify_peer))
575     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 1L);
576   else
577     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 0L);
578
579   if ((verify_host == NULL) || IS_TRUE (verify_host))
580     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 2L);
581   else
582     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 0L);
583
584   if (cacert != NULL)
585     curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
586
587 #ifdef HAVE_CURLOPT_TIMEOUT_MS
588   if (timeout != NULL)
589     curl_easy_setopt (curl, CURLOPT_TIMEOUT_MS, atol(timeout));
590   else
591     curl_easy_setopt (curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
592 #endif
593
594   return (0);
595 } /* }}} int ascent_init */
596
597 static int ascent_read (void) /* {{{ */
598 {
599   int status;
600
601   if (curl == NULL)
602   {
603     ERROR ("ascent plugin: I don't have a CURL object.");
604     return (-1);
605   }
606
607   if (url == NULL)
608   {
609     ERROR ("ascent plugin: No URL has been configured.");
610     return (-1);
611   }
612
613   ascent_buffer_fill = 0;
614   if (curl_easy_perform (curl) != CURLE_OK)
615   {
616     ERROR ("ascent plugin: curl_easy_perform failed: %s",
617         ascent_curl_error);
618     return (-1);
619   }
620
621   status = ascent_xml (ascent_buffer);
622   if (status != 0)
623     return (-1);
624   else
625     return (0);
626 } /* }}} int ascent_read */
627
628 void module_register (void)
629 {
630   plugin_register_config ("ascent", ascent_config, config_keys, config_keys_num);
631   plugin_register_init ("ascent", ascent_init);
632   plugin_register_read ("ascent", ascent_read);
633 } /* void module_register */
634
635 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */