2 * collectd - src/email.c
3 * Copyright (C) 2006-2008 Sebastian Harl
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.
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.
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
19 * Sebastian Harl <sh at tokkee.org>
23 * This plugin communicates with a spam filter, a virus scanner or similar
24 * software using a UNIX socket and a very simple protocol:
26 * e-mail type (e.g. ham, spam, virus, ...) and size
32 * successful spam checks
33 * c:<type1>[,<type2>,...]
40 #include "configfile.h"
48 #include <sys/socket.h>
50 #include <sys/select.h>
52 /* some systems (e.g. Darwin) seem to not define UNIX_PATH_MAX at all */
54 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
55 #endif /* UNIX_PATH_MAX */
59 #endif /* HAVE_GRP_H */
61 #define SOCK_PATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-email"
63 #define MAX_CONNS_LIMIT 16384
65 #define log_debug(...) DEBUG ("email: "__VA_ARGS__)
66 #define log_err(...) ERROR ("email: "__VA_ARGS__)
67 #define log_warn(...) WARNING ("email: "__VA_ARGS__)
70 * Private data structures
72 /* linked list of email and check types */
84 /* collector thread control information */
85 typedef struct collector {
88 /* socket descriptor of the current/last connection */
92 /* linked list of pending connections */
94 /* socket to read data from */
97 /* linked list of connections */
109 /* valid configuration file keys */
110 static const char *config_keys[] =
117 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
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;
125 /* state of the plugin */
126 static int disabled = 0;
128 /* thread managing "client" connections */
129 static pthread_t connector = (pthread_t) 0;
130 static int connector_socket = -1;
132 /* tell the collector threads that a new connection is available */
133 static pthread_cond_t conn_available = PTHREAD_COND_INITIALIZER;
135 /* connections that are waiting to be processed */
136 static pthread_mutex_t conns_mutex = PTHREAD_MUTEX_INITIALIZER;
137 static conn_list_t conns;
139 /* tell the connector thread that a collector is available */
140 static pthread_cond_t collector_available = PTHREAD_COND_INITIALIZER;
142 /* collector threads */
143 static collector_t **collectors = NULL;
145 static pthread_mutex_t available_mutex = PTHREAD_MUTEX_INITIALIZER;
146 static int available_collectors;
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;
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;
156 static pthread_mutex_t score_mutex = PTHREAD_MUTEX_INITIALIZER;
158 static int score_count;
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;
167 static int email_config (const char *key, const char *value)
169 if (0 == strcasecmp (key, "SocketFile")) {
170 if (NULL != sock_file)
172 sock_file = sstrdup (value);
174 else if (0 == strcasecmp (key, "SocketGroup")) {
175 if (NULL != sock_group)
177 sock_group = sstrdup (value);
179 else if (0 == strcasecmp (key, "SocketPerms")) {
180 /* the user is responsible for providing reasonable values */
181 sock_perms = (int)strtol (value, NULL, 8);
183 else if (0 == strcasecmp (key, "MaxConns")) {
184 long int tmp = strtol (value, NULL, 0);
187 fprintf (stderr, "email plugin: `MaxConns' was set to invalid "
188 "value %li, will use default %i.\n",
190 ERROR ("email plugin: `MaxConns' was set to invalid "
191 "value %li, will use default %i.\n",
193 max_conns = MAX_CONNS;
195 else if (tmp > MAX_CONNS_LIMIT) {
196 fprintf (stderr, "email plugin: `MaxConns' was set to invalid "
197 "value %li, will use hardcoded limit %i.\n",
198 tmp, MAX_CONNS_LIMIT);
199 ERROR ("email plugin: `MaxConns' was set to invalid "
200 "value %li, will use hardcoded limit %i.\n",
201 tmp, MAX_CONNS_LIMIT);
202 max_conns = MAX_CONNS_LIMIT;
205 max_conns = (int)tmp;
212 } /* static int email_config (char *, char *) */
214 /* Increment the value of the given name in the given list by incr. */
215 static void type_list_incr (type_list_t *list, char *name, int incr)
217 if (NULL == list->head) {
218 list->head = (type_t *)smalloc (sizeof (type_t));
220 list->head->name = sstrdup (name);
221 list->head->value = incr;
222 list->head->next = NULL;
224 list->tail = list->head;
229 for (ptr = list->head; NULL != ptr; ptr = ptr->next) {
230 if (0 == strcmp (name, ptr->name))
235 list->tail->next = (type_t *)smalloc (sizeof (type_t));
236 list->tail = list->tail->next;
238 list->tail->name = sstrdup (name);
239 list->tail->value = incr;
240 list->tail->next = NULL;
247 } /* static void type_list_incr (type_list_t *, char *) */
249 static void *collect (void *arg)
251 collector_t *this = (collector_t *)arg;
256 pthread_mutex_lock (&conns_mutex);
258 while (NULL == conns.head) {
259 pthread_cond_wait (&conn_available, &conns_mutex);
262 connection = conns.head;
263 conns.head = conns.head->next;
265 if (NULL == conns.head) {
269 pthread_mutex_unlock (&conns_mutex);
271 /* make the socket available to the global
272 * thread and connection management */
273 this->socket = connection->socket;
275 log_debug ("collect: handling connection on fd #%i",
276 fileno (this->socket));
279 /* 256 bytes ought to be enough for anybody ;-) */
280 char line[256 + 1]; /* line + '\0' */
284 if (NULL == fgets (line, sizeof (line), this->socket)) {
287 log_err ("collect: reading from socket (fd #%i) "
288 "failed: %s", fileno (this->socket),
289 sstrerror (errno, errbuf, sizeof (errbuf)));
295 if (('\n' != line[len - 1]) && ('\r' != line[len - 1])) {
296 log_warn ("collect: line too long (> %zu characters): "
297 "'%s' (truncated)", sizeof (line) - 1, line);
299 while (NULL != fgets (line, sizeof (line), this->socket))
300 if (('\n' == line[len - 1]) || ('\r' == line[len - 1]))
305 line[len - 1] = '\0';
307 log_debug ("collect: line = '%s'", line);
309 if (':' != line[1]) {
310 log_err ("collect: syntax error in line '%s'", line);
314 if ('e' == line[0]) { /* e:<type>:<bytes> */
316 char *type = strtok_r (line + 2, ":", &ptr);
317 char *tmp = strtok_r (NULL, ":", &ptr);
321 log_err ("collect: syntax error in line '%s'", line);
327 pthread_mutex_lock (&count_mutex);
328 type_list_incr (&list_count, type, 1);
329 pthread_mutex_unlock (&count_mutex);
332 pthread_mutex_lock (&size_mutex);
333 type_list_incr (&list_size, type, bytes);
334 pthread_mutex_unlock (&size_mutex);
337 else if ('s' == line[0]) { /* s:<value> */
338 pthread_mutex_lock (&score_mutex);
339 score = (score * (double)score_count + atof (line + 2))
340 / (double)(score_count + 1);
342 pthread_mutex_unlock (&score_mutex);
344 else if ('c' == line[0]) { /* c:<type1>[,<type2>,...] */
346 char *type = strtok_r (line + 2, ",", &ptr);
349 pthread_mutex_lock (&check_mutex);
350 type_list_incr (&list_check, type, 1);
351 pthread_mutex_unlock (&check_mutex);
352 } while (NULL != (type = strtok_r (NULL, ",", &ptr)));
355 log_err ("collect: unknown type '%c'", line[0]);
359 log_debug ("Shutting down connection on fd #%i",
360 fileno (this->socket));
362 fclose (connection->socket);
367 pthread_mutex_lock (&available_mutex);
368 ++available_collectors;
369 pthread_mutex_unlock (&available_mutex);
371 pthread_cond_signal (&collector_available);
374 pthread_exit ((void *)0);
376 } /* static void *collect (void *) */
378 static void *open_connection (void __attribute__((unused)) *arg)
380 struct sockaddr_un addr;
382 char *path = (NULL == sock_file) ? SOCK_PATH : sock_file;
383 char *group = (NULL == sock_group) ? COLLECTD_GRP_NAME : sock_group;
385 /* create UNIX socket */
387 if (-1 == (connector_socket = socket (PF_UNIX, SOCK_STREAM, 0))) {
390 log_err ("socket() failed: %s",
391 sstrerror (errno, errbuf, sizeof (errbuf)));
392 pthread_exit ((void *)1);
395 addr.sun_family = AF_UNIX;
396 sstrncpy (addr.sun_path, path, (size_t)(UNIX_PATH_MAX - 1));
399 if (-1 == bind (connector_socket, (struct sockaddr *)&addr,
400 offsetof (struct sockaddr_un, sun_path)
401 + strlen(addr.sun_path))) {
404 close (connector_socket);
405 connector_socket = -1;
406 log_err ("bind() failed: %s",
407 sstrerror (errno, errbuf, sizeof (errbuf)));
408 pthread_exit ((void *)1);
412 if (-1 == listen (connector_socket, 5)) {
415 close (connector_socket);
416 connector_socket = -1;
417 log_err ("listen() failed: %s",
418 sstrerror (errno, errbuf, sizeof (errbuf)));
419 pthread_exit ((void *)1);
429 status = getgrnam_r (group, &sg, grbuf, sizeof (grbuf), &grp);
433 log_warn ("getgrnam_r (%s) failed: %s", group,
434 sstrerror (errno, errbuf, sizeof (errbuf)));
436 else if (grp == NULL)
438 log_warn ("No such group: `%s'", group);
442 status = chown (path, (uid_t) -1, grp->gr_gid);
446 log_warn ("chown (%s, -1, %i) failed: %s",
447 path, (int) grp->gr_gid,
448 sstrerror (errno, errbuf, sizeof (errbuf)));
454 if (0 != chmod (path, sock_perms)) {
456 log_warn ("chmod() failed: %s",
457 sstrerror (errno, errbuf, sizeof (errbuf)));
460 { /* initialize collector threads */
464 pthread_attr_t ptattr;
469 pthread_attr_init (&ptattr);
470 pthread_attr_setdetachstate (&ptattr, PTHREAD_CREATE_DETACHED);
472 available_collectors = max_conns;
475 (collector_t **)smalloc (max_conns * sizeof (collector_t *));
477 for (i = 0; i < max_conns; ++i) {
478 collectors[i] = (collector_t *)smalloc (sizeof (collector_t));
479 collectors[i]->socket = NULL;
481 if (0 != (err = plugin_thread_create (&collectors[i]->thread,
482 &ptattr, collect, collectors[i]))) {
484 log_err ("pthread_create() failed: %s",
485 sstrerror (errno, errbuf, sizeof (errbuf)));
486 collectors[i]->thread = (pthread_t) 0;
490 pthread_attr_destroy (&ptattr);
498 pthread_mutex_lock (&available_mutex);
500 while (0 == available_collectors) {
501 pthread_cond_wait (&collector_available, &available_mutex);
504 --available_collectors;
506 pthread_mutex_unlock (&available_mutex);
511 remote = accept (connector_socket, NULL, NULL);
519 close (connector_socket);
520 connector_socket = -1;
521 log_err ("accept() failed: %s",
522 sstrerror (errno, errbuf, sizeof (errbuf)));
523 pthread_exit ((void *)1);
526 /* access() succeeded. */
530 connection = malloc (sizeof (*connection));
531 if (connection != NULL)
536 memset (connection, 0, sizeof (*connection));
538 connection->socket = fdopen (remote, "r");
539 connection->next = NULL;
541 if (NULL == connection->socket) {
547 pthread_mutex_lock (&conns_mutex);
549 if (NULL == conns.head) {
550 conns.head = connection;
551 conns.tail = connection;
554 conns.tail->next = connection;
555 conns.tail = conns.tail->next;
558 pthread_mutex_unlock (&conns_mutex);
560 pthread_cond_signal (&conn_available);
563 pthread_exit ((void *) 0);
565 } /* static void *open_connection (void *) */
567 static int email_init (void)
571 if (0 != (err = plugin_thread_create (&connector, NULL,
572 open_connection, NULL))) {
575 log_err ("pthread_create() failed: %s",
576 sstrerror (errno, errbuf, sizeof (errbuf)));
581 } /* int email_init */
583 static void type_list_free (type_list_t *t)
590 type_t *next = this->next;
602 static int email_shutdown (void)
606 if (connector != ((pthread_t) 0)) {
607 pthread_kill (connector, SIGTERM);
608 connector = (pthread_t) 0;
611 if (connector_socket >= 0) {
612 close (connector_socket);
613 connector_socket = -1;
616 /* don't allow any more connections to be processed */
617 pthread_mutex_lock (&conns_mutex);
619 available_collectors = 0;
621 if (collectors != NULL) {
622 for (i = 0; i < max_conns; ++i) {
623 if (collectors[i] == NULL)
626 if (collectors[i]->thread != ((pthread_t) 0)) {
627 pthread_kill (collectors[i]->thread, SIGTERM);
628 collectors[i]->thread = (pthread_t) 0;
631 if (collectors[i]->socket != NULL) {
632 fclose (collectors[i]->socket);
633 collectors[i]->socket = NULL;
636 sfree (collectors[i]);
639 } /* if (collectors != NULL) */
641 pthread_mutex_unlock (&conns_mutex);
643 type_list_free (&list_count);
644 type_list_free (&list_count_copy);
645 type_list_free (&list_size);
646 type_list_free (&list_size_copy);
647 type_list_free (&list_check);
648 type_list_free (&list_check_copy);
650 unlink ((NULL == sock_file) ? SOCK_PATH : sock_file);
655 } /* static void email_shutdown (void) */
657 static void email_submit (const char *type, const char *type_instance, gauge_t value)
660 value_list_t vl = VALUE_LIST_INIT;
662 values[0].gauge = value;
666 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
667 sstrncpy (vl.plugin, "email", sizeof (vl.plugin));
668 sstrncpy (vl.type, type, sizeof (vl.type));
669 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
671 plugin_dispatch_values (&vl);
672 } /* void email_submit */
674 /* Copy list l1 to list l2. l2 may partly exist already, but it is assumed
675 * that neither the order nor the name of any element of either list is
676 * changed and no elements are deleted. The values of l1 are reset to zero
677 * after they have been copied to l2. */
678 static void copy_type_list (type_list_t *l1, type_list_t *l2)
685 for (ptr1 = l1->head, ptr2 = l2->head; NULL != ptr1;
686 ptr1 = ptr1->next, last = ptr2, ptr2 = ptr2->next) {
688 ptr2 = (type_t *)smalloc (sizeof (type_t));
702 if (NULL == ptr2->name) {
703 ptr2->name = sstrdup (ptr1->name);
706 ptr2->value = ptr1->value;
712 static int email_read (void)
723 pthread_mutex_lock (&count_mutex);
725 copy_type_list (&list_count, &list_count_copy);
727 pthread_mutex_unlock (&count_mutex);
729 for (ptr = list_count_copy.head; NULL != ptr; ptr = ptr->next) {
730 email_submit ("email_count", ptr->name, ptr->value);
734 pthread_mutex_lock (&size_mutex);
736 copy_type_list (&list_size, &list_size_copy);
738 pthread_mutex_unlock (&size_mutex);
740 for (ptr = list_size_copy.head; NULL != ptr; ptr = ptr->next) {
741 email_submit ("email_size", ptr->name, ptr->value);
745 pthread_mutex_lock (&score_mutex);
748 score_count_old = score_count;
752 pthread_mutex_unlock (&score_mutex);
754 if (score_count_old > 0)
755 email_submit ("spam_score", "", score_old);
758 pthread_mutex_lock (&check_mutex);
760 copy_type_list (&list_check, &list_check_copy);
762 pthread_mutex_unlock (&check_mutex);
764 for (ptr = list_check_copy.head; NULL != ptr; ptr = ptr->next)
765 email_submit ("spam_check", ptr->name, ptr->value);
768 } /* int email_read */
770 void module_register (void)
772 plugin_register_config ("email", email_config, config_keys, config_keys_num);
773 plugin_register_init ("email", email_init);
774 plugin_register_read ("email", email_read);
775 plugin_register_shutdown ("email", email_shutdown);
776 } /* void module_register */
778 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */