1 /* $Cambridge: exim/src/src/transports/autoreply.c,v 1.8 2006/02/07 11:19:03 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
12 #include "autoreply.h"
16 /* Options specific to the autoreply transport. They must be in alphabetic
17 order (note that "_" comes before the lower case letters). Those starting
18 with "*" are not settable by the user but are used by the option-reading
19 software for alternative value types. Some options are publicly visible and so
20 are stored in the driver instance block. These are flagged with opt_public. */
22 optionlist autoreply_transport_options[] = {
23 { "bcc", opt_stringptr,
24 (void *)offsetof(autoreply_transport_options_block, bcc) },
25 { "cc", opt_stringptr,
26 (void *)offsetof(autoreply_transport_options_block, cc) },
27 { "file", opt_stringptr,
28 (void *)offsetof(autoreply_transport_options_block, file) },
29 { "file_expand", opt_bool,
30 (void *)offsetof(autoreply_transport_options_block, file_expand) },
31 { "file_optional", opt_bool,
32 (void *)offsetof(autoreply_transport_options_block, file_optional) },
33 { "from", opt_stringptr,
34 (void *)offsetof(autoreply_transport_options_block, from) },
35 { "headers", opt_stringptr,
36 (void *)offsetof(autoreply_transport_options_block, headers) },
37 { "log", opt_stringptr,
38 (void *)offsetof(autoreply_transport_options_block, logfile) },
40 (void *)offsetof(autoreply_transport_options_block, mode) },
41 { "never_mail", opt_stringptr,
42 (void *)offsetof(autoreply_transport_options_block, never_mail) },
43 { "once", opt_stringptr,
44 (void *)offsetof(autoreply_transport_options_block, oncelog) },
45 { "once_file_size", opt_int,
46 (void *)offsetof(autoreply_transport_options_block, once_file_size) },
47 { "once_repeat", opt_stringptr,
48 (void *)offsetof(autoreply_transport_options_block, once_repeat) },
49 { "reply_to", opt_stringptr,
50 (void *)offsetof(autoreply_transport_options_block, reply_to) },
51 { "return_message", opt_bool,
52 (void *)offsetof(autoreply_transport_options_block, return_message) },
53 { "subject", opt_stringptr,
54 (void *)offsetof(autoreply_transport_options_block, subject) },
55 { "text", opt_stringptr,
56 (void *)offsetof(autoreply_transport_options_block, text) },
57 { "to", opt_stringptr,
58 (void *)offsetof(autoreply_transport_options_block, to) },
61 /* Size of the options list. An extern variable has to be used so that its
62 address can appear in the tables drtables.c. */
64 int autoreply_transport_options_count =
65 sizeof(autoreply_transport_options)/sizeof(optionlist);
67 /* Default private options block for the autoreply transport. */
69 autoreply_transport_options_block autoreply_transport_option_defaults = {
81 NULL, /* once_repeat */
82 NULL, /* never_mail */
84 0, /* once_file_size */
85 FALSE, /* file_expand */
86 FALSE, /* file_optional */
87 FALSE /* return message */
92 /* Type of text for the checkexpand() function */
94 enum { cke_text, cke_hdr, cke_file };
98 /*************************************************
99 * Initialization entry point *
100 *************************************************/
102 /* Called for each instance, after its options have been read, to
103 enable consistency checks to be done, or anything else that needs
107 autoreply_transport_init(transport_instance *tblock)
110 autoreply_transport_options_block *ob =
111 (autoreply_transport_options_block *)(tblock->options_block);
114 /* If a fixed uid field is set, then a gid field must also be set. */
116 if (tblock->uid_set && !tblock->gid_set && tblock->expand_gid == NULL)
117 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
118 "user set without group for the %s transport", tblock->name);
124 /*************************************************
125 * Expand string and check *
126 *************************************************/
128 /* If the expansion fails, the error is set up in the address. Expanded
129 strings must be checked to ensure they contain only printing characters
130 and white space. If not, the function fails.
134 addr address that is being worked on
135 name transport name, for error text
136 type type, for checking content:
138 cke_hdr => header, allow \n + whitespace
139 cke_file => file name, no non-printers allowed
141 Returns: expanded string if expansion succeeds;
146 checkexpand(uschar *s, address_item *addr, uschar *name, int type)
149 uschar *ss = expand_string(s);
153 addr->transport_return = FAIL;
154 addr->message = string_sprintf("Expansion of \"%s\" failed in %s transport: "
155 "%s", s, name, expand_string_message);
159 if (type != cke_text) for (t = ss; *t != 0; t++)
162 if (mac_isprint(c)) continue;
163 if (type == cke_hdr && c == '\n' && (t[1] == ' ' || t[1] == '\t')) continue;
164 s = string_printing(s);
165 addr->transport_return = FAIL;
166 addr->message = string_sprintf("Expansion of \"%s\" in %s transport "
167 "contains non-printing character %d", s, name, c);
177 /*************************************************
178 * Check a header line for never_mail *
179 *************************************************/
181 /* This is called to check to, cc, and bcc for addresses in the never_mail
182 list. Any that are found are removed.
185 listptr points to the list of addresses
186 never_mail an address list, already expanded
192 check_never_mail(uschar **listptr, uschar *never_mail)
194 uschar *s = *listptr;
198 uschar *error, *next;
199 uschar *e = parse_find_address_end(s, FALSE);
201 int start, end, domain, rc;
203 /* Temporarily terminate the string at the address end while extracting
204 the operative address within. */
207 next = parse_extract_address(s, &error, &start, &end, &domain, FALSE);
210 /* If there is some kind of syntax error, just give up on this header
213 if (next == NULL) break;
215 /* See if the address is on the never_mail list */
217 rc = match_address_list(next, /* address to check */
218 TRUE, /* start caseless */
219 FALSE, /* don't expand the list */
220 &never_mail, /* the list */
221 NULL, /* no caching */
222 -1, /* no expand setup */
223 0, /* separator from list */
224 NULL); /* no lookup value return */
226 if (rc == OK) /* Remove this address */
229 debug_printf("discarding recipient %s (matched never_mail)\n", next);
230 if (terminator == ',') e++;
231 memmove(s, e, Ustrlen(e) + 1);
233 else /* Skip over this address */
236 if (terminator == ',') s++;
240 /* Check to see if we removed the last address, leaving a terminating comma
241 that needs to be removed */
243 s = *listptr + Ustrlen(*listptr);
244 while (s > *listptr && (isspace(s[-1]) || s[-1] == ',')) s--;
247 /* Check to see if there any addresses left; if not, set NULL */
250 while (s != 0 && isspace(*s)) s++;
251 if (*s == 0) *listptr = NULL;
256 /*************************************************
258 *************************************************/
260 /* See local README for interface details. This transport always returns
261 FALSE, indicating that the top address has the status for all - though in fact
262 this transport can handle only one address at at time anyway. */
265 autoreply_transport_entry(
266 transport_instance *tblock, /* data for this instantiation */
267 address_item *addr) /* address we are working on */
274 EXIM_DB *dbm_file = NULL;
275 BOOL file_expand, return_message;
276 uschar *from, *reply_to, *to, *cc, *bcc, *subject, *headers, *text, *file;
277 uschar *logfile, *oncelog;
278 uschar *cache_buff = NULL;
279 uschar *cache_time = NULL;
281 time_t now = time(NULL);
282 time_t once_repeat_sec = 0;
286 autoreply_transport_options_block *ob =
287 (autoreply_transport_options_block *)(tblock->options_block);
289 DEBUG(D_transport) debug_printf("%s transport entered\n", tblock->name);
291 /* Set up for the good case */
293 addr->transport_return = OK;
294 addr->basic_errno = 0;
296 /* If the address is pointing to a reply block, then take all the data
297 from that block. It has typically been set up by a mail filter processing
298 router. Otherwise, the data must be supplied by this transport, and
299 it has to be expanded here. */
301 if (addr->reply != NULL)
303 DEBUG(D_transport) debug_printf("taking data from address\n");
304 from = addr->reply->from;
305 reply_to = addr->reply->reply_to;
306 to = addr->reply->to;
307 cc = addr->reply->cc;
308 bcc = addr->reply->bcc;
309 subject = addr->reply->subject;
310 headers = addr->reply->headers;
311 text = addr->reply->text;
312 file = addr->reply->file;
313 logfile = addr->reply->logfile;
314 oncelog = addr->reply->oncelog;
315 once_repeat_sec = addr->reply->once_repeat;
316 file_expand = addr->reply->file_expand;
317 expand_forbid = addr->reply->expand_forbid;
318 return_message = addr->reply->return_message;
322 uschar *oncerepeat = ob->once_repeat;
324 DEBUG(D_transport) debug_printf("taking data from transport\n");
326 reply_to = ob->reply_to;
330 subject = ob->subject;
331 headers = ob->headers;
334 logfile = ob->logfile;
335 oncelog = ob->oncelog;
336 file_expand = ob->file_expand;
337 return_message = ob->return_message;
340 (from = checkexpand(from, addr, tblock->name, cke_hdr)) == NULL) ||
342 (reply_to = checkexpand(reply_to, addr, tblock->name, cke_hdr)) == NULL) ||
344 (to = checkexpand(to, addr, tblock->name, cke_hdr)) == NULL) ||
346 (cc = checkexpand(cc, addr, tblock->name, cke_hdr)) == NULL) ||
348 (bcc = checkexpand(bcc, addr, tblock->name, cke_hdr)) == NULL) ||
350 (subject = checkexpand(subject, addr, tblock->name, cke_hdr)) == NULL) ||
352 (headers = checkexpand(headers, addr, tblock->name, cke_text)) == NULL) ||
354 (text = checkexpand(text, addr, tblock->name, cke_text)) == NULL) ||
356 (file = checkexpand(file, addr, tblock->name, cke_file)) == NULL) ||
358 (logfile = checkexpand(logfile, addr, tblock->name, cke_file)) == NULL) ||
360 (oncelog = checkexpand(oncelog, addr, tblock->name, cke_file)) == NULL) ||
361 (oncerepeat != NULL &&
362 (oncerepeat = checkexpand(oncerepeat, addr, tblock->name, cke_file)) == NULL))
365 if (oncerepeat != NULL)
367 once_repeat_sec = readconf_readtime(oncerepeat, 0, FALSE);
368 if (once_repeat_sec < 0)
370 addr->transport_return = FAIL;
371 addr->message = string_sprintf("Invalid time value \"%s\" for "
372 "\"once_repeat\" in %s transport", oncerepeat, tblock->name);
378 /* If the never_mail option is set, we have to scan all the recipients and
379 remove those that match. */
381 if (ob->never_mail != NULL)
383 uschar *never_mail = expand_string(ob->never_mail);
385 if (never_mail == NULL)
387 addr->transport_return = FAIL;
388 addr->message = string_sprintf("Failed to expand \"%s\" for "
389 "\"never_mail\" in %s transport", ob->never_mail, tblock->name);
393 if (to != NULL) check_never_mail(&to, never_mail);
394 if (cc != NULL) check_never_mail(&cc, never_mail);
395 if (bcc != NULL) check_never_mail(&bcc, never_mail);
397 if (to == NULL && cc == NULL && bcc == NULL)
400 debug_printf("*** all recipients removed by never_mail\n");
405 /* If the -N option is set, can't do any more. */
410 debug_printf("*** delivery by %s transport bypassed by -N option\n",
416 /* If the oncelog field is set, we send want to send only one message to the
417 given recipient(s). This works only on the "To" field. If there is no "To"
418 field, the message is always sent. If the To: field contains more than one
419 recipient, the effect might not be quite as envisaged. If once_file_size is
420 set, instead of a dbm file, we use a regular file containing a circular buffer
423 if (oncelog != NULL && *oncelog != 0 && to != NULL)
427 /* Handle fixed-size cache file. */
429 if (ob->once_file_size > 0)
433 cache_fd = Uopen(oncelog, O_CREAT|O_RDWR, ob->mode);
435 if (cache_fd < 0 || fstat(cache_fd, &statbuf) != 0)
437 addr->transport_return = DEFER;
438 addr->message = string_sprintf("Failed to %s \"once\" file %s when "
439 "sending message from %s transport: %s",
440 (cache_fd < 0)? "open" : "stat", oncelog, tblock->name,
445 /* Get store in the temporary pool and read the entire file into it. We get
446 an amount of store that is big enough to add the new entry on the end if we
449 cache_size = statbuf.st_size;
450 add_size = sizeof(time_t) + Ustrlen(to) + 1;
451 cache_buff = store_get(cache_size + add_size);
453 if (read(cache_fd, cache_buff, cache_size) != cache_size)
455 addr->transport_return = DEFER;
456 addr->basic_errno = errno;
457 addr->message = US"error while reading \"once\" file";
461 DEBUG(D_transport) debug_printf("%d bytes read from %s\n", cache_size, oncelog);
463 /* Scan the data for this recipient. Each entry in the file starts with
464 a time_t sized time value, followed by the address, followed by a binary
465 zero. If we find a match, put the time into "then", and the place where it
466 was found into "cache_time". Otherwise, "then" is left at zero. */
469 while (p < cache_buff + cache_size)
471 uschar *s = p + sizeof(time_t);
472 uschar *nextp = s + Ustrlen(s) + 1;
473 if (Ustrcmp(to, s) == 0)
475 memcpy(&then, p, sizeof(time_t));
483 /* Use a DBM file for the list of previous recipients. */
487 EXIM_DATUM key_datum, result_datum;
488 EXIM_DBOPEN(oncelog, O_RDWR|O_CREAT, ob->mode, &dbm_file);
489 if (dbm_file == NULL)
491 addr->transport_return = DEFER;
492 addr->message = string_sprintf("Failed to open %s file %s when sending "
493 "message from %s transport: %s", EXIM_DBTYPE, oncelog, tblock->name,
498 EXIM_DATUM_INIT(key_datum); /* Some DBM libraries need datums */
499 EXIM_DATUM_INIT(result_datum); /* to be cleared */
500 EXIM_DATUM_DATA(key_datum) = CS to;
501 EXIM_DATUM_SIZE(key_datum) = Ustrlen(to) + 1;
503 if (EXIM_DBGET(dbm_file, key_datum, result_datum))
505 /* If the datum size is that of a binary time, we are in the new world
506 where messages are sent periodically. Otherwise the file is an old one,
507 where the datum was filled with a tod_log time, which is assumed to be
508 different in size. For that, only one message is ever sent. This change
509 introduced at Exim 3.00. In a couple of years' time the test on the size
512 if (EXIM_DATUM_SIZE(result_datum) == sizeof(time_t))
514 memcpy(&then, EXIM_DATUM_DATA(result_datum), sizeof(time_t));
520 /* Either "then" is set zero, if no message has yet been sent, or it
521 is set to the time of the last sending. */
523 if (then != 0 && (once_repeat_sec <= 0 || now - then < once_repeat_sec))
525 DEBUG(D_transport) debug_printf("message previously sent to %s%s\n", to,
526 (once_repeat_sec > 0)? " and repeat time not reached" : "");
527 log_fd = Uopen(logfile, O_WRONLY|O_APPEND|O_CREAT, ob->mode);
530 uschar *ptr = log_buffer;
531 sprintf(CS ptr, "%s\n previously sent to %.200s\n", tod_stamp(tod_log), to);
533 (void)write(log_fd, log_buffer, ptr - log_buffer);
539 DEBUG(D_transport) debug_printf("%s %s\n", (then <= 0)?
540 "no previous message sent to" : "repeat time reached for", to);
543 /* We are going to send a message. Ensure any requested file is available. */
547 ff = Ufopen(file, "rb");
548 if (ff == NULL && !ob->file_optional)
550 addr->transport_return = DEFER;
551 addr->message = string_sprintf("Failed to open file %s when sending "
552 "message from %s transport: %s", file, tblock->name, strerror(errno));
557 /* Make a subprocess to send the message */
559 pid = child_open_exim(&fd);
561 /* Creation of child failed; defer this delivery. */
565 addr->transport_return = DEFER;
566 addr->message = string_sprintf("Failed to create child process to send "
567 "message from %s transport: %s", tblock->name, strerror(errno));
568 DEBUG(D_transport) debug_printf("%s\n", addr->message);
572 /* Create the message to be sent - recipients are taken from the headers,
573 as the -t option is used. The "headers" stuff *must* be last in case there
574 are newlines in it which might, if placed earlier, screw up other headers. */
576 f = fdopen(fd, "wb");
578 if (from != NULL) fprintf(f, "From: %s\n", from);
579 if (reply_to != NULL) fprintf(f, "Reply-To: %s\n", reply_to);
580 if (to != NULL) fprintf(f, "To: %s\n", to);
581 if (cc != NULL) fprintf(f, "Cc: %s\n", cc);
582 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
583 if (subject != NULL) fprintf(f, "Subject: %s\n", subject);
585 /* Generate In-Reply-To from the message_id header; there should
586 always be one, but code defensively. */
588 for (h = header_list; h != NULL; h = h->next)
589 if (h->type == htype_id) break;
593 uschar *s = Ustrchr(h->text, ':') + 1;
594 while (isspace(*s)) s++;
595 fprintf(f, "In-Reply-To: %s", s);
598 /* Add an Auto-Submitted: header */
600 fprintf(f, "Auto-Submitted: auto-replied\n");
602 /* Add any specially requested headers */
604 if (headers != NULL) fprintf(f, "%s\n", headers);
609 fprintf(f, "%s", CS text);
610 if (text[Ustrlen(text)-1] != '\n') fprintf(f, "\n");
615 while (Ufgets(big_buffer, big_buffer_size, ff) != NULL)
619 uschar *s = expand_string(big_buffer);
623 debug_printf("error while expanding line from file:\n %s\n %s\n",
624 big_buffer, expand_string_message);
626 fprintf(f, "%s", (s == NULL)? CS big_buffer : CS s);
628 else fprintf(f, "%s", CS big_buffer);
632 /* Copy the original message if required, observing the return size
633 limit if we are returning the body. */
637 uschar *rubric = (tblock->headers_only)?
638 US"------ This is a copy of the message's header lines.\n"
639 : (tblock->body_only)?
640 US"------ This is a copy of the body of the message, without the headers.\n"
642 US"------ This is a copy of the message, including all the headers.\n";
644 if (bounce_return_size_limit > 0 && !tblock->headers_only)
647 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
648 DELIVER_IN_BUFFER_SIZE;
649 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
652 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
653 "------ %d or so are included here.\n\n", rubric, statbuf.st_size,
656 else fprintf(f, "\n%s\n", rubric);
658 else fprintf(f, "\n%s\n", rubric);
662 transport_write_message(addr, fileno(f),
663 (tblock->body_only? topt_no_headers : 0) |
664 (tblock->headers_only? topt_no_body : 0) |
665 (tblock->return_path_add? topt_add_return_path : 0) |
666 (tblock->delivery_date_add? topt_add_delivery_date : 0) |
667 (tblock->envelope_to_add? topt_add_envelope_to : 0),
668 bounce_return_size_limit, tblock->add_headers, tblock->remove_headers,
669 NULL, NULL, tblock->rewrite_rules, tblock->rewrite_existflags);
672 /* End the message and wait for the child process to end; no timeout. */
675 rc = child_close(pid, 0);
677 /* Update the "sent to" log whatever the yield. This errs on the side of
678 missing out a message rather than risking sending more than one. We either have
679 cache_fd set to a fixed size, circular buffer file, or dbm_file set to an open
680 DBM file (or neither, if "once" is not set). */
682 /* Update fixed-size cache file. If cache_time is set, we found a previous
683 entry; that is the spot into which to put the current time. Otherwise we have
684 to add a new record; remove the first one in the file if the file is too big.
685 We always rewrite the entire file in a single write operation. This is
686 (hopefully) going to be the safest thing because there is no interlocking
687 between multiple simultaneous deliveries. */
691 uschar *from = cache_buff;
692 int size = cache_size;
693 (void)lseek(cache_fd, 0, SEEK_SET);
695 if (cache_time == NULL)
697 cache_time = from + size;
698 memcpy(cache_time + sizeof(time_t), to, add_size - sizeof(time_t));
701 if (cache_size > 0 && size > ob->once_file_size)
703 from += sizeof(time_t) + Ustrlen(from + sizeof(time_t)) + 1;
704 size -= (from - cache_buff);
708 memcpy(cache_time, &now, sizeof(time_t));
709 (void)write(cache_fd, from, size);
712 /* Update DBM file */
714 else if (dbm_file != NULL)
716 EXIM_DATUM key_datum, value_datum;
717 EXIM_DATUM_INIT(key_datum); /* Some DBM libraries need to have */
718 EXIM_DATUM_INIT(value_datum); /* cleared datums. */
719 EXIM_DATUM_DATA(key_datum) = CS to;
720 EXIM_DATUM_SIZE(key_datum) = Ustrlen(to) + 1;
722 /* Many OS define the datum value, sensibly, as a void *. However, there
723 are some which still have char *. By casting this address to a char * we
724 can avoid warning messages from the char * systems. */
726 EXIM_DATUM_DATA(value_datum) = CS (&now);
727 EXIM_DATUM_SIZE(value_datum) = (int)sizeof(time_t);
728 EXIM_DBPUT(dbm_file, key_datum, value_datum);
731 /* If sending failed, defer to try again - but if once is set the next
732 try will skip, of course. However, if there were no recipients in the
733 message, we do not fail. */
737 if (rc == EXIT_NORECIPIENTS)
739 DEBUG(D_any) debug_printf("%s transport: message contained no recipients\n",
744 addr->transport_return = DEFER;
745 addr->message = string_sprintf("Failed to send message from %s "
746 "transport (%d)", tblock->name, rc);
751 /* Log the sending of the message if successful and required. If the file
752 fails to open, it's hard to know what to do. We cannot write to the Exim
753 log from here, since we may be running under an unprivileged uid. We don't
754 want to fail the delivery, since the message has been successfully sent. For
755 the moment, ignore open failures. Write the log entry as a single write() to a
756 file opened for appending, in order to avoid interleaving of output from
757 different processes. The log_buffer can be used exactly as for main log
762 int log_fd = Uopen(logfile, O_WRONLY|O_APPEND|O_CREAT, ob->mode);
765 uschar *ptr = log_buffer;
766 DEBUG(D_transport) debug_printf("logging message details\n");
767 sprintf(CS ptr, "%s\n", tod_stamp(tod_log));
771 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
772 " From: %s\n", from);
777 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
783 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
789 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
795 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
796 " Subject: %s\n", subject);
801 (void)string_format(ptr, LOG_BUFFER_SIZE - (ptr-log_buffer),
805 (void)write(log_fd, log_buffer, ptr - log_buffer);
808 else DEBUG(D_transport) debug_printf("Failed to open log file %s for %s "
809 "transport: %s\n", logfile, tblock->name, strerror(errno));
813 if (dbm_file != NULL) EXIM_DBCLOSE(dbm_file);
814 if (cache_fd > 0) (void)close(cache_fd);
816 DEBUG(D_transport) debug_printf("%s transport succeeded\n", tblock->name);
821 /* End of transport/autoreply.c */