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
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_head;
203 struct addrinfo *ai_ptr;
207 /* Check if we already got opened connections */
208 if ((global_read_fh != NULL) && (global_write_fh != NULL))
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;
218 /* Get all addrs for this hostname */
219 struct addrinfo ai_hints = {
220 .ai_family = AF_UNSPEC,
221 .ai_flags = AI_ADDRCONFIG,
222 .ai_socktype = SOCK_STREAM
225 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
226 (config_port != NULL) ? config_port : DEFAULT_PORT,
231 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
232 gai_strerror (status));
236 /* Try all given hosts until we can connect to one */
237 for (ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
240 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
241 ai_ptr->ai_protocol);
245 WARNING ("teamspeak2 plugin: socket failed: %s",
246 sstrerror (errno, errbuf, sizeof (errbuf)));
251 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
255 WARNING ("teamspeak2 plugin: connect failed: %s",
256 sstrerror (errno, errbuf, sizeof (errbuf)));
263 * Success, we can break. Don't need more than one connection
268 freeaddrinfo (ai_head);
270 /* Check if we really got connected */
274 /* Create file objects from sockets */
275 global_read_fh = fdopen (sd, "r");
276 if (global_read_fh == NULL)
279 ERROR ("teamspeak2 plugin: fdopen failed: %s",
280 sstrerror (errno, errbuf, sizeof (errbuf)));
285 global_write_fh = fdopen (sd, "w");
286 if (global_write_fh == NULL)
289 ERROR ("teamspeak2 plugin: fdopen failed: %s",
290 sstrerror (errno, errbuf, sizeof (errbuf)));
291 tss2_close_socket ();
295 { /* Check that the server correctly identifies itself. */
299 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
300 if (buffer_ptr == NULL)
302 WARNING ("teamspeak2 plugin: Unexpected EOF received "
303 "from remote host %s:%s.",
304 config_host ? config_host : DEFAULT_HOST,
305 config_port ? config_port : DEFAULT_PORT);
307 buffer[sizeof (buffer) - 1] = 0;
309 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
311 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
312 "to server. Expected ``[TS]'', got ``%s''.",
314 tss2_close_socket ();
317 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
320 /* Copy the new filehandles to the given pointers */
321 if (ret_read_fh != NULL)
322 *ret_read_fh = global_read_fh;
323 if (ret_write_fh != NULL)
324 *ret_write_fh = global_write_fh;
326 } /* int tss2_get_socket */
328 static int tss2_send_request (FILE *fh, const char *request)
331 * This function puts a request to the server socket
335 status = fputs (request, fh);
338 ERROR ("teamspeak2 plugin: fputs failed.");
339 tss2_close_socket ();
345 } /* int tss2_send_request */
347 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
350 * Receive a single line from the given file object
355 * fgets is blocking but much easier then doing anything else
356 * TODO: Non-blocking Version would be safer
358 temp = fgets (buffer, buffer_size, fh);
362 ERROR ("teamspeak2 plugin: fgets failed: %s",
363 sstrerror (errno, errbuf, sizeof(errbuf)));
364 tss2_close_socket ();
368 buffer[buffer_size - 1] = 0;
370 } /* int tss2_receive_line */
372 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
375 * Tell the server to select the given vserver
382 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
384 status = tss2_send_request (write_fh, command);
387 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
392 status = tss2_receive_line (read_fh, response, sizeof (response));
395 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
398 response[sizeof (response) - 1] = 0;
401 if ((strncasecmp ("OK", response, 2) == 0)
402 && ((response[2] == 0)
403 || (response[2] == '\n')
404 || (response[2] == '\r')))
407 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
408 "Response received from server was: ``%s''.",
411 } /* int tss2_select_vserver */
413 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
417 * Reads the vserver's average packet loss and submits it to collectd.
418 * Be sure to run the tss2_read_vserver function before calling this so
419 * the vserver is selected correctly.
421 gauge_t packet_loss = NAN;
424 status = tss2_send_request (write_fh, "gapl\r\n");
427 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
437 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
440 /* Set to NULL just to make sure no one uses these FHs anymore. */
443 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
446 buffer[sizeof (buffer) - 1] = 0;
448 if (strncmp ("average_packet_loss=", buffer,
449 strlen ("average_packet_loss=")) == 0)
451 /* Got average packet loss, now interpret it */
453 /* Replace , with . */
466 packet_loss = strtod (value, &endptr);
470 WARNING ("teamspeak2 plugin: Could not read average package "
471 "loss from string: %s", buffer);
475 else if (strncasecmp ("OK", buffer, 2) == 0)
479 else if (strncasecmp ("ERROR", buffer, 5) == 0)
481 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
486 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
491 *ret_value = packet_loss;
493 } /* int tss2_vserver_gapl */
495 static int tss2_read_vserver (vserver_list_t *vserver)
498 * Poll information for the given vserver and submit it to collect.
499 * If vserver is NULL the global server information will be queried.
504 gauge_t channels = NAN;
505 gauge_t servers = NAN;
506 derive_t rx_octets = 0;
507 derive_t tx_octets = 0;
508 derive_t rx_packets = 0;
509 derive_t tx_packets = 0;
510 gauge_t packet_loss = NAN;
513 char plugin_instance[DATA_MAX_NAME_LEN] = { 0 };
518 /* Get the send/receive sockets */
519 status = tss2_get_socket (&read_fh, &write_fh);
522 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
528 /* Request global information */
529 status = tss2_send_request (write_fh, "gi\r\n");
533 /* Request server information */
534 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
537 /* Select the server */
538 status = tss2_select_vserver (read_fh, write_fh, vserver);
542 status = tss2_send_request (write_fh, "si\r\n");
547 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
551 /* Loop until break */
559 /* Read one line of the server's answer */
560 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
563 /* Set to NULL just to make sure no one uses these FHs anymore. */
566 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
570 if (strncasecmp ("ERROR", buffer, 5) == 0)
572 ERROR ("teamspeak2 plugin: Server returned an error: %s",
576 else if (strncasecmp ("OK", buffer, 2) == 0)
581 /* Split line into key and value */
582 key = strchr (buffer, '_');
585 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
590 /* Evaluate assignment */
591 value = strchr (key, '=');
594 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
600 /* Check for known key and save the given value */
601 /* global info: users_online,
602 * server info: currentusers. */
603 if ((strcmp ("currentusers", key) == 0)
604 || (strcmp ("users_online", key) == 0))
606 users = strtod (value, &endptr);
610 /* global info: channels,
611 * server info: currentchannels. */
612 else if ((strcmp ("currentchannels", key) == 0)
613 || (strcmp ("channels", key) == 0))
615 channels = strtod (value, &endptr);
620 else if (strcmp ("servers", key) == 0)
622 servers = strtod (value, &endptr);
626 else if (strcmp ("bytesreceived", key) == 0)
628 rx_octets = strtoll (value, &endptr, 0);
632 else if (strcmp ("bytessend", key) == 0)
634 tx_octets = strtoll (value, &endptr, 0);
638 else if (strcmp ("packetsreceived", key) == 0)
640 rx_packets = strtoll (value, &endptr, 0);
644 else if (strcmp ("packetssend", key) == 0)
646 tx_packets = strtoll (value, &endptr, 0);
650 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
651 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
652 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
653 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
654 || (strcmp ("adminemail", key) == 0)
655 || (strcmp ("clan_server", key) == 0)
656 || (strcmp ("countrynumber", key) == 0)
657 || (strcmp ("id", key) == 0)
658 || (strcmp ("ispname", key) == 0)
659 || (strcmp ("linkurl", key) == 0)
660 || (strcmp ("maxusers", key) == 0)
661 || (strcmp ("name", key) == 0)
662 || (strcmp ("password", key) == 0)
663 || (strcmp ("platform", key) == 0)
664 || (strcmp ("server_platform", key) == 0)
665 || (strcmp ("server_uptime", key) == 0)
666 || (strcmp ("server_version", key) == 0)
667 || (strcmp ("udpport", key) == 0)
668 || (strcmp ("uptime", key) == 0)
669 || (strcmp ("users_maximal", key) == 0)
670 || (strcmp ("welcomemessage", key) == 0))
674 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
675 "key = %s; value = %s;", key, value);
679 /* Collect vserver packet loss rates only if the loop above did not exit
681 if ((status == 0) && (vserver != NULL))
683 status = tss2_vserver_gapl (read_fh, write_fh, &packet_loss);
690 WARNING ("teamspeak2 plugin: Reading package loss "
691 "for vserver %i failed.", vserver->port);
695 if ((valid & 0x01) == 0x01)
696 tss2_submit_gauge (plugin_instance, "users", NULL, users);
698 if ((valid & 0x06) == 0x06)
699 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
701 if ((valid & 0x18) == 0x18)
702 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
704 if ((valid & 0x20) == 0x20)
705 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
707 if ((valid & 0x40) == 0x40)
708 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
710 if ((valid & 0x80) == 0x80)
711 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
716 } /* int tss2_read_vserver */
718 static int tss2_config (const char *key, const char *value)
721 * Interpret configuration values
723 if (strcasecmp ("Host", key) == 0)
727 temp = strdup (value);
730 ERROR("teamspeak2 plugin: strdup failed.");
736 else if (strcasecmp ("Port", key) == 0)
740 temp = strdup (value);
743 ERROR("teamspeak2 plugin: strdup failed.");
749 else if (strcasecmp ("Server", key) == 0)
751 /* Server variable found */
754 status = tss2_add_vserver (atoi (value));
760 /* Unknown variable found */
765 } /* int tss2_config */
767 static int tss2_read (void)
770 * Poll function which collects global and vserver information
771 * and submits it to collectd
773 vserver_list_t *vserver;
777 /* Handle global server variables */
778 status = tss2_read_vserver (NULL);
785 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
788 /* Handle vservers */
789 for (vserver = server_list; vserver != NULL; vserver = vserver->next)
791 status = tss2_read_vserver (vserver);
798 WARNING ("teamspeak2 plugin: Reading statistics "
799 "for vserver %i failed.", vserver->port);
807 } /* int tss2_read */
809 static int tss2_shutdown(void)
814 vserver_list_t *entry;
816 tss2_close_socket ();
820 while (entry != NULL)
822 vserver_list_t *next;
829 /* Get rid of the configuration */
834 } /* int tss2_shutdown */
836 void module_register(void)
839 * Mandatory module_register function
841 plugin_register_config ("teamspeak2", tss2_config,
842 config_keys, config_keys_num);
843 plugin_register_read ("teamspeak2", tss2_read);
844 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
845 } /* void module_register */
847 /* vim: set sw=4 ts=4 : */