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>
29 #include <netinet/in.h>
30 #include <arpa/inet.h>
31 #include <sys/types.h>
37 /* Default host and port */
38 #define DEFAULT_HOST "127.0.0.1"
39 #define DEFAULT_PORT "51234"
44 /* Server linked list structure */
45 typedef struct vserver_list_s
48 struct vserver_list_s *next;
50 static vserver_list_t *server_list = NULL;
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;
60 static const char *config_keys[] =
66 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
71 static int tss2_add_vserver (int vserver_port)
74 * Adds a new vserver to the linked list
76 vserver_list_t *entry;
78 /* Check port range */
79 if ((vserver_port <= 0) || (vserver_port > 65535))
81 ERROR ("teamspeak2 plugin: VServer port is invalid: %i",
87 entry = calloc (1, sizeof (*entry));
90 ERROR ("teamspeak2 plugin: calloc failed.");
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
124 value_list_t vl = VALUE_LIST_INIT;
126 vl.values = &(value_t) { .gauge = value };
128 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
130 if (plugin_instance != NULL)
131 sstrncpy (vl.plugin_instance, plugin_instance,
132 sizeof (vl.plugin_instance));
134 sstrncpy (vl.type, type, sizeof (vl.type));
136 if (type_instance != NULL)
137 sstrncpy (vl.type_instance, type_instance,
138 sizeof (vl.type_instance));
140 plugin_dispatch_values (&vl);
141 } /* void tss2_submit_gauge */
143 static void tss2_submit_io (const char *plugin_instance, const char *type,
144 derive_t rx, derive_t tx)
147 * Submits the io rx/tx tuple to the collectd daemon
149 value_list_t vl = VALUE_LIST_INIT;
156 vl.values_len = STATIC_ARRAY_SIZE (values);
157 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
159 if (plugin_instance != NULL)
160 sstrncpy (vl.plugin_instance, plugin_instance,
161 sizeof (vl.plugin_instance));
163 sstrncpy (vl.type, type, sizeof (vl.type));
165 plugin_dispatch_values (&vl);
166 } /* void tss2_submit_gauge */
168 static void tss2_close_socket (void)
173 if (global_write_fh != NULL)
175 fputs ("quit\r\n", global_write_fh);
178 if (global_read_fh != NULL)
180 fclose (global_read_fh);
181 global_read_fh = NULL;
184 if (global_write_fh != NULL)
186 fclose (global_write_fh);
187 global_write_fh = NULL;
189 } /* void tss2_close_socket */
191 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
194 * Returns connected file objects or establishes the connection
195 * if it's not already present
197 struct addrinfo *ai_head;
201 /* Check if we already got opened connections */
202 if ((global_read_fh != NULL) && (global_write_fh != NULL))
204 /* If so, use them */
205 if (ret_read_fh != NULL)
206 *ret_read_fh = global_read_fh;
207 if (ret_write_fh != NULL)
208 *ret_write_fh = global_write_fh;
212 /* Get all addrs for this hostname */
213 struct addrinfo ai_hints = {
214 .ai_family = AF_UNSPEC,
215 .ai_flags = AI_ADDRCONFIG,
216 .ai_socktype = SOCK_STREAM
219 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
220 (config_port != NULL) ? config_port : DEFAULT_PORT,
225 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
226 gai_strerror (status));
230 /* Try all given hosts until we can connect to one */
231 for (struct addrinfo *ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
234 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
235 ai_ptr->ai_protocol);
239 WARNING ("teamspeak2 plugin: socket failed: %s",
240 sstrerror (errno, errbuf, sizeof (errbuf)));
245 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
249 WARNING ("teamspeak2 plugin: connect failed: %s",
250 sstrerror (errno, errbuf, sizeof (errbuf)));
257 * Success, we can break. Don't need more than one connection
262 freeaddrinfo (ai_head);
264 /* Check if we really got connected */
268 /* Create file objects from sockets */
269 global_read_fh = fdopen (sd, "r");
270 if (global_read_fh == NULL)
273 ERROR ("teamspeak2 plugin: fdopen failed: %s",
274 sstrerror (errno, errbuf, sizeof (errbuf)));
279 global_write_fh = fdopen (sd, "w");
280 if (global_write_fh == NULL)
283 ERROR ("teamspeak2 plugin: fdopen failed: %s",
284 sstrerror (errno, errbuf, sizeof (errbuf)));
285 tss2_close_socket ();
289 { /* Check that the server correctly identifies itself. */
293 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
294 if (buffer_ptr == NULL)
296 WARNING ("teamspeak2 plugin: Unexpected EOF received "
297 "from remote host %s:%s.",
298 config_host ? config_host : DEFAULT_HOST,
299 config_port ? config_port : DEFAULT_PORT);
301 buffer[sizeof (buffer) - 1] = 0;
303 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
305 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
306 "to server. Expected ``[TS]'', got ``%s''.",
308 tss2_close_socket ();
311 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
314 /* Copy the new filehandles to the given pointers */
315 if (ret_read_fh != NULL)
316 *ret_read_fh = global_read_fh;
317 if (ret_write_fh != NULL)
318 *ret_write_fh = global_write_fh;
320 } /* int tss2_get_socket */
322 static int tss2_send_request (FILE *fh, const char *request)
325 * This function puts a request to the server socket
329 status = fputs (request, fh);
332 ERROR ("teamspeak2 plugin: fputs failed.");
333 tss2_close_socket ();
339 } /* int tss2_send_request */
341 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
344 * Receive a single line from the given file object
349 * fgets is blocking but much easier then doing anything else
350 * TODO: Non-blocking Version would be safer
352 temp = fgets (buffer, buffer_size, fh);
356 ERROR ("teamspeak2 plugin: fgets failed: %s",
357 sstrerror (errno, errbuf, sizeof(errbuf)));
358 tss2_close_socket ();
362 buffer[buffer_size - 1] = 0;
364 } /* int tss2_receive_line */
366 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
369 * Tell the server to select the given vserver
376 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
378 status = tss2_send_request (write_fh, command);
381 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
386 status = tss2_receive_line (read_fh, response, sizeof (response));
389 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
392 response[sizeof (response) - 1] = 0;
395 if ((strncasecmp ("OK", response, 2) == 0)
396 && ((response[2] == 0)
397 || (response[2] == '\n')
398 || (response[2] == '\r')))
401 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
402 "Response received from server was: ``%s''.",
405 } /* int tss2_select_vserver */
407 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
411 * Reads the vserver's average packet loss and submits it to collectd.
412 * Be sure to run the tss2_read_vserver function before calling this so
413 * the vserver is selected correctly.
415 gauge_t packet_loss = NAN;
418 status = tss2_send_request (write_fh, "gapl\r\n");
421 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
431 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
434 /* Set to NULL just to make sure no one uses these FHs anymore. */
437 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
440 buffer[sizeof (buffer) - 1] = 0;
442 if (strncmp ("average_packet_loss=", buffer,
443 strlen ("average_packet_loss=")) == 0)
445 /* Got average packet loss, now interpret it */
447 /* Replace , with . */
460 packet_loss = strtod (value, &endptr);
464 WARNING ("teamspeak2 plugin: Could not read average package "
465 "loss from string: %s", buffer);
469 else if (strncasecmp ("OK", buffer, 2) == 0)
473 else if (strncasecmp ("ERROR", buffer, 5) == 0)
475 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
480 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
485 *ret_value = packet_loss;
487 } /* int tss2_vserver_gapl */
489 static int tss2_read_vserver (vserver_list_t *vserver)
492 * Poll information for the given vserver and submit it to collect.
493 * If vserver is NULL the global server information will be queried.
498 gauge_t channels = NAN;
499 gauge_t servers = NAN;
500 derive_t rx_octets = 0;
501 derive_t tx_octets = 0;
502 derive_t rx_packets = 0;
503 derive_t tx_packets = 0;
504 gauge_t packet_loss = NAN;
507 char plugin_instance[DATA_MAX_NAME_LEN] = { 0 };
512 /* Get the send/receive sockets */
513 status = tss2_get_socket (&read_fh, &write_fh);
516 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
522 /* Request global information */
523 status = tss2_send_request (write_fh, "gi\r\n");
527 /* Request server information */
528 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
531 /* Select the server */
532 status = tss2_select_vserver (read_fh, write_fh, vserver);
536 status = tss2_send_request (write_fh, "si\r\n");
541 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
545 /* Loop until break */
553 /* Read one line of the server's answer */
554 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
557 /* Set to NULL just to make sure no one uses these FHs anymore. */
560 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
564 if (strncasecmp ("ERROR", buffer, 5) == 0)
566 ERROR ("teamspeak2 plugin: Server returned an error: %s",
570 else if (strncasecmp ("OK", buffer, 2) == 0)
575 /* Split line into key and value */
576 key = strchr (buffer, '_');
579 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
584 /* Evaluate assignment */
585 value = strchr (key, '=');
588 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
594 /* Check for known key and save the given value */
595 /* global info: users_online,
596 * server info: currentusers. */
597 if ((strcmp ("currentusers", key) == 0)
598 || (strcmp ("users_online", key) == 0))
600 users = strtod (value, &endptr);
604 /* global info: channels,
605 * server info: currentchannels. */
606 else if ((strcmp ("currentchannels", key) == 0)
607 || (strcmp ("channels", key) == 0))
609 channels = strtod (value, &endptr);
614 else if (strcmp ("servers", key) == 0)
616 servers = strtod (value, &endptr);
620 else if (strcmp ("bytesreceived", key) == 0)
622 rx_octets = strtoll (value, &endptr, 0);
626 else if (strcmp ("bytessend", key) == 0)
628 tx_octets = strtoll (value, &endptr, 0);
632 else if (strcmp ("packetsreceived", key) == 0)
634 rx_packets = strtoll (value, &endptr, 0);
638 else if (strcmp ("packetssend", key) == 0)
640 tx_packets = strtoll (value, &endptr, 0);
644 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
645 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
646 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
647 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
648 || (strcmp ("adminemail", key) == 0)
649 || (strcmp ("clan_server", key) == 0)
650 || (strcmp ("countrynumber", key) == 0)
651 || (strcmp ("id", key) == 0)
652 || (strcmp ("ispname", key) == 0)
653 || (strcmp ("linkurl", key) == 0)
654 || (strcmp ("maxusers", key) == 0)
655 || (strcmp ("name", key) == 0)
656 || (strcmp ("password", key) == 0)
657 || (strcmp ("platform", key) == 0)
658 || (strcmp ("server_platform", key) == 0)
659 || (strcmp ("server_uptime", key) == 0)
660 || (strcmp ("server_version", key) == 0)
661 || (strcmp ("udpport", key) == 0)
662 || (strcmp ("uptime", key) == 0)
663 || (strcmp ("users_maximal", key) == 0)
664 || (strcmp ("welcomemessage", key) == 0))
668 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
669 "key = %s; value = %s;", key, value);
673 /* Collect vserver packet loss rates only if the loop above did not exit
675 if ((status == 0) && (vserver != NULL))
677 status = tss2_vserver_gapl (read_fh, write_fh, &packet_loss);
684 WARNING ("teamspeak2 plugin: Reading package loss "
685 "for vserver %i failed.", vserver->port);
689 if ((valid & 0x01) == 0x01)
690 tss2_submit_gauge (plugin_instance, "users", NULL, users);
692 if ((valid & 0x06) == 0x06)
693 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
695 if ((valid & 0x18) == 0x18)
696 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
698 if ((valid & 0x20) == 0x20)
699 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
701 if ((valid & 0x40) == 0x40)
702 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
704 if ((valid & 0x80) == 0x80)
705 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
710 } /* int tss2_read_vserver */
712 static int tss2_config (const char *key, const char *value)
715 * Interpret configuration values
717 if (strcasecmp ("Host", key) == 0)
721 temp = strdup (value);
724 ERROR("teamspeak2 plugin: strdup failed.");
730 else if (strcasecmp ("Port", key) == 0)
734 temp = strdup (value);
737 ERROR("teamspeak2 plugin: strdup failed.");
743 else if (strcasecmp ("Server", key) == 0)
745 /* Server variable found */
748 status = tss2_add_vserver (atoi (value));
754 /* Unknown variable found */
759 } /* int tss2_config */
761 static int tss2_read (void)
764 * Poll function which collects global and vserver information
765 * and submits it to collectd
770 /* Handle global server variables */
771 status = tss2_read_vserver (NULL);
778 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
781 /* Handle vservers */
782 for (vserver_list_t *vserver = server_list; vserver != NULL; vserver = vserver->next)
784 status = tss2_read_vserver (vserver);
791 WARNING ("teamspeak2 plugin: Reading statistics "
792 "for vserver %i failed.", vserver->port);
800 } /* int tss2_read */
802 static int tss2_shutdown(void)
807 vserver_list_t *entry;
809 tss2_close_socket ();
813 while (entry != NULL)
815 vserver_list_t *next;
822 /* Get rid of the configuration */
827 } /* int tss2_shutdown */
829 void module_register(void)
832 * Mandatory module_register function
834 plugin_register_config ("teamspeak2", tss2_config,
835 config_keys, config_keys_num);
836 plugin_register_read ("teamspeak2", tss2_read);
837 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
838 } /* void module_register */
840 /* vim: set sw=4 ts=4 : */