src/email.c

   1 /**
   2  * collectd - src/email.c
   3  * Copyright (C) 2006-2008  Sebastian Harl
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Sebastian Harl <sh at tokkee.org>
  25  **/
  26
  27 /*
  28  * This plugin communicates with a spam filter, a virus scanner or similar
  29  * software using a UNIX socket and a very simple protocol:
  30  *
  31  * e-mail type (e.g. ham, spam, virus, ...) and size
  32  * e:<type>:<bytes>
  33  *
  34  * spam score
  35  * s:<value>
  36  *
  37  * successful spam checks
  38  * c:<type1>[,<type2>,...]
  39  */
  40
  41 #include "collectd.h"
  42
  43 #include "common.h"
  44 #include "plugin.h"
  45
  46 #include <stddef.h>
  47
  48 #include <sys/select.h>
  49 #include <sys/un.h>
  50
  51 /* some systems (e.g. Darwin) seem to not define UNIX_PATH_MAX at all */
  52 #ifndef UNIX_PATH_MAX
  53 #define UNIX_PATH_MAX sizeof(((struct sockaddr_un *)0)->sun_path)
  54 #endif /* UNIX_PATH_MAX */
  55
  56 #if HAVE_GRP_H
  57 #include <grp.h>
  58 #endif /* HAVE_GRP_H */
  59
  60 #define SOCK_PATH LOCALSTATEDIR "/run/" PACKAGE_NAME "-email"
  61 #define MAX_CONNS 5
  62 #define MAX_CONNS_LIMIT 16384
  63
  64 #define log_debug(...) DEBUG("email: "__VA_ARGS__)
  65 #define log_err(...) ERROR("email: "__VA_ARGS__)
  66 #define log_warn(...) WARNING("email: "__VA_ARGS__)
  67
  68 /*
  69  * Private data structures
  70  */
  71 /* linked list of email and check types */
  72 typedef struct type {
  73   char *name;
  74   int value;
  75   struct type *next;
  76 } type_t;
  77
  78 typedef struct {
  79   type_t *head;
  80   type_t *tail;
  81 } type_list_t;
  82
  83 /* collector thread control information */
  84 typedef struct collector {
  85   pthread_t thread;
  86
  87   /* socket descriptor of the current/last connection */
  88   FILE *socket;
  89 } collector_t;
  90
  91 /* linked list of pending connections */
  92 typedef struct conn {
  93   /* socket to read data from */
  94   FILE *socket;
  95
  96   /* linked list of connections */
  97   struct conn *next;
  98 } conn_t;
  99
 100 typedef struct {
 101   conn_t *head;
 102   conn_t *tail;
 103 } conn_list_t;
 104
 105 /*
 106  * Private variables
 107  */
 108 /* valid configuration file keys */
 109 static const char *config_keys[] = {"SocketFile", "SocketGroup", "SocketPerms",
 110                                     "MaxConns"};
 111 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
 112
 113 /* socket configuration */
 114 static char *sock_file = NULL;
 115 static char *sock_group = NULL;
 116 static int sock_perms = S_IRWXU | S_IRWXG;
 117 static int max_conns = MAX_CONNS;
 118
 119 /* state of the plugin */
 120 static int disabled = 0;
 121
 122 /* thread managing "client" connections */
 123 static pthread_t connector = (pthread_t)0;
 124 static int connector_socket = -1;
 125
 126 /* tell the collector threads that a new connection is available */
 127 static pthread_cond_t conn_available = PTHREAD_COND_INITIALIZER;
 128
 129 /* connections that are waiting to be processed */
 130 static pthread_mutex_t conns_mutex = PTHREAD_MUTEX_INITIALIZER;
 131 static conn_list_t conns;
 132
 133 /* tell the connector thread that a collector is available */
 134 static pthread_cond_t collector_available = PTHREAD_COND_INITIALIZER;
 135
 136 /* collector threads */
 137 static collector_t **collectors = NULL;
 138
 139 static pthread_mutex_t available_mutex = PTHREAD_MUTEX_INITIALIZER;
 140 static int available_collectors;
 141
 142 static pthread_mutex_t count_mutex = PTHREAD_MUTEX_INITIALIZER;
 143 static type_list_t list_count;
 144 static type_list_t list_count_copy;
 145
 146 static pthread_mutex_t size_mutex = PTHREAD_MUTEX_INITIALIZER;
 147 static type_list_t list_size;
 148 static type_list_t list_size_copy;
 149
 150 static pthread_mutex_t score_mutex = PTHREAD_MUTEX_INITIALIZER;
 151 static double score;
 152 static int score_count;
 153
 154 static pthread_mutex_t check_mutex = PTHREAD_MUTEX_INITIALIZER;
 155 static type_list_t list_check;
 156 static type_list_t list_check_copy;
 157
 158 /*
 159  * Private functions
 160  */
 161 static int email_config(const char *key, const char *value) {
 162   if (strcasecmp(key, "SocketFile") == 0) {
 163     if (sock_file != NULL)
 164       free(sock_file);
 165     sock_file = sstrdup(value);
 166   } else if (strcasecmp(key, "SocketGroup") == 0) {
 167     if (sock_group != NULL)
 168       free(sock_group);
 169     sock_group = sstrdup(value);
 170   } else if (strcasecmp(key, "SocketPerms") == 0) {
 171     /* the user is responsible for providing reasonable values */
 172     sock_perms = (int)strtol(value, NULL, 8);
 173   } else if (strcasecmp(key, "MaxConns") == 0) {
 174     long int tmp = strtol(value, NULL, 0);
 175
 176     if (tmp < 1) {
 177       fprintf(stderr, "email plugin: `MaxConns' was set to invalid "
 178                       "value %li, will use default %i.\n",
 179               tmp, MAX_CONNS);
 180       ERROR("email plugin: `MaxConns' was set to invalid "
 181             "value %li, will use default %i.\n",
 182             tmp, MAX_CONNS);
 183       max_conns = MAX_CONNS;
 184     } else if (tmp > MAX_CONNS_LIMIT) {
 185       fprintf(stderr, "email plugin: `MaxConns' was set to invalid "
 186                       "value %li, will use hardcoded limit %i.\n",
 187               tmp, MAX_CONNS_LIMIT);
 188       ERROR("email plugin: `MaxConns' was set to invalid "
 189             "value %li, will use hardcoded limit %i.\n",
 190             tmp, MAX_CONNS_LIMIT);
 191       max_conns = MAX_CONNS_LIMIT;
 192     } else {
 193       max_conns = (int)tmp;
 194     }
 195   } else {
 196     return -1;
 197   }
 198   return 0;
 199 } /* static int email_config (char *, char *) */
 200
 201 /* Increment the value of the given name in the given list by incr. */
 202 static void type_list_incr(type_list_t *list, char *name, int incr) {
 203   if (list->head == NULL) {
 204     list->head = smalloc(sizeof(*list->head));
 205
 206     list->head->name = sstrdup(name);
 207     list->head->value = incr;
 208     list->head->next = NULL;
 209
 210     list->tail = list->head;
 211   } else {
 212     type_t *ptr;
 213
 214     for (ptr = list->head; NULL != ptr; ptr = ptr->next) {
 215       if (strcmp(name, ptr->name) == 0)
 216         break;
 217     }
 218
 219     if (ptr == NULL) {
 220       list->tail->next = smalloc(sizeof(*list->tail->next));
 221       list->tail = list->tail->next;
 222
 223       list->tail->name = sstrdup(name);
 224       list->tail->value = incr;
 225       list->tail->next = NULL;
 226     } else {
 227       ptr->value += incr;
 228     }
 229   }
 230   return;
 231 } /* static void type_list_incr (type_list_t *, char *) */
 232
 233 static void *collect(void *arg) {
 234   collector_t *this = (collector_t *)arg;
 235
 236   while (1) {
 237     conn_t *connection;
 238
 239     pthread_mutex_lock(&conns_mutex);
 240
 241     while (conns.head == NULL) {
 242       pthread_cond_wait(&conn_available, &conns_mutex);
 243     }
 244
 245     connection = conns.head;
 246     conns.head = conns.head->next;
 247
 248     if (conns.head == NULL) {
 249       conns.tail = NULL;
 250     }
 251
 252     pthread_mutex_unlock(&conns_mutex);
 253
 254     /* make the socket available to the global
 255      * thread and connection management */
 256     this->socket = connection->socket;
 257
 258     log_debug("collect: handling connection on fd #%i", fileno(this->socket));
 259
 260     while (42) {
 261       /* 256 bytes ought to be enough for anybody ;-) */
 262       char line[256 + 1]; /* line + '\0' */
 263       int len = 0;
 264
 265       errno = 0;
 266       if (fgets(line, sizeof(line), this->socket) == NULL) {
 267         if (errno != 0) {
 268           log_err("collect: reading from socket (fd #%i) "
 269                   "failed: %s",
 270                   fileno(this->socket), STRERRNO);
 271         }
 272         break;
 273       }
 274
 275       len = strlen(line);
 276       if ((line[len - 1] != '\n') && (line[len - 1] != '\r')) {
 277         log_warn("collect: line too long (> %zu characters): "
 278                  "'%s' (truncated)",
 279                  sizeof(line) - 1, line);
 280
 281         while (fgets(line, sizeof(line), this->socket) != NULL)
 282           if ((line[len - 1] == '\n') || (line[len - 1] == '\r'))
 283             break;
 284         continue;
 285       }
 286       if (len < 3) { /* [a-z] ':' '\n' */
 287         continue;
 288       }
 289
 290       line[len - 1] = 0;
 291
 292       log_debug("collect: line = '%s'", line);
 293
 294       if (line[1] != ':') {
 295         log_err("collect: syntax error in line '%s'", line);
 296         continue;
 297       }
 298
 299       if (line[0] == 'e') { /* e:<type>:<bytes> */
 300         char *ptr = NULL;
 301         char *type = strtok_r(line + 2, ":", &ptr);
 302         char *tmp = strtok_r(NULL, ":", &ptr);
 303         int bytes = 0;
 304
 305         if (tmp == NULL) {
 306           log_err("collect: syntax error in line '%s'", line);
 307           continue;
 308         }
 309
 310         bytes = atoi(tmp);
 311
 312         pthread_mutex_lock(&count_mutex);
 313         type_list_incr(&list_count, type, /* increment = */ 1);
 314         pthread_mutex_unlock(&count_mutex);
 315
 316         if (bytes > 0) {
 317           pthread_mutex_lock(&size_mutex);
 318           type_list_incr(&list_size, type, /* increment = */ bytes);
 319           pthread_mutex_unlock(&size_mutex);
 320         }
 321       } else if (line[0] == 's') { /* s:<value> */
 322         pthread_mutex_lock(&score_mutex);
 323         score = (score * (double)score_count + atof(line + 2)) /
 324                 (double)(score_count + 1);
 325         ++score_count;
 326         pthread_mutex_unlock(&score_mutex);
 327       } else if (line[0] == 'c') { /* c:<type1>[,<type2>,...] */
 328         char *dummy = line + 2;
 329         char *endptr = NULL;
 330         char *type;
 331
 332         pthread_mutex_lock(&check_mutex);
 333         while ((type = strtok_r(dummy, ",", &endptr)) != NULL) {
 334           dummy = NULL;
 335           type_list_incr(&list_check, type, /* increment = */ 1);
 336         }
 337         pthread_mutex_unlock(&check_mutex);
 338       } else {
 339         log_err("collect: unknown type '%c'", line[0]);
 340       }
 341     } /* while (42) */
 342
 343     log_debug("Shutting down connection on fd #%i", fileno(this->socket));
 344
 345     fclose(connection->socket);
 346     free(connection);
 347
 348     this->socket = NULL;
 349
 350     pthread_mutex_lock(&available_mutex);
 351     ++available_collectors;
 352     pthread_mutex_unlock(&available_mutex);
 353
 354     pthread_cond_signal(&collector_available);
 355   } /* while (1) */
 356
 357   pthread_exit((void *)0);
 358   return (void *)0;
 359 } /* static void *collect (void *) */
 360
 361 static void *open_connection(void __attribute__((unused)) * arg) {
 362   const char *path = (NULL == sock_file) ? SOCK_PATH : sock_file;
 363   const char *group = (NULL == sock_group) ? COLLECTD_GRP_NAME : sock_group;
 364
 365   /* create UNIX socket */
 366   errno = 0;
 367   if ((connector_socket = socket(PF_UNIX, SOCK_STREAM, 0)) == -1) {
 368     disabled = 1;
 369     log_err("socket() failed: %s", STRERRNO);
 370     pthread_exit((void *)1);
 371   }
 372
 373   struct sockaddr_un addr = {.sun_family = AF_UNIX};
 374   sstrncpy(addr.sun_path, path, (size_t)(UNIX_PATH_MAX - 1));
 375
 376   errno = 0;
 377   if (bind(connector_socket, (struct sockaddr *)&addr,
 378            offsetof(struct sockaddr_un, sun_path) + strlen(addr.sun_path)) ==
 379       -1) {
 380     disabled = 1;
 381     close(connector_socket);
 382     connector_socket = -1;
 383     log_err("bind() failed: %s", STRERRNO);
 384     pthread_exit((void *)1);
 385   }
 386
 387   errno = 0;
 388   if (listen(connector_socket, 5) == -1) {
 389     disabled = 1;
 390     close(connector_socket);
 391     connector_socket = -1;
 392     log_err("listen() failed: %s", STRERRNO);
 393     pthread_exit((void *)1);
 394   }
 395
 396   {
 397     struct group sg;
 398     struct group *grp;
 399     int status;
 400
 401     long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
 402     if (grbuf_size <= 0)
 403       grbuf_size = sysconf(_SC_PAGESIZE);
 404     if (grbuf_size <= 0)
 405       grbuf_size = 4096;
 406     char grbuf[grbuf_size];
 407
 408     grp = NULL;
 409     status = getgrnam_r(group, &sg, grbuf, sizeof(grbuf), &grp);
 410     if (status != 0) {
 411       log_warn("getgrnam_r (%s) failed: %s", group, STRERROR(status));
 412     } else if (grp == NULL) {
 413       log_warn("No such group: `%s'", group);
 414     } else {
 415       status = chown(path, (uid_t)-1, grp->gr_gid);
 416       if (status != 0) {
 417         log_warn("chown (%s, -1, %i) failed: %s", path, (int)grp->gr_gid,
 418                  STRERRNO);
 419       }
 420     }
 421   }
 422
 423   errno = 0;
 424   if (chmod(path, sock_perms) != 0) {
 425     log_warn("chmod() failed: %s", STRERRNO);
 426   }
 427
 428   { /* initialize collector threads */
 429     pthread_attr_t ptattr;
 430
 431     conns.head = NULL;
 432     conns.tail = NULL;
 433
 434     pthread_attr_init(&ptattr);
 435     pthread_attr_setdetachstate(&ptattr, PTHREAD_CREATE_DETACHED);
 436
 437     available_collectors = max_conns;
 438
 439     collectors = smalloc(max_conns * sizeof(*collectors));
 440
 441     for (int i = 0; i < max_conns; ++i) {
 442       collectors[i] = smalloc(sizeof(*collectors[i]));
 443       collectors[i]->socket = NULL;
 444
 445       if (plugin_thread_create(&collectors[i]->thread, &ptattr, collect,
 446                                collectors[i], "email collector") != 0) {
 447         log_err("plugin_thread_create() failed: %s", STRERRNO);
 448         collectors[i]->thread = (pthread_t)0;
 449       }
 450     }
 451
 452     pthread_attr_destroy(&ptattr);
 453   }
 454
 455   while (1) {
 456     int remote = 0;
 457
 458     conn_t *connection;
 459
 460     pthread_mutex_lock(&available_mutex);
 461
 462     while (available_collectors == 0) {
 463       pthread_cond_wait(&collector_available, &available_mutex);
 464     }
 465
 466     --available_collectors;
 467
 468     pthread_mutex_unlock(&available_mutex);
 469
 470     while (42) {
 471       errno = 0;
 472
 473       remote = accept(connector_socket, NULL, NULL);
 474       if (remote == -1) {
 475         if (errno == EINTR)
 476           continue;
 477
 478         disabled = 1;
 479         close(connector_socket);
 480         connector_socket = -1;
 481         log_err("accept() failed: %s", STRERRNO);
 482         pthread_exit((void *)1);
 483       }
 484
 485       /* access() succeeded. */
 486       break;
 487     }
 488
 489     connection = calloc(1, sizeof(*connection));
 490     if (connection == NULL) {
 491       close(remote);
 492       continue;
 493     }
 494
 495     connection->socket = fdopen(remote, "r");
 496     connection->next = NULL;
 497
 498     if (connection->socket == NULL) {
 499       close(remote);
 500       sfree(connection);
 501       continue;
 502     }
 503
 504     pthread_mutex_lock(&conns_mutex);
 505
 506     if (conns.head == NULL) {
 507       conns.head = connection;
 508       conns.tail = connection;
 509     } else {
 510       conns.tail->next = connection;
 511       conns.tail = conns.tail->next;
 512     }
 513
 514     pthread_mutex_unlock(&conns_mutex);
 515
 516     pthread_cond_signal(&conn_available);
 517   }
 518
 519   pthread_exit((void *)0);
 520   return (void *)0;
 521 } /* static void *open_connection (void *) */
 522
 523 static int email_init(void) {
 524   if (plugin_thread_create(&connector, NULL, open_connection, NULL,
 525                            "email listener") != 0) {
 526     disabled = 1;
 527     log_err("plugin_thread_create() failed: %s", STRERRNO);
 528     return -1;
 529   }
 530
 531   return 0;
 532 } /* int email_init */
 533
 534 static void type_list_free(type_list_t *t) {
 535   type_t *this;
 536
 537   this = t->head;
 538   while (this != NULL) {
 539     type_t *next = this->next;
 540
 541     sfree(this->name);
 542     sfree(this);
 543
 544     this = next;
 545   }
 546
 547   t->head = NULL;
 548   t->tail = NULL;
 549 }
 550
 551 static int email_shutdown(void) {
 552   if (connector != ((pthread_t)0)) {
 553     pthread_kill(connector, SIGTERM);
 554     connector = (pthread_t)0;
 555   }
 556
 557   if (connector_socket >= 0) {
 558     close(connector_socket);
 559     connector_socket = -1;
 560   }
 561
 562   /* don't allow any more connections to be processed */
 563   pthread_mutex_lock(&conns_mutex);
 564
 565   available_collectors = 0;
 566
 567   if (collectors != NULL) {
 568     for (int i = 0; i < max_conns; ++i) {
 569       if (collectors[i] == NULL)
 570         continue;
 571
 572       if (collectors[i]->thread != ((pthread_t)0)) {
 573         pthread_kill(collectors[i]->thread, SIGTERM);
 574         collectors[i]->thread = (pthread_t)0;
 575       }
 576
 577       if (collectors[i]->socket != NULL) {
 578         fclose(collectors[i]->socket);
 579         collectors[i]->socket = NULL;
 580       }
 581
 582       sfree(collectors[i]);
 583     }
 584     sfree(collectors);
 585   } /* if (collectors != NULL) */
 586
 587   pthread_mutex_unlock(&conns_mutex);
 588
 589   type_list_free(&list_count);
 590   type_list_free(&list_count_copy);
 591   type_list_free(&list_size);
 592   type_list_free(&list_size_copy);
 593   type_list_free(&list_check);
 594   type_list_free(&list_check_copy);
 595
 596   unlink((sock_file == NULL) ? SOCK_PATH : sock_file);
 597
 598   sfree(sock_file);
 599   sfree(sock_group);
 600   return 0;
 601 } /* static void email_shutdown (void) */
 602
 603 static void email_submit(const char *type, const char *type_instance,
 604                          gauge_t value) {
 605   value_list_t vl = VALUE_LIST_INIT;
 606
 607   vl.values = &(value_t){.gauge = value};
 608   vl.values_len = 1;
 609   sstrncpy(vl.plugin, "email", sizeof(vl.plugin));
 610   sstrncpy(vl.type, type, sizeof(vl.type));
 611   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 612
 613   plugin_dispatch_values(&vl);
 614 } /* void email_submit */
 615
 616 /* Copy list l1 to list l2. l2 may partly exist already, but it is assumed
 617  * that neither the order nor the name of any element of either list is
 618  * changed and no elements are deleted. The values of l1 are reset to zero
 619  * after they have been copied to l2. */
 620 static void copy_type_list(type_list_t *l1, type_list_t *l2) {
 621   type_t *last = NULL;
 622
 623   for (type_t *ptr1 = l1->head, *ptr2 = l2->head; ptr1 != NULL;
 624        ptr1 = ptr1->next, last = ptr2, ptr2 = ptr2->next) {
 625     if (ptr2 == NULL) {
 626       ptr2 = smalloc(sizeof(*ptr2));
 627       ptr2->name = NULL;
 628       ptr2->next = NULL;
 629
 630       if (last == NULL) {
 631         l2->head = ptr2;
 632       } else {
 633         last->next = ptr2;
 634       }
 635
 636       l2->tail = ptr2;
 637     }
 638
 639     if (ptr2->name == NULL) {
 640       ptr2->name = sstrdup(ptr1->name);
 641     }
 642
 643     ptr2->value = ptr1->value;
 644     ptr1->value = 0;
 645   }
 646   return;
 647 }
 648
 649 static int email_read(void) {
 650   double score_old;
 651   int score_count_old;
 652
 653   if (disabled)
 654     return -1;
 655
 656   /* email count */
 657   pthread_mutex_lock(&count_mutex);
 658
 659   copy_type_list(&list_count, &list_count_copy);
 660
 661   pthread_mutex_unlock(&count_mutex);
 662
 663   for (type_t *ptr = list_count_copy.head; ptr != NULL; ptr = ptr->next) {
 664     email_submit("email_count", ptr->name, ptr->value);
 665   }
 666
 667   /* email size */
 668   pthread_mutex_lock(&size_mutex);
 669
 670   copy_type_list(&list_size, &list_size_copy);
 671
 672   pthread_mutex_unlock(&size_mutex);
 673
 674   for (type_t *ptr = list_size_copy.head; ptr != NULL; ptr = ptr->next) {
 675     email_submit("email_size", ptr->name, ptr->value);
 676   }
 677
 678   /* spam score */
 679   pthread_mutex_lock(&score_mutex);
 680
 681   score_old = score;
 682   score_count_old = score_count;
 683   score = 0.0;
 684   score_count = 0;
 685
 686   pthread_mutex_unlock(&score_mutex);
 687
 688   if (score_count_old > 0)
 689     email_submit("spam_score", "", score_old);
 690
 691   /* spam checks */
 692   pthread_mutex_lock(&check_mutex);
 693
 694   copy_type_list(&list_check, &list_check_copy);
 695
 696   pthread_mutex_unlock(&check_mutex);
 697
 698   for (type_t *ptr = list_check_copy.head; ptr != NULL; ptr = ptr->next)
 699     email_submit("spam_check", ptr->name, ptr->value);
 700
 701   return 0;
 702 } /* int email_read */
 703
 704 void module_register(void) {
 705   plugin_register_config("email", email_config, config_keys, config_keys_num);
 706   plugin_register_init("email", email_init);
 707   plugin_register_read("email", email_read);
 708   plugin_register_shutdown("email", email_shutdown);
 709 } /* void module_register */