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>,...]
45 #include "configfile.h"
54 #include <sys/select.h>
56 /* some systems (e.g. Darwin) seem to not define UNIX_PATH_MAX at all */
58 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
59 #endif /* UNIX_PATH_MAX */
63 #endif /* HAVE_GRP_H */
65 #define SOCK_PATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-email"
67 #define MAX_CONNS_LIMIT 16384
69 #define log_debug(...) DEBUG ("email: "__VA_ARGS__)
70 #define log_err(...) ERROR ("email: "__VA_ARGS__)
71 #define log_warn(...) WARNING ("email: "__VA_ARGS__)
74 * Private data structures
76 /* linked list of email and check types */
88 /* collector thread control information */
89 typedef struct collector {
92 /* socket descriptor of the current/last connection */
96 /* linked list of pending connections */
98 /* socket to read data from */
101 /* linked list of connections */
113 /* valid configuration file keys */
114 static const char *config_keys[] =
121 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
123 /* socket configuration */
124 static char *sock_file = NULL;
125 static char *sock_group = NULL;
126 static int sock_perms = S_IRWXU | S_IRWXG;
127 static int max_conns = MAX_CONNS;
129 /* state of the plugin */
130 static int disabled = 0;
132 /* thread managing "client" connections */
133 static pthread_t connector = (pthread_t) 0;
134 static int connector_socket = -1;
136 /* tell the collector threads that a new connection is available */
137 static pthread_cond_t conn_available = PTHREAD_COND_INITIALIZER;
139 /* connections that are waiting to be processed */
140 static pthread_mutex_t conns_mutex = PTHREAD_MUTEX_INITIALIZER;
141 static conn_list_t conns;
143 /* tell the connector thread that a collector is available */
144 static pthread_cond_t collector_available = PTHREAD_COND_INITIALIZER;
146 /* collector threads */
147 static collector_t **collectors = NULL;
149 static pthread_mutex_t available_mutex = PTHREAD_MUTEX_INITIALIZER;
150 static int available_collectors;
152 static pthread_mutex_t count_mutex = PTHREAD_MUTEX_INITIALIZER;
153 static type_list_t list_count;
154 static type_list_t list_count_copy;
156 static pthread_mutex_t size_mutex = PTHREAD_MUTEX_INITIALIZER;
157 static type_list_t list_size;
158 static type_list_t list_size_copy;
160 static pthread_mutex_t score_mutex = PTHREAD_MUTEX_INITIALIZER;
162 static int score_count;
164 static pthread_mutex_t check_mutex = PTHREAD_MUTEX_INITIALIZER;
165 static type_list_t list_check;
166 static type_list_t list_check_copy;
171 static int email_config (const char *key, const char *value)
173 if (0 == strcasecmp (key, "SocketFile")) {
174 if (NULL != sock_file)
176 sock_file = sstrdup (value);
178 else if (0 == strcasecmp (key, "SocketGroup")) {
179 if (NULL != sock_group)
181 sock_group = sstrdup (value);
183 else if (0 == strcasecmp (key, "SocketPerms")) {
184 /* the user is responsible for providing reasonable values */
185 sock_perms = (int)strtol (value, NULL, 8);
187 else if (0 == strcasecmp (key, "MaxConns")) {
188 long int tmp = strtol (value, NULL, 0);
191 fprintf (stderr, "email plugin: `MaxConns' was set to invalid "
192 "value %li, will use default %i.\n",
194 ERROR ("email plugin: `MaxConns' was set to invalid "
195 "value %li, will use default %i.\n",
197 max_conns = MAX_CONNS;
199 else if (tmp > MAX_CONNS_LIMIT) {
200 fprintf (stderr, "email plugin: `MaxConns' was set to invalid "
201 "value %li, will use hardcoded limit %i.\n",
202 tmp, MAX_CONNS_LIMIT);
203 ERROR ("email plugin: `MaxConns' was set to invalid "
204 "value %li, will use hardcoded limit %i.\n",
205 tmp, MAX_CONNS_LIMIT);
206 max_conns = MAX_CONNS_LIMIT;
209 max_conns = (int)tmp;
216 } /* static int email_config (char *, char *) */
218 /* Increment the value of the given name in the given list by incr. */
219 static void type_list_incr (type_list_t *list, char *name, int incr)
221 if (NULL == list->head) {
222 list->head = (type_t *)smalloc (sizeof (type_t));
224 list->head->name = sstrdup (name);
225 list->head->value = incr;
226 list->head->next = NULL;
228 list->tail = list->head;
233 for (ptr = list->head; NULL != ptr; ptr = ptr->next) {
234 if (0 == strcmp (name, ptr->name))
239 list->tail->next = (type_t *)smalloc (sizeof (type_t));
240 list->tail = list->tail->next;
242 list->tail->name = sstrdup (name);
243 list->tail->value = incr;
244 list->tail->next = NULL;
251 } /* static void type_list_incr (type_list_t *, char *) */
253 static void *collect (void *arg)
255 collector_t *this = (collector_t *)arg;
260 pthread_mutex_lock (&conns_mutex);
262 while (NULL == conns.head) {
263 pthread_cond_wait (&conn_available, &conns_mutex);
266 connection = conns.head;
267 conns.head = conns.head->next;
269 if (NULL == conns.head) {
273 pthread_mutex_unlock (&conns_mutex);
275 /* make the socket available to the global
276 * thread and connection management */
277 this->socket = connection->socket;
279 log_debug ("collect: handling connection on fd #%i",
280 fileno (this->socket));
283 /* 256 bytes ought to be enough for anybody ;-) */
284 char line[256 + 1]; /* line + '\0' */
288 if (NULL == fgets (line, sizeof (line), this->socket)) {
291 log_err ("collect: reading from socket (fd #%i) "
292 "failed: %s", fileno (this->socket),
293 sstrerror (errno, errbuf, sizeof (errbuf)));
299 if (('\n' != line[len - 1]) && ('\r' != line[len - 1])) {
300 log_warn ("collect: line too long (> %zu characters): "
301 "'%s' (truncated)", sizeof (line) - 1, line);
303 while (NULL != fgets (line, sizeof (line), this->socket))
304 if (('\n' == line[len - 1]) || ('\r' == line[len - 1]))
308 if (len < 3) { /* [a-z] ':' '\n' */
314 log_debug ("collect: line = '%s'", line);
316 if (':' != line[1]) {
317 log_err ("collect: syntax error in line '%s'", line);
321 if ('e' == line[0]) { /* e:<type>:<bytes> */
323 char *type = strtok_r (line + 2, ":", &ptr);
324 char *tmp = strtok_r (NULL, ":", &ptr);
328 log_err ("collect: syntax error in line '%s'", line);
334 pthread_mutex_lock (&count_mutex);
335 type_list_incr (&list_count, type, /* increment = */ 1);
336 pthread_mutex_unlock (&count_mutex);
339 pthread_mutex_lock (&size_mutex);
340 type_list_incr (&list_size, type, /* increment = */ bytes);
341 pthread_mutex_unlock (&size_mutex);
344 else if ('s' == line[0]) { /* s:<value> */
345 pthread_mutex_lock (&score_mutex);
346 score = (score * (double)score_count + atof (line + 2))
347 / (double)(score_count + 1);
349 pthread_mutex_unlock (&score_mutex);
351 else if ('c' == line[0]) { /* c:<type1>[,<type2>,...] */
352 char *dummy = line + 2;
356 pthread_mutex_lock (&check_mutex);
357 while ((type = strtok_r (dummy, ",", &endptr)) != NULL)
360 type_list_incr (&list_check, type, /* increment = */ 1);
362 pthread_mutex_unlock (&check_mutex);
365 log_err ("collect: unknown type '%c'", line[0]);
369 log_debug ("Shutting down connection on fd #%i",
370 fileno (this->socket));
372 fclose (connection->socket);
377 pthread_mutex_lock (&available_mutex);
378 ++available_collectors;
379 pthread_mutex_unlock (&available_mutex);
381 pthread_cond_signal (&collector_available);
384 pthread_exit ((void *)0);
386 } /* static void *collect (void *) */
388 static void *open_connection (void __attribute__((unused)) *arg)
390 struct sockaddr_un addr;
392 const char *path = (NULL == sock_file) ? SOCK_PATH : sock_file;
393 const char *group = (NULL == sock_group) ? COLLECTD_GRP_NAME : sock_group;
395 /* create UNIX socket */
397 if (-1 == (connector_socket = socket (PF_UNIX, SOCK_STREAM, 0))) {
400 log_err ("socket() failed: %s",
401 sstrerror (errno, errbuf, sizeof (errbuf)));
402 pthread_exit ((void *)1);
405 addr.sun_family = AF_UNIX;
406 sstrncpy (addr.sun_path, path, (size_t)(UNIX_PATH_MAX - 1));
409 if (-1 == bind (connector_socket, (struct sockaddr *)&addr,
410 offsetof (struct sockaddr_un, sun_path)
411 + strlen(addr.sun_path))) {
414 close (connector_socket);
415 connector_socket = -1;
416 log_err ("bind() failed: %s",
417 sstrerror (errno, errbuf, sizeof (errbuf)));
418 pthread_exit ((void *)1);
422 if (-1 == listen (connector_socket, 5)) {
425 close (connector_socket);
426 connector_socket = -1;
427 log_err ("listen() failed: %s",
428 sstrerror (errno, errbuf, sizeof (errbuf)));
429 pthread_exit ((void *)1);
439 status = getgrnam_r (group, &sg, grbuf, sizeof (grbuf), &grp);
443 log_warn ("getgrnam_r (%s) failed: %s", group,
444 sstrerror (errno, errbuf, sizeof (errbuf)));
446 else if (grp == NULL)
448 log_warn ("No such group: `%s'", group);
452 status = chown (path, (uid_t) -1, grp->gr_gid);
456 log_warn ("chown (%s, -1, %i) failed: %s",
457 path, (int) grp->gr_gid,
458 sstrerror (errno, errbuf, sizeof (errbuf)));
464 if (0 != chmod (path, sock_perms)) {
466 log_warn ("chmod() failed: %s",
467 sstrerror (errno, errbuf, sizeof (errbuf)));
470 { /* initialize collector threads */
474 pthread_attr_t ptattr;
479 pthread_attr_init (&ptattr);
480 pthread_attr_setdetachstate (&ptattr, PTHREAD_CREATE_DETACHED);
482 available_collectors = max_conns;
485 (collector_t **)smalloc (max_conns * sizeof (collector_t *));
487 for (i = 0; i < max_conns; ++i) {
488 collectors[i] = (collector_t *)smalloc (sizeof (collector_t));
489 collectors[i]->socket = NULL;
491 if (0 != (err = plugin_thread_create (&collectors[i]->thread,
492 &ptattr, collect, collectors[i]))) {
494 log_err ("pthread_create() failed: %s",
495 sstrerror (errno, errbuf, sizeof (errbuf)));
496 collectors[i]->thread = (pthread_t) 0;
500 pthread_attr_destroy (&ptattr);
508 pthread_mutex_lock (&available_mutex);
510 while (0 == available_collectors) {
511 pthread_cond_wait (&collector_available, &available_mutex);
514 --available_collectors;
516 pthread_mutex_unlock (&available_mutex);
521 remote = accept (connector_socket, NULL, NULL);
529 close (connector_socket);
530 connector_socket = -1;
531 log_err ("accept() failed: %s",
532 sstrerror (errno, errbuf, sizeof (errbuf)));
533 pthread_exit ((void *)1);
536 /* access() succeeded. */
540 connection = malloc (sizeof (*connection));
541 if (connection == NULL)
546 memset (connection, 0, sizeof (*connection));
548 connection->socket = fdopen (remote, "r");
549 connection->next = NULL;
551 if (NULL == connection->socket) {
557 pthread_mutex_lock (&conns_mutex);
559 if (NULL == conns.head) {
560 conns.head = connection;
561 conns.tail = connection;
564 conns.tail->next = connection;
565 conns.tail = conns.tail->next;
568 pthread_mutex_unlock (&conns_mutex);
570 pthread_cond_signal (&conn_available);
573 pthread_exit ((void *) 0);
575 } /* static void *open_connection (void *) */
577 static int email_init (void)
581 if (0 != (err = plugin_thread_create (&connector, NULL,
582 open_connection, NULL))) {
585 log_err ("pthread_create() failed: %s",
586 sstrerror (errno, errbuf, sizeof (errbuf)));
591 } /* int email_init */
593 static void type_list_free (type_list_t *t)
600 type_t *next = this->next;
612 static int email_shutdown (void)
616 if (connector != ((pthread_t) 0)) {
617 pthread_kill (connector, SIGTERM);
618 connector = (pthread_t) 0;
621 if (connector_socket >= 0) {
622 close (connector_socket);
623 connector_socket = -1;
626 /* don't allow any more connections to be processed */
627 pthread_mutex_lock (&conns_mutex);
629 available_collectors = 0;
631 if (collectors != NULL) {
632 for (i = 0; i < max_conns; ++i) {
633 if (collectors[i] == NULL)
636 if (collectors[i]->thread != ((pthread_t) 0)) {
637 pthread_kill (collectors[i]->thread, SIGTERM);
638 collectors[i]->thread = (pthread_t) 0;
641 if (collectors[i]->socket != NULL) {
642 fclose (collectors[i]->socket);
643 collectors[i]->socket = NULL;
646 sfree (collectors[i]);
649 } /* if (collectors != NULL) */
651 pthread_mutex_unlock (&conns_mutex);
653 type_list_free (&list_count);
654 type_list_free (&list_count_copy);
655 type_list_free (&list_size);
656 type_list_free (&list_size_copy);
657 type_list_free (&list_check);
658 type_list_free (&list_check_copy);
660 unlink ((NULL == sock_file) ? SOCK_PATH : sock_file);
665 } /* static void email_shutdown (void) */
667 static void email_submit (const char *type, const char *type_instance, gauge_t value)
670 value_list_t vl = VALUE_LIST_INIT;
672 values[0].gauge = value;
676 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
677 sstrncpy (vl.plugin, "email", sizeof (vl.plugin));
678 sstrncpy (vl.type, type, sizeof (vl.type));
679 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
681 plugin_dispatch_values (&vl);
682 } /* void email_submit */
684 /* Copy list l1 to list l2. l2 may partly exist already, but it is assumed
685 * that neither the order nor the name of any element of either list is
686 * changed and no elements are deleted. The values of l1 are reset to zero
687 * after they have been copied to l2. */
688 static void copy_type_list (type_list_t *l1, type_list_t *l2)
695 for (ptr1 = l1->head, ptr2 = l2->head; NULL != ptr1;
696 ptr1 = ptr1->next, last = ptr2, ptr2 = ptr2->next) {
698 ptr2 = (type_t *)smalloc (sizeof (type_t));
712 if (NULL == ptr2->name) {
713 ptr2->name = sstrdup (ptr1->name);
716 ptr2->value = ptr1->value;
722 static int email_read (void)
733 pthread_mutex_lock (&count_mutex);
735 copy_type_list (&list_count, &list_count_copy);
737 pthread_mutex_unlock (&count_mutex);
739 for (ptr = list_count_copy.head; NULL != ptr; ptr = ptr->next) {
740 email_submit ("email_count", ptr->name, ptr->value);
744 pthread_mutex_lock (&size_mutex);
746 copy_type_list (&list_size, &list_size_copy);
748 pthread_mutex_unlock (&size_mutex);
750 for (ptr = list_size_copy.head; NULL != ptr; ptr = ptr->next) {
751 email_submit ("email_size", ptr->name, ptr->value);
755 pthread_mutex_lock (&score_mutex);
758 score_count_old = score_count;
762 pthread_mutex_unlock (&score_mutex);
764 if (score_count_old > 0)
765 email_submit ("spam_score", "", score_old);
768 pthread_mutex_lock (&check_mutex);
770 copy_type_list (&list_check, &list_check_copy);
772 pthread_mutex_unlock (&check_mutex);
774 for (ptr = list_check_copy.head; NULL != ptr; ptr = ptr->next)
775 email_submit ("spam_check", ptr->name, ptr->value);
778 } /* int email_read */
780 void module_register (void)
782 plugin_register_config ("email", email_config, config_keys, config_keys_num);
783 plugin_register_init ("email", email_init);
784 plugin_register_read ("email", email_read);
785 plugin_register_shutdown ("email", email_shutdown);
786 } /* void module_register */
788 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */