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.
19 #include <h/rcvmail.h>
20 #include <h/signals.h>
25 #include <sys/ioctl.h>
32 #ifdef INITGROUPS_HEADER
33 #include INITGROUPS_HEADER
36 ** On AIX 4.1, initgroups() is defined and even documented (giving the
37 ** parameter types as char* and int), but doesn't have a prototype in any
38 ** of the system header files. AIX 4.3, SunOS 4.1.3, and ULTRIX 4.2A have
41 extern int initgroups(char*, int);
44 static struct swit switches[] = {
46 { "addr address", 0 },
52 { "sender address", 0 },
54 { "mailbox file", 0 },
56 { "home directory", -4 },
60 { "maildelivery file", 0 },
75 static int globbed = 0; /* have we built "vars" table yet? */
76 static int parsed = 0; /* have we built header field table yet */
78 static int verbose = 0;
81 static char *addr = NULL;
82 static char *user = NULL;
83 static char *info = NULL;
84 static char *file = NULL;
85 static char *sender = NULL;
86 static char *envelope = NULL; /* envelope information ("From " line) */
87 static char *mbox = NULL;
88 static char *home = NULL;
90 static struct passwd *pw; /* passwd file entry */
92 static char ddate[BUFSIZ]; /* record the delivery date */
95 volatile sig_atomic_t eflag = 0; /* flag to indecate interrupt */
96 static volatile pid_t child_id;
98 /* flags for pair->p_flags */
100 #define P_ADR 0x01 /* field is address */
101 #define P_HID 0x02 /* special (fake) field */
113 ** Lookup table for matching fields and patterns
114 ** in messages. The rest of the table is added
115 ** when the message is parsed.
117 static struct pair hdrs[NVEC + 1] = {
118 { "source", NULL, P_HID },
119 { "addr", NULL, P_HID },
120 { "Return-Path", NULL, P_ADR },
121 { "Reply-To", NULL, P_ADR },
122 { "From", NULL, P_ADR },
123 { "Sender", NULL, P_ADR },
124 { "To", NULL, P_ADR },
125 { "cc", NULL, P_ADR },
126 { "Resent-Reply-To", NULL, P_ADR },
127 { "Resent-From", NULL, P_ADR },
128 { "Resent-Sender", NULL, P_ADR },
129 { "Resent-To", NULL, P_ADR },
130 { "Resent-Cc", NULL, P_ADR },
135 ** The list of builtin variables to expand in a string
136 ** before it is executed by the "pipe" or "qpipe" action.
138 static struct pair vars[] = {
139 { "sender", NULL, P_NIL },
140 { "address", NULL, P_NIL },
141 { "size", NULL, P_NIL },
142 { "reply-to", NULL, P_CHK },
143 { "info", NULL, P_NIL },
147 extern char **environ;
152 static int localmail(int, char *);
153 static int usr_delivery(int, char *, int);
154 static int split(char *, char **);
155 static int parse(int);
156 static void expand(char *, char *, int);
157 static void glob(int);
158 static struct pair *lookup(struct pair *, char *);
159 static int usr_file(int, char *);
160 static int usr_pipe(int, char *, char *, char **, int);
161 static int usr_folder(int, char *);
162 static void alrmser(int);
163 static void get_sender(char *, char **);
164 static int copy_message(int, char *, int);
165 static void verbose_printf(char *fmt, ...);
166 static void adorn(char *, char *, ...);
167 static void debug_printf(char *fmt, ...);
168 static char *trimstr(char *);
172 main(int argc, char **argv)
176 char *cp, *mdlvr = NULL, buf[BUFSIZ];
177 char mailbox[BUFSIZ], tmpfil[BUFSIZ];
178 char **argp, **arguments;
180 setlocale(LC_ALL, "");
181 invo_name = mhbasename(*argv);
183 arguments = getarguments(invo_name, argc, argv, 0);
186 /* Parse arguments */
187 while ((cp = *argp++)) {
189 switch (smatch(++cp, switches)) {
191 ambigsw(cp, switches);
194 adios(NULL, "-%s unknown", cp);
197 snprintf(buf, sizeof(buf), "%s [switches] [address info sender]", invo_name);
198 print_help(buf, switches, 0);
201 print_version(invo_name);
205 if (!(addr = *argp++)) {
206 /* allow -xyz arguments */
207 adios(NULL, "missing argument to %s",
212 if (!(info = *argp++)) {
213 /* allow -xyz arguments */
214 adios(NULL, "missing argument to %s",
219 if (!(user = *argp++)) {
220 /* allow -xyz arguments */
221 adios(NULL, "missing argument to %s",
226 if (!(file = *argp++) || *file == '-') {
227 adios(NULL, "missing argument to %s",
232 if (!(sender = *argp++)) {
233 /* allow -xyz arguments */
234 adios(NULL, "missing argument to %s",
239 if (!(mbox = *argp++) || *mbox == '-') {
240 adios(NULL, "missing argument to %s",
245 if (!(home = *argp++) || *home == '-') {
246 adios(NULL, "missing argument to %s",
252 if (!(cp = *argp++) || *cp == '-') {
253 adios(NULL, "missing argument to %s",
257 adios(NULL, "only one maildelivery file at a time!");
275 switch (argp - (argv + 1)) {
289 addr = getusername();
292 user = (cp = strchr(addr, '.')) ? ++cp : addr;
294 if (!(pw = getpwnam(user))) {
295 adios(NULL, "no such local user as %s", user);
298 if (chdir(pw->pw_dir) == -1) {
303 if (geteuid() == 0) {
305 initgroups(pw->pw_name, pw->pw_gid);
315 /* Record the delivery time */
316 if (!(now = dlocaltimenow())) {
317 adios(NULL, "unable to ascertain local time");
319 snprintf(ddate, sizeof(ddate), "Delivery-Date: %s\n", dtimenow());
322 ** Copy the message to a temporary file
327 /* getting message from file */
328 if ((tempfd = open(file, O_RDONLY)) == -1) {
329 adios(file, "unable to open");
332 debug_printf("retrieving message from file \"%s\"\n",
335 if ((fd = copy_message(tempfd, tmpfil, 1)) == -1) {
336 adios(NULL, "unable to create temporary file");
340 /* getting message from stdin */
342 debug_printf("retrieving message from stdin\n");
344 if ((fd = copy_message(fileno(stdin), tmpfil, 1)) == -1) {
345 adios(NULL, "unable to create temporary file");
350 debug_printf("temporary file=\"%s\"\n", tmpfil);
354 ** Delete the temp file now or a copy of every single message
355 ** passed through slocal will be left in the /tmp directory until
356 ** deleted manually! This unlink() used to be under an 'else'
357 ** of the 'if (debug)' above, but since some people like to
358 ** always run slocal with -debug and log the results, the /tmp
359 ** directory would get choked over time. Of course, now that
360 ** we always delete the temp file, the "temporary file=" message
361 ** above is somewhat pointless -- someone watching debug output
362 ** wouldn't have a chance to 'tail -f' or 'ln' the temp file
363 ** before it's unlinked. The best thing would be to delay this
364 ** unlink() until later if debug == 1, but I'll leave that for
365 ** someone who cares about the temp-file-accessing functionality
366 ** (they'll have to watch out for cases where we adios()).
370 if (!(fp = fdopen(fd, "r+"))) {
371 adios(NULL, "unable to access temporary file");
374 /* If no sender given, extract it from envelope information. */
376 get_sender(envelope, &sender);
379 snprintf(mailbox, sizeof(mailbox), "%s/%s",
380 mailspool, pw->pw_name);
388 debug_printf("addr=\"%s\"\n", trimstr(addr));
389 debug_printf("user=\"%s\"\n", trimstr(user));
390 debug_printf("info=\"%s\"\n", trimstr(info));
391 debug_printf("sender=\"%s\"\n", trimstr(sender));
392 debug_printf("envelope=\"%s\"\n",
393 envelope ? trimstr(envelope) : "");
394 debug_printf("mbox=\"%s\"\n", trimstr(mbox));
395 debug_printf("home=\"%s\"\n", trimstr(home));
396 debug_printf("ddate=\"%s\"\n", trimstr(ddate));
397 debug_printf("now=%02d:%02d\n\n", now->tw_hour, now->tw_min);
400 /* deliver the message */
401 status = localmail(fd, mdlvr);
403 return (status != -1 ? RCV_MOK : RCV_MBX);
408 ** Main routine for delivering message.
411 localmail(int fd, char *mdlvr)
415 /* delivery according to personal Maildelivery file */
416 if (usr_delivery(fd, mdlvr ? mdlvr : ".maildelivery", 0) != -1) {
419 /* delivery according to global Maildelivery file */
420 snprintf(buf, sizeof buf, "%s/%s", mhetcdir, "maildelivery");
421 if (usr_delivery(fd, buf, 1) != -1) {
425 verbose_printf("(delivering to standard mail spool)\n");
427 /* last resort - deliver to standard mail spool */
428 return usr_file(fd, mbox);
432 #define matches(a,b) (stringdex(b, a) >= 0)
435 ** Parse the delivery file, and process incoming message.
438 usr_delivery(int fd, char *delivery, int su)
440 int i, accept, status=1, won, vecp, next;
441 char *field, *pattern, *action, *result, *string;
442 char buffer[BUFSIZ], tmpbuf[BUFSIZ];
443 char *cp, *vec[NVEC];
448 /* open the delivery file */
449 if (!(fp = fopen(delivery, "r"))) {
452 /* check if delivery file has bad ownership or permissions */
453 if (fstat(fileno(fp), &st) == -1 ||
454 (st.st_uid != 0 && (su || st.st_uid != pw->pw_uid)) ||
455 st.st_mode & (S_IWGRP|S_IWOTH)) {
457 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);
465 /* read and process delivery file */
466 while (fgets(buffer, sizeof(buffer), fp)) {
467 /* skip comments and empty lines */
468 if (*buffer == '#' || *buffer == '\n') {
471 /* zap trailing newline */
472 if ((cp = strchr(buffer, '\n'))) {
475 /* split buffer into fields */
476 vecp = split(buffer, vec);
478 /* check for too few fields */
481 debug_printf("WARNING: entry with only %d fields, skipping.\n", vecp);
486 for (i = 0; vec[i]; i++) {
487 debug_printf("vec[%d]: \"%s\"\n",
498 /* find out how to perform the action */
503 ** If previous condition failed, don't
504 ** do this - else fall through
513 ** If already delivered, skip this action.
514 ** Else consider delivered if action is
525 ** Take action, and consider delivered if
526 ** action is successful.
535 ** Take action, but don't consider delivered,
536 ** even if action is successful
542 /* check if the field matches */
550 ** "default" matches only if the message hasn't
551 ** been delivered yet.
553 if (mh_strcasecmp(field, "default")==0) {
561 /* parse message and build lookup table */
562 if (!parsed && parse(fd) == -1) {
567 ** find header field in lookup table, and
568 ** see if the pattern matches.
570 if ((p = lookup(hdrs, field)) && p->p_value &&
571 matches(p->p_value, pattern)) {
580 /* find out the action to perform */
583 /* deliver to quoted pipe */
584 if (mh_strcasecmp(action, "qpipe")) {
589 expand(tmpbuf, string, fd);
590 if (split(tmpbuf, vec) < 1) {
593 status = usr_pipe(fd, tmpbuf, vec[0], vec, 0);
597 /* deliver to pipe */
598 if (mh_strcasecmp(action, "pipe")) {
605 expand(tmpbuf, string, fd);
608 status = usr_pipe(fd, tmpbuf, "/bin/sh", vec+2, 0);
612 if (mh_strcasecmp(action, "file")==0) {
614 status = usr_file(fd, string);
617 if (mh_strcasecmp(action, "folder")!=0) {
622 /* deliver to nmh folder */
623 status = usr_folder(fd, string);
628 if (mh_strcasecmp(action, "mbox")!=0) {
634 status = usr_file(fd, string);
639 if (mh_strcasecmp(action, "destroy")!=0) {
647 next = 0; /* action failed, mark for 'N' result */
654 return (won ? 0 : -1);
659 ** Split buffer into fields (delimited by whitespace or
660 ** comma's). Return the number of fields found.
663 split(char *cp, char **vec)
670 /* split into a maximum of NVEC fields */
671 for (i = 0; i <= NVEC;) {
674 /* zap any whitespace and comma's */
675 while (isspace(*s) || *s == ',') {
678 /* end of buffer, time to leave */
682 /* get double quote text as a single field */
684 for (vec[i++] = ++s; *s && *s != '"'; s++) {
686 ** Check for escaped double quote. We need
687 ** to shift the string to remove slash.
697 /* zap trailing double quote */
703 if (*s == '\\' && *++s != '"') {
708 /* move forward to next field delimiter */
709 while (*s && !isspace(*s) && *s != ',') {
720 ** Parse the headers of a message, and build the
721 ** lookup table for matching fields and patterns.
729 char name[NAMESZ], field[BUFSIZ];
737 /* get a new FILE pointer to message */
738 if ((fd1 = dup(fd)) == -1) {
741 if (!(in = fdopen(fd1, "r"))) {
747 /* add special entries to lookup table */
748 if ((p = lookup(hdrs, "source"))) {
749 p->p_value = getcpy(sender);
751 if ((p = lookup(hdrs, "addr"))) {
752 p->p_value = getcpy(addr);
756 ** Scan the headers of the message and build a lookup table.
758 for (i = 0, state = FLD;;) {
759 switch (state = m_getfld(state, name, field, sizeof(field),
765 while (state == FLDPLUS) {
766 state = m_getfld(state, name, field,
770 for (p = hdrs; p->p_name; p++) {
771 if (mh_strcasecmp(p->p_name, name)!=0) {
772 if (!(p->p_flags & P_HID)) {
773 if ((cp = p->p_value)) {
774 if (p->p_flags & P_ADR) {
775 dp = cp + strlen(cp) - 1;
779 cp = add(",\n\t", cp);
784 p->p_value = add(lp, cp);
790 if (!p->p_name && i < NVEC) {
791 p->p_name = getcpy(name);
797 if (state != FLDEOF) {
809 advise(NULL, "format error in message");
813 advise(NULL, "internal error in m_getfld");
821 if ((p = lookup(vars, "reply-to"))) {
822 if (!(q = lookup(hdrs, "reply-to")) || !q->p_value) {
823 q = lookup(hdrs, "from");
825 p->p_value = getcpy(q ? q->p_value : "");
826 p->p_flags &= ~P_CHK;
828 debug_printf("vars[%d]: name=\"%s\" value=\"%s\"\n",
829 p - vars, p->p_name, trimstr(p->p_value));
833 for (p = hdrs; p->p_name; p++) {
834 debug_printf("hdrs[%d]: name=\"%s\" value=\"%s\"\n",
836 p->p_value ? trimstr(p->p_value) : "");
844 ** Expand any builtin variables such as $(sender),
845 ** $(address), etc., in a string.
848 expand(char *s1, char *s2, int fd)
856 while ((c = *s2++)) {
857 if (c != '$' || *s2 != '(') {
860 for (cp = ++s2; *s2 && *s2 != ')'; s2++) {
868 if ((p = lookup(vars, cp))) {
869 if (!parsed && (p->p_flags & P_CHK)) {
872 strcpy(s1, p->p_value);
882 ** Fill in the information missing from the "vars"
883 ** table, which is necessary to expand any builtin
884 ** variables in the string for a "pipe" or "qpipe"
897 if ((p = lookup(vars, "sender"))) {
898 p->p_value = getcpy(sender);
900 if ((p = lookup(vars, "address"))) {
901 p->p_value = getcpy(addr);
903 if ((p = lookup(vars, "size"))) {
904 snprintf(buffer, sizeof(buffer), "%d",
905 fstat(fd, &st) != -1 ? (int) st.st_size : 0);
906 p->p_value = getcpy(buffer);
908 if ((p = lookup(vars, "info"))) {
909 p->p_value = getcpy(info);
912 for (p = vars; p->p_name; p++) {
913 debug_printf("vars[%d]: name=\"%s\" value=\"%s\"\n",
914 p - vars, p->p_name, trimstr(p->p_value));
921 ** Find a matching name in a lookup table. If found,
922 ** return the "pairs" entry, else return NULL.
925 lookup(struct pair *pairs, char *key)
927 for (; pairs->p_name; pairs++) {
928 if (!mh_strcasecmp(pairs->p_name, key)) {
937 ** Deliver message by appending to a file, using rcvpack(1).
940 usr_file(int fd, char *mailbox)
945 verbose_printf("delivering to file \"%s\" (mbox style)",
952 return usr_pipe(fd, "rcvpack", "rcvpack", vec, 1);
957 ** Deliver message to a nmh folder, using rcvstore(1).
960 usr_folder(int fd, char *string)
962 char folder[BUFSIZ], *vec[3];
964 /* get folder name ready */
965 if (*string == '+') {
966 strncpy(folder, string, sizeof(folder));
968 snprintf(folder, sizeof(folder), "+%s", string);
971 verbose_printf("delivering to folder \"%s\"", folder + 1);
977 return usr_pipe(fd, "rcvstore", "rcvstore", vec, 1);
981 ** Deliver message to a process.
984 usr_pipe(int fd, char *cmd, char *pgm, char **vec, int suppress)
986 int bytes, seconds, status, n;
990 if (verbose && !suppress) {
991 verbose_printf("delivering to pipe \"%s\"", cmd);
993 lseek(fd, (off_t) 0, SEEK_SET);
995 switch ((child_id = fork())) {
999 adorn("fork", "unable to");
1008 freopen("/dev/null", "w", stdout);
1009 freopen("/dev/null", "w", stderr);
1013 for (n=4; n<OPEN_MAX; n++) {
1018 if ((fd = open("/dev/tty", O_RDWR)) != -1) {
1019 ioctl(fd, TIOCNOTTY, NULL);
1022 #endif /* TIOCNOTTY */
1024 /* put in own process group */
1025 setpgid((pid_t) 0, getpid());
1027 path = getenv("PATH");
1029 m_putenv("USER", pw->pw_name);
1030 m_putenv("HOME", pw->pw_dir);
1031 m_putenv("SHELL", pw->pw_shell);
1032 m_putenv("PATH", path);
1038 /* parent process */
1039 SIGNAL(SIGALRM, alrmser);
1040 bytes = fstat(fd, &st) != -1 ? (int) st.st_size : 100;
1042 /* amount of time to wait depends on message size */
1044 /* give at least 5 minutes */
1046 } else if (bytes >= 90000) {
1047 /* a half hour is long enough */
1050 seconds = (bytes / 60) + 300;
1052 alarm((unsigned int) seconds);
1053 status = pidwait(child_id, 0);
1058 verbose_printf(", timed-out; terminated\n");
1065 verbose_printf(", success.\n");
1066 } else if ((status & 0xff00) == 0xff00) {
1067 verbose_printf(", system error\n");
1069 pidstatus(status, stdout, ", failed");
1072 return (status == 0 ? 0 : -1);
1081 kill(-child_id, SIGKILL);
1086 ** Get the `sender' from the envelope
1087 ** information ("From " line).
1090 get_sender(char *envelope, char **sender)
1094 unsigned char buffer[BUFSIZ];
1097 *sender = getcpy("");
1101 i = strlen("From ");
1102 strncpy(buffer, envelope + i, sizeof(buffer));
1103 buffer[sizeof buffer -1] = '\0'; /* ensure termination */
1104 if ((cp = strchr(buffer, '\n'))) {
1115 for (cp = buffer + strlen(buffer) - 1; cp >= buffer; cp--)
1121 *sender = getcpy(buffer);
1126 ** Copy message into a temporary file.
1127 ** While copying, it will do some header processing
1128 ** including the extraction of the envelope information.
1131 copy_message(int qd, char *tmpfil, int fold)
1133 int i, first = 1, fd1, fd2;
1134 char buffer[BUFSIZ];
1138 tfile = m_mktemp2("/tmp/", invo_name, &fd1, NULL);
1139 if (tfile == NULL) return -1;
1141 strncpy(tmpfil, tfile, BUFSIZ);
1144 while ((i = read(qd, buffer, sizeof(buffer))) > 0) {
1145 if (write(fd1, buffer, i) != i) {
1155 lseek(fd1, (off_t) 0, SEEK_SET);
1159 /* dup the fd for incoming message */
1160 if ((fd2 = dup(qd)) == -1) {
1165 /* now create a FILE pointer for it */
1166 if (!(qfp = fdopen(fd2, "r"))) {
1172 /* dup the fd for temporary file */
1173 if ((fd2 = dup(fd1)) == -1) {
1179 /* now create a FILE pointer for it */
1180 if (!(ffp = fdopen(fd2, "r+"))) {
1188 ** copy message into temporary file
1189 ** and massage the headers. Save
1190 ** a copy of the "From " line for later.
1192 i = strlen("From ");
1193 while (fgets(buffer, sizeof(buffer), qfp)) {
1196 if (strncmp(buffer, "From ", i)==0) {
1198 ** get copy of envelope information
1201 envelope = getcpy(buffer);
1203 /* Put the delivery date in message */
1225 lseek(fd1, (off_t) 0, SEEK_SET);
1236 ** Trim strings for pretty printing of debugging output
1241 char buffer[BUFSIZ*4];
1242 unsigned char *bp, *sp;
1248 /* copy string into temp buffer */
1249 strncpy(buffer, cp, sizeof(buffer));
1252 /* skip over leading whitespace */
1253 while (isspace(*bp)) {
1256 /* start at the end and zap trailing whitespace */
1257 for (sp = bp + strlen(bp) - 1; sp >= bp; sp--) {
1265 /* replace remaining whitespace with spaces */
1266 for (sp = bp; *sp; sp++) {
1275 ** Function for printing `verbose' messages.
1278 verbose_printf(char *fmt, ...)
1283 vfprintf(stdout, fmt, ap);
1290 ** Function for printing `verbose' delivery
1294 adorn(char *what, char *fmt, ...)
1300 eindex = errno; /* save the errno */
1301 fprintf(stdout, ", ");
1304 vfprintf(stdout, fmt, ap);
1309 fprintf(stdout, " %s: ", what);
1311 if ((s = strerror(eindex))) {
1312 fprintf(stdout, "%s", s);
1314 fprintf(stdout, "Error %d", eindex);
1318 fputc('\n', stdout);
1324 ** Function for printing `debug' messages.
1327 debug_printf(char *fmt, ...)
1332 vfprintf(stderr, fmt, ap);