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 collectd.org>
22 **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
28 #include <netinet/in.h>
29 #include <arpa/inet.h>
30 #include <sys/types.h>
31 #include <netdb.h>
33 /*
34 * Defines
35 */
36 /* Default host and port */
37 #define DEFAULT_HOST "127.0.0.1"
38 #define DEFAULT_PORT "51234"
40 /*
41 * Variables
42 */
43 /* Server linked list structure */
44 typedef struct vserver_list_s
45 {
46 int port;
47 struct vserver_list_s *next;
48 } vserver_list_t;
49 static vserver_list_t *server_list = NULL;
51 /* Host data */
52 static char *config_host = NULL;
53 static char *config_port = NULL;
55 static FILE *global_read_fh = NULL;
56 static FILE *global_write_fh = NULL;
58 /* Config data */
59 static const char *config_keys[] =
60 {
61 "Host",
62 "Port",
63 "Server"
64 };
65 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
67 /*
68 * Functions
69 */
70 static int tss2_add_vserver (int vserver_port)
71 {
72 /*
73 * Adds a new vserver to the linked list
74 */
75 vserver_list_t *entry;
77 /* Check port range */
78 if ((vserver_port <= 0) || (vserver_port > 65535))
79 {
80 ERROR ("teamspeak2 plugin: VServer port is invalid: %i",
81 vserver_port);
82 return (-1);
83 }
85 /* Allocate memory */
86 entry = calloc (1, sizeof (*entry));
87 if (entry == NULL)
88 {
89 ERROR ("teamspeak2 plugin: calloc failed.");
90 return (-1);
91 }
93 /* Save data */
94 entry->port = vserver_port;
96 /* Insert to list */
97 if(server_list == NULL) {
98 /* Add the server as the first element */
99 server_list = entry;
100 }
101 else {
102 vserver_list_t *prev;
104 /* Add the server to the end of the list */
105 prev = server_list;
106 while (prev->next != NULL)
107 prev = prev->next;
108 prev->next = entry;
109 }
111 INFO ("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
113 return (0);
114 } /* int tss2_add_vserver */
116 static void tss2_submit_gauge (const char *plugin_instance,
117 const char *type, const char *type_instance,
118 gauge_t value)
119 {
120 /*
121 * Submits a gauge value to the collectd daemon
122 */
123 value_t values[1];
124 value_list_t vl = VALUE_LIST_INIT;
126 values[0].gauge = value;
128 vl.values = values;
129 vl.values_len = 1;
130 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
131 sstrncpy (vl.plugin, "teamspeak2", 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,
141 sizeof (vl.type_instance));
143 plugin_dispatch_values (&vl);
144 } /* void tss2_submit_gauge */
146 static void tss2_submit_io (const char *plugin_instance, const char *type,
147 derive_t rx, derive_t tx)
148 {
149 /*
150 * Submits the io rx/tx tuple to the collectd daemon
151 */
152 value_t values[2];
153 value_list_t vl = VALUE_LIST_INIT;
155 values[0].derive = rx;
156 values[1].derive = tx;
158 vl.values = values;
159 vl.values_len = 2;
160 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
161 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
163 if (plugin_instance != NULL)
164 sstrncpy (vl.plugin_instance, plugin_instance,
165 sizeof (vl.plugin_instance));
167 sstrncpy (vl.type, type, sizeof (vl.type));
169 plugin_dispatch_values (&vl);
170 } /* void tss2_submit_gauge */
172 static void tss2_close_socket (void)
173 {
174 /*
175 * Closes all sockets
176 */
177 if (global_write_fh != NULL)
178 {
179 fputs ("quit\r\n", global_write_fh);
180 }
182 if (global_read_fh != NULL)
183 {
184 fclose (global_read_fh);
185 global_read_fh = NULL;
186 }
188 if (global_write_fh != NULL)
189 {
190 fclose (global_write_fh);
191 global_write_fh = NULL;
192 }
193 } /* void tss2_close_socket */
195 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
196 {
197 /*
198 * Returns connected file objects or establishes the connection
199 * if it's not already present
200 */
201 struct addrinfo ai_hints = { 0 };
202 struct addrinfo *ai_head;
203 struct addrinfo *ai_ptr;
204 int sd = -1;
205 int status;
207 /* Check if we already got opened connections */
208 if ((global_read_fh != NULL) && (global_write_fh != NULL))
209 {
210 /* If so, use them */
211 if (ret_read_fh != NULL)
212 *ret_read_fh = global_read_fh;
213 if (ret_write_fh != NULL)
214 *ret_write_fh = global_write_fh;
215 return (0);
216 }
218 /* Get all addrs for this hostname */
219 ai_hints.ai_flags = AI_ADDRCONFIG;
220 ai_hints.ai_family = AF_UNSPEC;
221 ai_hints.ai_socktype = SOCK_STREAM;
223 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
224 (config_port != NULL) ? config_port : DEFAULT_PORT,
225 &ai_hints,
226 &ai_head);
227 if (status != 0)
228 {
229 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
230 gai_strerror (status));
231 return (-1);
232 }
234 /* Try all given hosts until we can connect to one */
235 for (ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
236 {
237 /* Create socket */
238 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
239 ai_ptr->ai_protocol);
240 if (sd < 0)
241 {
242 char errbuf[1024];
243 WARNING ("teamspeak2 plugin: socket failed: %s",
244 sstrerror (errno, errbuf, sizeof (errbuf)));
245 continue;
246 }
248 /* Try to connect */
249 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
250 if (status != 0)
251 {
252 char errbuf[1024];
253 WARNING ("teamspeak2 plugin: connect failed: %s",
254 sstrerror (errno, errbuf, sizeof (errbuf)));
255 close (sd);
256 sd = -1;
257 continue;
258 }
260 /*
261 * Success, we can break. Don't need more than one connection
262 */
263 break;
264 } /* for (ai_ptr) */
266 freeaddrinfo (ai_head);
268 /* Check if we really got connected */
269 if (sd < 0)
270 return (-1);
272 /* Create file objects from sockets */
273 global_read_fh = fdopen (sd, "r");
274 if (global_read_fh == NULL)
275 {
276 char errbuf[1024];
277 ERROR ("teamspeak2 plugin: fdopen failed: %s",
278 sstrerror (errno, errbuf, sizeof (errbuf)));
279 close (sd);
280 return (-1);
281 }
283 global_write_fh = fdopen (sd, "w");
284 if (global_write_fh == NULL)
285 {
286 char errbuf[1024];
287 ERROR ("teamspeak2 plugin: fdopen failed: %s",
288 sstrerror (errno, errbuf, sizeof (errbuf)));
289 tss2_close_socket ();
290 return (-1);
291 }
293 { /* Check that the server correctly identifies itself. */
294 char buffer[4096];
295 char *buffer_ptr;
297 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
298 if (buffer_ptr == NULL)
299 {
300 WARNING ("teamspeak2 plugin: Unexpected EOF received "
301 "from remote host %s:%s.",
302 config_host ? config_host : DEFAULT_HOST,
303 config_port ? config_port : DEFAULT_PORT);
304 }
305 buffer[sizeof (buffer) - 1] = 0;
307 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
308 {
309 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
310 "to server. Expected ``[TS]'', got ``%s''.",
311 buffer);
312 tss2_close_socket ();
313 return (-1);
314 }
315 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
316 }
318 /* Copy the new filehandles to the given pointers */
319 if (ret_read_fh != NULL)
320 *ret_read_fh = global_read_fh;
321 if (ret_write_fh != NULL)
322 *ret_write_fh = global_write_fh;
323 return (0);
324 } /* int tss2_get_socket */
326 static int tss2_send_request (FILE *fh, const char *request)
327 {
328 /*
329 * This function puts a request to the server socket
330 */
331 int status;
333 status = fputs (request, fh);
334 if (status < 0)
335 {
336 ERROR ("teamspeak2 plugin: fputs failed.");
337 tss2_close_socket ();
338 return (-1);
339 }
340 fflush (fh);
342 return (0);
343 } /* int tss2_send_request */
345 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
346 {
347 /*
348 * Receive a single line from the given file object
349 */
350 char *temp;
352 /*
353 * fgets is blocking but much easier then doing anything else
354 * TODO: Non-blocking Version would be safer
355 */
356 temp = fgets (buffer, buffer_size, fh);
357 if (temp == NULL)
358 {
359 char errbuf[1024];
360 ERROR ("teamspeak2 plugin: fgets failed: %s",
361 sstrerror (errno, errbuf, sizeof(errbuf)));
362 tss2_close_socket ();
363 return (-1);
364 }
366 buffer[buffer_size - 1] = 0;
367 return (0);
368 } /* int tss2_receive_line */
370 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
371 {
372 /*
373 * Tell the server to select the given vserver
374 */
375 char command[128];
376 char response[128];
377 int status;
379 /* Send request */
380 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
382 status = tss2_send_request (write_fh, command);
383 if (status != 0)
384 {
385 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
386 return (-1);
387 }
389 /* Get answer */
390 status = tss2_receive_line (read_fh, response, sizeof (response));
391 if (status != 0)
392 {
393 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
394 return (-1);
395 }
396 response[sizeof (response) - 1] = 0;
398 /* Check answer */
399 if ((strncasecmp ("OK", response, 2) == 0)
400 && ((response[2] == 0)
401 || (response[2] == '\n')
402 || (response[2] == '\r')))
403 return (0);
405 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
406 "Response received from server was: ``%s''.",
407 command, response);
408 return (-1);
409 } /* int tss2_select_vserver */
411 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
412 gauge_t *ret_value)
413 {
414 /*
415 * Reads the vserver's average packet loss and submits it to collectd.
416 * Be sure to run the tss2_read_vserver function before calling this so
417 * the vserver is selected correctly.
418 */
419 gauge_t packet_loss = NAN;
420 int status;
422 status = tss2_send_request (write_fh, "gapl\r\n");
423 if (status != 0)
424 {
425 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
426 return (-1);
427 }
429 while (42)
430 {
431 char buffer[4096];
432 char *value;
433 char *endptr = NULL;
435 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
436 if (status != 0)
437 {
438 /* Set to NULL just to make sure no one uses these FHs anymore. */
439 read_fh = NULL;
440 write_fh = NULL;
441 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
442 return (-1);
443 }
444 buffer[sizeof (buffer) - 1] = 0;
446 if (strncmp ("average_packet_loss=", buffer,
447 strlen ("average_packet_loss=")) == 0)
448 {
449 /* Got average packet loss, now interpret it */
450 value = &buffer[20];
451 /* Replace , with . */
452 while (*value != 0)
453 {
454 if (*value == ',')
455 {
456 *value = '.';
457 break;
458 }
459 value++;
460 }
462 value = &buffer[20];
464 packet_loss = strtod (value, &endptr);
465 if (value == endptr)
466 {
467 /* Failed */
468 WARNING ("teamspeak2 plugin: Could not read average package "
469 "loss from string: %s", buffer);
470 continue;
471 }
472 }
473 else if (strncasecmp ("OK", buffer, 2) == 0)
474 {
475 break;
476 }
477 else if (strncasecmp ("ERROR", buffer, 5) == 0)
478 {
479 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
480 return (-1);
481 }
482 else
483 {
484 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
485 buffer);
486 }
487 }
489 *ret_value = packet_loss;
490 return (0);
491 } /* int tss2_vserver_gapl */
493 static int tss2_read_vserver (vserver_list_t *vserver)
494 {
495 /*
496 * Poll information for the given vserver and submit it to collect.
497 * If vserver is NULL the global server information will be queried.
498 */
499 int status;
501 gauge_t users = NAN;
502 gauge_t channels = NAN;
503 gauge_t servers = NAN;
504 derive_t rx_octets = 0;
505 derive_t tx_octets = 0;
506 derive_t rx_packets = 0;
507 derive_t tx_packets = 0;
508 gauge_t packet_loss = NAN;
509 int valid = 0;
511 char plugin_instance[DATA_MAX_NAME_LEN] = { 0 };
513 FILE *read_fh;
514 FILE *write_fh;
516 /* Get the send/receive sockets */
517 status = tss2_get_socket (&read_fh, &write_fh);
518 if (status != 0)
519 {
520 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
521 return (-1);
522 }
524 if (vserver == NULL)
525 {
526 /* Request global information */
527 status = tss2_send_request (write_fh, "gi\r\n");
528 }
529 else
530 {
531 /* Request server information */
532 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
533 vserver->port);
535 /* Select the server */
536 status = tss2_select_vserver (read_fh, write_fh, vserver);
537 if (status != 0)
538 return (status);
540 status = tss2_send_request (write_fh, "si\r\n");
541 }
543 if (status != 0)
544 {
545 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
546 return (-1);
547 }
549 /* Loop until break */
550 while (42)
551 {
552 char buffer[4096];
553 char *key;
554 char *value;
555 char *endptr = NULL;
557 /* Read one line of the server's answer */
558 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
559 if (status != 0)
560 {
561 /* Set to NULL just to make sure no one uses these FHs anymore. */
562 read_fh = NULL;
563 write_fh = NULL;
564 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
565 break;
566 }
568 if (strncasecmp ("ERROR", buffer, 5) == 0)
569 {
570 ERROR ("teamspeak2 plugin: Server returned an error: %s",
571 buffer);
572 break;
573 }
574 else if (strncasecmp ("OK", buffer, 2) == 0)
575 {
576 break;
577 }
579 /* Split line into key and value */
580 key = strchr (buffer, '_');
581 if (key == NULL)
582 {
583 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
584 continue;
585 }
586 key++;
588 /* Evaluate assignment */
589 value = strchr (key, '=');
590 if (value == NULL)
591 {
592 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
593 continue;
594 }
595 *value = 0;
596 value++;
598 /* Check for known key and save the given value */
599 /* global info: users_online,
600 * server info: currentusers. */
601 if ((strcmp ("currentusers", key) == 0)
602 || (strcmp ("users_online", key) == 0))
603 {
604 users = strtod (value, &endptr);
605 if (value != endptr)
606 valid |= 0x01;
607 }
608 /* global info: channels,
609 * server info: currentchannels. */
610 else if ((strcmp ("currentchannels", key) == 0)
611 || (strcmp ("channels", key) == 0))
612 {
613 channels = strtod (value, &endptr);
614 if (value != endptr)
615 valid |= 0x40;
616 }
617 /* global only */
618 else if (strcmp ("servers", key) == 0)
619 {
620 servers = strtod (value, &endptr);
621 if (value != endptr)
622 valid |= 0x80;
623 }
624 else if (strcmp ("bytesreceived", key) == 0)
625 {
626 rx_octets = strtoll (value, &endptr, 0);
627 if (value != endptr)
628 valid |= 0x02;
629 }
630 else if (strcmp ("bytessend", key) == 0)
631 {
632 tx_octets = strtoll (value, &endptr, 0);
633 if (value != endptr)
634 valid |= 0x04;
635 }
636 else if (strcmp ("packetsreceived", key) == 0)
637 {
638 rx_packets = strtoll (value, &endptr, 0);
639 if (value != endptr)
640 valid |= 0x08;
641 }
642 else if (strcmp ("packetssend", key) == 0)
643 {
644 tx_packets = strtoll (value, &endptr, 0);
645 if (value != endptr)
646 valid |= 0x10;
647 }
648 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
649 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
650 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
651 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
652 || (strcmp ("adminemail", key) == 0)
653 || (strcmp ("clan_server", key) == 0)
654 || (strcmp ("countrynumber", key) == 0)
655 || (strcmp ("id", key) == 0)
656 || (strcmp ("ispname", key) == 0)
657 || (strcmp ("linkurl", key) == 0)
658 || (strcmp ("maxusers", key) == 0)
659 || (strcmp ("name", key) == 0)
660 || (strcmp ("password", key) == 0)
661 || (strcmp ("platform", key) == 0)
662 || (strcmp ("server_platform", key) == 0)
663 || (strcmp ("server_uptime", key) == 0)
664 || (strcmp ("server_version", key) == 0)
665 || (strcmp ("udpport", key) == 0)
666 || (strcmp ("uptime", key) == 0)
667 || (strcmp ("users_maximal", key) == 0)
668 || (strcmp ("welcomemessage", key) == 0))
669 /* ignore */;
670 else
671 {
672 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
673 "key = %s; value = %s;", key, value);
674 }
675 } /* while (42) */
677 /* Collect vserver packet loss rates only if the loop above did not exit
678 * with an error. */
679 if ((status == 0) && (vserver != NULL))
680 {
681 status = tss2_vserver_gapl (read_fh, write_fh, &packet_loss);
682 if (status == 0)
683 {
684 valid |= 0x20;
685 }
686 else
687 {
688 WARNING ("teamspeak2 plugin: Reading package loss "
689 "for vserver %i failed.", vserver->port);
690 }
691 }
693 if ((valid & 0x01) == 0x01)
694 tss2_submit_gauge (plugin_instance, "users", NULL, users);
696 if ((valid & 0x06) == 0x06)
697 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
699 if ((valid & 0x18) == 0x18)
700 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
702 if ((valid & 0x20) == 0x20)
703 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
705 if ((valid & 0x40) == 0x40)
706 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
708 if ((valid & 0x80) == 0x80)
709 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
711 if (valid == 0)
712 return (-1);
713 return (0);
714 } /* int tss2_read_vserver */
716 static int tss2_config (const char *key, const char *value)
717 {
718 /*
719 * Interpret configuration values
720 */
721 if (strcasecmp ("Host", key) == 0)
722 {
723 char *temp;
725 temp = strdup (value);
726 if (temp == NULL)
727 {
728 ERROR("teamspeak2 plugin: strdup failed.");
729 return (1);
730 }
731 sfree (config_host);
732 config_host = temp;
733 }
734 else if (strcasecmp ("Port", key) == 0)
735 {
736 char *temp;
738 temp = strdup (value);
739 if (temp == NULL)
740 {
741 ERROR("teamspeak2 plugin: strdup failed.");
742 return (1);
743 }
744 sfree (config_port);
745 config_port = temp;
746 }
747 else if (strcasecmp ("Server", key) == 0)
748 {
749 /* Server variable found */
750 int status;
752 status = tss2_add_vserver (atoi (value));
753 if (status != 0)
754 return (1);
755 }
756 else
757 {
758 /* Unknown variable found */
759 return (-1);
760 }
762 return 0;
763 } /* int tss2_config */
765 static int tss2_read (void)
766 {
767 /*
768 * Poll function which collects global and vserver information
769 * and submits it to collectd
770 */
771 vserver_list_t *vserver;
772 int success = 0;
773 int status;
775 /* Handle global server variables */
776 status = tss2_read_vserver (NULL);
777 if (status == 0)
778 {
779 success++;
780 }
781 else
782 {
783 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
784 }
786 /* Handle vservers */
787 for (vserver = server_list; vserver != NULL; vserver = vserver->next)
788 {
789 status = tss2_read_vserver (vserver);
790 if (status == 0)
791 {
792 success++;
793 }
794 else
795 {
796 WARNING ("teamspeak2 plugin: Reading statistics "
797 "for vserver %i failed.", vserver->port);
798 continue;
799 }
800 }
802 if (success == 0)
803 return (-1);
804 return (0);
805 } /* int tss2_read */
807 static int tss2_shutdown(void)
808 {
809 /*
810 * Shutdown handler
811 */
812 vserver_list_t *entry;
814 tss2_close_socket ();
816 entry = server_list;
817 server_list = NULL;
818 while (entry != NULL)
819 {
820 vserver_list_t *next;
822 next = entry->next;
823 sfree (entry);
824 entry = next;
825 }
827 /* Get rid of the configuration */
828 sfree (config_host);
829 sfree (config_port);
831 return (0);
832 } /* int tss2_shutdown */
834 void module_register(void)
835 {
836 /*
837 * Mandatory module_register function
838 */
839 plugin_register_config ("teamspeak2", tss2_config,
840 config_keys, config_keys_num);
841 plugin_register_read ("teamspeak2", tss2_read);
842 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
843 } /* void module_register */
845 /* vim: set sw=4 ts=4 : */