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