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>
27 #include "utils/common/common.h"
29 #include <arpa/inet.h>
31 #include <netinet/in.h>
32 #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 {
47 struct vserver_list_s *next;
49 static vserver_list_t *server_list;
52 static char *config_host;
53 static char *config_port;
55 static FILE *global_read_fh;
56 static FILE *global_write_fh;
59 static const char *config_keys[] = {"Host", "Port", "Server"};
60 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
65 static int tss2_add_vserver(int vserver_port) {
67 * Adds a new vserver to the linked list
69 vserver_list_t *entry;
71 /* Check port range */
72 if ((vserver_port <= 0) || (vserver_port > 65535)) {
73 ERROR("teamspeak2 plugin: VServer port is invalid: %i", vserver_port);
78 entry = calloc(1, sizeof(*entry));
80 ERROR("teamspeak2 plugin: calloc failed.");
85 entry->port = vserver_port;
88 if (server_list == NULL) {
89 /* Add the server as the first element */
94 /* Add the server to the end of the list */
96 while (prev->next != NULL)
101 INFO("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
104 } /* int tss2_add_vserver */
106 static void tss2_submit_gauge(const char *plugin_instance, const char *type,
107 const char *type_instance, gauge_t value) {
109 * Submits a gauge value to the collectd daemon
111 value_list_t vl = VALUE_LIST_INIT;
113 vl.values = &(value_t){.gauge = value};
115 sstrncpy(vl.plugin, "teamspeak2", sizeof(vl.plugin));
117 if (plugin_instance != NULL)
118 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
120 sstrncpy(vl.type, type, sizeof(vl.type));
122 if (type_instance != NULL)
123 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
125 plugin_dispatch_values(&vl);
126 } /* void tss2_submit_gauge */
128 static void tss2_submit_io(const char *plugin_instance, const char *type,
129 derive_t rx, derive_t tx) {
131 * Submits the io rx/tx tuple to the collectd daemon
133 value_list_t vl = VALUE_LIST_INIT;
140 vl.values_len = STATIC_ARRAY_SIZE(values);
141 sstrncpy(vl.plugin, "teamspeak2", sizeof(vl.plugin));
143 if (plugin_instance != NULL)
144 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
146 sstrncpy(vl.type, type, sizeof(vl.type));
148 plugin_dispatch_values(&vl);
149 } /* void tss2_submit_gauge */
151 static void tss2_close_socket(void) {
155 if (global_write_fh != NULL) {
156 fputs("quit\r\n", global_write_fh);
159 if (global_read_fh != NULL) {
160 fclose(global_read_fh);
161 global_read_fh = NULL;
164 if (global_write_fh != NULL) {
165 fclose(global_write_fh);
166 global_write_fh = NULL;
168 } /* void tss2_close_socket */
170 static int tss2_get_socket(FILE **ret_read_fh, FILE **ret_write_fh) {
172 * Returns connected file objects or establishes the connection
173 * if it's not already present
175 struct addrinfo *ai_head;
179 /* Check if we already got opened connections */
180 if ((global_read_fh != NULL) && (global_write_fh != NULL)) {
181 /* If so, use them */
182 if (ret_read_fh != NULL)
183 *ret_read_fh = global_read_fh;
184 if (ret_write_fh != NULL)
185 *ret_write_fh = global_write_fh;
189 /* Get all addrs for this hostname */
190 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC,
191 .ai_flags = AI_ADDRCONFIG,
192 .ai_socktype = SOCK_STREAM};
194 status = getaddrinfo((config_host != NULL) ? config_host : DEFAULT_HOST,
195 (config_port != NULL) ? config_port : DEFAULT_PORT,
196 &ai_hints, &ai_head);
198 ERROR("teamspeak2 plugin: getaddrinfo failed: %s", gai_strerror(status));
202 /* Try all given hosts until we can connect to one */
203 for (struct addrinfo *ai_ptr = ai_head; ai_ptr != NULL;
204 ai_ptr = ai_ptr->ai_next) {
206 sd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
208 WARNING("teamspeak2 plugin: socket failed: %s", STRERRNO);
213 status = connect(sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
215 WARNING("teamspeak2 plugin: connect failed: %s", STRERRNO);
222 * Success, we can break. Don't need more than one connection
227 freeaddrinfo(ai_head);
229 /* Check if we really got connected */
233 /* Create file objects from sockets */
234 global_read_fh = fdopen(sd, "r");
235 if (global_read_fh == NULL) {
236 ERROR("teamspeak2 plugin: fdopen failed: %s", STRERRNO);
241 global_write_fh = fdopen(sd, "w");
242 if (global_write_fh == NULL) {
243 ERROR("teamspeak2 plugin: fdopen failed: %s", STRERRNO);
248 { /* Check that the server correctly identifies itself. */
252 buffer_ptr = fgets(buffer, sizeof(buffer), global_read_fh);
253 if (buffer_ptr == NULL) {
254 WARNING("teamspeak2 plugin: Unexpected EOF received "
255 "from remote host %s:%s.",
256 config_host ? config_host : DEFAULT_HOST,
257 config_port ? config_port : DEFAULT_PORT);
259 buffer[sizeof(buffer) - 1] = '\0';
261 if (memcmp("[TS]\r\n", buffer, 6) != 0) {
262 ERROR("teamspeak2 plugin: Unexpected response when connecting "
263 "to server. Expected ``[TS]'', got ``%s''.",
268 DEBUG("teamspeak2 plugin: Server send correct banner, connected!");
271 /* Copy the new filehandles to the given pointers */
272 if (ret_read_fh != NULL)
273 *ret_read_fh = global_read_fh;
274 if (ret_write_fh != NULL)
275 *ret_write_fh = global_write_fh;
277 } /* int tss2_get_socket */
279 static int tss2_send_request(FILE *fh, const char *request) {
281 * This function puts a request to the server socket
285 status = fputs(request, fh);
287 ERROR("teamspeak2 plugin: fputs failed.");
294 } /* int tss2_send_request */
296 static int tss2_receive_line(FILE *fh, char *buffer, int buffer_size) {
298 * Receive a single line from the given file object
303 * fgets is blocking but much easier then doing anything else
304 * TODO: Non-blocking Version would be safer
306 temp = fgets(buffer, buffer_size, fh);
308 ERROR("teamspeak2 plugin: fgets failed: %s", STRERRNO);
313 buffer[buffer_size - 1] = '\0';
315 } /* int tss2_receive_line */
317 static int tss2_select_vserver(FILE *read_fh, FILE *write_fh,
318 vserver_list_t *vserver) {
320 * Tell the server to select the given vserver
327 snprintf(command, sizeof(command), "sel %i\r\n", vserver->port);
329 status = tss2_send_request(write_fh, command);
331 ERROR("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
336 status = tss2_receive_line(read_fh, response, sizeof(response));
338 ERROR("teamspeak2 plugin: tss2_receive_line failed.");
341 response[sizeof(response) - 1] = '\0';
344 if ((strncasecmp("OK", response, 2) == 0) &&
345 ((response[2] == 0) || (response[2] == '\n') || (response[2] == '\r')))
348 ERROR("teamspeak2 plugin: Command ``%s'' failed. "
349 "Response received from server was: ``%s''.",
352 } /* int tss2_select_vserver */
354 static int tss2_vserver_gapl(FILE *read_fh, FILE *write_fh,
355 gauge_t *ret_value) {
357 * Reads the vserver's average packet loss and submits it to collectd.
358 * Be sure to run the tss2_read_vserver function before calling this so
359 * the vserver is selected correctly.
361 gauge_t packet_loss = NAN;
364 status = tss2_send_request(write_fh, "gapl\r\n");
366 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
375 status = tss2_receive_line(read_fh, buffer, sizeof(buffer));
377 /* Set to NULL just to make sure no one uses these FHs anymore. */
380 ERROR("teamspeak2 plugin: tss2_receive_line failed.");
383 buffer[sizeof(buffer) - 1] = '\0';
385 if (strncmp("average_packet_loss=", buffer,
386 strlen("average_packet_loss=")) == 0) {
387 /* Got average packet loss, now interpret it */
389 /* Replace , with . */
390 while (*value != 0) {
400 packet_loss = strtod(value, &endptr);
401 if (value == endptr) {
403 WARNING("teamspeak2 plugin: Could not read average package "
404 "loss from string: %s",
408 } else if (strncasecmp("OK", buffer, 2) == 0) {
410 } else if (strncasecmp("ERROR", buffer, 5) == 0) {
411 ERROR("teamspeak2 plugin: Server returned an error: %s", buffer);
414 WARNING("teamspeak2 plugin: Server returned unexpected string: %s",
419 *ret_value = packet_loss;
421 } /* int tss2_vserver_gapl */
423 static int tss2_read_vserver(vserver_list_t *vserver) {
425 * Poll information for the given vserver and submit it to collect.
426 * If vserver is NULL the global server information will be queried.
431 gauge_t channels = NAN;
432 gauge_t servers = NAN;
433 derive_t rx_octets = 0;
434 derive_t tx_octets = 0;
435 derive_t rx_packets = 0;
436 derive_t tx_packets = 0;
437 gauge_t packet_loss = NAN;
440 char plugin_instance[DATA_MAX_NAME_LEN] = {0};
445 /* Get the send/receive sockets */
446 status = tss2_get_socket(&read_fh, &write_fh);
448 ERROR("teamspeak2 plugin: tss2_get_socket failed.");
452 if (vserver == NULL) {
453 /* Request global information */
454 status = tss2_send_request(write_fh, "gi\r\n");
456 /* Request server information */
457 snprintf(plugin_instance, sizeof(plugin_instance), "vserver%i",
460 /* Select the server */
461 status = tss2_select_vserver(read_fh, write_fh, vserver);
465 status = tss2_send_request(write_fh, "si\r\n");
469 ERROR("teamspeak2 plugin: tss2_send_request failed.");
473 /* Loop until break */
480 /* Read one line of the server's answer */
481 status = tss2_receive_line(read_fh, buffer, sizeof(buffer));
483 /* Set to NULL just to make sure no one uses these FHs anymore. */
486 ERROR("teamspeak2 plugin: tss2_receive_line failed.");
490 if (strncasecmp("ERROR", buffer, 5) == 0) {
491 ERROR("teamspeak2 plugin: Server returned an error: %s", buffer);
493 } else if (strncasecmp("OK", buffer, 2) == 0) {
497 /* Split line into key and value */
498 key = strchr(buffer, '_');
500 DEBUG("teamspeak2 plugin: Cannot parse line: %s", buffer);
505 /* Evaluate assignment */
506 value = strchr(key, '=');
508 DEBUG("teamspeak2 plugin: Cannot parse line: %s", buffer);
514 /* Check for known key and save the given value */
515 /* global info: users_online,
516 * server info: currentusers. */
517 if ((strcmp("currentusers", key) == 0) ||
518 (strcmp("users_online", key) == 0)) {
519 users = strtod(value, &endptr);
523 /* global info: channels,
524 * server info: currentchannels. */
525 else if ((strcmp("currentchannels", key) == 0) ||
526 (strcmp("channels", key) == 0)) {
527 channels = strtod(value, &endptr);
532 else if (strcmp("servers", key) == 0) {
533 servers = strtod(value, &endptr);
536 } else if (strcmp("bytesreceived", key) == 0) {
537 rx_octets = strtoll(value, &endptr, 0);
540 } else if (strcmp("bytessend", key) == 0) {
541 tx_octets = strtoll(value, &endptr, 0);
544 } else if (strcmp("packetsreceived", key) == 0) {
545 rx_packets = strtoll(value, &endptr, 0);
548 } else if (strcmp("packetssend", key) == 0) {
549 tx_packets = strtoll(value, &endptr, 0);
552 } else if ((strncmp("allow_codec_", key, strlen("allow_codec_")) == 0) ||
553 (strncmp("bwinlast", key, strlen("bwinlast")) == 0) ||
554 (strncmp("bwoutlast", key, strlen("bwoutlast")) == 0) ||
555 (strncmp("webpost_", key, strlen("webpost_")) == 0) ||
556 (strcmp("adminemail", key) == 0) ||
557 (strcmp("clan_server", key) == 0) ||
558 (strcmp("countrynumber", key) == 0) ||
559 (strcmp("id", key) == 0) || (strcmp("ispname", key) == 0) ||
560 (strcmp("linkurl", key) == 0) ||
561 (strcmp("maxusers", key) == 0) || (strcmp("name", key) == 0) ||
562 (strcmp("password", key) == 0) ||
563 (strcmp("platform", key) == 0) ||
564 (strcmp("server_platform", key) == 0) ||
565 (strcmp("server_uptime", key) == 0) ||
566 (strcmp("server_version", key) == 0) ||
567 (strcmp("udpport", key) == 0) || (strcmp("uptime", key) == 0) ||
568 (strcmp("users_maximal", key) == 0) ||
569 (strcmp("welcomemessage", key) == 0))
572 INFO("teamspeak2 plugin: Unknown key-value-pair: "
573 "key = %s; value = %s;",
578 /* Collect vserver packet loss rates only if the loop above did not exit
580 if ((status == 0) && (vserver != NULL)) {
581 status = tss2_vserver_gapl(read_fh, write_fh, &packet_loss);
585 WARNING("teamspeak2 plugin: Reading package loss "
586 "for vserver %i failed.",
591 if ((valid & 0x01) == 0x01)
592 tss2_submit_gauge(plugin_instance, "users", NULL, users);
594 if ((valid & 0x06) == 0x06)
595 tss2_submit_io(plugin_instance, "io_octets", rx_octets, tx_octets);
597 if ((valid & 0x18) == 0x18)
598 tss2_submit_io(plugin_instance, "io_packets", rx_packets, tx_packets);
600 if ((valid & 0x20) == 0x20)
601 tss2_submit_gauge(plugin_instance, "percent", "packet_loss", packet_loss);
603 if ((valid & 0x40) == 0x40)
604 tss2_submit_gauge(plugin_instance, "gauge", "channels", channels);
606 if ((valid & 0x80) == 0x80)
607 tss2_submit_gauge(plugin_instance, "gauge", "servers", servers);
612 } /* int tss2_read_vserver */
614 static int tss2_config(const char *key, const char *value) {
616 * Interpret configuration values
618 if (strcasecmp("Host", key) == 0) {
621 temp = strdup(value);
623 ERROR("teamspeak2 plugin: strdup failed.");
628 } else if (strcasecmp("Port", key) == 0) {
631 temp = strdup(value);
633 ERROR("teamspeak2 plugin: strdup failed.");
638 } else if (strcasecmp("Server", key) == 0) {
639 /* Server variable found */
642 status = tss2_add_vserver(atoi(value));
646 /* Unknown variable found */
651 } /* int tss2_config */
653 static int tss2_read(void) {
655 * Poll function which collects global and vserver information
656 * and submits it to collectd
661 /* Handle global server variables */
662 status = tss2_read_vserver(NULL);
666 WARNING("teamspeak2 plugin: Reading global server variables failed.");
669 /* Handle vservers */
670 for (vserver_list_t *vserver = server_list; vserver != NULL;
671 vserver = vserver->next) {
672 status = tss2_read_vserver(vserver);
676 WARNING("teamspeak2 plugin: Reading statistics "
677 "for vserver %i failed.",
686 } /* int tss2_read */
688 static int tss2_shutdown(void) {
692 vserver_list_t *entry;
698 while (entry != NULL) {
699 vserver_list_t *next;
706 /* Get rid of the configuration */
711 } /* int tss2_shutdown */
713 void module_register(void) {
715 * Mandatory module_register function
717 plugin_register_config("teamspeak2", tss2_config, config_keys,
719 plugin_register_read("teamspeak2", tss2_read);
720 plugin_register_shutdown("teamspeak2", tss2_shutdown);
721 } /* void module_register */