2 * collectd - src/teamspeak2.c
3 * Copyright (C) 2008 Stefan Hacker
4 * Copyright (C) 2008 Florian Forster
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.
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.
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
20 * Stefan Hacker <d0t at dbclan dot de>
21 * Florian Forster <octo at collectd.org>
28 #include <netinet/in.h>
29 #include <arpa/inet.h>
30 #include <sys/types.h>
36 /* Default host and port */
37 #define DEFAULT_HOST "127.0.0.1"
38 #define DEFAULT_PORT "51234"
43 /* Server linked list structure */
44 typedef struct vserver_list_s
47 struct vserver_list_s *next;
49 static vserver_list_t *server_list = NULL;
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;
59 static const char *config_keys[] =
65 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
70 static int tss2_add_vserver (int vserver_port)
73 * Adds a new vserver to the linked list
75 vserver_list_t *entry;
77 /* Check port range */
78 if ((vserver_port <= 0) || (vserver_port > 65535))
80 ERROR ("teamspeak2 plugin: VServer port is invalid: %i",
86 entry = (vserver_list_t *) malloc (sizeof (vserver_list_t));
89 ERROR ("teamspeak2 plugin: malloc failed.");
92 memset (entry, 0, sizeof (vserver_list_t));
95 entry->port = vserver_port;
98 if(server_list == NULL) {
99 /* Add the server as the first element */
103 vserver_list_t *prev;
105 /* Add the server to the end of the list */
107 while (prev->next != NULL)
112 INFO ("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
115 } /* int tss2_add_vserver */
117 static void tss2_submit_gauge (const char *plugin_instance,
118 const char *type, const char *type_instance,
122 * Submits a gauge value to the collectd daemon
125 value_list_t vl = VALUE_LIST_INIT;
127 values[0].gauge = value;
131 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
132 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
134 if (plugin_instance != NULL)
135 sstrncpy (vl.plugin_instance, plugin_instance,
136 sizeof (vl.plugin_instance));
138 sstrncpy (vl.type, type, sizeof (vl.type));
140 if (type_instance != NULL)
141 sstrncpy (vl.type_instance, type_instance,
142 sizeof (vl.type_instance));
144 plugin_dispatch_values (&vl);
145 } /* void tss2_submit_gauge */
147 static void tss2_submit_io (const char *plugin_instance, const char *type,
148 derive_t rx, derive_t tx)
151 * Submits the io rx/tx tuple to the collectd daemon
154 value_list_t vl = VALUE_LIST_INIT;
156 values[0].derive = rx;
157 values[1].derive = tx;
161 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
162 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
164 if (plugin_instance != NULL)
165 sstrncpy (vl.plugin_instance, plugin_instance,
166 sizeof (vl.plugin_instance));
168 sstrncpy (vl.type, type, sizeof (vl.type));
170 plugin_dispatch_values (&vl);
171 } /* void tss2_submit_gauge */
173 static void tss2_close_socket (void)
178 if (global_write_fh != NULL)
180 fputs ("quit\r\n", global_write_fh);
183 if (global_read_fh != NULL)
185 fclose (global_read_fh);
186 global_read_fh = NULL;
189 if (global_write_fh != NULL)
191 fclose (global_write_fh);
192 global_write_fh = NULL;
194 } /* void tss2_close_socket */
196 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
199 * Returns connected file objects or establishes the connection
200 * if it's not already present
202 struct addrinfo ai_hints;
203 struct addrinfo *ai_head;
204 struct addrinfo *ai_ptr;
208 /* Check if we already got opened connections */
209 if ((global_read_fh != NULL) && (global_write_fh != NULL))
211 /* If so, use them */
212 if (ret_read_fh != NULL)
213 *ret_read_fh = global_read_fh;
214 if (ret_write_fh != NULL)
215 *ret_write_fh = global_write_fh;
219 /* Get all addrs for this hostname */
220 memset (&ai_hints, 0, sizeof (ai_hints));
222 ai_hints.ai_flags |= AI_ADDRCONFIG;
224 ai_hints.ai_family = AF_UNSPEC;
225 ai_hints.ai_socktype = SOCK_STREAM;
227 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
228 (config_port != NULL) ? config_port : DEFAULT_PORT,
233 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
234 gai_strerror (status));
238 /* Try all given hosts until we can connect to one */
239 for (ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
242 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
243 ai_ptr->ai_protocol);
247 WARNING ("teamspeak2 plugin: socket failed: %s",
248 sstrerror (errno, errbuf, sizeof (errbuf)));
253 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
257 WARNING ("teamspeak2 plugin: connect failed: %s",
258 sstrerror (errno, errbuf, sizeof (errbuf)));
264 * Success, we can break. Don't need more than one connection
269 freeaddrinfo (ai_head);
271 /* Check if we really got connected */
275 /* Create file objects from sockets */
276 global_read_fh = fdopen (sd, "r");
277 if (global_read_fh == NULL)
280 ERROR ("teamspeak2 plugin: fdopen failed: %s",
281 sstrerror (errno, errbuf, sizeof (errbuf)));
286 global_write_fh = fdopen (sd, "w");
287 if (global_write_fh == NULL)
290 ERROR ("teamspeak2 plugin: fdopen failed: %s",
291 sstrerror (errno, errbuf, sizeof (errbuf)));
292 tss2_close_socket ();
296 { /* Check that the server correctly identifies itself. */
300 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
301 if (buffer_ptr == NULL)
303 WARNING ("teamspeak2 plugin: Unexpected EOF received "
304 "from remote host %s:%s.",
305 config_host ? config_host : DEFAULT_HOST,
306 config_port ? config_port : DEFAULT_PORT);
308 buffer[sizeof (buffer) - 1] = 0;
310 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
312 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
313 "to server. Expected ``[TS]'', got ``%s''.",
315 tss2_close_socket ();
318 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
321 /* Copy the new filehandles to the given pointers */
322 if (ret_read_fh != NULL)
323 *ret_read_fh = global_read_fh;
324 if (ret_write_fh != NULL)
325 *ret_write_fh = global_write_fh;
327 } /* int tss2_get_socket */
329 static int tss2_send_request (FILE *fh, const char *request)
332 * This function puts a request to the server socket
336 status = fputs (request, fh);
339 ERROR ("teamspeak2 plugin: fputs failed.");
340 tss2_close_socket ();
346 } /* int tss2_send_request */
348 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
351 * Receive a single line from the given file object
356 * fgets is blocking but much easier then doing anything else
357 * TODO: Non-blocking Version would be safer
359 temp = fgets (buffer, buffer_size, fh);
363 ERROR ("teamspeak2 plugin: fgets failed: %s",
364 sstrerror (errno, errbuf, sizeof(errbuf)));
365 tss2_close_socket ();
369 buffer[buffer_size - 1] = 0;
371 } /* int tss2_receive_line */
373 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
376 * Tell the server to select the given vserver
383 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
385 status = tss2_send_request (write_fh, command);
388 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
393 status = tss2_receive_line (read_fh, response, sizeof (response));
396 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
399 response[sizeof (response) - 1] = 0;
402 if ((strncasecmp ("OK", response, 2) == 0)
403 && ((response[2] == 0)
404 || (response[2] == '\n')
405 || (response[2] == '\r')))
408 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
409 "Response received from server was: ``%s''.",
412 } /* int tss2_select_vserver */
414 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
418 * Reads the vserver's average packet loss and submits it to collectd.
419 * Be sure to run the tss2_read_vserver function before calling this so
420 * the vserver is selected correctly.
422 gauge_t packet_loss = NAN;
425 status = tss2_send_request (write_fh, "gapl\r\n");
428 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
438 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
441 /* Set to NULL just to make sure no one uses these FHs anymore. */
444 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
447 buffer[sizeof (buffer) - 1] = 0;
449 if (strncmp ("average_packet_loss=", buffer,
450 strlen ("average_packet_loss=")) == 0)
452 /* Got average packet loss, now interpret it */
454 /* Replace , with . */
467 packet_loss = strtod (value, &endptr);
471 WARNING ("teamspeak2 plugin: Could not read average package "
472 "loss from string: %s", buffer);
476 else if (strncasecmp ("OK", buffer, 2) == 0)
480 else if (strncasecmp ("ERROR", buffer, 5) == 0)
482 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
487 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
492 *ret_value = packet_loss;
494 } /* int tss2_vserver_gapl */
496 static int tss2_read_vserver (vserver_list_t *vserver)
499 * Poll information for the given vserver and submit it to collect.
500 * If vserver is NULL the global server information will be queried.
505 gauge_t channels = NAN;
506 gauge_t servers = NAN;
507 derive_t rx_octets = 0;
508 derive_t tx_octets = 0;
509 derive_t rx_packets = 0;
510 derive_t tx_packets = 0;
511 gauge_t packet_loss = NAN;
514 char plugin_instance[DATA_MAX_NAME_LEN];
519 /* Get the send/receive sockets */
520 status = tss2_get_socket (&read_fh, &write_fh);
523 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
529 /* Request global information */
530 memset (plugin_instance, 0, sizeof (plugin_instance));
532 status = tss2_send_request (write_fh, "gi\r\n");
536 /* Request server information */
537 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
540 /* Select the server */
541 status = tss2_select_vserver (read_fh, write_fh, vserver);
545 status = tss2_send_request (write_fh, "si\r\n");
550 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
554 /* Loop until break */
562 /* Read one line of the server's answer */
563 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
566 /* Set to NULL just to make sure no one uses these FHs anymore. */
569 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
573 if (strncasecmp ("ERROR", buffer, 5) == 0)
575 ERROR ("teamspeak2 plugin: Server returned an error: %s",
579 else if (strncasecmp ("OK", buffer, 2) == 0)
584 /* Split line into key and value */
585 key = strchr (buffer, '_');
588 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
593 /* Evaluate assignment */
594 value = strchr (key, '=');
597 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
603 /* Check for known key and save the given value */
604 /* global info: users_online,
605 * server info: currentusers. */
606 if ((strcmp ("currentusers", key) == 0)
607 || (strcmp ("users_online", key) == 0))
609 users = strtod (value, &endptr);
613 /* global info: channels,
614 * server info: currentchannels. */
615 else if ((strcmp ("currentchannels", key) == 0)
616 || (strcmp ("channels", key) == 0))
618 channels = strtod (value, &endptr);
623 else if (strcmp ("servers", key) == 0)
625 servers = strtod (value, &endptr);
629 else if (strcmp ("bytesreceived", key) == 0)
631 rx_octets = strtoll (value, &endptr, 0);
635 else if (strcmp ("bytessend", key) == 0)
637 tx_octets = strtoll (value, &endptr, 0);
641 else if (strcmp ("packetsreceived", key) == 0)
643 rx_packets = strtoll (value, &endptr, 0);
647 else if (strcmp ("packetssend", key) == 0)
649 tx_packets = strtoll (value, &endptr, 0);
653 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
654 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
655 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
656 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
657 || (strcmp ("adminemail", key) == 0)
658 || (strcmp ("clan_server", key) == 0)
659 || (strcmp ("countrynumber", key) == 0)
660 || (strcmp ("id", key) == 0)
661 || (strcmp ("ispname", key) == 0)
662 || (strcmp ("linkurl", key) == 0)
663 || (strcmp ("maxusers", key) == 0)
664 || (strcmp ("name", key) == 0)
665 || (strcmp ("password", key) == 0)
666 || (strcmp ("platform", key) == 0)
667 || (strcmp ("server_platform", key) == 0)
668 || (strcmp ("server_uptime", key) == 0)
669 || (strcmp ("server_version", key) == 0)
670 || (strcmp ("udpport", key) == 0)
671 || (strcmp ("uptime", key) == 0)
672 || (strcmp ("users_maximal", key) == 0)
673 || (strcmp ("welcomemessage", key) == 0))
677 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
678 "key = %s; value = %s;", key, value);
682 /* Collect vserver packet loss rates only if the loop above did not exit
684 if ((status == 0) && (vserver != NULL))
686 status = tss2_vserver_gapl (read_fh, write_fh, &packet_loss);
693 WARNING ("teamspeak2 plugin: Reading package loss "
694 "for vserver %i failed.", vserver->port);
698 if ((valid & 0x01) == 0x01)
699 tss2_submit_gauge (plugin_instance, "users", NULL, users);
701 if ((valid & 0x06) == 0x06)
702 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
704 if ((valid & 0x18) == 0x18)
705 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
707 if ((valid & 0x20) == 0x20)
708 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
710 if ((valid & 0x40) == 0x40)
711 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
713 if ((valid & 0x80) == 0x80)
714 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
719 } /* int tss2_read_vserver */
721 static int tss2_config (const char *key, const char *value)
724 * Interpret configuration values
726 if (strcasecmp ("Host", key) == 0)
730 temp = strdup (value);
733 ERROR("teamspeak2 plugin: strdup failed.");
739 else if (strcasecmp ("Port", key) == 0)
743 temp = strdup (value);
746 ERROR("teamspeak2 plugin: strdup failed.");
752 else if (strcasecmp ("Server", key) == 0)
754 /* Server variable found */
757 status = tss2_add_vserver (atoi (value));
763 /* Unknown variable found */
768 } /* int tss2_config */
770 static int tss2_read (void)
773 * Poll function which collects global and vserver information
774 * and submits it to collectd
776 vserver_list_t *vserver;
780 /* Handle global server variables */
781 status = tss2_read_vserver (NULL);
788 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
791 /* Handle vservers */
792 for (vserver = server_list; vserver != NULL; vserver = vserver->next)
794 status = tss2_read_vserver (vserver);
801 WARNING ("teamspeak2 plugin: Reading statistics "
802 "for vserver %i failed.", vserver->port);
810 } /* int tss2_read */
812 static int tss2_shutdown(void)
817 vserver_list_t *entry;
819 tss2_close_socket ();
823 while (entry != NULL)
825 vserver_list_t *next;
832 /* Get rid of the configuration */
837 } /* int tss2_shutdown */
839 void module_register(void)
842 * Mandatory module_register function
844 plugin_register_config ("teamspeak2", tss2_config,
845 config_keys, config_keys_num);
846 plugin_register_read ("teamspeak2", tss2_read);
847 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
848 } /* void module_register */
850 /* vim: set sw=4 ts=4 : */