2 ** slocal.c -- asynchronously filter and deliver new mail
4 ** This code is Copyright (c) 2002, by the authors of nmh. See the
5 ** COPYRIGHT file in the root directory of the nmh distribution for
6 ** complete copyright information.
10 ** Under sendmail, users should add the line
12 ** "| /usr/local/mmh/bin/slocal"
14 ** to their $HOME/.forward file.
20 #include <h/rcvmail.h>
21 #include <h/signals.h>
27 #include <sys/ioctl.h>
30 #ifdef INITGROUPS_HEADER
31 #include INITGROUPS_HEADER
34 ** On AIX 4.1, initgroups() is defined and even documented (giving the
35 ** parameter types as char* and int), but doesn't have a prototype in any
36 ** of the system header files. AIX 4.3, SunOS 4.1.3, and ULTRIX 4.2A have
39 extern int initgroups(char*, int);
42 static struct swit switches[] = {
44 { "addr address", 0 },
50 { "sender address", 0 },
52 { "mailbox file", 0 },
54 { "home directory", -4 },
58 { "maildelivery file", 0 },
73 static int globbed = 0; /* have we built "vars" table yet? */
74 static int parsed = 0; /* have we built header field table yet */
76 static int verbose = 0;
79 static char *addr = NULL;
80 static char *user = NULL;
81 static char *info = NULL;
82 static char *file = NULL;
83 static char *sender = NULL;
84 static char *envelope = NULL; /* envelope information ("From " line) */
85 static char *mbox = NULL;
86 static char *home = NULL;
88 static struct passwd *pw; /* passwd file entry */
90 static char ddate[BUFSIZ]; /* record the delivery date */
95 /* flags for pair->p_flags */
97 #define P_ADR 0x01 /* field is address */
98 #define P_HID 0x02 /* special (fake) field */
110 ** Lookup table for matching fields and patterns
111 ** in messages. The rest of the table is added
112 ** when the message is parsed.
114 static struct pair hdrs[NVEC + 1] = {
115 { "source", NULL, P_HID },
116 { "addr", NULL, P_HID },
117 { "Return-Path", NULL, P_ADR },
118 { "Reply-To", NULL, P_ADR },
119 { "From", NULL, P_ADR },
120 { "Sender", NULL, P_ADR },
121 { "To", NULL, P_ADR },
122 { "cc", NULL, P_ADR },
123 { "Resent-Reply-To", NULL, P_ADR },
124 { "Resent-From", NULL, P_ADR },
125 { "Resent-Sender", NULL, P_ADR },
126 { "Resent-To", NULL, P_ADR },
127 { "Resent-Cc", NULL, P_ADR },
132 ** The list of builtin variables to expand in a string
133 ** before it is executed by the "pipe" or "qpipe" action.
135 static struct pair vars[] = {
136 { "sender", NULL, P_NIL },
137 { "address", NULL, P_NIL },
138 { "size", NULL, P_NIL },
139 { "reply-to", NULL, P_CHK },
140 { "info", NULL, P_NIL },
144 extern char **environ;
149 static int localmail(int, char *);
150 static int usr_delivery(int, char *, int);
151 static int split(char *, char **);
152 static int parse(int);
153 static void expand(char *, char *, int);
154 static void glob(int);
155 static struct pair *lookup(struct pair *, char *);
156 static int usr_file(int, char *);
157 static int usr_pipe(int, char *, char *, char **, int);
158 static int usr_folder(int, char *);
159 static void alrmser(int);
160 static void get_sender(char *, char **);
161 static int copy_message(int, char *, int);
162 static void verbose_printf(char *fmt, ...);
163 static void adorn(char *, char *, ...);
164 static void debug_printf(char *fmt, ...);
165 static char *trim(char *);
169 main(int argc, char **argv)
173 char *cp, *mdlvr = NULL, buf[BUFSIZ];
174 char mailbox[BUFSIZ], tmpfil[BUFSIZ];
175 char **argp, **arguments;
178 setlocale(LC_ALL, "");
180 invo_name = mhbasename(*argv);
182 /* foil search of user profile/context */
183 if (context_foil(NULL) == -1) {
186 arguments = getarguments(invo_name, argc, argv, 0);
189 /* Parse arguments */
190 while ((cp = *argp++)) {
192 switch (smatch(++cp, switches)) {
194 ambigsw(cp, switches);
197 adios(NULL, "-%s unknown", cp);
200 snprintf(buf, sizeof(buf), "%s [switches] [address info sender]", invo_name);
201 print_help(buf, switches, 0);
204 print_version(invo_name);
208 if (!(addr = *argp++)) {
209 /* allow -xyz arguments */
210 adios(NULL, "missing argument to %s",
215 if (!(info = *argp++)) {
216 /* allow -xyz arguments */
217 adios(NULL, "missing argument to %s",
222 if (!(user = *argp++)) {
223 /* allow -xyz arguments */
224 adios(NULL, "missing argument to %s",
229 if (!(file = *argp++) || *file == '-') {
230 adios(NULL, "missing argument to %s",
235 if (!(sender = *argp++)) {
236 /* allow -xyz arguments */
237 adios(NULL, "missing argument to %s",
242 if (!(mbox = *argp++) || *mbox == '-') {
243 adios(NULL, "missing argument to %s",
248 if (!(home = *argp++) || *home == '-') {
249 adios(NULL, "missing argument to %s",
255 if (!(cp = *argp++) || *cp == '-') {
256 adios(NULL, "missing argument to %s",
260 adios(NULL, "only one maildelivery file at a time!");
278 switch (argp - (argv + 1)) {
292 addr = getusername();
295 user = (cp = strchr(addr, '.')) ? ++cp : addr;
297 if (!(pw = getpwnam(user))) {
298 adios(NULL, "no such local user as %s", user);
301 if (chdir(pw->pw_dir) == -1) {
306 if (geteuid() == 0) {
308 initgroups(pw->pw_name, pw->pw_gid);
318 /* Record the delivery time */
319 if (!(now = dlocaltimenow())) {
320 adios(NULL, "unable to ascertain local time");
322 snprintf(ddate, sizeof(ddate), "Delivery-Date: %s\n", dtimenow());
325 ** Copy the message to a temporary file
330 /* getting message from file */
331 if ((tempfd = open(file, O_RDONLY)) == -1) {
332 adios(file, "unable to open");
335 debug_printf("retrieving message from file \"%s\"\n",
338 if ((fd = copy_message(tempfd, tmpfil, 1)) == -1) {
339 adios(NULL, "unable to create temporary file");
343 /* getting message from stdin */
345 debug_printf("retrieving message from stdin\n");
347 if ((fd = copy_message(fileno(stdin), tmpfil, 1)) == -1) {
348 adios(NULL, "unable to create temporary file");
353 debug_printf("temporary file=\"%s\"\n", tmpfil);
357 ** Delete the temp file now or a copy of every single message
358 ** passed through slocal will be left in the /tmp directory until
359 ** deleted manually! This unlink() used to be under an 'else'
360 ** of the 'if (debug)' above, but since some people like to
361 ** always run slocal with -debug and log the results, the /tmp
362 ** directory would get choked over time. Of course, now that
363 ** we always delete the temp file, the "temporary file=" message
364 ** above is somewhat pointless -- someone watching debug output
365 ** wouldn't have a chance to 'tail -f' or 'ln' the temp file
366 ** before it's unlinked. The best thing would be to delay this
367 ** unlink() until later if debug == 1, but I'll leave that for
368 ** someone who cares about the temp-file-accessing functionality
369 ** (they'll have to watch out for cases where we adios()).
373 if (!(fp = fdopen(fd, "r+"))) {
374 adios(NULL, "unable to access temporary file");
377 /* If no sender given, extract it from envelope information. */
379 get_sender(envelope, &sender);
382 snprintf(mailbox, sizeof(mailbox), "%s/%s",
383 mailspool, pw->pw_name);
391 debug_printf("addr=\"%s\"\n", trim(addr));
392 debug_printf("user=\"%s\"\n", trim(user));
393 debug_printf("info=\"%s\"\n", trim(info));
394 debug_printf("sender=\"%s\"\n", trim(sender));
395 debug_printf("envelope=\"%s\"\n",
396 envelope ? trim(envelope) : "");
397 debug_printf("mbox=\"%s\"\n", trim(mbox));
398 debug_printf("home=\"%s\"\n", trim(home));
399 debug_printf("ddate=\"%s\"\n", trim(ddate));
400 debug_printf("now=%02d:%02d\n\n", now->tw_hour, now->tw_min);
403 /* deliver the message */
404 status = localmail(fd, mdlvr);
406 done(status != -1 ? RCV_MOK : RCV_MBX);
412 ** Main routine for delivering message.
415 localmail(int fd, char *mdlvr)
419 /* delivery according to personal Maildelivery file */
420 if (usr_delivery(fd, mdlvr ? mdlvr : ".maildelivery", 0) != -1) {
423 /* delivery according to global Maildelivery file */
424 snprintf(buf, sizeof buf, "%s/%s", mhetcdir, "maildelivery");
425 if (usr_delivery(fd, buf, 1) != -1) {
429 verbose_printf("(delivering to standard mail spool)\n");
431 /* last resort - deliver to standard mail spool */
432 return usr_file(fd, mbox);
436 #define matches(a,b) (stringdex(b, a) >= 0)
439 ** Parse the delivery file, and process incoming message.
442 usr_delivery(int fd, char *delivery, int su)
444 int i, accept, status=1, won, vecp, next;
445 char *field, *pattern, *action, *result, *string;
446 char buffer[BUFSIZ], tmpbuf[BUFSIZ];
447 char *cp, *vec[NVEC];
452 /* open the delivery file */
453 if (!(fp = fopen(delivery, "r"))) {
456 /* check if delivery file has bad ownership or permissions */
457 if (fstat(fileno(fp), &st) == -1 ||
458 (st.st_uid != 0 && (su || st.st_uid != pw->pw_uid)) ||
459 st.st_mode & (S_IWGRP|S_IWOTH)) {
461 verbose_printf("WARNING: %s has bad ownership/modes (su=%d,uid=%d,owner=%d,mode=0%o)\n", delivery, su, (int) pw->pw_uid, (int) st.st_uid, (int) st.st_mode);
469 /* read and process delivery file */
470 while (fgets(buffer, sizeof(buffer), fp)) {
471 /* skip comments and empty lines */
472 if (*buffer == '#' || *buffer == '\n') {
475 /* zap trailing newline */
476 if ((cp = strchr(buffer, '\n'))) {
479 /* split buffer into fields */
480 vecp = split(buffer, vec);
482 /* check for too few fields */
485 debug_printf("WARNING: entry with only %d fields, skipping.\n", vecp);
490 for (i = 0; vec[i]; i++) {
491 debug_printf("vec[%d]: \"%s\"\n",
502 /* find out how to perform the action */
507 ** If previous condition failed, don't
508 ** do this - else fall through
517 ** If already delivered, skip this action.
518 ** Else consider delivered if action is
529 ** Take action, and consider delivered if
530 ** action is successful.
539 ** Take action, but don't consider delivered,
540 ** even if action is successful
546 /* check if the field matches */
554 ** "default" matches only if the message hasn't
555 ** been delivered yet.
557 if (mh_strcasecmp(field, "default")==0) {
565 /* parse message and build lookup table */
566 if (!parsed && parse(fd) == -1) {
571 ** find header field in lookup table, and
572 ** see if the pattern matches.
574 if ((p = lookup(hdrs, field)) && p->p_value &&
575 matches(p->p_value, pattern)) {
584 /* find out the action to perform */
587 /* deliver to quoted pipe */
588 if (mh_strcasecmp(action, "qpipe")) {
593 expand(tmpbuf, string, fd);
594 if (split(tmpbuf, vec) < 1) {
597 status = usr_pipe(fd, tmpbuf, vec[0], vec, 0);
601 /* deliver to pipe */
602 if (mh_strcasecmp(action, "pipe")) {
609 expand(tmpbuf, string, fd);
612 status = usr_pipe(fd, tmpbuf, "/bin/sh", vec+2, 0);
616 if (mh_strcasecmp(action, "file")==0) {
618 status = usr_file(fd, string);
621 if (mh_strcasecmp(action, "folder")!=0) {
626 /* deliver to nmh folder */
627 status = usr_folder(fd, string);
632 if (mh_strcasecmp(action, "mbox")!=0) {
638 status = usr_file(fd, string);
643 if (mh_strcasecmp(action, "destroy")!=0) {
651 next = 0; /* action failed, mark for 'N' result */
658 return (won ? 0 : -1);
663 ** Split buffer into fields (delimited by whitespace or
664 ** comma's). Return the number of fields found.
667 split(char *cp, char **vec)
674 /* split into a maximum of NVEC fields */
675 for (i = 0; i <= NVEC;) {
678 /* zap any whitespace and comma's */
679 while (isspace(*s) || *s == ',') {
682 /* end of buffer, time to leave */
686 /* get double quote text as a single field */
688 for (vec[i++] = ++s; *s && *s != '"'; s++) {
690 ** Check for escaped double quote. We need
691 ** to shift the string to remove slash.
701 /* zap trailing double quote */
707 if (*s == '\\' && *++s != '"') {
712 /* move forward to next field delimiter */
713 while (*s && !isspace(*s) && *s != ',') {
724 ** Parse the headers of a message, and build the
725 ** lookup table for matching fields and patterns.
733 char name[NAMESZ], field[BUFSIZ];
741 /* get a new FILE pointer to message */
742 if ((fd1 = dup(fd)) == -1) {
745 if (!(in = fdopen(fd1, "r"))) {
751 /* add special entries to lookup table */
752 if ((p = lookup(hdrs, "source"))) {
753 p->p_value = getcpy(sender);
755 if ((p = lookup(hdrs, "addr"))) {
756 p->p_value = getcpy(addr);
760 ** Scan the headers of the message and build a lookup table.
762 for (i = 0, state = FLD;;) {
763 switch (state = m_getfld(state, name, field, sizeof(field),
769 while (state == FLDPLUS) {
770 state = m_getfld(state, name, field,
774 for (p = hdrs; p->p_name; p++) {
775 if (mh_strcasecmp(p->p_name, name)!=0) {
776 if (!(p->p_flags & P_HID)) {
777 if ((cp = p->p_value)) {
778 if (p->p_flags & P_ADR) {
779 dp = cp + strlen(cp) - 1;
783 cp = add(",\n\t", cp);
788 p->p_value = add(lp, cp);
794 if (!p->p_name && i < NVEC) {
795 p->p_name = getcpy(name);
801 if (state != FLDEOF) {
813 advise(NULL, "format error in message");
817 advise(NULL, "internal error in m_getfld");
825 if ((p = lookup(vars, "reply-to"))) {
826 if (!(q = lookup(hdrs, "reply-to")) || !q->p_value) {
827 q = lookup(hdrs, "from");
829 p->p_value = getcpy(q ? q->p_value : "");
830 p->p_flags &= ~P_CHK;
832 debug_printf("vars[%d]: name=\"%s\" value=\"%s\"\n",
833 p - vars, p->p_name, trim(p->p_value));
837 for (p = hdrs; p->p_name; p++) {
838 debug_printf("hdrs[%d]: name=\"%s\" value=\"%s\"\n",
840 p->p_value ? trim(p->p_value) : "");
848 ** Expand any builtin variables such as $(sender),
849 ** $(address), etc., in a string.
852 expand(char *s1, char *s2, int fd)
860 while ((c = *s2++)) {
861 if (c != '$' || *s2 != '(') {
864 for (cp = ++s2; *s2 && *s2 != ')'; s2++) {
872 if ((p = lookup(vars, cp))) {
873 if (!parsed && (p->p_flags & P_CHK)) {
876 strcpy(s1, p->p_value);
886 ** Fill in the information missing from the "vars"
887 ** table, which is necessary to expand any builtin
888 ** variables in the string for a "pipe" or "qpipe"
901 if ((p = lookup(vars, "sender"))) {
902 p->p_value = getcpy(sender);
904 if ((p = lookup(vars, "address"))) {
905 p->p_value = getcpy(addr);
907 if ((p = lookup(vars, "size"))) {
908 snprintf(buffer, sizeof(buffer), "%d",
909 fstat(fd, &st) != -1 ? (int) st.st_size : 0);
910 p->p_value = getcpy(buffer);
912 if ((p = lookup(vars, "info"))) {
913 p->p_value = getcpy(info);
916 for (p = vars; p->p_name; p++) {
917 debug_printf("vars[%d]: name=\"%s\" value=\"%s\"\n",
918 p - vars, p->p_name, trim(p->p_value));
925 ** Find a matching name in a lookup table. If found,
926 ** return the "pairs" entry, else return NULL.
929 lookup(struct pair *pairs, char *key)
931 for (; pairs->p_name; pairs++) {
932 if (!mh_strcasecmp(pairs->p_name, key)) {
941 ** Deliver message by appending to a file, using rcvpack(1).
944 usr_file(int fd, char *mailbox)
949 verbose_printf("delivering to file \"%s\" (mbox style)",
956 return usr_pipe(fd, "rcvpack", "rcvpack", vec, 1);
961 ** Deliver message to a nmh folder, using rcvstore(1).
964 usr_folder(int fd, char *string)
966 char folder[BUFSIZ], *vec[3];
968 /* get folder name ready */
969 if (*string == '+') {
970 strncpy(folder, string, sizeof(folder));
972 snprintf(folder, sizeof(folder), "+%s", string);
975 verbose_printf("delivering to folder \"%s\"", folder + 1);
981 return usr_pipe(fd, "rcvstore", "rcvstore", vec, 1);
985 ** Deliver message to a process.
988 usr_pipe(int fd, char *cmd, char *pgm, char **vec, int suppress)
991 int bytes, seconds, status, n;
995 if (verbose && !suppress) {
996 verbose_printf("delivering to pipe \"%s\"", cmd);
998 lseek(fd, (off_t) 0, SEEK_SET);
1000 switch ((child_id = fork())) {
1004 adorn("fork", "unable to");
1013 freopen("/dev/null", "w", stdout);
1014 freopen("/dev/null", "w", stderr);
1018 for (n=4; n<OPEN_MAX; n++) {
1023 if ((fd = open("/dev/tty", O_RDWR)) != -1) {
1024 ioctl(fd, TIOCNOTTY, NULL);
1027 #endif /* TIOCNOTTY */
1029 /* put in own process group */
1030 setpgid((pid_t) 0, getpid());
1032 path = getenv("PATH");
1034 m_putenv("USER", pw->pw_name);
1035 m_putenv("HOME", pw->pw_dir);
1036 m_putenv("SHELL", pw->pw_shell);
1037 m_putenv("PATH", path);
1043 /* parent process */
1044 if (setjmp(myctx)) {
1046 ** Ruthlessly kill the child and anything
1047 ** else in its process group.
1049 kill(-child_id, SIGKILL);
1051 verbose_printf(", timed-out; terminated\n");
1054 SIGNAL(SIGALRM, alrmser);
1055 bytes = fstat(fd, &st) != -1 ? (int) st.st_size : 100;
1057 /* amount of time to wait depends on message size */
1059 /* give at least 5 minutes */
1061 } else if (bytes >= 90000) {
1062 /* a half hour is long enough */
1065 seconds = (bytes / 60) + 300;
1067 alarm((unsigned int) seconds);
1068 status = pidwait(child_id, 0);
1073 verbose_printf(", success.\n");
1074 } else if ((status & 0xff00) == 0xff00) {
1075 verbose_printf(", system error\n");
1077 pidstatus(status, stdout, ", failed");
1080 return (status == 0 ? 0 : -1);
1088 longjmp(myctx, DONE);
1093 ** Get the `sender' from the envelope
1094 ** information ("From " line).
1097 get_sender(char *envelope, char **sender)
1101 unsigned char buffer[BUFSIZ];
1104 *sender = getcpy("");
1108 i = strlen("From ");
1109 strncpy(buffer, envelope + i, sizeof(buffer));
1110 buffer[sizeof buffer -1] = '\0'; /* ensure termination */
1111 if ((cp = strchr(buffer, '\n'))) {
1122 for (cp = buffer + strlen(buffer) - 1; cp >= buffer; cp--)
1128 *sender = getcpy(buffer);
1133 ** Copy message into a temporary file.
1134 ** While copying, it will do some header processing
1135 ** including the extraction of the envelope information.
1138 copy_message(int qd, char *tmpfil, int fold)
1140 int i, first = 1, fd1, fd2;
1141 char buffer[BUFSIZ];
1145 tfile = m_mktemp2("/tmp/", invo_name, &fd1, NULL);
1146 if (tfile == NULL) return -1;
1148 strncpy(tmpfil, tfile, BUFSIZ);
1151 while ((i = read(qd, buffer, sizeof(buffer))) > 0) {
1152 if (write(fd1, buffer, i) != i) {
1162 lseek(fd1, (off_t) 0, SEEK_SET);
1166 /* dup the fd for incoming message */
1167 if ((fd2 = dup(qd)) == -1) {
1172 /* now create a FILE pointer for it */
1173 if (!(qfp = fdopen(fd2, "r"))) {
1179 /* dup the fd for temporary file */
1180 if ((fd2 = dup(fd1)) == -1) {
1186 /* now create a FILE pointer for it */
1187 if (!(ffp = fdopen(fd2, "r+"))) {
1195 ** copy message into temporary file
1196 ** and massage the headers. Save
1197 ** a copy of the "From " line for later.
1199 i = strlen("From ");
1200 while (fgets(buffer, sizeof(buffer), qfp)) {
1203 if (strncmp(buffer, "From ", i)==0) {
1205 ** get copy of envelope information
1208 envelope = getcpy(buffer);
1210 /* Put the delivery date in message */
1232 lseek(fd1, (off_t) 0, SEEK_SET);
1243 ** Trim strings for pretty printing of debugging output
1248 char buffer[BUFSIZ*4];
1249 unsigned char *bp, *sp;
1255 /* copy string into temp buffer */
1256 strncpy(buffer, cp, sizeof(buffer));
1259 /* skip over leading whitespace */
1260 while (isspace(*bp)) {
1263 /* start at the end and zap trailing whitespace */
1264 for (sp = bp + strlen(bp) - 1; sp >= bp; sp--) {
1272 /* replace remaining whitespace with spaces */
1273 for (sp = bp; *sp; sp++) {
1282 ** Function for printing `verbose' messages.
1285 verbose_printf(char *fmt, ...)
1290 vfprintf(stdout, fmt, ap);
1297 ** Function for printing `verbose' delivery
1301 adorn(char *what, char *fmt, ...)
1307 eindex = errno; /* save the errno */
1308 fprintf(stdout, ", ");
1311 vfprintf(stdout, fmt, ap);
1316 fprintf(stdout, " %s: ", what);
1318 if ((s = strerror(eindex))) {
1319 fprintf(stdout, "%s", s);
1321 fprintf(stdout, "Error %d", eindex);
1325 fputc('\n', stdout);
1331 ** Function for printing `debug' messages.
1334 debug_printf(char *fmt, ...)
1339 vfprintf(stderr, fmt, ap);