1 /**
2 * collectd - src/teamspeak2.c
3 * Copyright (C) 2008 Stefan Hacker
4 * Copyright (C) 2008 Florian Forster
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors:
20 * Stefan Hacker <d0t at dbclan dot de>
21 * Florian Forster <octo at verplant.org>
22 **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
28 #include <arpa/inet.h>
29 #include <netinet/in.h>
30 #include <sys/types.h>
31 #include <sys/socket.h>
32 #include <netdb.h>
34 /*
35 * Defines
36 */
37 /* Default host and port */
38 #define DEFAULT_HOST "127.0.0.1"
39 #define DEFAULT_PORT "51234"
41 /*
42 * Variables
43 */
44 /* Server linked list structure */
45 typedef struct vserver_list_s
46 {
47 int port;
48 struct vserver_list_s *next;
49 } vserver_list_t;
50 static vserver_list_t *server_list = NULL;
52 /* Host data */
53 static char *config_host = NULL;
54 static char *config_port = NULL;
56 static FILE *global_read_fh = NULL;
57 static FILE *global_write_fh = NULL;
59 /* Config data */
60 static const char *config_keys[] =
61 {
62 "Host",
63 "Port",
64 "Server"
65 };
66 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
68 /*
69 * Functions
70 */
71 static int tss2_add_vserver (int vserver_port)
72 {
73 /*
74 * Adds a new vserver to the linked list
75 */
76 vserver_list_t *entry;
78 /* Check port range */
79 if ((vserver_port <= 0) || (vserver_port > 65535))
80 {
81 ERROR ("teamspeak2 plugin: VServer port is invalid: %i",
82 vserver_port);
83 return (-1);
84 }
86 /* Allocate memory */
87 entry = (vserver_list_t *) malloc (sizeof (vserver_list_t));
88 if (entry == NULL)
89 {
90 ERROR ("teamspeak2 plugin: malloc failed.");
91 return (-1);
92 }
93 memset (entry, 0, sizeof (vserver_list_t));
95 /* Save data */
96 entry->port = vserver_port;
98 /* Insert to list */
99 if(server_list == NULL) {
100 /* Add the server as the first element */
101 server_list = entry;
102 }
103 else {
104 vserver_list_t *prev;
106 /* Add the server to the end of the list */
107 prev = server_list;
108 while (prev->next != NULL)
109 prev = prev->next;
110 prev->next = entry;
111 }
113 INFO ("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
115 return (0);
116 } /* int tss2_add_vserver */
118 static void tss2_submit_gauge (const char *plugin_instance,
119 const char *type, const char *type_instance,
120 gauge_t value)
121 {
122 /*
123 * Submits a gauge value to the collectd daemon
124 */
125 value_t values[1];
126 value_list_t vl = VALUE_LIST_INIT;
128 values[0].gauge = value;
130 vl.values = values;
131 vl.values_len = 1;
132 vl.time = time (NULL);
133 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
134 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
136 if (plugin_instance != NULL)
137 sstrncpy (vl.plugin_instance, plugin_instance,
138 sizeof (vl.plugin_instance));
140 sstrncpy (vl.type, type, sizeof (vl.type));
142 if (type_instance != NULL)
143 sstrncpy (vl.type_instance, type_instance,
144 sizeof (vl.type_instance));
146 plugin_dispatch_values (&vl);
147 } /* void tss2_submit_gauge */
149 static void tss2_submit_io (const char *plugin_instance, const char *type,
150 counter_t rx, counter_t tx)
151 {
152 /*
153 * Submits the io rx/tx tuple to the collectd daemon
154 */
155 value_t values[2];
156 value_list_t vl = VALUE_LIST_INIT;
158 values[0].counter = rx;
159 values[1].counter = tx;
161 vl.values = values;
162 vl.values_len = 2;
163 vl.time = time (NULL);
164 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
165 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
167 if (plugin_instance != NULL)
168 sstrncpy (vl.plugin_instance, plugin_instance,
169 sizeof (vl.plugin_instance));
171 sstrncpy (vl.type, type, sizeof (vl.type));
173 plugin_dispatch_values (&vl);
174 } /* void tss2_submit_gauge */
176 static void tss2_close_socket (void)
177 {
178 /*
179 * Closes all sockets
180 */
181 if (global_write_fh != NULL)
182 {
183 fputs ("quit\r\n", global_write_fh);
184 }
186 if (global_read_fh != NULL)
187 {
188 fclose (global_read_fh);
189 global_read_fh = NULL;
190 }
192 if (global_write_fh != NULL)
193 {
194 fclose (global_write_fh);
195 global_write_fh = NULL;
196 }
197 } /* void tss2_close_socket */
199 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
200 {
201 /*
202 * Returns connected file objects or establishes the connection
203 * if it's not already present
204 */
205 struct addrinfo ai_hints;
206 struct addrinfo *ai_head;
207 struct addrinfo *ai_ptr;
208 int sd = -1;
209 int status;
211 /* Check if we already got opened connections */
212 if ((global_read_fh != NULL) && (global_write_fh != NULL))
213 {
214 /* If so, use them */
215 if (ret_read_fh != NULL)
216 *ret_read_fh = global_read_fh;
217 if (ret_write_fh != NULL)
218 *ret_write_fh = global_write_fh;
219 return (0);
220 }
222 /* Get all addrs for this hostname */
223 memset (&ai_hints, 0, sizeof (ai_hints));
224 #ifdef AI_ADDRCONFIG
225 ai_hints.ai_flags |= AI_ADDRCONFIG;
226 #endif
227 ai_hints.ai_family = AF_UNSPEC;
228 ai_hints.ai_socktype = SOCK_STREAM;
230 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
231 (config_port != NULL) ? config_port : DEFAULT_PORT,
232 &ai_hints,
233 &ai_head);
234 if (status != 0)
235 {
236 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
237 gai_strerror (status));
238 return (-1);
239 }
241 /* Try all given hosts until we can connect to one */
242 for (ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
243 {
244 /* Create socket */
245 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
246 ai_ptr->ai_protocol);
247 if (sd < 0)
248 {
249 char errbuf[1024];
250 WARNING ("teamspeak2 plugin: socket failed: %s",
251 sstrerror (errno, errbuf, sizeof (errbuf)));
252 continue;
253 }
255 /* Try to connect */
256 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
257 if (status != 0)
258 {
259 char errbuf[1024];
260 WARNING ("teamspeak2 plugin: connect failed: %s",
261 sstrerror (errno, errbuf, sizeof (errbuf)));
262 close (sd);
263 continue;
264 }
266 /*
267 * Success, we can break. Don't need more than one connection
268 */
269 break;
270 } /* for (ai_ptr) */
272 freeaddrinfo (ai_head);
274 /* Check if we really got connected */
275 if (sd < 0)
276 return (-1);
278 /* Create file objects from sockets */
279 global_read_fh = fdopen (sd, "r");
280 if (global_read_fh == NULL)
281 {
282 char errbuf[1024];
283 ERROR ("teamspeak2 plugin: fdopen failed: %s",
284 sstrerror (errno, errbuf, sizeof (errbuf)));
285 close (sd);
286 return (-1);
287 }
289 global_write_fh = fdopen (sd, "w");
290 if (global_write_fh == NULL)
291 {
292 char errbuf[1024];
293 ERROR ("teamspeak2 plugin: fdopen failed: %s",
294 sstrerror (errno, errbuf, sizeof (errbuf)));
295 tss2_close_socket ();
296 return (-1);
297 }
299 { /* Check that the server correctly identifies itself. */
300 char buffer[4096];
301 char *buffer_ptr;
303 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
304 buffer[sizeof (buffer) - 1] = 0;
306 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
307 {
308 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
309 "to server. Expected ``[TS]'', got ``%s''.",
310 buffer);
311 tss2_close_socket ();
312 return (-1);
313 }
314 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
315 }
317 /* Copy the new filehandles to the given pointers */
318 if (ret_read_fh != NULL)
319 *ret_read_fh = global_read_fh;
320 if (ret_write_fh != NULL)
321 *ret_write_fh = global_write_fh;
322 return (0);
323 } /* int tss2_get_socket */
325 static int tss2_send_request (FILE *fh, const char *request)
326 {
327 /*
328 * This function puts a request to the server socket
329 */
330 int status;
332 status = fputs (request, fh);
333 if (status < 0)
334 {
335 ERROR ("teamspeak2 plugin: fputs failed.");
336 tss2_close_socket ();
337 return (-1);
338 }
339 fflush (fh);
341 return (0);
342 } /* int tss2_send_request */
344 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
345 {
346 /*
347 * Receive a single line from the given file object
348 */
349 char *temp;
351 /*
352 * fgets is blocking but much easier then doing anything else
353 * TODO: Non-blocking Version would be safer
354 */
355 temp = fgets (buffer, buffer_size, fh);
356 if (temp == NULL)
357 {
358 char errbuf[1024];
359 ERROR ("teamspeak2 plugin: fgets failed: %s",
360 sstrerror (errno, errbuf, sizeof(errbuf)));
361 tss2_close_socket ();
362 return (-1);
363 }
365 buffer[buffer_size - 1] = 0;
366 return (0);
367 } /* int tss2_receive_line */
369 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
370 {
371 /*
372 * Tell the server to select the given vserver
373 */
374 char command[128];
375 char response[128];
376 int status;
378 /* Send request */
379 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
381 status = tss2_send_request (write_fh, command);
382 if (status != 0)
383 {
384 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
385 return (-1);
386 }
388 /* Get answer */
389 status = tss2_receive_line (read_fh, response, sizeof (response));
390 if (status != 0)
391 {
392 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
393 return (-1);
394 }
395 response[sizeof (response) - 1] = 0;
397 /* Check answer */
398 if ((strncasecmp ("OK", response, 2) == 0)
399 && ((response[2] == 0)
400 || (response[2] == '\n')
401 || (response[2] == '\r')))
402 return (0);
404 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
405 "Response received from server was: ``%s''.",
406 command, response);
407 return (-1);
408 } /* int tss2_select_vserver */
410 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
411 vserver_list_t *vserver, gauge_t *ret_value)
412 {
413 /*
414 * Reads the vserver's average packet loss and submits it to collectd.
415 * Be sure to run the tss2_read_vserver function before calling this so
416 * the vserver is selected correctly.
417 */
418 gauge_t packet_loss = NAN;
419 int status;
421 status = tss2_send_request (write_fh, "gapl\r\n");
422 if (status != 0)
423 {
424 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
425 return (-1);
426 }
428 while (42)
429 {
430 char buffer[4096];
431 char *value;
432 char *endptr = NULL;
434 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
435 if (status != 0)
436 {
437 /* Set to NULL just to make sure noone uses these FHs anymore. */
438 read_fh = NULL;
439 write_fh = NULL;
440 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
441 return (-1);
442 }
443 buffer[sizeof (buffer) - 1] = 0;
445 if (strncmp ("average_packet_loss=", buffer,
446 strlen ("average_packet_loss=")) == 0)
447 {
448 /* Got average packet loss, now interpret it */
449 value = &buffer[20];
450 /* Replace , with . */
451 while (*value != 0)
452 {
453 if (*value == ',')
454 {
455 *value = '.';
456 break;
457 }
458 value++;
459 }
461 value = &buffer[20];
463 packet_loss = strtod (value, &endptr);
464 if (value == endptr)
465 {
466 /* Failed */
467 WARNING ("teamspeak2 plugin: Could not read average package "
468 "loss from string: %s", buffer);
469 continue;
470 }
471 }
472 else if (strncasecmp ("OK", buffer, 2) == 0)
473 {
474 break;
475 }
476 else if (strncasecmp ("ERROR", buffer, 5) == 0)
477 {
478 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
479 return (-1);
480 }
481 else
482 {
483 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
484 buffer);
485 }
486 }
488 *ret_value = packet_loss;
489 return (0);
490 } /* int tss2_vserver_gapl */
492 static int tss2_read_vserver (vserver_list_t *vserver)
493 {
494 /*
495 * Poll information for the given vserver and submit it to collect.
496 * If vserver is NULL the global server information will be queried.
497 */
498 int status;
500 gauge_t users = NAN;
501 gauge_t channels = NAN;
502 gauge_t servers = NAN;
503 counter_t rx_octets = 0;
504 counter_t tx_octets = 0;
505 counter_t rx_packets = 0;
506 counter_t tx_packets = 0;
507 gauge_t packet_loss = NAN;
508 int valid = 0;
510 char plugin_instance[DATA_MAX_NAME_LEN];
512 FILE *read_fh;
513 FILE *write_fh;
515 /* Get the send/receive sockets */
516 status = tss2_get_socket (&read_fh, &write_fh);
517 if (status != 0)
518 {
519 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
520 return (-1);
521 }
523 if (vserver == NULL)
524 {
525 /* Request global information */
526 memset (plugin_instance, 0, sizeof (plugin_instance));
528 status = tss2_send_request (write_fh, "gi\r\n");
529 }
530 else
531 {
532 /* Request server information */
533 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
534 vserver->port);
536 /* Select the server */
537 status = tss2_select_vserver (read_fh, write_fh, vserver);
538 if (status != 0)
539 return (status);
541 status = tss2_send_request (write_fh, "si\r\n");
542 }
544 if (status != 0)
545 {
546 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
547 return (-1);
548 }
550 /* Loop until break */
551 while (42)
552 {
553 char buffer[4096];
554 char *key;
555 char *value;
556 char *endptr = NULL;
558 /* Read one line of the server's answer */
559 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
560 if (status != 0)
561 {
562 /* Set to NULL just to make sure noone uses these FHs anymore. */
563 read_fh = NULL;
564 write_fh = NULL;
565 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
566 break;
567 }
569 if (strncasecmp ("ERROR", buffer, 5) == 0)
570 {
571 ERROR ("teamspeak2 plugin: Server returned an error: %s",
572 buffer);
573 break;
574 }
575 else if (strncasecmp ("OK", buffer, 2) == 0)
576 {
577 break;
578 }
580 /* Split line into key and value */
581 key = strchr (buffer, '_');
582 if (key == NULL)
583 {
584 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
585 continue;
586 }
587 key++;
589 /* Evaluate assignment */
590 value = strchr (key, '=');
591 if (value == NULL)
592 {
593 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
594 continue;
595 }
596 *value = 0;
597 value++;
599 /* Check for known key and save the given value */
600 /* global info: users_online,
601 * server info: currentusers. */
602 if ((strcmp ("currentusers", key) == 0)
603 || (strcmp ("users_online", key) == 0))
604 {
605 users = strtod (value, &endptr);
606 if (value != endptr)
607 valid |= 0x01;
608 }
609 /* global info: channels,
610 * server info: currentchannels. */
611 else if ((strcmp ("currentchannels", key) == 0)
612 || (strcmp ("channels", key) == 0))
613 {
614 channels = strtod (value, &endptr);
615 if (value != endptr)
616 valid |= 0x40;
617 }
618 /* global only */
619 else if (strcmp ("servers", key) == 0)
620 {
621 servers = strtod (value, &endptr);
622 if (value != endptr)
623 valid |= 0x80;
624 }
625 else if (strcmp ("bytesreceived", key) == 0)
626 {
627 rx_octets = strtoll (value, &endptr, 0);
628 if (value != endptr)
629 valid |= 0x02;
630 }
631 else if (strcmp ("bytessend", key) == 0)
632 {
633 tx_octets = strtoll (value, &endptr, 0);
634 if (value != endptr)
635 valid |= 0x04;
636 }
637 else if (strcmp ("packetsreceived", key) == 0)
638 {
639 rx_packets = strtoll (value, &endptr, 0);
640 if (value != endptr)
641 valid |= 0x08;
642 }
643 else if (strcmp ("packetssend", key) == 0)
644 {
645 tx_packets = strtoll (value, &endptr, 0);
646 if (value != endptr)
647 valid |= 0x10;
648 }
649 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
650 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
651 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
652 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
653 || (strcmp ("adminemail", key) == 0)
654 || (strcmp ("clan_server", key) == 0)
655 || (strcmp ("countrynumber", key) == 0)
656 || (strcmp ("id", key) == 0)
657 || (strcmp ("ispname", key) == 0)
658 || (strcmp ("linkurl", key) == 0)
659 || (strcmp ("maxusers", key) == 0)
660 || (strcmp ("name", key) == 0)
661 || (strcmp ("password", key) == 0)
662 || (strcmp ("platform", key) == 0)
663 || (strcmp ("server_platform", key) == 0)
664 || (strcmp ("server_uptime", key) == 0)
665 || (strcmp ("server_version", key) == 0)
666 || (strcmp ("udpport", key) == 0)
667 || (strcmp ("uptime", key) == 0)
668 || (strcmp ("users_maximal", key) == 0)
669 || (strcmp ("welcomemessage", key) == 0))
670 /* ignore */;
671 else
672 {
673 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
674 "key = %s; value = %s;", key, value);
675 }
676 } /* while (42) */
678 /* Collect vserver packet loss rates only if the loop above did not exit
679 * with an error. */
680 if ((status == 0) && (vserver != NULL))
681 {
682 status = tss2_vserver_gapl (read_fh, write_fh, vserver, &packet_loss);
683 if (status == 0)
684 {
685 valid |= 0x20;
686 }
687 else
688 {
689 WARNING ("teamspeak2 plugin: Reading package loss "
690 "for vserver %i failed.", vserver->port);
691 }
692 }
694 if ((valid & 0x01) == 0x01)
695 tss2_submit_gauge (plugin_instance, "users", NULL, users);
697 if ((valid & 0x06) == 0x06)
698 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
700 if ((valid & 0x18) == 0x18)
701 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
703 if ((valid & 0x20) == 0x20)
704 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
706 if ((valid & 0x40) == 0x40)
707 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
709 if ((valid & 0x80) == 0x80)
710 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
712 if (valid == 0)
713 return (-1);
714 return (0);
715 } /* int tss2_read_vserver */
717 static int tss2_config (const char *key, const char *value)
718 {
719 /*
720 * Interpret configuration values
721 */
722 if (strcasecmp ("Host", key) == 0)
723 {
724 char *temp;
726 temp = strdup (value);
727 if (temp == NULL)
728 {
729 ERROR("teamspeak2 plugin: strdup failed.");
730 return (1);
731 }
732 sfree (config_host);
733 config_host = temp;
734 }
735 else if (strcasecmp ("Port", key) == 0)
736 {
737 char *temp;
739 temp = strdup (value);
740 if (temp == NULL)
741 {
742 ERROR("teamspeak2 plugin: strdup failed.");
743 return (1);
744 }
745 sfree (config_port);
746 config_port = temp;
747 }
748 else if (strcasecmp ("Server", key) == 0)
749 {
750 /* Server variable found */
751 int status;
753 status = tss2_add_vserver (atoi (value));
754 if (status != 0)
755 return (1);
756 }
757 else
758 {
759 /* Unknown variable found */
760 return (-1);
761 }
763 return 0;
764 } /* int tss2_config */
766 static int tss2_read (void)
767 {
768 /*
769 * Poll function which collects global and vserver information
770 * and submits it to collectd
771 */
772 vserver_list_t *vserver;
773 int success = 0;
774 int status;
776 /* Handle global server variables */
777 status = tss2_read_vserver (NULL);
778 if (status == 0)
779 {
780 success++;
781 }
782 else
783 {
784 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
785 }
787 /* Handle vservers */
788 for (vserver = server_list; vserver != NULL; vserver = vserver->next)
789 {
790 status = tss2_read_vserver (vserver);
791 if (status == 0)
792 {
793 success++;
794 }
795 else
796 {
797 WARNING ("teamspeak2 plugin: Reading statistics "
798 "for vserver %i failed.", vserver->port);
799 continue;
800 }
801 }
803 if (success == 0)
804 return (-1);
805 return (0);
806 } /* int tss2_read */
808 static int tss2_shutdown(void)
809 {
810 /*
811 * Shutdown handler
812 */
813 vserver_list_t *entry;
815 tss2_close_socket ();
817 entry = server_list;
818 server_list = NULL;
819 while (entry != NULL)
820 {
821 vserver_list_t *next;
823 next = entry->next;
824 sfree (entry);
825 entry = next;
826 }
828 /* Get rid of the configuration */
829 sfree (config_host);
830 sfree (config_port);
832 return (0);
833 } /* int tss2_shutdown */
835 void module_register(void)
836 {
837 /*
838 * Mandatory module_register function
839 */
840 plugin_register_config ("teamspeak2", tss2_config,
841 config_keys, config_keys_num);
842 plugin_register_read ("teamspeak2", tss2_read);
843 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
844 } /* void module_register */
846 /* vim: set sw=4 ts=4 : */