fixed build issues
[collectd.git] / src / exec.c
1 /**
2  * collectd - src/exec.c
3  * Copyright (C) 2007-2010  Florian octo Forster
4  * Copyright (C) 2007-2009  Sebastian Harl
5  * Copyright (C) 2008       Peter Holik
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation; only version 2 of the License is applicable.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  *
20  * Authors:
21  *   Florian octo Forster <octo at collectd.org>
22  *   Sebastian Harl <sh at tokkee.org>
23  *   Peter Holik <peter at holik.at>
24  **/
25
26 #define _DEFAULT_SOURCE
27 #define _BSD_SOURCE /* For setgroups */
28
29 #include "collectd.h"
30
31 #include "common.h"
32 #include "plugin.h"
33
34 #include "utils_cmd_putnotif.h"
35 #include "utils_cmd_putval.h"
36
37 #include <grp.h>
38 #include <pwd.h>
39 #include <signal.h>
40 #include <sys/types.h>
41
42 #include <stdlib.h>
43 #ifdef HAVE_SYS_CAPABILITY_H
44 #include <sys/capability.h>
45 #endif
46
47 #define PL_NORMAL 0x01
48 #define PL_NOTIF_ACTION 0x02
49
50 #define PL_RUNNING 0x10
51
52 /*
53  * Private data types
54  */
55 /*
56  * Access to this structure is serialized using the `pl_lock' lock and the
57  * `PL_RUNNING' flag. The execution of notifications is *not* serialized, so
58  * all functions used to handle notifications MUST NOT write to this structure.
59  * The `pid' and `status' fields are thus unused if the `PL_NOTIF_ACTION' flag
60  * is set.
61  * The `PL_RUNNING' flag is set in `exec_read' and unset in `exec_read_one'.
62  */
63 struct program_list_s;
64 typedef struct program_list_s program_list_t;
65 struct program_list_s {
66   char *user;
67   char *group;
68   char *exec;
69   char **argv;
70   int pid;
71   int status;
72   int flags;
73   program_list_t *next;
74 };
75
76 typedef struct program_list_and_notification_s {
77   program_list_t *pl;
78   notification_t n;
79 } program_list_and_notification_t;
80
81 /*
82  * constants
83  */
84 const long int MAX_GRBUF_SIZE = 65536;
85
86 /*
87  * Private variables
88  */
89 static program_list_t *pl_head;
90 static pthread_mutex_t pl_lock = PTHREAD_MUTEX_INITIALIZER;
91
92 /*
93  * Functions
94  */
95 static void sigchld_handler(int __attribute__((unused)) signal) /* {{{ */
96 {
97   pid_t pid;
98   int status;
99   while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
100     program_list_t *pl;
101     for (pl = pl_head; pl != NULL; pl = pl->next)
102       if (pl->pid == pid)
103         break;
104     if (pl != NULL)
105       pl->status = status;
106   } /* while (waitpid) */
107 } /* void sigchld_handler }}} */
108
109 static int exec_config_exec(oconfig_item_t *ci) /* {{{ */
110 {
111   program_list_t *pl;
112   char buffer[128];
113   int i;
114
115   if (ci->children_num != 0) {
116     WARNING("exec plugin: The config option `%s' may not be a block.", ci->key);
117     return -1;
118   }
119   if (ci->values_num < 2) {
120     WARNING("exec plugin: The config option `%s' needs at least two "
121             "arguments.",
122             ci->key);
123     return -1;
124   }
125   if ((ci->values[0].type != OCONFIG_TYPE_STRING) ||
126       (ci->values[1].type != OCONFIG_TYPE_STRING)) {
127     WARNING("exec plugin: The first two arguments to the `%s' option must "
128             "be string arguments.",
129             ci->key);
130     return -1;
131   }
132
133   pl = calloc(1, sizeof(*pl));
134   if (pl == NULL) {
135     ERROR("exec plugin: calloc failed.");
136     return -1;
137   }
138
139   if (strcasecmp("NotificationExec", ci->key) == 0)
140     pl->flags |= PL_NOTIF_ACTION;
141   else
142     pl->flags |= PL_NORMAL;
143
144   pl->user = strdup(ci->values[0].value.string);
145   if (pl->user == NULL) {
146     ERROR("exec plugin: strdup failed.");
147     sfree(pl);
148     return -1;
149   }
150
151   pl->group = strchr(pl->user, ':');
152   if (pl->group != NULL) {
153     *pl->group = '\0';
154     pl->group++;
155   }
156
157   pl->exec = strdup(ci->values[1].value.string);
158   if (pl->exec == NULL) {
159     ERROR("exec plugin: strdup failed.");
160     sfree(pl->user);
161     sfree(pl);
162     return -1;
163   }
164
165   pl->argv = calloc(ci->values_num, sizeof(*pl->argv));
166   if (pl->argv == NULL) {
167     ERROR("exec plugin: calloc failed.");
168     sfree(pl->exec);
169     sfree(pl->user);
170     sfree(pl);
171     return -1;
172   }
173
174   {
175     char *tmp = strrchr(ci->values[1].value.string, '/');
176     if (tmp == NULL)
177       sstrncpy(buffer, ci->values[1].value.string, sizeof(buffer));
178     else
179       sstrncpy(buffer, tmp + 1, sizeof(buffer));
180   }
181   pl->argv[0] = strdup(buffer);
182   if (pl->argv[0] == NULL) {
183     ERROR("exec plugin: strdup failed.");
184     sfree(pl->argv);
185     sfree(pl->exec);
186     sfree(pl->user);
187     sfree(pl);
188     return -1;
189   }
190
191   for (i = 1; i < (ci->values_num - 1); i++) {
192     if (ci->values[i + 1].type == OCONFIG_TYPE_STRING) {
193       pl->argv[i] = strdup(ci->values[i + 1].value.string);
194     } else {
195       if (ci->values[i + 1].type == OCONFIG_TYPE_NUMBER) {
196         snprintf(buffer, sizeof(buffer), "%lf", ci->values[i + 1].value.number);
197       } else {
198         if (ci->values[i + 1].value.boolean)
199           sstrncpy(buffer, "true", sizeof(buffer));
200         else
201           sstrncpy(buffer, "false", sizeof(buffer));
202       }
203
204       pl->argv[i] = strdup(buffer);
205     }
206
207     if (pl->argv[i] == NULL) {
208       ERROR("exec plugin: strdup failed.");
209       break;
210     }
211   } /* for (i) */
212
213   if (i < (ci->values_num - 1)) {
214     while ((--i) >= 0) {
215       sfree(pl->argv[i]);
216     }
217     sfree(pl->argv);
218     sfree(pl->exec);
219     sfree(pl->user);
220     sfree(pl);
221     return -1;
222   }
223
224   for (i = 0; pl->argv[i] != NULL; i++) {
225     DEBUG("exec plugin: argv[%i] = %s", i, pl->argv[i]);
226   }
227
228   pl->next = pl_head;
229   pl_head = pl;
230
231   return 0;
232 } /* int exec_config_exec }}} */
233
234 static int exec_config(oconfig_item_t *ci) /* {{{ */
235 {
236   for (int i = 0; i < ci->children_num; i++) {
237     oconfig_item_t *child = ci->children + i;
238     if ((strcasecmp("Exec", child->key) == 0) ||
239         (strcasecmp("NotificationExec", child->key) == 0))
240       exec_config_exec(child);
241     else {
242       WARNING("exec plugin: Unknown config option `%s'.", child->key);
243     }
244   } /* for (i) */
245
246   return 0;
247 } /* int exec_config }}} */
248
249 static void set_environment(void) /* {{{ */
250 {
251   char buffer[1024];
252
253 #ifdef HAVE_SETENV
254   snprintf(buffer, sizeof(buffer), "%.3f",
255            CDTIME_T_TO_DOUBLE(plugin_get_interval()));
256   setenv("COLLECTD_INTERVAL", buffer, /* overwrite = */ 1);
257
258   sstrncpy(buffer, hostname_g, sizeof(buffer));
259   setenv("COLLECTD_HOSTNAME", buffer, /* overwrite = */ 1);
260 #else
261   snprintf(buffer, sizeof(buffer), "COLLECTD_INTERVAL=%.3f",
262            CDTIME_T_TO_DOUBLE(plugin_get_interval()));
263   putenv(buffer);
264
265   snprintf(buffer, sizeof(buffer), "COLLECTD_HOSTNAME=%s", hostname_g);
266   putenv(buffer);
267 #endif
268 } /* }}} void set_environment */
269
270 __attribute__((noreturn)) static void exec_child(program_list_t *pl, int uid,
271                                                  int gid, int egid) /* {{{ */
272 {
273   int status;
274
275 #if HAVE_SETGROUPS
276   if (getuid() == 0) {
277     gid_t glist[2];
278     size_t glist_len;
279
280     glist[0] = gid;
281     glist_len = 1;
282
283     if ((gid != egid) && (egid != -1)) {
284       glist[1] = egid;
285       glist_len = 2;
286     }
287
288     setgroups(glist_len, glist);
289   }
290 #endif /* HAVE_SETGROUPS */
291
292   status = setgid(gid);
293   if (status != 0) {
294     ERROR("exec plugin: setgid (%i) failed: %s", gid, STRERRNO);
295     exit(-1);
296   }
297
298   if (egid != -1) {
299     status = setegid(egid);
300     if (status != 0) {
301       ERROR("exec plugin: setegid (%i) failed: %s", egid, STRERRNO);
302       exit(-1);
303     }
304   }
305
306   status = setuid(uid);
307   if (status != 0) {
308     ERROR("exec plugin: setuid (%i) failed: %s", uid, STRERRNO);
309     exit(-1);
310   }
311
312   execvp(pl->exec, pl->argv);
313
314   ERROR("exec plugin: Failed to execute ``%s'': %s", pl->exec, STRERRNO);
315   exit(-1);
316 } /* void exec_child }}} */
317
318 static void reset_signal_mask(void) /* {{{ */
319 {
320   sigset_t ss;
321
322   sigemptyset(&ss);
323   sigprocmask(SIG_SETMASK, &ss, /* old mask = */ NULL);
324 } /* }}} void reset_signal_mask */
325
326 static int create_pipe(int fd_pipe[2]) /* {{{ */
327 {
328   int status;
329
330   status = pipe(fd_pipe);
331   if (status != 0) {
332     ERROR("exec plugin: pipe failed: %s", STRERRNO);
333     return -1;
334   }
335
336   return 0;
337 } /* }}} int create_pipe */
338
339 static void close_pipe(int fd_pipe[2]) /* {{{ */
340 {
341   if (fd_pipe[0] != -1)
342     close(fd_pipe[0]);
343
344   if (fd_pipe[1] != -1)
345     close(fd_pipe[1]);
346 } /* }}} void close_pipe */
347
348 /*
349  * Get effective group ID from group name.
350  */
351 static int getegr_id(program_list_t *pl, int gid) /* {{{ */
352 {
353   int egid = -1;
354   if (pl->group != NULL) {
355     if (*pl->group != '\0') {
356       struct group *gr_ptr = NULL;
357       struct group gr;
358
359       long int grbuf_size = sysconf(_SC_GETGR_R_SIZE_MAX);
360       if (grbuf_size <= 0)
361         grbuf_size = sysconf(_SC_PAGESIZE);
362       if (grbuf_size <= 0)
363         grbuf_size = 4096;
364
365       long int size;
366       size = grbuf_size;
367       char *temp = NULL;
368       char *grbuf = NULL;
369       int getgr_failed = 0;
370       grbuf = malloc(size);
371       if (grbuf == NULL) {
372         ERROR("exec plugin: get group information for '%s' failed: buffer "
373               "malloc() failed",
374               pl->group);
375         getgr_failed = 1;
376         goto gr_finally;
377       }
378       int status;
379       while ((status = getgrnam_r(pl->group, &gr, grbuf, size, &gr_ptr)) != 0) {
380         switch (errno) {
381         case ERANGE:
382           if ((size + grbuf_size) < size ||
383               (size + grbuf_size) > MAX_GRBUF_SIZE) {
384             ERROR("exec plugin: get group information for '%s' max buffer "
385                   "limit (%ld) reached \n",
386                   pl->group, MAX_GRBUF_SIZE);
387             getgr_failed = 1;
388             goto gr_finally;
389           }
390           /* grow the buffer by 'grbuf_size' each time getgrnamr fails */
391           size += grbuf_size;
392           temp = realloc(grbuf, size);
393           if (temp == NULL) {
394             ERROR("exec plugin: get group information for '%s' realloc() "
395                   "buffer to (%ld) failed ",
396                   pl->group, size);
397             getgr_failed = 1;
398             goto gr_finally;
399           }
400           grbuf = temp;
401           break;
402         default:
403           ERROR("exec plugin: default errno: get group information for '%s' "
404                 "failed : %s",
405                 pl->group, STRERRNO);
406           getgr_failed = 1;
407           goto gr_finally;
408         }
409       }
410       if (gr_ptr == NULL) {
411         ERROR("exec plugin: No such group: `%s'", pl->group);
412         getgr_failed = 1;
413         goto gr_finally;
414       }
415       egid = gr.gr_gid;
416     gr_finally:
417       free(grbuf);
418       DEBUG("exec plugin: release grbuf memory ");
419       grbuf = NULL;
420       if (getgr_failed > 0) {
421         egid = -2; // arbitrary value to indicate fail
422       }
423     } else {
424       egid = gid;
425     }
426   } /* if (pl->group == NULL) */
427   return egid;
428 }
429
430 /*
431  * Creates three pipes (one for reading, one for writing and one for errors),
432  * forks a child, sets up the pipes so that fd_in is connected to STDIN of
433  * the child and fd_out is connected to STDOUT and fd_err is connected to STDERR
434  * of the child. Then is calls `exec_child'.
435  */
436 static int fork_child(program_list_t *pl, int *fd_in, int *fd_out,
437                       int *fd_err) /* {{{ */
438 {
439   int fd_pipe_in[2] = {-1, -1};
440   int fd_pipe_out[2] = {-1, -1};
441   int fd_pipe_err[2] = {-1, -1};
442   int status;
443   int pid;
444
445   int uid;
446   int gid;
447   int egid;
448
449   struct passwd *sp_ptr;
450   struct passwd sp;
451
452   if (pl->pid != 0)
453     return -1;
454
455   long int nambuf_size = sysconf(_SC_GETPW_R_SIZE_MAX);
456   if (nambuf_size <= 0)
457     nambuf_size = sysconf(_SC_PAGESIZE);
458   if (nambuf_size <= 0)
459     nambuf_size = 4096;
460   char nambuf[nambuf_size];
461
462   if ((create_pipe(fd_pipe_in) == -1) || (create_pipe(fd_pipe_out) == -1) ||
463       (create_pipe(fd_pipe_err) == -1))
464     goto failed;
465
466   sp_ptr = NULL;
467   status = getpwnam_r(pl->user, &sp, nambuf, sizeof(nambuf), &sp_ptr);
468   if (status != 0) {
469     ERROR("exec plugin: Failed to get user information for user ``%s'': %s",
470           pl->user, STRERROR(status));
471     goto failed;
472   }
473
474   if (sp_ptr == NULL) {
475     ERROR("exec plugin: No such user: `%s'", pl->user);
476     goto failed;
477   }
478
479   uid = sp.pw_uid;
480   gid = sp.pw_gid;
481   if (uid == 0) {
482     ERROR("exec plugin: Cowardly refusing to exec program as root.");
483     goto failed;
484   }
485
486   /* The group configured in the configfile is set as effective group, because
487    * this way the forked process can (re-)gain the user's primary group. */
488   egid = getegr_id(pl, gid);
489   if (egid <= -2) {
490     ERROR("exec plugin: getegr_id failed: %s", STRERRNO);
491     goto failed;
492   }
493
494   pid = fork();
495   if (pid < 0) {
496     ERROR("exec plugin: fork failed: %s", STRERRNO);
497     goto failed;
498   } else if (pid == 0) {
499     int fd_num;
500
501     /* Close all file descriptors but the pipe end we need. */
502     fd_num = getdtablesize();
503     for (int fd = 0; fd < fd_num; fd++) {
504       if ((fd == fd_pipe_in[0]) || (fd == fd_pipe_out[1]) ||
505           (fd == fd_pipe_err[1]))
506         continue;
507       close(fd);
508     }
509
510     /* Connect the `in' pipe to STDIN */
511     if (fd_pipe_in[0] != STDIN_FILENO) {
512       dup2(fd_pipe_in[0], STDIN_FILENO);
513       close(fd_pipe_in[0]);
514     }
515
516     /* Now connect the `out' pipe to STDOUT */
517     if (fd_pipe_out[1] != STDOUT_FILENO) {
518       dup2(fd_pipe_out[1], STDOUT_FILENO);
519       close(fd_pipe_out[1]);
520     }
521
522     /* Now connect the `err' pipe to STDERR */
523     if (fd_pipe_err[1] != STDERR_FILENO) {
524       dup2(fd_pipe_err[1], STDERR_FILENO);
525       close(fd_pipe_err[1]);
526     }
527
528     set_environment();
529
530     /* Unblock all signals */
531     reset_signal_mask();
532
533     exec_child(pl, uid, gid, egid);
534     /* does not return */
535   }
536
537   close(fd_pipe_in[0]);
538   close(fd_pipe_out[1]);
539   close(fd_pipe_err[1]);
540
541   if (fd_in != NULL)
542     *fd_in = fd_pipe_in[1];
543   else
544     close(fd_pipe_in[1]);
545
546   if (fd_out != NULL)
547     *fd_out = fd_pipe_out[0];
548   else
549     close(fd_pipe_out[0]);
550
551   if (fd_err != NULL)
552     *fd_err = fd_pipe_err[0];
553   else
554     close(fd_pipe_err[0]);
555
556   return pid;
557
558 failed:
559   close_pipe(fd_pipe_in);
560   close_pipe(fd_pipe_out);
561   close_pipe(fd_pipe_err);
562
563   return -1;
564 } /* int fork_child }}} */
565
566 static int parse_line(char *buffer) /* {{{ */
567 {
568   if (strncasecmp("PUTVAL", buffer, strlen("PUTVAL")) == 0)
569     return cmd_handle_putval(stdout, buffer);
570   else if (strncasecmp("PUTNOTIF", buffer, strlen("PUTNOTIF")) == 0)
571     return handle_putnotif(stdout, buffer);
572   else {
573     ERROR("exec plugin: Unable to parse command, ignoring line: \"%s\"",
574           buffer);
575     return -1;
576   }
577 } /* int parse_line }}} */
578
579 static void *exec_read_one(void *arg) /* {{{ */
580 {
581   program_list_t *pl = (program_list_t *)arg;
582   int fd, fd_err, highest_fd;
583   fd_set fdset, copy;
584   int status;
585   char buffer[1200]; /* if not completely read */
586   char buffer_err[1024];
587   char *pbuffer = buffer;
588   char *pbuffer_err = buffer_err;
589
590   status = fork_child(pl, NULL, &fd, &fd_err);
591   if (status < 0) {
592     /* Reset the "running" flag */
593     pthread_mutex_lock(&pl_lock);
594     pl->flags &= ~PL_RUNNING;
595     pthread_mutex_unlock(&pl_lock);
596     pthread_exit((void *)1);
597   }
598   pl->pid = status;
599
600   assert(pl->pid != 0);
601
602   FD_ZERO(&fdset);
603   FD_SET(fd, &fdset);
604   FD_SET(fd_err, &fdset);
605
606   /* Determine the highest file descriptor */
607   highest_fd = (fd > fd_err) ? fd : fd_err;
608
609   /* We use a copy of fdset, as select modifies it */
610   copy = fdset;
611
612   while (1) {
613     int len;
614
615     status = select(highest_fd + 1, &copy, NULL, NULL, NULL);
616     if (status < 0) {
617       if (errno == EINTR)
618         continue;
619       break;
620     }
621
622     if (FD_ISSET(fd, &copy)) {
623       char *pnl;
624
625       len = read(fd, pbuffer, sizeof(buffer) - 1 - (pbuffer - buffer));
626
627       if (len < 0) {
628         if (errno == EAGAIN || errno == EINTR)
629           continue;
630         break;
631       } else if (len == 0)
632         break; /* We've reached EOF */
633
634       pbuffer[len] = '\0';
635
636       len += pbuffer - buffer;
637       pbuffer = buffer;
638
639       while ((pnl = strchr(pbuffer, '\n'))) {
640         *pnl = '\0';
641         if (*(pnl - 1) == '\r')
642           *(pnl - 1) = '\0';
643
644         parse_line(pbuffer);
645
646         pbuffer = ++pnl;
647       }
648       /* not completely read ? */
649       if (pbuffer - buffer < len) {
650         len -= pbuffer - buffer;
651         memmove(buffer, pbuffer, len);
652         pbuffer = buffer + len;
653       } else
654         pbuffer = buffer;
655     } else if (FD_ISSET(fd_err, &copy)) {
656       char *pnl;
657
658       len = read(fd_err, pbuffer_err,
659                  sizeof(buffer_err) - 1 - (pbuffer_err - buffer_err));
660
661       if (len < 0) {
662         if (errno == EAGAIN || errno == EINTR)
663           continue;
664         break;
665       } else if (len == 0) {
666         /* We've reached EOF */
667         NOTICE("exec plugin: Program `%s' has closed STDERR.", pl->exec);
668
669         /* Remove file descriptor form select() set. */
670         FD_CLR(fd_err, &fdset);
671         copy = fdset;
672         highest_fd = fd;
673
674         /* Clean up file descriptor */
675         close(fd_err);
676         fd_err = -1;
677         continue;
678       }
679
680       pbuffer_err[len] = '\0';
681
682       len += pbuffer_err - buffer_err;
683       pbuffer_err = buffer_err;
684
685       while ((pnl = strchr(pbuffer_err, '\n'))) {
686         *pnl = '\0';
687         if (*(pnl - 1) == '\r')
688           *(pnl - 1) = '\0';
689
690         ERROR("exec plugin: exec_read_one: error = %s", pbuffer_err);
691
692         pbuffer_err = ++pnl;
693       }
694       /* not completely read ? */
695       if (pbuffer_err - buffer_err < len) {
696         len -= pbuffer_err - buffer_err;
697         memmove(buffer_err, pbuffer_err, len);
698         pbuffer_err = buffer_err + len;
699       } else
700         pbuffer_err = buffer_err;
701     }
702     /* reset copy */
703     copy = fdset;
704   }
705
706   DEBUG("exec plugin: exec_read_one: Waiting for `%s' to exit.", pl->exec);
707   if (waitpid(pl->pid, &status, 0) > 0)
708     pl->status = status;
709
710   DEBUG("exec plugin: Child %i exited with status %i.", (int)pl->pid,
711         pl->status);
712
713   pl->pid = 0;
714
715   pthread_mutex_lock(&pl_lock);
716   pl->flags &= ~PL_RUNNING;
717   pthread_mutex_unlock(&pl_lock);
718
719   close(fd);
720   if (fd_err >= 0)
721     close(fd_err);
722
723   pthread_exit((void *)0);
724   return NULL;
725 } /* void *exec_read_one }}} */
726
727 static void *exec_notification_one(void *arg) /* {{{ */
728 {
729   program_list_t *pl = ((program_list_and_notification_t *)arg)->pl;
730   notification_t *n = &((program_list_and_notification_t *)arg)->n;
731   int fd;
732   FILE *fh;
733   int pid;
734   int status;
735   const char *severity;
736
737   pid = fork_child(pl, &fd, NULL, NULL);
738   if (pid < 0) {
739     sfree(arg);
740     pthread_exit((void *)1);
741   }
742
743   fh = fdopen(fd, "w");
744   if (fh == NULL) {
745     ERROR("exec plugin: fdopen (%i) failed: %s", fd, STRERRNO);
746     kill(pid, SIGTERM);
747     close(fd);
748     sfree(arg);
749     pthread_exit((void *)1);
750   }
751
752   severity = "FAILURE";
753   if (n->severity == NOTIF_WARNING)
754     severity = "WARNING";
755   else if (n->severity == NOTIF_OKAY)
756     severity = "OKAY";
757
758   fprintf(fh, "Severity: %s\n"
759               "Time: %.3f\n",
760           severity, CDTIME_T_TO_DOUBLE(n->time));
761
762   /* Print the optional fields */
763   if (strlen(n->host) > 0)
764     fprintf(fh, "Host: %s\n", n->host);
765   if (strlen(n->plugin) > 0)
766     fprintf(fh, "Plugin: %s\n", n->plugin);
767   if (strlen(n->plugin_instance) > 0)
768     fprintf(fh, "PluginInstance: %s\n", n->plugin_instance);
769   if (strlen(n->type) > 0)
770     fprintf(fh, "Type: %s\n", n->type);
771   if (strlen(n->type_instance) > 0)
772     fprintf(fh, "TypeInstance: %s\n", n->type_instance);
773
774   for (notification_meta_t *meta = n->meta; meta != NULL; meta = meta->next) {
775     if (meta->type == NM_TYPE_STRING)
776       fprintf(fh, "%s: %s\n", meta->name, meta->nm_value.nm_string);
777     else if (meta->type == NM_TYPE_SIGNED_INT)
778       fprintf(fh, "%s: %" PRIi64 "\n", meta->name,
779               meta->nm_value.nm_signed_int);
780     else if (meta->type == NM_TYPE_UNSIGNED_INT)
781       fprintf(fh, "%s: %" PRIu64 "\n", meta->name,
782               meta->nm_value.nm_unsigned_int);
783     else if (meta->type == NM_TYPE_DOUBLE)
784       fprintf(fh, "%s: %e\n", meta->name, meta->nm_value.nm_double);
785     else if (meta->type == NM_TYPE_BOOLEAN)
786       fprintf(fh, "%s: %s\n", meta->name,
787               meta->nm_value.nm_boolean ? "true" : "false");
788   }
789
790   fprintf(fh, "\n%s\n", n->message);
791
792   fflush(fh);
793   fclose(fh);
794
795   waitpid(pid, &status, 0);
796
797   DEBUG("exec plugin: Child %i exited with status %i.", pid, status);
798
799   if (n->meta != NULL)
800     plugin_notification_meta_free(n->meta);
801   n->meta = NULL;
802   sfree(arg);
803   pthread_exit((void *)0);
804   return NULL;
805 } /* void *exec_notification_one }}} */
806
807 static int exec_init(void) /* {{{ */
808 {
809   struct sigaction sa = {.sa_handler = sigchld_handler};
810
811   sigaction(SIGCHLD, &sa, NULL);
812
813 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_SETUID) && defined(CAP_SETGID)
814   if ((check_capability(CAP_SETUID) != 0) ||
815       (check_capability(CAP_SETGID) != 0)) {
816     if (getuid() == 0)
817       WARNING(
818           "exec plugin: Running collectd as root, but the CAP_SETUID "
819           "or CAP_SETGID capabilities are missing. The plugin's read function "
820           "will probably fail. Is your init system dropping capabilities?");
821     else
822       WARNING(
823           "exec plugin: collectd doesn't have the CAP_SETUID or "
824           "CAP_SETGID capabilities. If you don't want to run collectd as root, "
825           "try running \"setcap 'cap_setuid=ep cap_setgid=ep'\" on the "
826           "collectd binary.");
827   }
828 #endif
829
830   return 0;
831 } /* int exec_init }}} */
832
833 static int exec_read(void) /* {{{ */
834 {
835   for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
836     pthread_t t;
837     pthread_attr_t attr;
838
839     /* Only execute `normal' style executables here. */
840     if ((pl->flags & PL_NORMAL) == 0)
841       continue;
842
843     pthread_mutex_lock(&pl_lock);
844     /* Skip if a child is already running. */
845     if ((pl->flags & PL_RUNNING) != 0) {
846       pthread_mutex_unlock(&pl_lock);
847       continue;
848     }
849     pl->flags |= PL_RUNNING;
850     pthread_mutex_unlock(&pl_lock);
851
852     pthread_attr_init(&attr);
853     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
854     int status =
855         plugin_thread_create(&t, &attr, exec_read_one, (void *)pl, "exec read");
856     if (status != 0) {
857       ERROR("exec plugin: plugin_thread_create failed.");
858     }
859     pthread_attr_destroy(&attr);
860   } /* for (pl) */
861
862   return 0;
863 } /* int exec_read }}} */
864
865 static int exec_notification(const notification_t *n, /* {{{ */
866                              user_data_t __attribute__((unused)) * user_data) {
867   program_list_and_notification_t *pln;
868
869   for (program_list_t *pl = pl_head; pl != NULL; pl = pl->next) {
870     pthread_t t;
871     pthread_attr_t attr;
872
873     /* Only execute `notification' style executables here. */
874     if ((pl->flags & PL_NOTIF_ACTION) == 0)
875       continue;
876
877     /* Skip if a child is already running. */
878     if (pl->pid != 0)
879       continue;
880
881     pln = malloc(sizeof(*pln));
882     if (pln == NULL) {
883       ERROR("exec plugin: malloc failed.");
884       continue;
885     }
886
887     pln->pl = pl;
888     memcpy(&pln->n, n, sizeof(notification_t));
889
890     /* Set the `meta' member to NULL, otherwise `plugin_notification_meta_copy'
891      * will run into an endless loop. */
892     pln->n.meta = NULL;
893     plugin_notification_meta_copy(&pln->n, n);
894
895     pthread_attr_init(&attr);
896     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
897     int status = plugin_thread_create(&t, &attr, exec_notification_one,
898                                       (void *)pln, "exec notify");
899     if (status != 0) {
900       ERROR("exec plugin: plugin_thread_create failed.");
901     }
902     pthread_attr_destroy(&attr);
903   } /* for (pl) */
904
905   return 0;
906 } /* }}} int exec_notification */
907
908 static int exec_shutdown(void) /* {{{ */
909 {
910   program_list_t *pl;
911   program_list_t *next;
912
913   pl = pl_head;
914   while (pl != NULL) {
915     next = pl->next;
916
917     if (pl->pid > 0) {
918       kill(pl->pid, SIGTERM);
919       INFO("exec plugin: Sent SIGTERM to %hu", (unsigned short int)pl->pid);
920     }
921
922     sfree(pl->user);
923     sfree(pl);
924
925     pl = next;
926   } /* while (pl) */
927   pl_head = NULL;
928
929   return 0;
930 } /* int exec_shutdown }}} */
931
932 void module_register(void) {
933   plugin_register_complex_config("exec", exec_config);
934   plugin_register_init("exec", exec_init);
935   plugin_register_read("exec", exec_read);
936   plugin_register_notification("exec", exec_notification,
937                                /* user_data = */ NULL);
938   plugin_register_shutdown("exec", exec_shutdown);
939 } /* void module_register */