2 * collectd - src/email.c
3 * Copyright (C) 2006-2008 Sebastian Harl
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Sebastian Harl <sh at tokkee.org>
28 * This plugin communicates with a spam filter, a virus scanner or similar
29 * software using a UNIX socket and a very simple protocol:
31 * e-mail type (e.g. ham, spam, virus, ...) and size
37 * successful spam checks
38 * c:<type1>[,<type2>,...]
44 #include "utils/common/common.h"
48 #include <sys/select.h>
51 /* some systems (e.g. Darwin) seem to not define UNIX_PATH_MAX at all */
53 #define UNIX_PATH_MAX sizeof(((struct sockaddr_un *)0)->sun_path)
54 #endif /* UNIX_PATH_MAX */
58 #endif /* HAVE_GRP_H */
60 #define SOCK_PATH LOCALSTATEDIR "/run/" PACKAGE_NAME "-email"
62 #define MAX_CONNS_LIMIT 16384
64 #define log_debug(...) DEBUG("email: "__VA_ARGS__)
65 #define log_err(...) ERROR("email: "__VA_ARGS__)
66 #define log_warn(...) WARNING("email: "__VA_ARGS__)
69 * Private data structures
71 /* linked list of email and check types */
83 /* collector thread control information */
84 typedef struct collector {
87 /* socket descriptor of the current/last connection */
91 /* linked list of pending connections */
93 /* socket to read data from */
96 /* linked list of connections */
108 /* valid configuration file keys */
109 static const char *config_keys[] = {"SocketFile", "SocketGroup", "SocketPerms",
111 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
113 /* socket configuration */
114 static char *sock_file;
115 static char *sock_group;
116 static int sock_perms = S_IRWXU | S_IRWXG;
117 static int max_conns = MAX_CONNS;
119 /* state of the plugin */
122 /* thread managing "client" connections */
123 static pthread_t connector = (pthread_t)0;
124 static int connector_socket = -1;
126 /* tell the collector threads that a new connection is available */
127 static pthread_cond_t conn_available = PTHREAD_COND_INITIALIZER;
129 /* connections that are waiting to be processed */
130 static pthread_mutex_t conns_mutex = PTHREAD_MUTEX_INITIALIZER;
131 static conn_list_t conns;
133 /* tell the connector thread that a collector is available */
134 static pthread_cond_t collector_available = PTHREAD_COND_INITIALIZER;
136 /* collector threads */
137 static collector_t **collectors;
139 static pthread_mutex_t available_mutex = PTHREAD_MUTEX_INITIALIZER;
140 static int available_collectors;
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;
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;
150 static pthread_mutex_t score_mutex = PTHREAD_MUTEX_INITIALIZER;
152 static int score_count;
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;
161 static int email_config(const char *key, const char *value) {
162 if (strcasecmp(key, "SocketFile") == 0) {
163 if (sock_file != NULL)
165 sock_file = sstrdup(value);
166 } else if (strcasecmp(key, "SocketGroup") == 0) {
167 if (sock_group != NULL)
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);
178 "email plugin: `MaxConns' was set to invalid "
179 "value %li, will use default %i.\n",
181 ERROR("email plugin: `MaxConns' was set to invalid "
182 "value %li, will use default %i.\n",
184 max_conns = MAX_CONNS;
185 } else if (tmp > MAX_CONNS_LIMIT) {
187 "email plugin: `MaxConns' was set to invalid "
188 "value %li, will use hardcoded limit %i.\n",
189 tmp, MAX_CONNS_LIMIT);
190 ERROR("email plugin: `MaxConns' was set to invalid "
191 "value %li, will use hardcoded limit %i.\n",
192 tmp, MAX_CONNS_LIMIT);
193 max_conns = MAX_CONNS_LIMIT;
195 max_conns = (int)tmp;
201 } /* static int email_config (char *, char *) */
203 /* Increment the value of the given name in the given list by incr. */
204 static void type_list_incr(type_list_t *list, char *name, int incr) {
205 if (list->head == NULL) {
206 list->head = smalloc(sizeof(*list->head));
208 list->head->name = sstrdup(name);
209 list->head->value = incr;
210 list->head->next = NULL;
212 list->tail = list->head;
216 for (ptr = list->head; NULL != ptr; ptr = ptr->next) {
217 if (strcmp(name, ptr->name) == 0)
222 list->tail->next = smalloc(sizeof(*list->tail->next));
223 list->tail = list->tail->next;
225 list->tail->name = sstrdup(name);
226 list->tail->value = incr;
227 list->tail->next = NULL;
233 } /* static void type_list_incr (type_list_t *, char *) */
235 static void *collect(void *arg) {
236 collector_t *this = (collector_t *)arg;
241 pthread_mutex_lock(&conns_mutex);
243 while (conns.head == NULL) {
244 pthread_cond_wait(&conn_available, &conns_mutex);
247 connection = conns.head;
248 conns.head = conns.head->next;
250 if (conns.head == NULL) {
254 pthread_mutex_unlock(&conns_mutex);
256 /* make the socket available to the global
257 * thread and connection management */
258 this->socket = connection->socket;
260 log_debug("collect: handling connection on fd #%i", fileno(this->socket));
263 /* 256 bytes ought to be enough for anybody ;-) */
264 char line[256 + 1]; /* line + '\0' */
267 if (fgets(line, sizeof(line), this->socket) == NULL) {
269 log_err("collect: reading from socket (fd #%i) "
271 fileno(this->socket), STRERRNO);
276 size_t len = strlen(line);
277 if ((line[len - 1] != '\n') && (line[len - 1] != '\r')) {
278 log_warn("collect: line too long (> %" PRIsz " characters): "
280 sizeof(line) - 1, line);
282 while (fgets(line, sizeof(line), this->socket) != NULL)
283 if ((line[len - 1] == '\n') || (line[len - 1] == '\r'))
287 if (len < 3) { /* [a-z] ':' '\n' */
291 line[len - 1] = '\0';
293 log_debug("collect: line = '%s'", line);
295 if (line[1] != ':') {
296 log_err("collect: syntax error in line '%s'", line);
300 if (line[0] == 'e') { /* e:<type>:<bytes> */
301 char *type = line + 2;
302 char *bytes_str = strchr(type, ':');
303 if (bytes_str == NULL) {
304 log_err("collect: syntax error in line '%s'", line);
311 pthread_mutex_lock(&count_mutex);
312 type_list_incr(&list_count, type, /* increment = */ 1);
313 pthread_mutex_unlock(&count_mutex);
315 int bytes = atoi(bytes_str);
317 pthread_mutex_lock(&size_mutex);
318 type_list_incr(&list_size, type, /* increment = */ bytes);
319 pthread_mutex_unlock(&size_mutex);
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);
326 pthread_mutex_unlock(&score_mutex);
327 } else if (line[0] == 'c') { /* c:<type1>[,<type2>,...] */
328 char *dummy = line + 2;
332 pthread_mutex_lock(&check_mutex);
333 while ((type = strtok_r(dummy, ",", &endptr)) != NULL) {
335 type_list_incr(&list_check, type, /* increment = */ 1);
337 pthread_mutex_unlock(&check_mutex);
339 log_err("collect: unknown type '%c'", line[0]);
343 log_debug("Shutting down connection on fd #%i", fileno(this->socket));
345 fclose(connection->socket);
350 pthread_mutex_lock(&available_mutex);
351 ++available_collectors;
352 pthread_mutex_unlock(&available_mutex);
354 pthread_cond_signal(&collector_available);
357 pthread_exit((void *)0);
359 } /* static void *collect (void *) */
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;
365 /* create UNIX socket */
367 if ((connector_socket = socket(PF_UNIX, SOCK_STREAM, 0)) == -1) {
369 log_err("socket() failed: %s", STRERRNO);
370 pthread_exit((void *)1);
373 struct sockaddr_un addr = {
374 .sun_family = AF_UNIX,
376 sstrncpy(addr.sun_path, path, (size_t)(UNIX_PATH_MAX - 1));
379 if (bind(connector_socket, (struct sockaddr *)&addr,
380 offsetof(struct sockaddr_un, sun_path) + strlen(addr.sun_path)) ==
383 close(connector_socket);
384 connector_socket = -1;
385 log_err("bind() failed: %s", STRERRNO);
386 pthread_exit((void *)1);
390 if (listen(connector_socket, 5) == -1) {
392 close(connector_socket);
393 connector_socket = -1;
394 log_err("listen() failed: %s", STRERRNO);
395 pthread_exit((void *)1);
403 long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
405 grbuf_size = sysconf(_SC_PAGESIZE);
408 char grbuf[grbuf_size];
411 status = getgrnam_r(group, &sg, grbuf, sizeof(grbuf), &grp);
413 log_warn("getgrnam_r (%s) failed: %s", group, STRERROR(status));
414 } else if (grp == NULL) {
415 log_warn("No such group: `%s'", group);
417 status = chown(path, (uid_t)-1, grp->gr_gid);
419 log_warn("chown (%s, -1, %i) failed: %s", path, (int)grp->gr_gid,
426 if (chmod(path, sock_perms) != 0) {
427 log_warn("chmod() failed: %s", STRERRNO);
430 { /* initialize collector threads */
431 pthread_attr_t ptattr;
436 pthread_attr_init(&ptattr);
437 pthread_attr_setdetachstate(&ptattr, PTHREAD_CREATE_DETACHED);
439 available_collectors = max_conns;
441 collectors = smalloc(max_conns * sizeof(*collectors));
443 for (int i = 0; i < max_conns; ++i) {
444 collectors[i] = smalloc(sizeof(*collectors[i]));
445 collectors[i]->socket = NULL;
447 if (plugin_thread_create(&collectors[i]->thread, &ptattr, collect,
448 collectors[i], "email collector") != 0) {
449 log_err("plugin_thread_create() failed: %s", STRERRNO);
450 collectors[i]->thread = (pthread_t)0;
454 pthread_attr_destroy(&ptattr);
462 pthread_mutex_lock(&available_mutex);
464 while (available_collectors == 0) {
465 pthread_cond_wait(&collector_available, &available_mutex);
468 --available_collectors;
470 pthread_mutex_unlock(&available_mutex);
475 remote = accept(connector_socket, NULL, NULL);
481 close(connector_socket);
482 connector_socket = -1;
483 log_err("accept() failed: %s", STRERRNO);
484 pthread_exit((void *)1);
487 /* access() succeeded. */
491 connection = calloc(1, sizeof(*connection));
492 if (connection == NULL) {
497 connection->socket = fdopen(remote, "r");
498 connection->next = NULL;
500 if (connection->socket == NULL) {
506 pthread_mutex_lock(&conns_mutex);
508 if (conns.head == NULL) {
509 conns.head = connection;
510 conns.tail = connection;
512 conns.tail->next = connection;
513 conns.tail = conns.tail->next;
516 pthread_mutex_unlock(&conns_mutex);
518 pthread_cond_signal(&conn_available);
521 pthread_exit((void *)0);
523 } /* static void *open_connection (void *) */
525 static int email_init(void) {
526 if (plugin_thread_create(&connector, NULL, open_connection, NULL,
527 "email listener") != 0) {
529 log_err("plugin_thread_create() failed: %s", STRERRNO);
534 } /* int email_init */
536 static void type_list_free(type_list_t *t) {
540 while (this != NULL) {
541 type_t *next = this->next;
553 static int email_shutdown(void) {
554 if (connector != ((pthread_t)0)) {
555 pthread_kill(connector, SIGTERM);
556 connector = (pthread_t)0;
559 if (connector_socket >= 0) {
560 close(connector_socket);
561 connector_socket = -1;
564 /* don't allow any more connections to be processed */
565 pthread_mutex_lock(&conns_mutex);
567 available_collectors = 0;
569 if (collectors != NULL) {
570 for (int i = 0; i < max_conns; ++i) {
571 if (collectors[i] == NULL)
574 if (collectors[i]->thread != ((pthread_t)0)) {
575 pthread_kill(collectors[i]->thread, SIGTERM);
576 collectors[i]->thread = (pthread_t)0;
579 if (collectors[i]->socket != NULL) {
580 fclose(collectors[i]->socket);
581 collectors[i]->socket = NULL;
584 sfree(collectors[i]);
587 } /* if (collectors != NULL) */
589 pthread_mutex_unlock(&conns_mutex);
591 type_list_free(&list_count);
592 type_list_free(&list_count_copy);
593 type_list_free(&list_size);
594 type_list_free(&list_size_copy);
595 type_list_free(&list_check);
596 type_list_free(&list_check_copy);
598 unlink((sock_file == NULL) ? SOCK_PATH : sock_file);
603 } /* static void email_shutdown (void) */
605 static void email_submit(const char *type, const char *type_instance,
607 value_list_t vl = VALUE_LIST_INIT;
609 vl.values = &(value_t){.gauge = value};
611 sstrncpy(vl.plugin, "email", sizeof(vl.plugin));
612 sstrncpy(vl.type, type, sizeof(vl.type));
613 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
615 plugin_dispatch_values(&vl);
616 } /* void email_submit */
618 /* Copy list l1 to list l2. l2 may partly exist already, but it is assumed
619 * that neither the order nor the name of any element of either list is
620 * changed and no elements are deleted. The values of l1 are reset to zero
621 * after they have been copied to l2. */
622 static void copy_type_list(type_list_t *l1, type_list_t *l2) {
625 for (type_t *ptr1 = l1->head, *ptr2 = l2->head; ptr1 != NULL;
626 ptr1 = ptr1->next, last = ptr2, ptr2 = ptr2->next) {
628 ptr2 = smalloc(sizeof(*ptr2));
641 if (ptr2->name == NULL) {
642 ptr2->name = sstrdup(ptr1->name);
645 ptr2->value = ptr1->value;
651 static int email_read(void) {
659 pthread_mutex_lock(&count_mutex);
661 copy_type_list(&list_count, &list_count_copy);
663 pthread_mutex_unlock(&count_mutex);
665 for (type_t *ptr = list_count_copy.head; ptr != NULL; ptr = ptr->next) {
666 email_submit("email_count", ptr->name, ptr->value);
670 pthread_mutex_lock(&size_mutex);
672 copy_type_list(&list_size, &list_size_copy);
674 pthread_mutex_unlock(&size_mutex);
676 for (type_t *ptr = list_size_copy.head; ptr != NULL; ptr = ptr->next) {
677 email_submit("email_size", ptr->name, ptr->value);
681 pthread_mutex_lock(&score_mutex);
684 score_count_old = score_count;
688 pthread_mutex_unlock(&score_mutex);
690 if (score_count_old > 0)
691 email_submit("spam_score", "", score_old);
694 pthread_mutex_lock(&check_mutex);
696 copy_type_list(&list_check, &list_check_copy);
698 pthread_mutex_unlock(&check_mutex);
700 for (type_t *ptr = list_check_copy.head; ptr != NULL; ptr = ptr->next)
701 email_submit("spam_check", ptr->name, ptr->value);
704 } /* int email_read */
706 void module_register(void) {
707 plugin_register_config("email", email_config, config_keys, config_keys_num);
708 plugin_register_init("email", email_init);
709 plugin_register_read("email", email_read);
710 plugin_register_shutdown("email", email_shutdown);
711 } /* void module_register */