src/teamspeak2.c

   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 verplant.org>
  22  **/
  23
  24 #include "collectd.h"
  25 #include "common.h"
  26 #include "plugin.h"
  27
  28 #include <arpa/inet.h>
  29 #include <netinet/in.h>
  30 #include <sys/types.h>
  31 #include <sys/socket.h>
  32 #include <netdb.h>
  33
  34 /*
  35  * Defines
  36  */
  37 /* Default host and port */
  38 #define DEFAULT_HOST    "127.0.0.1"
  39 #define DEFAULT_PORT    "51234"
  40
  41 /*
  42  * Variables
  43  */
  44 /* Server linked list structure */
  45 typedef struct vserver_list_s
  46 {
  47         int port;
  48         struct vserver_list_s *next;
  49 } vserver_list_t;
  50 static vserver_list_t *server_list = NULL;
  51
  52 /* Host data */
  53 static char *config_host = NULL;
  54 static char *config_port = NULL;
  55
  56 static FILE *global_read_fh = NULL;
  57 static FILE *global_write_fh = NULL;
  58
  59 /* Config data */
  60 static const char *config_keys[] =
  61 {
  62         "Host",
  63         "Port",
  64         "Server"
  65 };
  66 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  67
  68 /*
  69  * Functions
  70  */
  71 static int tss2_add_vserver (int vserver_port)
  72 {
  73         vserver_list_t *entry;
  74
  75         if ((vserver_port <= 0) || (vserver_port > 65535))
  76         {
  77                 ERROR ("teamspeak2 plugin: VServer port is invalid: %i",
  78                                 vserver_port);
  79                 return (-1);
  80         }
  81
  82         entry = (vserver_list_t *) malloc (sizeof (vserver_list_t));
  83         if (entry == NULL)
  84         {
  85                 ERROR ("teamspeak2 plugin: malloc failed.");
  86                 return (-1);
  87         }
  88         memset (entry, 0, sizeof (vserver_list_t));
  89
  90         entry->port = vserver_port;
  91
  92         if(server_list == NULL) {
  93                 /* Add the server as the first element */
  94                 server_list = entry;
  95         }
  96         else {
  97                 vserver_list_t *prev;
  98
  99                 /* Add the server to the end of the list */
 100                 prev = server_list;
 101                 while (prev->next != NULL)
 102                         prev = prev->next;
 103                 prev->next = entry;
 104         }
 105
 106         INFO ("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
 107
 108         return (0);
 109 } /* int tss2_add_vserver */
 110
 111 static void tss2_submit_gauge (const char *plugin_instance, const char *type,
 112                 gauge_t value)
 113 {
 114         value_t values[1];
 115         value_list_t vl = VALUE_LIST_INIT;
 116
 117         values[0].gauge = value;
 118
 119         vl.values     = values;
 120         vl.values_len = 1;
 121         vl.time       = time (NULL);
 122         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 123         sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
 124
 125         if (plugin_instance != NULL)
 126                 sstrncpy (vl.plugin_instance, plugin_instance,
 127                                 sizeof (vl.plugin_instance));
 128
 129         plugin_dispatch_values (type, &vl);
 130 } /* void tss2_submit_gauge */
 131
 132 static void tss2_submit_io (const char *plugin_instance, const char *type,
 133                 counter_t rx, counter_t tx)
 134 {
 135         value_t values[2];
 136         value_list_t vl = VALUE_LIST_INIT;
 137
 138         values[0].counter = rx;
 139         values[1].counter = tx;
 140
 141         vl.values     = values;
 142         vl.values_len = 2;
 143         vl.time       = time (NULL);
 144         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 145         sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
 146
 147         if (plugin_instance != NULL)
 148                 sstrncpy (vl.plugin_instance, plugin_instance,
 149                                 sizeof (vl.plugin_instance));
 150
 151         plugin_dispatch_values (type, &vl);
 152 } /* void tss2_submit_gauge */
 153
 154 static void tss2_close_socket (void)
 155 {
 156         if (global_write_fh != NULL)
 157         {
 158                 fputs ("quit\r\n", global_write_fh);
 159         }
 160
 161         if (global_read_fh != NULL)
 162         {
 163                 fclose (global_read_fh);
 164                 global_read_fh = NULL;
 165         }
 166
 167         if (global_write_fh != NULL)
 168         {
 169                 fclose (global_write_fh);
 170                 global_write_fh = NULL;
 171         }
 172 } /* void tss2_close_socket */
 173
 174 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
 175 {
 176         struct addrinfo ai_hints;
 177         struct addrinfo *ai_head;
 178         struct addrinfo *ai_ptr;
 179         int sd = -1;
 180         int status;
 181
 182         if ((global_read_fh != NULL) && (global_write_fh != NULL))
 183         {
 184                 if (ret_read_fh != NULL)
 185                         *ret_read_fh = global_read_fh;
 186                 if (ret_write_fh != NULL)
 187                         *ret_write_fh = global_write_fh;
 188                 return (0);
 189         }
 190
 191         memset (&ai_hints, 0, sizeof (ai_hints));
 192 #ifdef AI_ADDRCONFIG
 193         ai_hints.ai_flags |= AI_ADDRCONFIG;
 194 #endif
 195         ai_hints.ai_family = AF_UNSPEC;
 196         ai_hints.ai_socktype = SOCK_STREAM;
 197
 198         status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
 199                         (config_port != NULL) ? config_port : DEFAULT_PORT,
 200                         &ai_hints,
 201                         &ai_head);
 202         if (status != 0)
 203         {
 204                 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
 205                                 gai_strerror (status));
 206                 return (-1);
 207         }
 208
 209         for (ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 210         {
 211                 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
 212                                 ai_ptr->ai_protocol);
 213                 if (sd < 0)
 214                 {
 215                         char errbuf[1024];
 216                         WARNING ("teamspeak2 plugin: socket failed: %s",
 217                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 218                         continue;
 219                 }
 220
 221                 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 222                 if (status != 0)
 223                 {
 224                         char errbuf[1024];
 225                         WARNING ("teamspeak2 plugin: connect failed: %s",
 226                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 227                         close (sd);
 228                         continue;
 229                 }
 230
 231                 break;
 232         } /* for (ai_ptr) */
 233
 234         freeaddrinfo (ai_head);
 235
 236         if (sd < 0)
 237                 return (-1);
 238
 239         global_read_fh = fdopen (sd, "r");
 240         if (global_read_fh == NULL)
 241         {
 242                 char errbuf[1024];
 243                 ERROR ("teamspeak2 plugin: fdopen failed: %s",
 244                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 245                 close (sd);
 246                 return (-1);
 247         }
 248
 249         global_write_fh = fdopen (sd, "w");
 250         if (global_write_fh == NULL)
 251         {
 252                 char errbuf[1024];
 253                 ERROR ("teamspeak2 plugin: fdopen failed: %s",
 254                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 255                 tss2_close_socket ();
 256                 return (-1);
 257         }
 258
 259         { /* Check that the server correctly identifies itself. */
 260                 char buffer[4096];
 261                 char *buffer_ptr;
 262
 263                 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
 264                 buffer[sizeof (buffer) - 1] = 0;
 265
 266                 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
 267                 {
 268                         ERROR ("teamspeak2 plugin: Unexpected response when connecting "
 269                                         "to server. Expected ``[TS]'', got ``%s''.",
 270                                         buffer);
 271                         tss2_close_socket ();
 272                         return (-1);
 273                 }
 274         }
 275
 276         if (ret_read_fh != NULL)
 277                 *ret_read_fh = global_read_fh;
 278         if (ret_write_fh != NULL)
 279                 *ret_write_fh = global_write_fh;
 280         return (0);
 281 } /* int tss2_get_socket */
 282
 283 static int tss2_send_request (FILE *fh, const char *request)
 284 {
 285         int status;
 286
 287         status = fputs (request, fh);
 288         if (status < 0)
 289         {
 290                 ERROR ("teamspeak2 plugin: fputs failed.");
 291                 tss2_close_socket ();
 292                 return (-1);
 293         }
 294
 295         return (0);
 296 } /* int tss2_send_request */
 297
 298 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
 299 {
 300         char *temp;
 301
 302         /*
 303          * fgets is blocking but much easier then doing anything else
 304          * TODO: Non-blocking Version would be safer
 305          */
 306         temp = fgets (buffer, buffer_size, fh);
 307         if (temp == NULL)
 308         {
 309                 char errbuf[1024];
 310                 ERROR ("teamspeak2 plugin: fgets failed: %s",
 311                                 sstrerror (errno, errbuf, sizeof(errbuf)));
 312                 tss2_close_socket ();
 313                 return (-1);
 314         }
 315
 316         buffer[buffer_size - 1] = 0;
 317         return (0);
 318 } /* int tss2_receive_line */
 319
 320 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
 321 {
 322         char command[128];
 323         char response[128];
 324         int status;
 325
 326         snprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
 327         command[sizeof (command) - 1] = 0;
 328
 329         status = tss2_send_request (write_fh, command);
 330         if (status != 0)
 331         {
 332                 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
 333                 return (-1);
 334         }
 335
 336         status = tss2_receive_line (read_fh, response, sizeof (response));
 337         if (status != 0)
 338         {
 339                 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
 340                 return (-1);
 341         }
 342         response[sizeof (response)] = 0;
 343
 344         if ((strncmp ("OK", response, 2) == 0)
 345                         && ((response[2] == 0)
 346                                 || (response[2] == '\n')
 347                                 || (response[2] == '\r')))
 348                 return (0);
 349
 350         ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
 351                         "Response received from server was: ``%s''.",
 352                         command, response);
 353         return (-1);
 354 } /* int tss2_select_vserver */
 355
 356 static int tss2_read_vserver (vserver_list_t *vserver)
 357 {
 358         int status;
 359
 360         gauge_t users = NAN;
 361         counter_t rx_octets = 0;
 362         counter_t tx_octets = 0;
 363         counter_t rx_packets = 0;
 364         counter_t tx_packets = 0;
 365         int valid = 0;
 366
 367         char plugin_instance[DATA_MAX_NAME_LEN];
 368
 369         FILE *read_fh;
 370         FILE *write_fh;
 371
 372         status = tss2_get_socket (&read_fh, &write_fh);
 373         if (status != 0)
 374         {
 375                 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
 376                 return (-1);
 377         }
 378
 379         if (vserver == NULL)
 380         {
 381                 memset (plugin_instance, 0, sizeof (plugin_instance));
 382
 383                 status = tss2_send_request (write_fh, "gi\r\n");
 384         }
 385         else
 386         {
 387                 snprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
 388                                 vserver->port);
 389                 plugin_instance[sizeof (plugin_instance) - 1] = 0;
 390
 391                 status = tss2_select_vserver (read_fh, write_fh, vserver);
 392                 if (status != 0)
 393                         return (status);
 394                 status = tss2_send_request (write_fh, "si\r\n");
 395         }
 396
 397         if (status != 0)
 398         {
 399                 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
 400                 return (-1);
 401         }
 402
 403         while (42)
 404         {
 405                 char buffer[4096];
 406                 char *key;
 407                 char *value;
 408                 char *endptr = NULL;
 409
 410                 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
 411                 if (status != 0)
 412                 {
 413                         /* Set to NULL just to make sure noone uses these FHs anymore. */
 414                         read_fh = NULL;
 415                         write_fh = NULL;
 416                         ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
 417                         break;
 418                 }
 419
 420                 if (strncmp ("ERROR", buffer, 5) == 0)
 421                 {
 422                         ERROR ("teamspeak2 plugin: Server returned an error: %s",
 423                                         buffer);
 424                         break;
 425                 }
 426                 else if (strncmp ("OK", buffer, 2) == 0)
 427                 {
 428                         break;
 429                 }
 430
 431                 /* Split line into key and value */
 432                 key = strchr (buffer, '_');
 433                 if (key == NULL)
 434                 {
 435                         DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
 436                         continue;
 437                 }
 438                 key++;
 439
 440                 value = strchr (key, '=');
 441                 if (value == NULL)
 442                 {
 443                         DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
 444                         continue;
 445                 }
 446                 *value = 0;
 447                 value++;
 448
 449                 if ((strcmp ("currentusers", key) == 0)
 450                                 || (strcmp ("users_online", key) == 0))
 451                 {
 452                         users = strtod (value, &endptr);
 453                         if (value != endptr)
 454                                 valid |= 0x01;
 455                 }
 456                 else if (strcmp ("bytesreceived", key) == 0)
 457                 {
 458                         rx_octets = strtoll (value, &endptr, 0);
 459                         if (value != endptr)
 460                                 valid |= 0x02;
 461                 }
 462                 else if (strcmp ("bytessend", key) == 0)
 463                 {
 464                         tx_octets = strtoll (value, &endptr, 0);
 465                         if (value != endptr)
 466                                 valid |= 0x04;
 467                 }
 468                 else if (strcmp ("packetsreceived", key) == 0)
 469                 {
 470                         rx_packets = strtoll (value, &endptr, 0);
 471                         if (value != endptr)
 472                                 valid |= 0x08;
 473                 }
 474                 else if (strcmp ("packetssend", key) == 0)
 475                 {
 476                         tx_packets = strtoll (value, &endptr, 0);
 477                         if (value != endptr)
 478                                 valid |= 0x10;
 479                 }
 480                 else
 481                 {
 482                         DEBUG ("teamspeak2 plugin: Unknown key-value-pair: key = %s; value = %s;",
 483                                         key, value);
 484                 }
 485         } /* while (42) */
 486
 487         if ((valid & 0x01) == 0x01)
 488                 tss2_submit_gauge (plugin_instance, "users", users);
 489
 490         if ((valid & 0x06) == 0x06)
 491                 tss2_submit_io (plugin_instance, "if_octets", rx_octets, tx_octets);
 492
 493         if ((valid & 0x18) == 0x18)
 494                 tss2_submit_io (plugin_instance, "if_packets", rx_packets, tx_packets);
 495
 496         if (valid == 0)
 497                 return (-1);
 498         return (0);
 499 } /* int tss2_read_vserver */
 500
 501 static int tss2_config (const char *key, const char *value)
 502 {
 503     if (strcasecmp ("Host", key) == 0)
 504         {
 505                 char *temp;
 506
 507                 temp = strdup (value);
 508                 if (temp == NULL)
 509                 {
 510                         ERROR("teamspeak2 plugin: strdup failed.");
 511                         return (1);
 512                 }
 513                 sfree (config_host);
 514                 config_host = temp;
 515         }
 516         else if (strcasecmp ("Port", key) == 0)
 517         {
 518                 char *temp;
 519
 520                 temp = strdup (value);
 521                 if (temp == NULL)
 522                 {
 523                         ERROR("teamspeak2 plugin: strdup failed.");
 524                         return (1);
 525                 }
 526                 sfree (config_port);
 527                 config_port = temp;
 528         }
 529         else if (strcasecmp ("Server", key) == 0)
 530         {
 531                 /* Server variable found */
 532                 int status;
 533
 534                 status = tss2_add_vserver (atoi (value));
 535                 if (status != 0)
 536                         return (1);
 537         }
 538         else
 539         {
 540                 /* Unknow variable found */
 541                 return (-1);
 542         }
 543
 544         return 0;
 545 } /* int tss2_config */
 546
 547 static int tss2_read (void)
 548 {
 549         vserver_list_t *vserver;
 550         int success = 0;
 551         int status;
 552
 553         /* Handle global server variables */
 554         status = tss2_read_vserver (NULL);
 555         if (status == 0)
 556         {
 557                 success++;
 558         }
 559         else
 560         {
 561                 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
 562         }
 563
 564         for (vserver = server_list; vserver != NULL; vserver = vserver->next)
 565         {
 566                 status = tss2_read_vserver (vserver);
 567                 if (status == 0)
 568                 {
 569                         success++;
 570                 }
 571                 else
 572                 {
 573                         WARNING ("teamspeak2 plugin: Reading statistics "
 574                                         "for vserver %i failed.", vserver->port);
 575                         continue;
 576                 }
 577         }
 578
 579         if (success == 0)
 580                 return (-1);
 581     return (0);
 582 } /* int tss2_read */
 583
 584 static int tss2_shutdown(void)
 585 {
 586         vserver_list_t *entry;
 587
 588         tss2_close_socket ();
 589
 590         entry = server_list;
 591         server_list = NULL;
 592         while (entry != NULL)
 593         {
 594                 vserver_list_t *next;
 595
 596                 next = entry->next;
 597                 sfree (entry);
 598                 entry = next;
 599         }
 600
 601         /* Get rid of the configuration */
 602         sfree (config_host);
 603         sfree (config_port);
 604
 605     return (0);
 606 } /* int tss2_shutdown */
 607
 608 void module_register(void)
 609 {
 610         plugin_register_config ("teamspeak2", tss2_config,
 611                         config_keys, config_keys_num);
 612         plugin_register_read ("teamspeak2", tss2_read);
 613         plugin_register_shutdown ("teamspeak2", tss2_shutdown);
 614 } /* void module_register */
 615
 616 /* vim: set sw=4 ts=4 : */