1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
14 /* Data block for keeping track of subprocesses for parallel remote
17 typedef struct pardata {
18 address_item *addrlist; /* chain of addresses */
19 address_item *addr; /* next address data expected for */
20 pid_t pid; /* subprocess pid */
21 int fd; /* pipe fd for getting result from subprocess */
22 int transport_count; /* returned transport count value */
23 BOOL done; /* no more data needed */
24 uschar *msg; /* error message */
25 uschar *return_path; /* return_path for these addresses */
28 /* Values for the process_recipients variable */
30 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
31 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
34 /* Mutually recursive functions for marking addresses done. */
36 static void child_done(address_item *, uschar *);
37 static void address_done(address_item *, uschar *);
39 /* Table for turning base-62 numbers into binary */
41 static uschar tab62[] =
42 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
43 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
44 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
45 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
46 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
47 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
51 /*************************************************
52 * Local static variables *
53 *************************************************/
55 /* addr_duplicate is global because it needs to be seen from the Envelope-To
58 static address_item *addr_defer = NULL;
59 static address_item *addr_failed = NULL;
60 static address_item *addr_fallback = NULL;
61 static address_item *addr_local = NULL;
62 static address_item *addr_new = NULL;
63 static address_item *addr_remote = NULL;
64 static address_item *addr_route = NULL;
65 static address_item *addr_succeed = NULL;
67 static FILE *message_log = NULL;
68 static BOOL update_spool;
69 static BOOL remove_journal;
70 static int parcount = 0;
71 static pardata *parlist = NULL;
72 static int return_count;
73 static uschar *frozen_info = US"";
74 static uschar *used_return_path = NULL;
76 static uschar spoolname[PATH_MAX];
80 /*************************************************
81 * Make a new address item *
82 *************************************************/
84 /* This function gets the store and initializes with default values. The
85 transport_return value defaults to DEFER, so that any unexpected failure to
86 deliver does not wipe out the message. The default unique string is set to a
87 copy of the address, so that its domain can be lowercased.
90 address the RFC822 address string
91 copy force a copy of the address
93 Returns: a pointer to an initialized address_item
97 deliver_make_addr(uschar *address, BOOL copy)
99 address_item *addr = store_get(sizeof(address_item));
100 *addr = address_defaults;
101 if (copy) address = string_copy(address);
102 addr->address = address;
103 addr->unique = string_copy(address);
110 /*************************************************
111 * Set expansion values for an address *
112 *************************************************/
114 /* Certain expansion variables are valid only when handling an address or
115 address list. This function sets them up or clears the values, according to its
119 addr the address in question, or NULL to clear values
124 deliver_set_expansions(address_item *addr)
128 uschar ***p = address_expansions;
129 while (*p != NULL) **p++ = NULL;
133 /* Exactly what gets set depends on whether there is one or more addresses, and
134 what they contain. These first ones are always set, taking their values from
135 the first address. */
137 if (addr->host_list == NULL)
139 deliver_host = deliver_host_address = US"";
143 deliver_host = addr->host_list->name;
144 deliver_host_address = addr->host_list->address;
147 deliver_recipients = addr;
148 deliver_address_data = addr->p.address_data;
149 deliver_domain_data = addr->p.domain_data;
150 deliver_localpart_data = addr->p.localpart_data;
152 /* These may be unset for multiple addresses */
154 deliver_domain = addr->domain;
155 self_hostname = addr->self_hostname;
157 #ifdef EXPERIMENTAL_BRIGHTMAIL
158 bmi_deliver = 1; /* deliver by default */
159 bmi_alt_location = NULL;
160 bmi_base64_verdict = NULL;
161 bmi_base64_tracker_verdict = NULL;
164 /* If there's only one address we can set everything. */
166 if (addr->next == NULL)
168 address_item *addr_orig;
170 deliver_localpart = addr->local_part;
171 deliver_localpart_prefix = addr->prefix;
172 deliver_localpart_suffix = addr->suffix;
174 for (addr_orig = addr; addr_orig->parent != NULL;
175 addr_orig = addr_orig->parent);
176 deliver_domain_orig = addr_orig->domain;
178 /* Re-instate any prefix and suffix in the original local part. In all
179 normal cases, the address will have a router associated with it, and we can
180 choose the caseful or caseless version accordingly. However, when a system
181 filter sets up a pipe, file, or autoreply delivery, no router is involved.
182 In this case, though, there won't be any prefix or suffix to worry about. */
184 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
185 addr_orig->router->caseful_local_part?
186 addr_orig->cc_local_part : addr_orig->lc_local_part;
188 /* If there's a parent, make its domain and local part available, and if
189 delivering to a pipe or file, or sending an autoreply, get the local
190 part from the parent. For pipes and files, put the pipe or file string
191 into address_pipe and address_file. */
193 if (addr->parent != NULL)
195 deliver_domain_parent = addr->parent->domain;
196 deliver_localpart_parent = (addr->parent->router == NULL)?
197 addr->parent->local_part :
198 addr->parent->router->caseful_local_part?
199 addr->parent->cc_local_part : addr->parent->lc_local_part;
201 /* File deliveries have their own flag because they need to be picked out
202 as special more often. */
204 if (testflag(addr, af_pfr))
206 if (testflag(addr, af_file)) address_file = addr->local_part;
207 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
208 deliver_localpart = addr->parent->local_part;
209 deliver_localpart_prefix = addr->parent->prefix;
210 deliver_localpart_suffix = addr->parent->suffix;
214 #ifdef EXPERIMENTAL_BRIGHTMAIL
215 /* Set expansion variables related to Brightmail AntiSpam */
216 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
217 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
218 /* get message delivery status (0 - don't deliver | 1 - deliver) */
219 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
220 /* if message is to be delivered, get eventual alternate location */
221 if (bmi_deliver == 1) {
222 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
228 /* For multiple addresses, don't set local part, and leave the domain and
229 self_hostname set only if it is the same for all of them. It is possible to
230 have multiple pipe and file addresses, but only when all addresses have routed
231 to the same pipe or file. */
236 if (testflag(addr, af_pfr))
238 if (testflag(addr, af_file)) address_file = addr->local_part;
239 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
241 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
243 if (deliver_domain != NULL &&
244 Ustrcmp(deliver_domain, addr2->domain) != 0)
245 deliver_domain = NULL;
246 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
247 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
248 self_hostname = NULL;
249 if (deliver_domain == NULL && self_hostname == NULL) break;
257 /*************************************************
258 * Open a msglog file *
259 *************************************************/
261 /* This function is used both for normal message logs, and for files in the
262 msglog directory that are used to catch output from pipes. Try to create the
263 directory if it does not exist. From release 4.21, normal message logs should
264 be created when the message is received.
267 filename the file name
268 mode the mode required
269 error used for saying what failed
271 Returns: a file descriptor, or -1 (with errno set)
275 open_msglog_file(uschar *filename, int mode, uschar **error)
277 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
279 if (fd < 0 && errno == ENOENT)
282 sprintf(CS temp, "msglog/%s", message_subdir);
283 if (message_subdir[0] == 0) temp[6] = 0;
284 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
285 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
288 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
289 function is called as root). Double check the mode, because the group setting
290 doesn't always get set automatically. */
294 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
295 if (fchown(fd, exim_uid, exim_gid) < 0)
300 if (fchmod(fd, mode) < 0)
306 else *error = US"create";
314 /*************************************************
315 * Write to msglog if required *
316 *************************************************/
318 /* Write to the message log, if configured. This function may also be called
322 format a string format
328 deliver_msglog(const char *format, ...)
331 if (!message_logs) return;
332 va_start(ap, format);
333 vfprintf(message_log, format, ap);
341 /*************************************************
342 * Replicate status for batch *
343 *************************************************/
345 /* When a transport handles a batch of addresses, it may treat them
346 individually, or it may just put the status in the first one, and return FALSE,
347 requesting that the status be copied to all the others externally. This is the
348 replication function. As well as the status, it copies the transport pointer,
349 which may have changed if appendfile passed the addresses on to a different
352 Argument: pointer to the first address in a chain
357 replicate_status(address_item *addr)
360 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
362 addr2->transport = addr->transport;
363 addr2->transport_return = addr->transport_return;
364 addr2->basic_errno = addr->basic_errno;
365 addr2->more_errno = addr->more_errno;
366 addr2->special_action = addr->special_action;
367 addr2->message = addr->message;
368 addr2->user_message = addr->user_message;
374 /*************************************************
375 * Compare lists of hosts *
376 *************************************************/
378 /* This function is given two pointers to chains of host items, and it yields
379 TRUE if the lists refer to the same hosts in the same order, except that
381 (1) Multiple hosts with the same non-negative MX values are permitted to appear
382 in different orders. Round-robinning nameservers can cause this to happen.
384 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
385 permitted to appear in different orders. This is caused by randomizing
388 This enables Exim to use a single SMTP transaction for sending to two entirely
389 different domains that happen to end up pointing at the same hosts.
392 one points to the first host list
393 two points to the second host list
395 Returns: TRUE if the lists refer to the same host set
399 same_hosts(host_item *one, host_item *two)
401 while (one != NULL && two != NULL)
403 if (Ustrcmp(one->name, two->name) != 0)
406 host_item *end_one = one;
407 host_item *end_two = two;
409 /* Batch up only if there was no MX and the list was not randomized */
411 if (mx == MX_NONE) return FALSE;
413 /* Find the ends of the shortest sequence of identical MX values */
415 while (end_one->next != NULL && end_one->next->mx == mx &&
416 end_two->next != NULL && end_two->next->mx == mx)
418 end_one = end_one->next;
419 end_two = end_two->next;
422 /* If there aren't any duplicates, there's no match. */
424 if (end_one == one) return FALSE;
426 /* For each host in the 'one' sequence, check that it appears in the 'two'
427 sequence, returning FALSE if not. */
432 for (hi = two; hi != end_two->next; hi = hi->next)
433 if (Ustrcmp(one->name, hi->name) == 0) break;
434 if (hi == end_two->next) return FALSE;
435 if (one == end_one) break;
439 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
440 Ensure both are pointing at the last host, and carry on as for equality. */
451 /* True if both are NULL */
458 /*************************************************
459 * Compare header lines *
460 *************************************************/
462 /* This function is given two pointers to chains of header items, and it yields
463 TRUE if they are the same header texts in the same order.
466 one points to the first header list
467 two points to the second header list
469 Returns: TRUE if the lists refer to the same header set
473 same_headers(header_line *one, header_line *two)
477 if (one == two) return TRUE; /* Includes the case where both NULL */
478 if (one == NULL || two == NULL) return FALSE;
479 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
487 /*************************************************
488 * Compare string settings *
489 *************************************************/
491 /* This function is given two pointers to strings, and it returns
492 TRUE if they are the same pointer, or if the two strings are the same.
495 one points to the first string
496 two points to the second string
498 Returns: TRUE or FALSE
502 same_strings(uschar *one, uschar *two)
504 if (one == two) return TRUE; /* Includes the case where both NULL */
505 if (one == NULL || two == NULL) return FALSE;
506 return (Ustrcmp(one, two) == 0);
511 /*************************************************
512 * Compare uid/gid for addresses *
513 *************************************************/
515 /* This function is given a transport and two addresses. It yields TRUE if the
516 uid/gid/initgroups settings for the two addresses are going to be the same when
521 addr1 the first address
522 addr2 the second address
524 Returns: TRUE or FALSE
528 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
530 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
532 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
533 (testflag(addr1, af_uid_set) &&
534 (addr1->uid != addr2->uid ||
535 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
539 if (!tp->gid_set && tp->expand_gid == NULL)
541 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
542 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
552 /*************************************************
553 * Record that an address is complete *
554 *************************************************/
556 /* This function records that an address is complete. This is straightforward
557 for most addresses, where the unique address is just the full address with the
558 domain lower cased. For homonyms (addresses that are the same as one of their
559 ancestors) their are complications. Their unique addresses have \x\ prepended
560 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
563 Exim used to record the unique addresses of homonyms as "complete". This,
564 however, fails when the pattern of redirection varies over time (e.g. if taking
565 unseen copies at only some times of day) because the prepended numbers may vary
566 from one delivery run to the next. This problem is solved by never recording
567 prepended unique addresses as complete. Instead, when a homonymic address has
568 actually been delivered via a transport, we record its basic unique address
569 followed by the name of the transport. This is checked in subsequent delivery
570 runs whenever an address is routed to a transport.
572 If the completed address is a top-level one (has no parent, which means it
573 cannot be homonymic) we also add the original address to the non-recipients
574 tree, so that it gets recorded in the spool file and therefore appears as
575 "done" in any spool listings. The original address may differ from the unique
576 address in the case of the domain.
578 Finally, this function scans the list of duplicates, marks as done any that
579 match this address, and calls child_done() for their ancestors.
582 addr address item that has been completed
583 now current time as a string
589 address_done(address_item *addr, uschar *now)
593 update_spool = TRUE; /* Ensure spool gets updated */
595 /* Top-level address */
597 if (addr->parent == NULL)
599 tree_add_nonrecipient(addr->unique);
600 tree_add_nonrecipient(addr->address);
603 /* Homonymous child address */
605 else if (testflag(addr, af_homonym))
607 if (addr->transport != NULL)
609 tree_add_nonrecipient(
610 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
614 /* Non-homonymous child address */
616 else tree_add_nonrecipient(addr->unique);
618 /* Check the list of duplicate addresses and ensure they are now marked
621 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
623 if (Ustrcmp(addr->unique, dup->unique) == 0)
625 tree_add_nonrecipient(dup->unique);
626 child_done(dup, now);
634 /*************************************************
635 * Decrease counts in parents and mark done *
636 *************************************************/
638 /* This function is called when an address is complete. If there is a parent
639 address, its count of children is decremented. If there are still other
640 children outstanding, the function exits. Otherwise, if the count has become
641 zero, address_done() is called to mark the parent and its duplicates complete.
642 Then loop for any earlier ancestors.
645 addr points to the completed address item
646 now the current time as a string, for writing to the message log
652 child_done(address_item *addr, uschar *now)
655 while (addr->parent != NULL)
658 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
659 address_done(addr, now);
661 /* Log the completion of all descendents only when there is no ancestor with
662 the same original address. */
664 for (aa = addr->parent; aa != NULL; aa = aa->parent)
665 if (Ustrcmp(aa->address, addr->address) == 0) break;
666 if (aa != NULL) continue;
668 deliver_msglog("%s %s: children all complete\n", now, addr->address);
669 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
676 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
677 this is a nonstandard call; no two-characher delivery flag is written
678 but sender-host and sender are prefixed and "msg" is inserted in the log line.
681 flags passed to log_write()
684 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
687 int size = 256; /* Used for a temporary, */
688 int ptr = 0; /* expanding buffer, for */
689 uschar *s; /* building log lines; */
690 void *reset_point; /* released afterwards. */
693 /* Log the delivery on the main log. We use an extensible string to build up
694 the log line, and reset the store afterwards. Remote deliveries should always
695 have a pointer to the host item that succeeded; local deliveries can have a
696 pointer to a single host item in their host list, for use by the transport. */
698 s = reset_point = store_get(size);
700 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
702 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
706 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
709 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
710 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
712 #ifdef EXPERIMENTAL_SRS
713 if(addr->p.srs_sender)
714 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
716 #ifdef EXPERIMENTAL_DBL
717 dbl_delivery_ip = NULL; /* presume no successful remote delivery */
720 /* You might think that the return path must always be set for a successful
721 delivery; indeed, I did for some time, until this statement crashed. The case
722 when it is not set is for a delivery to /dev/null which is optimised by not
725 if (used_return_path != NULL &&
726 (log_extra_selector & LX_return_path_on_delivery) != 0)
727 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
730 s = string_append(s, &size, &ptr, 2, US" ", msg);
732 /* For a delivery from a system filter, there may not be a router */
733 if (addr->router != NULL)
734 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
736 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
738 if ((log_extra_selector & LX_delivery_size) != 0)
739 s = string_append(s, &size, &ptr, 2, US" S=",
740 string_sprintf("%d", transport_count));
744 if (addr->transport->info->local)
746 if (addr->host_list != NULL)
747 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
748 if (addr->shadow_message != NULL)
749 s = string_cat(s, &size, &ptr, addr->shadow_message,
750 Ustrlen(addr->shadow_message));
753 /* Remote delivery */
757 if (addr->host_used != NULL)
759 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
760 US" [", addr->host_used->address, US"]");
761 if ((log_extra_selector & LX_outgoing_port) != 0)
762 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
763 addr->host_used->port));
764 if (continue_sequence > 1)
765 s = string_cat(s, &size, &ptr, US"*", 1);
769 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
770 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
771 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
772 addr->cipher != NULL)
773 s = string_append(s, &size, &ptr, 2, US" CV=",
774 testflag(addr, af_cert_verified)? "yes":"no");
775 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
776 s = string_append(s, &size, &ptr, 3, US" DN=\"",
777 string_printing(addr->peerdn), US"\"");
780 if (addr->authenticator)
782 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
785 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
786 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
787 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
791 #ifdef EXPERIMENTAL_PRDR
792 if (addr->flags & af_prdr_used)
793 s = string_append(s, &size, &ptr, 1, US" PRDR");
796 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
797 addr->message != NULL)
800 uschar *p = big_buffer;
801 uschar *ss = addr->message;
803 for (i = 0; i < 100 && ss[i] != 0; i++)
805 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
810 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
814 /* Time on queue and actual time taken to deliver */
816 if ((log_extra_selector & LX_queue_time) != 0)
818 s = string_append(s, &size, &ptr, 2, US" QT=",
819 readconf_printtime(time(NULL) - received_time));
822 if ((log_extra_selector & LX_deliver_time) != 0)
824 s = string_append(s, &size, &ptr, 2, US" DT=",
825 readconf_printtime(addr->more_errno));
828 /* string_cat() always leaves room for the terminator. Release the
829 store we used to build the line after writing it. */
832 log_write(0, flags, "%s", s);
833 #ifdef EXPERIMENTAL_DBL
836 debug_printf(" DBL(Delivery): dbl_delivery_query=|%s| dbl_delivery_IP=%s\n", dbl_delivery_query, dbl_delivery_ip);
838 if (dbl_delivery_ip != NULL && dbl_delivery_query != NULL)
839 expand_string(dbl_delivery_query);
841 store_reset(reset_point);
847 /*************************************************
848 * Actions at the end of handling an address *
849 *************************************************/
851 /* This is a function for processing a single address when all that can be done
852 with it has been done.
855 addr points to the address block
856 result the result of the delivery attempt
857 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
858 driver_type indicates which type of driver (transport, or router) was last
859 to process the address
860 logchar '=' or '-' for use when logging deliveries with => or ->
866 post_process_one(address_item *addr, int result, int logflags, int driver_type,
869 uschar *now = tod_stamp(tod_log);
870 uschar *driver_kind = NULL;
871 uschar *driver_name = NULL;
874 int size = 256; /* Used for a temporary, */
875 int ptr = 0; /* expanding buffer, for */
876 uschar *s; /* building log lines; */
877 void *reset_point; /* released afterwards. */
880 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
882 /* Set up driver kind and name for logging. Disable logging if the router or
883 transport has disabled it. */
885 if (driver_type == DTYPE_TRANSPORT)
887 if (addr->transport != NULL)
889 driver_name = addr->transport->name;
890 driver_kind = US" transport";
891 disable_logging = addr->transport->disable_logging;
893 else driver_kind = US"transporting";
895 else if (driver_type == DTYPE_ROUTER)
897 if (addr->router != NULL)
899 driver_name = addr->router->name;
900 driver_kind = US" router";
901 disable_logging = addr->router->disable_logging;
903 else driver_kind = US"routing";
906 /* If there's an error message set, ensure that it contains only printing
907 characters - it should, but occasionally things slip in and this at least
908 stops the log format from getting wrecked. We also scan the message for an LDAP
909 expansion item that has a password setting, and flatten the password. This is a
910 fudge, but I don't know a cleaner way of doing this. (If the item is badly
911 malformed, it won't ever have gone near LDAP.) */
913 if (addr->message != NULL)
915 addr->message = string_printing(addr->message);
916 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
917 (Ustrstr(addr->message, "mysql") != NULL ||
918 Ustrstr(addr->message, "pgsql") != NULL ||
919 Ustrstr(addr->message, "sqlite") != NULL ||
920 Ustrstr(addr->message, "ldap:") != NULL ||
921 Ustrstr(addr->message, "ldapdn:") != NULL ||
922 Ustrstr(addr->message, "ldapm:") != NULL))
924 addr->message = string_sprintf("Temporary internal error");
928 /* If we used a transport that has one of the "return_output" options set, and
929 if it did in fact generate some output, then for return_output we treat the
930 message as failed if it was not already set that way, so that the output gets
931 returned to the sender, provided there is a sender to send it to. For
932 return_fail_output, do this only if the delivery failed. Otherwise we just
933 unlink the file, and remove the name so that if the delivery failed, we don't
934 try to send back an empty or unwanted file. The log_output options operate only
937 In any case, we close the message file, because we cannot afford to leave a
938 file-descriptor for one address while processing (maybe very many) others. */
940 if (addr->return_file >= 0 && addr->return_filename != NULL)
942 BOOL return_output = FALSE;
944 (void)EXIMfsync(addr->return_file);
946 /* If there is no output, do nothing. */
948 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
950 transport_instance *tb = addr->transport;
952 /* Handle logging options */
954 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
955 (result == DEFER && tb->log_defer_output))
958 FILE *f = Ufopen(addr->return_filename, "rb");
960 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
961 "from %s transport: %s", addr->return_filename, tb->name,
965 s = US Ufgets(big_buffer, big_buffer_size, f);
968 uschar *p = big_buffer + Ustrlen(big_buffer);
969 while (p > big_buffer && isspace(p[-1])) p--;
971 s = string_printing(big_buffer);
972 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
973 addr->address, tb->name, s);
979 /* Handle returning options, but only if there is an address to return
982 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
984 if (tb->return_output)
986 addr->transport_return = result = FAIL;
987 if (addr->basic_errno == 0 && addr->message == NULL)
988 addr->message = US"return message generated";
989 return_output = TRUE;
992 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
996 /* Get rid of the file unless it might be returned, but close it in
1001 Uunlink(addr->return_filename);
1002 addr->return_filename = NULL;
1003 addr->return_file = -1;
1006 (void)close(addr->return_file);
1009 /* The sucess case happens only after delivery by a transport. */
1013 addr->next = addr_succeed;
1014 addr_succeed = addr;
1016 /* Call address_done() to ensure that we don't deliver to this address again,
1017 and write appropriate things to the message log. If it is a child address, we
1018 call child_done() to scan the ancestors and mark them complete if this is the
1019 last child to complete. */
1021 address_done(addr, now);
1022 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1024 if (addr->parent == NULL)
1026 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1027 driver_name, driver_kind);
1031 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1032 addr->parent->address, driver_name, driver_kind);
1033 child_done(addr, now);
1036 delivery_log(LOG_MAIN, addr, logchar, NULL);
1040 /* Soft failure, or local delivery process failed; freezing may be
1043 else if (result == DEFER || result == PANIC)
1045 if (result == PANIC) logflags |= LOG_PANIC;
1047 /* This puts them on the chain in reverse order. Do not change this, because
1048 the code for handling retries assumes that the one with the retry
1049 information is last. */
1051 addr->next = addr_defer;
1054 /* The only currently implemented special action is to freeze the
1055 message. Logging of this is done later, just before the -H file is
1058 if (addr->special_action == SPECIAL_FREEZE)
1060 deliver_freeze = TRUE;
1061 deliver_frozen_at = time(NULL);
1062 update_spool = TRUE;
1065 /* If doing a 2-stage queue run, we skip writing to either the message
1066 log or the main log for SMTP defers. */
1068 if (!queue_2stage || addr->basic_errno != 0)
1072 /* For errors of the type "retry time not reached" (also remotes skipped
1073 on queue run), logging is controlled by L_retry_defer. Note that this kind
1074 of error number is negative, and all the retry ones are less than any
1077 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1080 /* Build up the line that is used for both the message log and the main
1083 s = reset_point = store_get(size);
1085 /* Create the address string for logging. Must not do this earlier, because
1086 an OK result may be changed to FAIL when a pipe returns text. */
1088 log_address = string_log_address(addr,
1089 (log_write_selector & L_all_parents) != 0, result == OK);
1091 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1093 /* Either driver_name contains something and driver_kind contains
1094 " router" or " transport" (note the leading space), or driver_name is
1095 a null string and driver_kind contains "routing" without the leading
1096 space, if all routing has been deferred. When a domain has been held,
1097 so nothing has been done at all, both variables contain null strings. */
1099 if (driver_name == NULL)
1101 if (driver_kind != NULL)
1102 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1106 if (driver_kind[1] == 't' && addr->router != NULL)
1107 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1109 ss[1] = toupper(driver_kind[1]);
1110 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1113 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1114 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1116 if (addr->basic_errno > 0)
1117 s = string_append(s, &size, &ptr, 2, US": ",
1118 US strerror(addr->basic_errno));
1120 if (addr->message != NULL)
1121 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1125 /* Log the deferment in the message log, but don't clutter it
1126 up with retry-time defers after the first delivery attempt. */
1128 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1129 deliver_msglog("%s %s\n", now, s);
1131 /* Write the main log and reset the store */
1133 log_write(use_log_selector, logflags, "== %s", s);
1134 store_reset(reset_point);
1139 /* Hard failure. If there is an address to which an error message can be sent,
1140 put this address on the failed list. If not, put it on the deferred list and
1141 freeze the mail message for human attention. The latter action can also be
1142 explicitly requested by a router or transport. */
1146 /* If this is a delivery error, or a message for which no replies are
1147 wanted, and the message's age is greater than ignore_bounce_errors_after,
1148 force the af_ignore_error flag. This will cause the address to be discarded
1149 later (with a log entry). */
1151 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1152 setflag(addr, af_ignore_error);
1154 /* Freeze the message if requested, or if this is a bounce message (or other
1155 message with null sender) and this address does not have its own errors
1156 address. However, don't freeze if errors are being ignored. The actual code
1157 to ignore occurs later, instead of sending a message. Logging of freezing
1158 occurs later, just before writing the -H file. */
1160 if (!testflag(addr, af_ignore_error) &&
1161 (addr->special_action == SPECIAL_FREEZE ||
1162 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1165 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1166 (sender_local && !local_error_message)?
1167 US" (message created with -f <>)" : US" (delivery error message)";
1168 deliver_freeze = TRUE;
1169 deliver_frozen_at = time(NULL);
1170 update_spool = TRUE;
1172 /* The address is put on the defer rather than the failed queue, because
1173 the message is being retained. */
1175 addr->next = addr_defer;
1179 /* Don't put the address on the nonrecipients tree yet; wait until an
1180 error message has been successfully sent. */
1184 addr->next = addr_failed;
1188 /* Build up the log line for the message and main logs */
1190 s = reset_point = store_get(size);
1192 /* Create the address string for logging. Must not do this earlier, because
1193 an OK result may be changed to FAIL when a pipe returns text. */
1195 log_address = string_log_address(addr,
1196 (log_write_selector & L_all_parents) != 0, result == OK);
1198 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1200 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1201 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1203 /* Return path may not be set if no delivery actually happened */
1205 if (used_return_path != NULL &&
1206 (log_extra_selector & LX_return_path_on_delivery) != 0)
1208 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1211 if (addr->router != NULL)
1212 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1213 if (addr->transport != NULL)
1214 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1216 if (addr->host_used != NULL)
1217 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1218 US" [", addr->host_used->address, US"]");
1220 if (addr->basic_errno > 0)
1221 s = string_append(s, &size, &ptr, 2, US": ",
1222 US strerror(addr->basic_errno));
1224 if (addr->message != NULL)
1225 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1229 /* Do the logging. For the message log, "routing failed" for those cases,
1230 just to make it clearer. */
1232 if (driver_name == NULL)
1233 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1235 deliver_msglog("%s %s\n", now, s);
1237 log_write(0, LOG_MAIN, "** %s", s);
1238 store_reset(reset_point);
1241 /* Ensure logging is turned on again in all cases */
1243 disable_logging = FALSE;
1249 /*************************************************
1250 * Address-independent error *
1251 *************************************************/
1253 /* This function is called when there's an error that is not dependent on a
1254 particular address, such as an expansion string failure. It puts the error into
1255 all the addresses in a batch, logs the incident on the main and panic logs, and
1256 clears the expansions. It is mostly called from local_deliver(), but can be
1257 called for a remote delivery via findugid().
1260 logit TRUE if (MAIN+PANIC) logging required
1261 addr the first of the chain of addresses
1263 format format string for error message, or NULL if already set in addr
1264 ... arguments for the format
1270 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1272 address_item *addr2;
1273 addr->basic_errno = code;
1279 va_start(ap, format);
1280 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1281 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1282 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1284 addr->message = string_copy(buffer);
1287 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1289 addr2->basic_errno = code;
1290 addr2->message = addr->message;
1293 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1294 deliver_set_expansions(NULL);
1300 /*************************************************
1301 * Check a "never users" list *
1302 *************************************************/
1304 /* This function is called to check whether a uid is on one of the two "never
1308 uid the uid to be checked
1309 nusers the list to be scanned; the first item in the list is the count
1311 Returns: TRUE if the uid is on the list
1315 check_never_users(uid_t uid, uid_t *nusers)
1318 if (nusers == NULL) return FALSE;
1319 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1325 /*************************************************
1326 * Find uid and gid for a transport *
1327 *************************************************/
1329 /* This function is called for both local and remote deliveries, to find the
1330 uid/gid under which to run the delivery. The values are taken preferentially
1331 from the transport (either explicit or deliver_as_creator), then from the
1332 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1333 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1334 panic error is logged, and the function fails (which normally leads to delivery
1338 addr the address (possibly a chain)
1340 uidp pointer to uid field
1341 gidp pointer to gid field
1342 igfp pointer to the use_initgroups field
1344 Returns: FALSE if failed - error has been set in address(es)
1348 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1351 uschar *nuname = NULL;
1352 BOOL gid_set = FALSE;
1354 /* Default initgroups flag comes from the transport */
1356 *igfp = tp->initgroups;
1358 /* First see if there's a gid on the transport, either fixed or expandable.
1359 The expanding function always logs failure itself. */
1366 else if (tp->expand_gid != NULL)
1368 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1369 &(addr->message))) gid_set = TRUE;
1372 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1377 /* If the transport did not set a group, see if the router did. */
1379 if (!gid_set && testflag(addr, af_gid_set))
1385 /* Pick up a uid from the transport if one is set. */
1387 if (tp->uid_set) *uidp = tp->uid;
1389 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1390 it does not provide a passwd value from which a gid can be taken. */
1392 else if (tp->expand_uid != NULL)
1395 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1396 uidp, &(addr->message)))
1398 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1401 if (!gid_set && pw != NULL)
1408 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1410 else if (tp->deliver_as_creator)
1412 *uidp = originator_uid;
1415 *gidp = originator_gid;
1420 /* Otherwise see if the address specifies the uid and if so, take it and its
1423 else if (testflag(addr, af_uid_set))
1426 *igfp = testflag(addr, af_initgroups);
1429 /* Nothing has specified the uid - default to the Exim user, and group if the
1442 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1443 defaulting to the Exim uid. In other words, if the configuration has specified
1444 a uid, it must also provide a gid. */
1448 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1449 "%s transport", tp->name);
1453 /* Check that the uid is not on the lists of banned uids that may not be used
1454 for delivery processes. */
1456 if (check_never_users(*uidp, never_users))
1457 nuname = US"never_users";
1458 else if (check_never_users(*uidp, fixed_never_users))
1459 nuname = US"fixed_never_users";
1463 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1464 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1476 /*************************************************
1477 * Check the size of a message for a transport *
1478 *************************************************/
1480 /* Checks that the message isn't too big for the selected transport.
1481 This is called only when it is known that the limit is set.
1485 addr the (first) address being delivered
1488 DEFER expansion failed or did not yield an integer
1489 FAIL message too big
1493 check_message_size(transport_instance *tp, address_item *addr)
1498 deliver_set_expansions(addr);
1499 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1500 deliver_set_expansions(NULL);
1502 if (expand_string_message != NULL)
1505 if (size_limit == -1)
1506 addr->message = string_sprintf("failed to expand message_size_limit "
1507 "in %s transport: %s", tp->name, expand_string_message);
1509 addr->message = string_sprintf("invalid message_size_limit "
1510 "in %s transport: %s", tp->name, expand_string_message);
1512 else if (size_limit > 0 && message_size > size_limit)
1516 string_sprintf("message is too big (transport limit = %d)",
1525 /*************************************************
1526 * Transport-time check for a previous delivery *
1527 *************************************************/
1529 /* Check that this base address hasn't previously been delivered to its routed
1530 transport. If it has been delivered, mark it done. The check is necessary at
1531 delivery time in order to handle homonymic addresses correctly in cases where
1532 the pattern of redirection changes between delivery attempts (so the unique
1533 fields change). Non-homonymic previous delivery is detected earlier, at routing
1534 time (which saves unnecessary routing).
1537 addr the address item
1538 testing TRUE if testing wanted only, without side effects
1540 Returns: TRUE if previously delivered by the transport
1544 previously_transported(address_item *addr, BOOL testing)
1546 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1547 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1549 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1551 DEBUG(D_deliver|D_route|D_transport)
1552 debug_printf("%s was previously delivered (%s transport): discarded\n",
1553 addr->address, addr->transport->name);
1554 if (!testing) child_done(addr, tod_stamp(tod_log));
1563 /******************************************************
1564 * Check for a given header in a header string *
1565 ******************************************************/
1567 /* This function is used when generating quota warnings. The configuration may
1568 specify any header lines it likes in quota_warn_message. If certain of them are
1569 missing, defaults are inserted, so we need to be able to test for the presence
1573 hdr the required header name
1574 hstring the header string
1576 Returns: TRUE the header is in the string
1577 FALSE the header is not in the string
1581 contains_header(uschar *hdr, uschar *hstring)
1583 int len = Ustrlen(hdr);
1584 uschar *p = hstring;
1587 if (strncmpic(p, hdr, len) == 0)
1590 while (*p == ' ' || *p == '\t') p++;
1591 if (*p == ':') return TRUE;
1593 while (*p != 0 && *p != '\n') p++;
1594 if (*p == '\n') p++;
1602 /*************************************************
1603 * Perform a local delivery *
1604 *************************************************/
1606 /* Each local delivery is performed in a separate process which sets its
1607 uid and gid as specified. This is a safer way than simply changing and
1608 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1609 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1610 all systems have seteuid().
1612 If the uid/gid are specified in the transport_instance, they are used; the
1613 transport initialization must ensure that either both or neither are set.
1614 Otherwise, the values associated with the address are used. If neither are set,
1615 it is a configuration error.
1617 The transport or the address may specify a home directory (transport over-
1618 rides), and if they do, this is set as $home. If neither have set a working
1619 directory, this value is used for that as well. Otherwise $home is left unset
1620 and the cwd is set to "/" - a directory that should be accessible to all users.
1622 Using a separate process makes it more complicated to get error information
1623 back. We use a pipe to pass the return code and also an error code and error
1624 text string back to the parent process.
1627 addr points to an address block for this delivery; for "normal" local
1628 deliveries this is the only address to be delivered, but for
1629 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1630 a number of addresses can be handled simultaneously, and in this
1631 case addr will point to a chain of addresses with the same
1634 shadowing TRUE if running a shadow transport; this causes output from pipes
1641 deliver_local(address_item *addr, BOOL shadowing)
1643 BOOL use_initgroups;
1646 int status, len, rc;
1649 uschar *working_directory;
1650 address_item *addr2;
1651 transport_instance *tp = addr->transport;
1653 /* Set up the return path from the errors or sender address. If the transport
1654 has its own return path setting, expand it and replace the existing value. */
1656 if(addr->p.errors_address != NULL)
1657 return_path = addr->p.errors_address;
1658 #ifdef EXPERIMENTAL_SRS
1659 else if(addr->p.srs_sender != NULL)
1660 return_path = addr->p.srs_sender;
1663 return_path = sender_address;
1665 if (tp->return_path != NULL)
1667 uschar *new_return_path = expand_string(tp->return_path);
1668 if (new_return_path == NULL)
1670 if (!expand_string_forcedfail)
1672 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1673 US"Failed to expand return path \"%s\" in %s transport: %s",
1674 tp->return_path, tp->name, expand_string_message);
1678 else return_path = new_return_path;
1681 /* For local deliveries, one at a time, the value used for logging can just be
1682 set directly, once and for all. */
1684 used_return_path = return_path;
1686 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1687 gets put into the address(es), and the expansions are unset, so we can just
1690 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1692 /* See if either the transport or the address specifies a home directory. A
1693 home directory set in the address may already be expanded; a flag is set to
1694 indicate that. In other cases we must expand it. */
1696 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1697 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1698 !testflag(addr, af_home_expanded))) /* not expanded */
1700 uschar *rawhome = deliver_home;
1701 deliver_home = NULL; /* in case it contains $home */
1702 deliver_home = expand_string(rawhome);
1703 if (deliver_home == NULL)
1705 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1706 "to expand for %s transport: %s", rawhome, tp->name,
1707 expand_string_message);
1710 if (*deliver_home != '/')
1712 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1713 "is not absolute for %s transport", deliver_home, tp->name);
1718 /* See if either the transport or the address specifies a current directory,
1719 and if so, expand it. If nothing is set, use the home directory, unless it is
1720 also unset in which case use "/", which is assumed to be a directory to which
1721 all users have access. It is necessary to be in a visible directory for some
1722 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1723 2.5) require this. */
1725 working_directory = (tp->current_dir != NULL)?
1726 tp->current_dir : addr->current_dir;
1728 if (working_directory != NULL)
1730 uschar *raw = working_directory;
1731 working_directory = expand_string(raw);
1732 if (working_directory == NULL)
1734 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1735 "failed to expand for %s transport: %s", raw, tp->name,
1736 expand_string_message);
1739 if (*working_directory != '/')
1741 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1742 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1746 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1748 /* If one of the return_output flags is set on the transport, create and open a
1749 file in the message log directory for the transport to write its output onto.
1750 This is mainly used by pipe transports. The file needs to be unique to the
1751 address. This feature is not available for shadow transports. */
1753 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1754 tp->log_output || tp->log_fail_output))
1757 addr->return_filename =
1758 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1759 message_id, getpid(), return_count++);
1760 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1761 if (addr->return_file < 0)
1763 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1764 "to return message: %s", error, tp->name, strerror(errno));
1769 /* Create the pipe for inter-process communication. */
1773 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1778 /* Now fork the process to do the real work in the subprocess, but first
1779 ensure that all cached resources are freed so that the subprocess starts with
1780 a clean slate and doesn't interfere with the parent process. */
1784 if ((pid = fork()) == 0)
1786 BOOL replicate = TRUE;
1788 /* Prevent core dumps, as we don't want them in users' home directories.
1789 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1790 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1791 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1792 complain if the error is "not supported".
1794 There are two scenarios where changing the max limit has an effect. In one,
1795 the user is using a .forward and invoking a command of their choice via pipe;
1796 for these, we do need the max limit to be 0 unless the admin chooses to
1797 permit an increased limit. In the other, the command is invoked directly by
1798 the transport and is under administrator control, thus being able to raise
1799 the limit aids in debugging. So there's no general always-right answer.
1801 Thus we inhibit core-dumps completely but let individual transports, while
1802 still root, re-raise the limits back up to aid debugging. We make the
1803 default be no core-dumps -- few enough people can use core dumps in
1804 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1811 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1813 #ifdef SETRLIMIT_NOT_SUPPORTED
1814 if (errno != ENOSYS && errno != ENOTSUP)
1816 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1821 /* Reset the random number generator, so different processes don't all
1822 have the same sequence. */
1826 /* If the transport has a setup entry, call this first, while still
1827 privileged. (Appendfile uses this to expand quota, for example, while
1828 able to read private files.) */
1830 if (addr->transport->setup != NULL)
1832 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1836 addr->transport_return = DEFER;
1840 addr->transport_return = PANIC;
1845 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1846 when the process becomes unprivileged, it won't be able to write to the
1847 process log. SIGHUP is ignored throughout exim, except when it is being
1850 signal(SIGINT, SIG_IGN);
1851 signal(SIGTERM, SIG_IGN);
1852 signal(SIGUSR1, SIG_IGN);
1854 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1855 half - for transports that exec things (e.g. pipe). Then set the required
1858 (void)close(pfd[pipe_read]);
1859 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1861 exim_setugid(uid, gid, use_initgroups,
1862 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1863 addr->address, addr->transport->name));
1867 address_item *batched;
1868 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1869 for (batched = addr->next; batched != NULL; batched = batched->next)
1870 debug_printf("additional batched address: %s\n", batched->address);
1873 /* Set an appropriate working directory. */
1875 if (Uchdir(working_directory) < 0)
1877 addr->transport_return = DEFER;
1878 addr->basic_errno = errno;
1879 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1882 /* If successful, call the transport */
1887 set_process_info("delivering %s to %s using %s", message_id,
1888 addr->local_part, addr->transport->name);
1890 /* Setting this global in the subprocess means we need never clear it */
1891 transport_name = addr->transport->name;
1893 /* If a transport filter has been specified, set up its argument list.
1894 Any errors will get put into the address, and FALSE yielded. */
1896 if (addr->transport->filter_command != NULL)
1898 ok = transport_set_up_command(&transport_filter_argv,
1899 addr->transport->filter_command,
1900 TRUE, PANIC, addr, US"transport filter", NULL);
1901 transport_filter_timeout = addr->transport->filter_timeout;
1903 else transport_filter_argv = NULL;
1907 debug_print_string(addr->transport->debug_string);
1908 replicate = !(addr->transport->info->code)(addr->transport, addr);
1912 /* Pass the results back down the pipe. If necessary, first replicate the
1913 status in the top address to the others in the batch. The label is the
1914 subject of a goto when a call to the transport's setup function fails. We
1915 pass the pointer to the transport back in case it got changed as a result of
1916 file_format in appendfile. */
1920 if (replicate) replicate_status(addr);
1921 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1924 int local_part_length = Ustrlen(addr2->local_part);
1928 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
1929 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
1930 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
1931 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
1932 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
1933 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
1934 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
1935 sizeof(transport_instance *))) != sizeof(transport_instance *)
1937 /* For a file delivery, pass back the local part, in case the original
1938 was only part of the final delivery path. This gives more complete
1941 || (testflag(addr2, af_file)
1942 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
1943 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
1947 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1948 ret == -1 ? strerror(errno) : "short write");
1950 /* Now any messages */
1952 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1954 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1955 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
1956 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
1958 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
1959 ret == -1 ? strerror(errno) : "short write");
1963 /* OK, this process is now done. Free any cached resources that it opened,
1964 and close the pipe we were writing down before exiting. */
1966 (void)close(pfd[pipe_write]);
1971 /* Back in the main process: panic if the fork did not succeed. This seems
1972 better than returning an error - if forking is failing it is probably best
1973 not to try other deliveries for this message. */
1976 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1979 /* Read the pipe to get the delivery status codes and error messages. Our copy
1980 of the writing end must be closed first, as otherwise read() won't return zero
1981 on an empty pipe. We check that a status exists for each address before
1982 overwriting the address structure. If data is missing, the default DEFER status
1983 will remain. Afterwards, close the reading end. */
1985 (void)close(pfd[pipe_write]);
1987 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1989 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1995 addr2->transport_return = status;
1996 len = read(pfd[pipe_read], (void *)&transport_count,
1997 sizeof(transport_count));
1998 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1999 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2000 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2001 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2002 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2003 sizeof(transport_instance *));
2005 if (testflag(addr2, af_file))
2007 int local_part_length;
2008 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2009 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2010 big_buffer[local_part_length] = 0;
2011 addr2->local_part = string_copy(big_buffer);
2014 for (i = 0, sptr = &(addr2->message); i < 2;
2015 i++, sptr = &(addr2->user_message))
2018 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2019 if (message_length > 0)
2021 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2022 if (len > 0) *sptr = string_copy(big_buffer);
2029 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2030 "from delivery subprocess", addr2->unique);
2035 (void)close(pfd[pipe_read]);
2037 /* Unless shadowing, write all successful addresses immediately to the journal
2038 file, to ensure they are recorded asap. For homonymic addresses, use the base
2039 address plus the transport name. Failure to write the journal is panic-worthy,
2040 but don't stop, as it may prove possible subsequently to update the spool file
2041 in order to record the delivery. */
2045 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2047 if (addr2->transport_return != OK) continue;
2049 if (testflag(addr2, af_homonym))
2050 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2052 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2054 /* In the test harness, wait just a bit to let the subprocess finish off
2055 any debug output etc first. */
2057 if (running_in_test_harness) millisleep(300);
2059 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2060 len = Ustrlen(big_buffer);
2061 if (write(journal_fd, big_buffer, len) != len)
2062 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2063 big_buffer, strerror(errno));
2066 /* Ensure the journal file is pushed out to disk. */
2068 if (EXIMfsync(journal_fd) < 0)
2069 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2073 /* Wait for the process to finish. If it terminates with a non-zero code,
2074 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2075 status values of all the addresses as they are. Take care to handle the case
2076 when the subprocess doesn't seem to exist. This has been seen on one system
2077 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2078 happens, wait() doesn't recognize the termination of child processes. Exim now
2079 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2081 while ((rc = wait(&status)) != pid)
2083 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2085 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2086 addr->transport->driver_name);
2092 if ((status & 0xffff) != 0)
2094 int msb = (status >> 8) & 255;
2095 int lsb = status & 255;
2096 int code = (msb == 0)? (lsb & 0x7f) : msb;
2097 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2098 addr->special_action = SPECIAL_FREEZE;
2099 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2100 "status 0x%04x: %s %d",
2101 addr->transport->driver_name,
2103 (msb == 0)? "terminated by signal" : "exit code",
2107 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2109 if (addr->special_action == SPECIAL_WARN &&
2110 addr->transport->warn_message != NULL)
2113 uschar *warn_message;
2115 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2117 warn_message = expand_string(addr->transport->warn_message);
2118 if (warn_message == NULL)
2119 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2120 "message for %s transport): %s", addr->transport->warn_message,
2121 addr->transport->name, expand_string_message);
2124 pid_t pid = child_open_exim(&fd);
2127 FILE *f = fdopen(fd, "wb");
2128 if (errors_reply_to != NULL &&
2129 !contains_header(US"Reply-To", warn_message))
2130 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2131 fprintf(f, "Auto-Submitted: auto-replied\n");
2132 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2133 fprintf(f, "%s", CS warn_message);
2135 /* Close and wait for child process to complete, without a timeout. */
2138 (void)child_close(pid, 0);
2142 addr->special_action = SPECIAL_NONE;
2148 /*************************************************
2149 * Do local deliveries *
2150 *************************************************/
2152 /* This function processes the list of addresses in addr_local. True local
2153 deliveries are always done one address at a time. However, local deliveries can
2154 be batched up in some cases. Typically this is when writing batched SMTP output
2155 files for use by some external transport mechanism, or when running local
2156 deliveries over LMTP.
2163 do_local_deliveries(void)
2166 open_db *dbm_file = NULL;
2167 time_t now = time(NULL);
2169 /* Loop until we have exhausted the supply of local deliveries */
2171 while (addr_local != NULL)
2173 time_t delivery_start;
2175 address_item *addr2, *addr3, *nextaddr;
2176 int logflags = LOG_MAIN;
2177 int logchar = dont_deliver? '*' : '=';
2178 transport_instance *tp;
2180 /* Pick the first undelivered address off the chain */
2182 address_item *addr = addr_local;
2183 addr_local = addr->next;
2186 DEBUG(D_deliver|D_transport)
2187 debug_printf("--------> %s <--------\n", addr->address);
2189 /* An internal disaster if there is no transport. Should not occur! */
2191 if ((tp = addr->transport) == NULL)
2193 logflags |= LOG_PANIC;
2194 disable_logging = FALSE; /* Jic */
2196 (addr->router != NULL)?
2197 string_sprintf("No transport set by %s router", addr->router->name)
2199 string_sprintf("No transport set by system filter");
2200 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2204 /* Check that this base address hasn't previously been delivered to this
2205 transport. The check is necessary at this point to handle homonymic addresses
2206 correctly in cases where the pattern of redirection changes between delivery
2207 attempts. Non-homonymic previous delivery is detected earlier, at routing
2210 if (previously_transported(addr, FALSE)) continue;
2212 /* There are weird cases where logging is disabled */
2214 disable_logging = tp->disable_logging;
2216 /* Check for batched addresses and possible amalgamation. Skip all the work
2217 if either batch_max <= 1 or there aren't any other addresses for local
2220 if (tp->batch_max > 1 && addr_local != NULL)
2222 int batch_count = 1;
2223 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2224 BOOL uses_lp = (testflag(addr, af_pfr) &&
2225 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2226 readconf_depends((driver_instance *)tp, US"local_part");
2227 uschar *batch_id = NULL;
2228 address_item **anchor = &addr_local;
2229 address_item *last = addr;
2232 /* Expand the batch_id string for comparison with other addresses.
2233 Expansion failure suppresses batching. */
2235 if (tp->batch_id != NULL)
2237 deliver_set_expansions(addr);
2238 batch_id = expand_string(tp->batch_id);
2239 deliver_set_expansions(NULL);
2240 if (batch_id == NULL)
2242 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2243 "in %s transport (%s): %s", tp->name, addr->address,
2244 expand_string_message);
2245 batch_count = tp->batch_max;
2249 /* Until we reach the batch_max limit, pick off addresses which have the
2250 same characteristics. These are:
2253 not previously delivered (see comment about 50 lines above)
2254 same local part if the transport's configuration contains $local_part
2255 or if this is a file or pipe delivery from a redirection
2256 same domain if the transport's configuration contains $domain
2258 same additional headers
2259 same headers to be removed
2260 same uid/gid for running the transport
2261 same first host if a host list is set
2264 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2267 tp == next->transport &&
2268 !previously_transported(next, TRUE) &&
2269 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2270 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2271 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2272 same_strings(next->p.errors_address, addr->p.errors_address) &&
2273 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2274 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2275 same_ugid(tp, addr, next) &&
2276 ((addr->host_list == NULL && next->host_list == NULL) ||
2277 (addr->host_list != NULL && next->host_list != NULL &&
2278 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2280 /* If the transport has a batch_id setting, batch_id will be non-NULL
2281 from the expansion outside the loop. Expand for this address and compare.
2282 Expansion failure makes this address ineligible for batching. */
2284 if (ok && batch_id != NULL)
2287 address_item *save_nextnext = next->next;
2288 next->next = NULL; /* Expansion for a single address */
2289 deliver_set_expansions(next);
2290 next->next = save_nextnext;
2291 bid = expand_string(tp->batch_id);
2292 deliver_set_expansions(NULL);
2295 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2296 "in %s transport (%s): %s", tp->name, next->address,
2297 expand_string_message);
2300 else ok = (Ustrcmp(batch_id, bid) == 0);
2303 /* Take address into batch if OK. */
2307 *anchor = next->next; /* Include the address */
2313 else anchor = &(next->next); /* Skip the address */
2317 /* We now have one or more addresses that can be delivered in a batch. Check
2318 whether the transport is prepared to accept a message of this size. If not,
2319 fail them all forthwith. If the expansion fails, or does not yield an
2320 integer, defer delivery. */
2322 if (tp->message_size_limit != NULL)
2324 int rc = check_message_size(tp, addr);
2327 replicate_status(addr);
2328 while (addr != NULL)
2331 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2334 continue; /* With next batch of addresses */
2338 /* If we are not running the queue, or if forcing, all deliveries will be
2339 attempted. Otherwise, we must respect the retry times for each address. Even
2340 when not doing this, we need to set up the retry key string, and determine
2341 whether a retry record exists, because after a successful delivery, a delete
2342 retry item must be set up. Keep the retry database open only for the duration
2343 of these checks, rather than for all local deliveries, because some local
2344 deliveries (e.g. to pipes) can take a substantial time. */
2346 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2347 if (dbm_file == NULL)
2349 DEBUG(D_deliver|D_retry|D_hints_lookup)
2350 debug_printf("no retry data available\n");
2355 while (addr2 != NULL)
2357 BOOL ok = TRUE; /* to deliver this address */
2360 /* Set up the retry key to include the domain or not, and change its
2361 leading character from "R" to "T". Must make a copy before doing this,
2362 because the old key may be pointed to from a "delete" retry item after
2365 retry_key = string_copy(
2366 (tp->retry_use_local_part)? addr2->address_retry_key :
2367 addr2->domain_retry_key);
2370 /* Inspect the retry data. If there is no hints file, delivery happens. */
2372 if (dbm_file != NULL)
2374 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2376 /* If there is no retry record, delivery happens. If there is,
2377 remember it exists so it can be deleted after a successful delivery. */
2379 if (retry_record != NULL)
2381 setflag(addr2, af_lt_retry_exists);
2383 /* A retry record exists for this address. If queue running and not
2384 forcing, inspect its contents. If the record is too old, or if its
2385 retry time has come, or if it has passed its cutoff time, delivery
2390 debug_printf("retry record exists: age=%s ",
2391 readconf_printtime(now - retry_record->time_stamp));
2392 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2393 debug_printf(" time to retry = %s expired = %d\n",
2394 readconf_printtime(retry_record->next_try - now),
2395 retry_record->expired);
2398 if (queue_running && !deliver_force)
2400 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2401 (now >= retry_record->next_try) ||
2402 retry_record->expired;
2404 /* If we haven't reached the retry time, there is one more check
2405 to do, which is for the ultimate address timeout. */
2408 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2412 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2415 /* This address is to be delivered. Leave it on the chain. */
2420 addr2 = addr2->next;
2423 /* This address is to be deferred. Take it out of the chain, and
2424 post-process it as complete. Must take it out of the chain first,
2425 because post processing puts it on another chain. */
2429 address_item *this = addr2;
2430 this->message = US"Retry time not yet reached";
2431 this->basic_errno = ERRNO_LRETRY;
2432 if (addr3 == NULL) addr2 = addr = addr2->next;
2433 else addr2 = addr3->next = addr2->next;
2434 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2438 if (dbm_file != NULL) dbfn_close(dbm_file);
2440 /* If there are no addresses left on the chain, they all deferred. Loop
2441 for the next set of addresses. */
2443 if (addr == NULL) continue;
2445 /* So, finally, we do have some addresses that can be passed to the
2446 transport. Before doing so, set up variables that are relevant to a
2449 deliver_set_expansions(addr);
2450 delivery_start = time(NULL);
2451 deliver_local(addr, FALSE);
2452 deliver_time = (int)(time(NULL) - delivery_start);
2454 /* If a shadow transport (which must perforce be another local transport), is
2455 defined, and its condition is met, we must pass the message to the shadow
2456 too, but only those addresses that succeeded. We do this by making a new
2457 chain of addresses - also to keep the original chain uncontaminated. We must
2458 use a chain rather than doing it one by one, because the shadow transport may
2461 NOTE: if the condition fails because of a lookup defer, there is nothing we
2464 if (tp->shadow != NULL &&
2465 (tp->shadow_condition == NULL ||
2466 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2468 transport_instance *stp;
2469 address_item *shadow_addr = NULL;
2470 address_item **last = &shadow_addr;
2472 for (stp = transports; stp != NULL; stp = stp->next)
2473 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2476 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2479 /* Pick off the addresses that have succeeded, and make clones. Put into
2480 the shadow_message field a pointer to the shadow_message field of the real
2483 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2485 if (addr2->transport_return != OK) continue;
2486 addr3 = store_get(sizeof(address_item));
2489 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2490 addr3->transport = stp;
2491 addr3->transport_return = DEFER;
2492 addr3->return_filename = NULL;
2493 addr3->return_file = -1;
2495 last = &(addr3->next);
2498 /* If we found any addresses to shadow, run the delivery, and stick any
2499 message back into the shadow_message field in the original. */
2501 if (shadow_addr != NULL)
2503 int save_count = transport_count;
2505 DEBUG(D_deliver|D_transport)
2506 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2507 deliver_local(shadow_addr, TRUE);
2509 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2511 int sresult = shadow_addr->transport_return;
2512 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2513 string_sprintf(" ST=%s", stp->name) :
2514 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2515 (shadow_addr->basic_errno <= 0)?
2516 US"" : US strerror(shadow_addr->basic_errno),
2517 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2519 (shadow_addr->message != NULL)? shadow_addr->message :
2520 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2522 DEBUG(D_deliver|D_transport)
2523 debug_printf("%s shadow transport returned %s for %s\n",
2525 (sresult == OK)? "OK" :
2526 (sresult == DEFER)? "DEFER" :
2527 (sresult == FAIL)? "FAIL" :
2528 (sresult == PANIC)? "PANIC" : "?",
2529 shadow_addr->address);
2532 DEBUG(D_deliver|D_transport)
2533 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2535 transport_count = save_count; /* Restore original transport count */
2539 /* Cancel the expansions that were set up for the delivery. */
2541 deliver_set_expansions(NULL);
2543 /* Now we can process the results of the real transport. We must take each
2544 address off the chain first, because post_process_one() puts it on another
2547 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2549 int result = addr2->transport_return;
2550 nextaddr = addr2->next;
2552 DEBUG(D_deliver|D_transport)
2553 debug_printf("%s transport returned %s for %s\n",
2555 (result == OK)? "OK" :
2556 (result == DEFER)? "DEFER" :
2557 (result == FAIL)? "FAIL" :
2558 (result == PANIC)? "PANIC" : "?",
2561 /* If there is a retry_record, or if delivery is deferred, build a retry
2562 item for setting a new retry time or deleting the old retry record from
2563 the database. These items are handled all together after all addresses
2564 have been handled (so the database is open just for a short time for
2567 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2569 int flags = (result == DEFER)? 0 : rf_delete;
2570 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2571 addr2->address_retry_key : addr2->domain_retry_key);
2573 retry_add_item(addr2, retry_key, flags);
2576 /* Done with this address */
2578 if (result == OK) addr2->more_errno = deliver_time;
2579 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2581 /* If a pipe delivery generated text to be sent back, the result may be
2582 changed to FAIL, and we must copy this for subsequent addresses in the
2585 if (addr2->transport_return != result)
2587 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2589 addr3->transport_return = addr2->transport_return;
2590 addr3->basic_errno = addr2->basic_errno;
2591 addr3->message = addr2->message;
2593 result = addr2->transport_return;
2596 /* Whether or not the result was changed to FAIL, we need to copy the
2597 return_file value from the first address into all the addresses of the
2598 batch, so they are all listed in the error message. */
2600 addr2->return_file = addr->return_file;
2602 /* Change log character for recording successful deliveries. */
2604 if (result == OK) logchar = '-';
2606 } /* Loop back for next batch of addresses */
2612 /*************************************************
2613 * Sort remote deliveries *
2614 *************************************************/
2616 /* This function is called if remote_sort_domains is set. It arranges that the
2617 chain of addresses for remote deliveries is ordered according to the strings
2618 specified. Try to make this shuffling reasonably efficient by handling
2619 sequences of addresses rather than just single ones.
2626 sort_remote_deliveries(void)
2629 address_item **aptr = &addr_remote;
2630 uschar *listptr = remote_sort_domains;
2634 while (*aptr != NULL &&
2635 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2638 address_item *moved = NULL;
2639 address_item **bptr = &moved;
2641 while (*aptr != NULL)
2643 address_item **next;
2644 deliver_domain = (*aptr)->domain; /* set $domain */
2645 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2646 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2648 aptr = &((*aptr)->next);
2652 next = &((*aptr)->next);
2653 while (*next != NULL &&
2654 (deliver_domain = (*next)->domain, /* Set $domain */
2655 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2656 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2657 next = &((*next)->next);
2659 /* If the batch of non-matchers is at the end, add on any that were
2660 extracted further up the chain, and end this iteration. Otherwise,
2661 extract them from the chain and hang on the moved chain. */
2673 aptr = &((*aptr)->next);
2676 /* If the loop ended because the final address matched, *aptr will
2677 be NULL. Add on to the end any extracted non-matching addresses. If
2678 *aptr is not NULL, the loop ended via "break" when *next is null, that
2679 is, there was a string of non-matching addresses at the end. In this
2680 case the extracted addresses have already been added on the end. */
2682 if (*aptr == NULL) *aptr = moved;
2688 debug_printf("remote addresses after sorting:\n");
2689 for (addr = addr_remote; addr != NULL; addr = addr->next)
2690 debug_printf(" %s\n", addr->address);
2696 /*************************************************
2697 * Read from pipe for remote delivery subprocess *
2698 *************************************************/
2700 /* This function is called when the subprocess is complete, but can also be
2701 called before it is complete, in order to empty a pipe that is full (to prevent
2702 deadlock). It must therefore keep track of its progress in the parlist data
2705 We read the pipe to get the delivery status codes and a possible error message
2706 for each address, optionally preceded by unusability data for the hosts and
2707 also by optional retry data.
2709 Read in large chunks into the big buffer and then scan through, interpreting
2710 the data therein. In most cases, only a single read will be necessary. No
2711 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2712 that we read the next chunk when there is less than 2500 bytes left in the
2713 non-final chunk, we can assume each item is complete in the buffer before
2714 handling it. Each item is written using a single write(), which is atomic for
2715 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2716 often bigger) so even if we are reading while the subprocess is still going, we
2717 should never have only a partial item in the buffer.
2720 poffset the offset of the parlist item
2721 eop TRUE if the process has completed
2723 Returns: TRUE if the terminating 'Z' item has been read,
2724 or there has been a disaster (i.e. no more data needed);
2729 par_read_pipe(int poffset, BOOL eop)
2732 pardata *p = parlist + poffset;
2733 address_item *addrlist = p->addrlist;
2734 address_item *addr = p->addr;
2737 uschar *endptr = big_buffer;
2738 uschar *ptr = endptr;
2739 uschar *msg = p->msg;
2740 BOOL done = p->done;
2741 BOOL unfinished = TRUE;
2743 /* Loop through all items, reading from the pipe when necessary. The pipe
2744 is set up to be non-blocking, but there are two different Unix mechanisms in
2745 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2746 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2747 which returns 0 for both end of file and no more data. We distinguish the
2748 two cases by taking 0 as end of file only when we know the process has
2751 Each separate item is written to the pipe in a single write(), and as they are
2752 all short items, the writes will all be atomic and we should never find
2753 ourselves in the position of having read an incomplete item. "Short" in this
2754 case can mean up to about 1K in the case when there is a long error message
2755 associated with an address. */
2757 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2758 (int)p->pid, eop? "ended" : "not ended");
2762 retry_item *r, **rp;
2763 int remaining = endptr - ptr;
2765 /* Read (first time) or top up the chars in the buffer if necessary.
2766 There will be only one read if we get all the available data (i.e. don't
2767 fill the buffer completely). */
2769 if (remaining < 2500 && unfinished)
2772 int available = big_buffer_size - remaining;
2774 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2777 endptr = big_buffer + remaining;
2778 len = read(fd, endptr, available);
2780 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2782 /* If the result is EAGAIN and the process is not complete, just
2783 stop reading any more and process what we have already. */
2787 if (!eop && errno == EAGAIN) len = 0; else
2789 msg = string_sprintf("failed to read pipe from transport process "
2790 "%d for transport %s: %s", pid, addr->transport->driver_name,
2796 /* If the length is zero (eof or no-more-data), just process what we
2797 already have. Note that if the process is still running and we have
2798 read all the data in the pipe (but less that "available") then we
2799 won't read any more, as "unfinished" will get set FALSE. */
2802 unfinished = len == available;
2805 /* If we are at the end of the available data, exit the loop. */
2807 if (ptr >= endptr) break;
2809 /* Handle each possible type of item, assuming the complete item is
2810 available in store. */
2814 /* Host items exist only if any hosts were marked unusable. Match
2815 up by checking the IP address. */
2818 for (h = addrlist->host_list; h != NULL; h = h->next)
2820 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2828 /* Retry items are sent in a preceding R item for each address. This is
2829 kept separate to keep each message short enough to guarantee it won't
2830 be split in the pipe. Hopefully, in the majority of cases, there won't in
2831 fact be any retry items at all.
2833 The complete set of retry items might include an item to delete a
2834 routing retry if there was a previous routing delay. However, routing
2835 retries are also used when a remote transport identifies an address error.
2836 In that case, there may also be an "add" item for the same key. Arrange
2837 that a "delete" item is dropped in favour of an "add" item. */
2840 if (addr == NULL) goto ADDR_MISMATCH;
2842 DEBUG(D_deliver|D_retry)
2843 debug_printf("reading retry information for %s from subprocess\n",
2846 /* Cut out any "delete" items on the list. */
2848 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2850 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2852 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2853 *rp = r->next; /* Excise a delete item */
2854 DEBUG(D_deliver|D_retry)
2855 debug_printf(" existing delete item dropped\n");
2859 /* We want to add a delete item only if there is no non-delete item;
2860 however we still have to step ptr through the data. */
2862 if (r == NULL || (*ptr & rf_delete) == 0)
2864 r = store_get(sizeof(retry_item));
2865 r->next = addr->retries;
2868 r->key = string_copy(ptr);
2870 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2871 ptr += sizeof(r->basic_errno);
2872 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2873 ptr += sizeof(r->more_errno);
2874 r->message = (*ptr)? string_copy(ptr) : NULL;
2875 DEBUG(D_deliver|D_retry)
2876 debug_printf(" added %s item\n",
2877 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2882 DEBUG(D_deliver|D_retry)
2883 debug_printf(" delete item not added: non-delete item exists\n");
2886 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2892 /* Put the amount of data written into the parlist block */
2895 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2896 ptr += sizeof(transport_count);
2899 /* Address items are in the order of items on the address chain. We
2900 remember the current address value in case this function is called
2901 several times to empty the pipe in stages. Information about delivery
2902 over TLS is sent in a preceding X item for each address. We don't put
2903 it in with the other info, in order to keep each message short enough to
2904 guarantee it won't be split in the pipe. */
2908 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2909 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2911 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2916 case 'C': /* client authenticator information */
2920 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
2923 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
2926 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
2932 #ifdef EXPERIMENTAL_PRDR
2934 addr->flags |= af_prdr_used; break;
2941 msg = string_sprintf("address count mismatch for data read from pipe "
2942 "for transport process %d for transport %s", pid,
2943 addrlist->transport->driver_name);
2948 addr->transport_return = *ptr++;
2949 addr->special_action = *ptr++;
2950 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2951 ptr += sizeof(addr->basic_errno);
2952 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2953 ptr += sizeof(addr->more_errno);
2954 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2955 ptr += sizeof(addr->flags);
2956 addr->message = (*ptr)? string_copy(ptr) : NULL;
2958 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2961 /* Always two strings for host information, followed by the port number */
2965 h = store_get(sizeof(host_item));
2966 h->name = string_copy(ptr);
2968 h->address = string_copy(ptr);
2970 memcpy(&(h->port), ptr, sizeof(h->port));
2971 ptr += sizeof(h->port);
2972 addr->host_used = h;
2976 /* Finished with this address */
2981 /* Z marks the logical end of the data. It is followed by '0' if
2982 continue_transport was NULL at the end of transporting, otherwise '1'.
2983 We need to know when it becomes NULL during a delivery down a passed SMTP
2984 channel so that we don't try to pass anything more down it. Of course, for
2985 most normal messages it will remain NULL all the time. */
2990 continue_transport = NULL;
2991 continue_hostname = NULL;
2994 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
2997 /* Anything else is a disaster. */
3000 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3001 "process %d for transport %s", ptr[-1], pid,
3002 addr->transport->driver_name);
3008 /* The done flag is inspected externally, to determine whether or not to
3009 call the function again when the process finishes. */
3013 /* If the process hadn't finished, and we haven't seen the end of the data
3014 or suffered a disaster, update the rest of the state, and return FALSE to
3015 indicate "not finished". */
3024 /* Close our end of the pipe, to prevent deadlock if the far end is still
3025 pushing stuff into it. */
3030 /* If we have finished without error, but haven't had data for every address,
3031 something is wrong. */
3033 if (msg == NULL && addr != NULL)
3034 msg = string_sprintf("insufficient address data read from pipe "
3035 "for transport process %d for transport %s", pid,
3036 addr->transport->driver_name);
3038 /* If an error message is set, something has gone wrong in getting back
3039 the delivery data. Put the message into each address and freeze it. */
3043 for (addr = addrlist; addr != NULL; addr = addr->next)
3045 addr->transport_return = DEFER;
3046 addr->special_action = SPECIAL_FREEZE;
3047 addr->message = msg;
3051 /* Return TRUE to indicate we have got all we need from this process, even
3052 if it hasn't actually finished yet. */
3059 /*************************************************
3060 * Post-process a set of remote addresses *
3061 *************************************************/
3063 /* Do what has to be done immediately after a remote delivery for each set of
3064 addresses, then re-write the spool if necessary. Note that post_process_one
3065 puts the address on an appropriate queue; hence we must fish off the next
3066 one first. This function is also called if there is a problem with setting
3067 up a subprocess to do a remote delivery in parallel. In this case, the final
3068 argument contains a message, and the action must be forced to DEFER.
3071 addr pointer to chain of address items
3072 logflags flags for logging
3073 msg NULL for normal cases; -> error message for unexpected problems
3074 fallback TRUE if processing fallback hosts
3080 remote_post_process(address_item *addr, int logflags, uschar *msg,
3085 /* If any host addresses were found to be unusable, add them to the unusable
3086 tree so that subsequent deliveries don't try them. */
3088 for (h = addr->host_list; h != NULL; h = h->next)
3090 if (h->address == NULL) continue;
3091 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3094 /* Now handle each address on the chain. The transport has placed '=' or '-'
3095 into the special_action field for each successful delivery. */
3097 while (addr != NULL)
3099 address_item *next = addr->next;
3101 /* If msg == NULL (normal processing) and the result is DEFER and we are
3102 processing the main hosts and there are fallback hosts available, put the
3103 address on the list for fallback delivery. */
3105 if (addr->transport_return == DEFER &&
3106 addr->fallback_hosts != NULL &&
3110 addr->host_list = addr->fallback_hosts;
3111 addr->next = addr_fallback;
3112 addr_fallback = addr;
3113 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3116 /* If msg is set (=> unexpected problem), set it in the address before
3117 doing the ordinary post processing. */
3123 addr->message = msg;
3124 addr->transport_return = DEFER;
3126 (void)post_process_one(addr, addr->transport_return, logflags,
3127 DTYPE_TRANSPORT, addr->special_action);
3135 /* If we have just delivered down a passed SMTP channel, and that was
3136 the last address, the channel will have been closed down. Now that
3137 we have logged that delivery, set continue_sequence to 1 so that
3138 any subsequent deliveries don't get "*" incorrectly logged. */
3140 if (continue_transport == NULL) continue_sequence = 1;
3145 /*************************************************
3146 * Wait for one remote delivery subprocess *
3147 *************************************************/
3149 /* This function is called while doing remote deliveries when either the
3150 maximum number of processes exist and we need one to complete so that another
3151 can be created, or when waiting for the last ones to complete. It must wait for
3152 the completion of one subprocess, empty the control block slot, and return a
3153 pointer to the address chain.
3156 Returns: pointer to the chain of addresses handled by the process;
3157 NULL if no subprocess found - this is an unexpected error
3160 static address_item *
3163 int poffset, status;
3164 address_item *addr, *addrlist;
3167 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3168 "to finish", message_id);
3170 /* Loop until either a subprocess completes, or there are no subprocesses in
3171 existence - in which case give an error return. We cannot proceed just by
3172 waiting for a completion, because a subprocess may have filled up its pipe, and
3173 be waiting for it to be emptied. Therefore, if no processes have finished, we
3174 wait for one of the pipes to acquire some data by calling select(), with a
3175 timeout just in case.
3177 The simple approach is just to iterate after reading data from a ready pipe.
3178 This leads to non-ideal behaviour when the subprocess has written its final Z
3179 item, closed the pipe, and is in the process of exiting (the common case). A
3180 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3181 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3184 To avoid this, if all the data that is needed has been read from a subprocess
3185 after select(), an explicit wait() for it is done. We know that all it is doing
3186 is writing to the pipe and then exiting, so the wait should not be long.
3188 The non-blocking waitpid() is to some extent just insurance; if we could
3189 reliably detect end-of-file on the pipe, we could always know when to do a
3190 blocking wait() for a completed process. However, because some systems use
3191 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3192 use code that functions without the need to recognize EOF.
3194 There's a double loop here just in case we end up with a process that is not in
3195 the list of remote delivery processes. Something has obviously gone wrong if
3196 this is the case. (For example, a process that is incorrectly left over from
3197 routing or local deliveries might be found.) The damage can be minimized by
3198 looping back and looking for another process. If there aren't any, the error
3199 return will happen. */
3201 for (;;) /* Normally we do not repeat this loop */
3203 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3206 fd_set select_pipes;
3207 int maxpipe, readycount;
3209 /* A return value of -1 can mean several things. If errno != ECHILD, it
3210 either means invalid options (which we discount), or that this process was
3211 interrupted by a signal. Just loop to try the waitpid() again.
3213 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3214 in existence. This should never happen, and is an unexpected error.
3215 However, there is a nasty complication when running under Linux. If "strace
3216 -f" is being used under Linux to trace this process and its children,
3217 subprocesses are "stolen" from their parents and become the children of the
3218 tracing process. A general wait such as the one we've just obeyed returns
3219 as if there are no children while subprocesses are running. Once a
3220 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3221 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3224 This does not happen using "truss" on Solaris, nor (I think) with other
3225 tracing facilities on other OS. It seems to be specific to Linux.
3227 What we do to get round this is to use kill() to see if any of our
3228 subprocesses are still in existence. If kill() gives an OK return, we know
3229 it must be for one of our processes - it can't be for a re-use of the pid,
3230 because if our process had finished, waitpid() would have found it. If any
3231 of our subprocesses are in existence, we proceed to use select() as if
3232 waitpid() had returned zero. I think this is safe. */
3236 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3239 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3240 "for process existence\n");
3242 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3244 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3246 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3247 "stolen by strace\n", (int)pid);
3248 break; /* With poffset set */
3252 if (poffset >= remote_max_parallel)
3254 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3255 return NULL; /* This is the error return */
3259 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3260 been handled above. A return value of zero means that there is at least one
3261 subprocess, but there are no completed subprocesses. See if any pipes are
3262 ready with any data for reading. */
3264 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3267 FD_ZERO(&select_pipes);
3268 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3270 if (parlist[poffset].pid != 0)
3272 int fd = parlist[poffset].fd;
3273 FD_SET(fd, &select_pipes);
3274 if (fd > maxpipe) maxpipe = fd;
3278 /* Stick in a 60-second timeout, just in case. */
3283 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3286 /* Scan through the pipes and read any that are ready; use the count
3287 returned by select() to stop when there are no more. Select() can return
3288 with no processes (e.g. if interrupted). This shouldn't matter.
3290 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3291 read, or there was a disaster. In either case, we are finished with this
3292 process. Do an explicit wait() for the process and break the main loop if
3295 It turns out that we have to deal with the case of an interrupted system
3296 call, which can happen on some operating systems if the signal handling is
3297 set up to do that by default. */
3300 readycount > 0 && poffset < remote_max_parallel;
3303 if ((pid = parlist[poffset].pid) != 0 &&
3304 FD_ISSET(parlist[poffset].fd, &select_pipes))
3307 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3309 for (;;) /* Loop for signals */
3311 pid_t endedpid = waitpid(pid, &status, 0);
3312 if (endedpid == pid) goto PROCESS_DONE;
3313 if (endedpid != (pid_t)(-1) || errno != EINTR)
3314 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3315 "%d (errno = %d) from waitpid() for process %d",
3316 (int)endedpid, errno, (int)pid);
3322 /* Now go back and look for a completed subprocess again. */
3325 /* A completed process was detected by the non-blocking waitpid(). Find the
3326 data block that corresponds to this subprocess. */
3328 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3329 if (pid == parlist[poffset].pid) break;
3331 /* Found the data block; this is a known remote delivery process. We don't
3332 need to repeat the outer loop. This should be what normally happens. */
3334 if (poffset < remote_max_parallel) break;
3336 /* This situation is an error, but it's probably better to carry on looking
3337 for another process than to give up (as we used to do). */
3339 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3340 "transport process list", pid);
3341 } /* End of the "for" loop */
3343 /* Come here when all the data was completely read after a select(), and
3344 the process in pid has been wait()ed for. */
3351 debug_printf("remote delivery process %d ended\n", (int)pid);
3353 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3357 set_process_info("delivering %s", message_id);
3359 /* Get the chain of processed addresses */
3361 addrlist = parlist[poffset].addrlist;
3363 /* If the process did not finish cleanly, record an error and freeze (except
3364 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3365 in case the delivery did actually happen. */
3367 if ((status & 0xffff) != 0)
3370 int msb = (status >> 8) & 255;
3371 int lsb = status & 255;
3372 int code = (msb == 0)? (lsb & 0x7f) : msb;
3374 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3376 addrlist->transport->driver_name,
3378 (msb == 0)? "terminated by signal" : "exit code",
3381 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3382 addrlist->special_action = SPECIAL_FREEZE;
3384 for (addr = addrlist; addr != NULL; addr = addr->next)
3386 addr->transport_return = DEFER;
3387 addr->message = msg;
3390 remove_journal = FALSE;
3393 /* Else complete reading the pipe to get the result of the delivery, if all
3394 the data has not yet been obtained. */
3396 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3398 /* Put the data count and return path into globals, mark the data slot unused,
3399 decrement the count of subprocesses, and return the address chain. */
3401 transport_count = parlist[poffset].transport_count;
3402 used_return_path = parlist[poffset].return_path;
3403 parlist[poffset].pid = 0;
3410 /*************************************************
3411 * Wait for subprocesses and post-process *
3412 *************************************************/
3414 /* This function waits for subprocesses until the number that are still running
3415 is below a given threshold. For each complete subprocess, the addresses are
3416 post-processed. If we can't find a running process, there is some shambles.
3417 Better not bomb out, as that might lead to multiple copies of the message. Just
3418 log and proceed as if all done.
3421 max maximum number of subprocesses to leave running
3422 fallback TRUE if processing fallback hosts
3428 par_reduce(int max, BOOL fallback)
3430 while (parcount > max)
3432 address_item *doneaddr = par_wait();
3433 if (doneaddr == NULL)
3435 log_write(0, LOG_MAIN|LOG_PANIC,
3436 "remote delivery process count got out of step");
3439 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3447 rmt_dlv_checked_write(int fd, void * buf, int size)
3449 int ret = write(fd, buf, size);
3451 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3452 ret == -1 ? strerror(errno) : "short write");
3455 /*************************************************
3456 * Do remote deliveries *
3457 *************************************************/
3459 /* This function is called to process the addresses in addr_remote. We must
3460 pick off the queue all addresses that have the same transport, remote
3461 destination, and errors address, and hand them to the transport in one go,
3462 subject to some configured limitations. If this is a run to continue delivering
3463 to an existing delivery channel, skip all but those addresses that can go to
3464 that channel. The skipped addresses just get deferred.
3466 If mua_wrapper is set, all addresses must be able to be sent in a single
3467 transaction. If not, this function yields FALSE.
3469 In Exim 4, remote deliveries are always done in separate processes, even
3470 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3471 is so that the base process can retain privilege. This makes the
3472 implementation of fallback transports feasible (though not initially done.)
3474 We create up to the configured number of subprocesses, each of which passes
3475 back the delivery state via a pipe. (However, when sending down an existing
3476 connection, remote_max_parallel is forced to 1.)
3479 fallback TRUE if processing fallback hosts
3481 Returns: TRUE normally
3482 FALSE if mua_wrapper is set and the addresses cannot all be sent
3487 do_remote_deliveries(BOOL fallback)
3493 parcount = 0; /* Number of executing subprocesses */
3495 /* When sending down an existing channel, only do one delivery at a time.
3496 We use a local variable (parmax) to hold the maximum number of processes;
3497 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3499 if (continue_transport != NULL) remote_max_parallel = 1;
3500 parmax = remote_max_parallel;
3502 /* If the data for keeping a list of processes hasn't yet been
3505 if (parlist == NULL)
3507 parlist = store_get(remote_max_parallel * sizeof(pardata));
3508 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3509 parlist[poffset].pid = 0;
3512 /* Now loop for each remote delivery */
3514 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3520 int address_count = 1;
3521 int address_count_max;
3523 BOOL use_initgroups;
3524 BOOL pipe_done = FALSE;
3525 transport_instance *tp;
3526 address_item **anchor = &addr_remote;
3527 address_item *addr = addr_remote;
3528 address_item *last = addr;
3531 /* Pull the first address right off the list. */
3533 addr_remote = addr->next;
3536 DEBUG(D_deliver|D_transport)
3537 debug_printf("--------> %s <--------\n", addr->address);
3539 /* If no transport has been set, there has been a big screw-up somewhere. */
3541 if ((tp = addr->transport) == NULL)
3543 disable_logging = FALSE; /* Jic */
3544 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3545 US"No transport set by router", fallback);
3549 /* Check that this base address hasn't previously been delivered to this
3550 transport. The check is necessary at this point to handle homonymic addresses
3551 correctly in cases where the pattern of redirection changes between delivery
3552 attempts. Non-homonymic previous delivery is detected earlier, at routing
3555 if (previously_transported(addr, FALSE)) continue;
3557 /* Force failure if the message is too big. */
3559 if (tp->message_size_limit != NULL)
3561 int rc = check_message_size(tp, addr);
3564 addr->transport_return = rc;
3565 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3570 /* Get the flag which specifies whether the transport can handle different
3571 domains that nevertheless resolve to the same set of hosts. */
3573 multi_domain = tp->multi_domain;
3575 /* Get the maximum it can handle in one envelope, with zero meaning
3576 unlimited, which is forced for the MUA wrapper case. */
3578 address_count_max = tp->max_addresses;
3579 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3582 /************************************************************************/
3583 /***** This is slightly experimental code, but should be safe. *****/
3585 /* The address_count_max value is the maximum number of addresses that the
3586 transport can send in one envelope. However, the transport must be capable of
3587 dealing with any number of addresses. If the number it gets exceeds its
3588 envelope limitation, it must send multiple copies of the message. This can be
3589 done over a single connection for SMTP, so uses less resources than making
3590 multiple connections. On the other hand, if remote_max_parallel is greater
3591 than one, it is perhaps a good idea to use parallel processing to move the
3592 message faster, even if that results in multiple simultaneous connections to
3595 How can we come to some compromise between these two ideals? What we do is to
3596 limit the number of addresses passed to a single instance of a transport to
3597 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3598 number of addresses routed to remote transports divided by
3599 remote_max_parallel. For example, if the message has 100 remote recipients,
3600 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3601 once. But if rcpt_max is 100, we could send up to 100.
3603 Of course, not all the remotely addresses in a message are going to go to the
3604 same set of hosts (except in smarthost configurations), so this is just a
3605 heuristic way of dividing up the work.
3607 Furthermore (1), because this may not be wanted in some cases, and also to
3608 cope with really pathological cases, there is also a limit to the number of
3609 messages that are sent over one connection. This is the same limit that is
3610 used when sending several different messages over the same connection.
3611 Continue_sequence is set when in this situation, to the number sent so
3612 far, including this message.
3614 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3615 is probably because they are using VERP, in which case they want to pass only
3616 one address at a time to the transport, in order to be able to use
3617 $local_part and $domain in constructing a new return path. We could test for
3618 the use of these variables, but as it is so likely they will be used when the
3619 maximum is 1, we don't bother. Just leave the value alone. */
3621 if (address_count_max != 1 &&
3622 address_count_max < remote_delivery_count/remote_max_parallel)
3624 int new_max = remote_delivery_count/remote_max_parallel;
3625 int message_max = tp->connection_max_messages;
3626 if (connection_max_messages >= 0) message_max = connection_max_messages;
3627 message_max -= continue_sequence - 1;
3628 if (message_max > 0 && new_max > address_count_max * message_max)
3629 new_max = address_count_max * message_max;
3630 address_count_max = new_max;
3633 /************************************************************************/
3636 /* Pick off all addresses which have the same transport, errors address,
3637 destination, and extra headers. In some cases they point to the same host
3638 list, but we also need to check for identical host lists generated from
3639 entirely different domains. The host list pointers can be NULL in the case
3640 where the hosts are defined in the transport. There is also a configured
3641 maximum limit of addresses that can be handled at once (see comments above
3642 for how it is computed). */
3644 while ((next = *anchor) != NULL && address_count < address_count_max)
3646 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3648 tp == next->transport
3650 same_hosts(next->host_list, addr->host_list)
3652 same_strings(next->p.errors_address, addr->p.errors_address)
3654 same_headers(next->p.extra_headers, addr->p.extra_headers)
3656 same_ugid(tp, next, addr)
3658 (next->p.remove_headers == addr->p.remove_headers ||
3659 (next->p.remove_headers != NULL &&
3660 addr->p.remove_headers != NULL &&
3661 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3663 *anchor = next->next;
3665 next->first = addr; /* remember top one (for retry processing) */
3670 else anchor = &(next->next);
3673 /* If we are acting as an MUA wrapper, all addresses must go in a single
3674 transaction. If not, put them back on the chain and yield FALSE. */
3676 if (mua_wrapper && addr_remote != NULL)
3678 last->next = addr_remote;
3683 /* Set up the expansion variables for this set of addresses */
3685 deliver_set_expansions(addr);
3687 /* Ensure any transport-set auth info is fresh */
3688 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3690 /* Compute the return path, expanding a new one if required. The old one
3691 must be set first, as it might be referred to in the expansion. */
3693 if(addr->p.errors_address != NULL)
3694 return_path = addr->p.errors_address;
3695 #ifdef EXPERIMENTAL_SRS
3696 else if(addr->p.srs_sender != NULL)
3697 return_path = addr->p.srs_sender;
3700 return_path = sender_address;
3702 if (tp->return_path != NULL)
3704 uschar *new_return_path = expand_string(tp->return_path);
3705 if (new_return_path == NULL)
3707 if (!expand_string_forcedfail)
3709 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3710 string_sprintf("Failed to expand return path \"%s\": %s",
3711 tp->return_path, expand_string_message), fallback);
3715 else return_path = new_return_path;
3718 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3719 logs and sets up error messages, so we just post-process and continue with
3720 the next address. */
3722 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3724 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3728 /* If this transport has a setup function, call it now so that it gets
3729 run in this process and not in any subprocess. That way, the results of
3730 any setup that are retained by the transport can be reusable. One of the
3731 things the setup does is to set the fallback host lists in the addresses.
3732 That is why it is called at this point, before the continue delivery
3733 processing, because that might use the fallback hosts. */
3735 if (tp->setup != NULL)
3736 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3738 /* If this is a run to continue delivery down an already-established
3739 channel, check that this set of addresses matches the transport and
3740 the channel. If it does not, defer the addresses. If a host list exists,
3741 we must check that the continue host is on the list. Otherwise, the
3742 host is set in the transport. */
3744 continue_more = FALSE; /* In case got set for the last lot */
3745 if (continue_transport != NULL)
3747 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3748 if (ok && addr->host_list != NULL)
3752 for (h = addr->host_list; h != NULL; h = h->next)
3754 if (Ustrcmp(h->name, continue_hostname) == 0)
3755 { ok = TRUE; break; }
3759 /* Addresses not suitable; defer or queue for fallback hosts (which
3760 might be the continue host) and skip to next address. */
3764 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3767 if (addr->fallback_hosts != NULL && !fallback)
3771 next->host_list = next->fallback_hosts;
3772 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3773 if (next->next == NULL) break;
3776 next->next = addr_fallback;
3777 addr_fallback = addr;
3782 while (next->next != NULL) next = next->next;
3783 next->next = addr_defer;
3790 /* Set a flag indicating whether there are further addresses that list
3791 the continued host. This tells the transport to leave the channel open,
3792 but not to pass it to another delivery process. */
3794 for (next = addr_remote; next != NULL; next = next->next)
3797 for (h = next->host_list; h != NULL; h = h->next)
3799 if (Ustrcmp(h->name, continue_hostname) == 0)
3800 { continue_more = TRUE; break; }
3805 /* The transports set up the process info themselves as they may connect
3806 to more than one remote machine. They also have to set up the filter
3807 arguments, if required, so that the host name and address are available
3810 transport_filter_argv = NULL;
3812 /* Create the pipe for inter-process communication. If pipe creation
3813 fails, it is probably because the value of remote_max_parallel is so
3814 large that too many file descriptors for pipes have been created. Arrange
3815 to wait for a process to finish, and then try again. If we still can't
3816 create a pipe when all processes have finished, break the retry loop. */
3820 if (pipe(pfd) == 0) pipe_done = TRUE;
3821 else if (parcount > 0) parmax = parcount;
3824 /* We need to make the reading end of the pipe non-blocking. There are
3825 two different options for this. Exim is cunningly (I hope!) coded so
3826 that it can use either of them, though it prefers O_NONBLOCK, which
3827 distinguishes between EOF and no-more-data. */
3830 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3832 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3835 /* If the maximum number of subprocesses already exist, wait for a process
3836 to finish. If we ran out of file descriptors, parmax will have been reduced
3837 from its initial value of remote_max_parallel. */
3839 par_reduce(parmax - 1, fallback);
3842 /* If we failed to create a pipe and there were no processes to wait
3843 for, we have to give up on this one. Do this outside the above loop
3844 so that we can continue the main loop. */
3848 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3849 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3853 /* Find a free slot in the pardata list. Must do this after the possible
3854 waiting for processes to finish, because a terminating process will free
3857 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3858 if (parlist[poffset].pid == 0) break;
3860 /* If there isn't one, there has been a horrible disaster. */
3862 if (poffset >= remote_max_parallel)
3864 (void)close(pfd[pipe_write]);
3865 (void)close(pfd[pipe_read]);
3866 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3867 US"Unexpectedly no free subprocess slot", fallback);
3871 /* Now fork a subprocess to do the remote delivery, but before doing so,
3872 ensure that any cached resourses are released so as not to interfere with
3873 what happens in the subprocess. */
3877 if ((pid = fork()) == 0)
3879 int fd = pfd[pipe_write];
3882 /* Setting this global in the subprocess means we need never clear it */
3883 transport_name = tp->name;
3885 /* There are weird circumstances in which logging is disabled */
3886 disable_logging = tp->disable_logging;
3888 /* Show pids on debug output if parallelism possible */
3890 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3892 DEBUG(D_any|D_v) debug_selector |= D_pid;
3893 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3896 /* Reset the random number generator, so different processes don't all
3897 have the same sequence. In the test harness we want different, but
3898 predictable settings for each delivery process, so do something explicit
3899 here rather they rely on the fixed reset in the random number function. */
3901 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3903 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3904 a new process that may be forked to do another delivery down the same
3907 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3909 /* Close open file descriptors for the pipes of other processes
3910 that are running in parallel. */
3912 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3913 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3915 /* This process has inherited a copy of the file descriptor
3916 for the data file, but its file pointer is shared with all the
3917 other processes running in parallel. Therefore, we have to re-open
3918 the file in order to get a new file descriptor with its own
3919 file pointer. We don't need to lock it, as the lock is held by
3920 the parent process. There doesn't seem to be any way of doing
3921 a dup-with-new-file-pointer. */
3923 (void)close(deliver_datafile);
3924 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3926 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3928 if (deliver_datafile < 0)
3929 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3930 "parallel delivery: %s", spoolname, strerror(errno));
3932 /* Set the close-on-exec flag */
3934 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3937 /* Set the uid/gid of this process; bombs out on failure. */
3939 exim_setugid(uid, gid, use_initgroups,
3940 string_sprintf("remote delivery to %s with transport=%s",
3941 addr->address, tp->name));
3943 /* Close the unwanted half of this process' pipe, set the process state,
3944 and run the transport. Afterwards, transport_count will contain the number
3945 of bytes written. */
3947 (void)close(pfd[pipe_read]);
3948 set_process_info("delivering %s using %s", message_id, tp->name);
3949 debug_print_string(tp->debug_string);
3950 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3952 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3953 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3955 /* Ensure any cached resources that we used are now released */
3959 /* Pass the result back down the pipe. This is a lot more information
3960 than is needed for a local delivery. We have to send back the error
3961 status for each address, the usability status for each host that is
3962 flagged as unusable, and all the retry items. When TLS is in use, we
3963 send also the cipher and peerdn information. Each type of information
3964 is flagged by an identifying byte, and is then in a fixed format (with
3965 strings terminated by zeros), and there is a final terminator at the
3966 end. The host information and retry information is all attached to
3967 the first address, so that gets sent at the start. */
3969 /* Host unusability information: for most success cases this will
3972 for (h = addr->host_list; h != NULL; h = h->next)
3974 if (h->address == NULL || h->status < hstatus_unusable) continue;
3975 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3976 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3979 /* The number of bytes written. This is the same for each address. Even
3980 if we sent several copies of the message down the same connection, the
3981 size of each one is the same, and it's that value we have got because
3982 transport_count gets reset before calling transport_write_message(). */
3984 big_buffer[0] = 'S';
3985 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3986 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
3988 /* Information about what happened to each address. Four item types are
3989 used: an optional 'X' item first, for TLS information, then an optional "C"
3990 item for any client-auth info followed by 'R' items for any retry settings,
3991 and finally an 'A' item for the remaining data. */
3993 for(; addr != NULL; addr = addr->next)
3998 /* The certificate verification status goes into the flags */
4000 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4002 /* Use an X item only if there's something to send */
4005 if (addr->cipher != NULL)
4008 sprintf(CS ptr, "X%.128s", addr->cipher);
4010 if (addr->peerdn == NULL) *ptr++ = 0; else
4012 sprintf(CS ptr, "%.512s", addr->peerdn);
4015 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4019 if (client_authenticator)
4022 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4024 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4026 if (client_authenticated_id)
4029 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4031 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4033 if (client_authenticated_sender)
4036 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4038 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4041 #ifdef EXPERIMENTAL_PRDR
4042 if (addr->flags & af_prdr_used) rmt_dlv_checked_write(fd, "P", 1);
4045 /* Retry information: for most success cases this will be null. */
4047 for (r = addr->retries; r != NULL; r = r->next)
4050 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4051 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4052 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4053 ptr += sizeof(r->basic_errno);
4054 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4055 ptr += sizeof(r->more_errno);
4056 if (r->message == NULL) *ptr++ = 0; else
4058 sprintf(CS ptr, "%.512s", r->message);
4061 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4064 /* The rest of the information goes in an 'A' item. */
4066 ptr = big_buffer + 3;
4067 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4068 addr->special_action);
4069 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4070 ptr += sizeof(addr->basic_errno);
4071 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4072 ptr += sizeof(addr->more_errno);
4073 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4074 ptr += sizeof(addr->flags);
4076 if (addr->message == NULL) *ptr++ = 0; else
4078 sprintf(CS ptr, "%.1024s", addr->message);
4082 if (addr->user_message == NULL) *ptr++ = 0; else
4084 sprintf(CS ptr, "%.1024s", addr->user_message);
4088 if (addr->host_used == NULL) *ptr++ = 0; else
4090 sprintf(CS ptr, "%.256s", addr->host_used->name);
4092 sprintf(CS ptr, "%.64s", addr->host_used->address);
4094 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4095 ptr += sizeof(addr->host_used->port);
4097 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4100 /* Add termination flag, close the pipe, and that's it. The character
4101 after 'Z' indicates whether continue_transport is now NULL or not.
4102 A change from non-NULL to NULL indicates a problem with a continuing
4105 big_buffer[0] = 'Z';
4106 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4107 rmt_dlv_checked_write(fd, big_buffer, 2);
4112 /* Back in the mainline: close the unwanted half of the pipe. */
4114 (void)close(pfd[pipe_write]);
4116 /* Fork failed; defer with error message */
4120 (void)close(pfd[pipe_read]);
4121 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4122 string_sprintf("fork failed for remote delivery to %s: %s",
4123 addr->domain, strerror(errno)), fallback);
4127 /* Fork succeeded; increment the count, and remember relevant data for
4128 when the process finishes. */
4131 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4132 parlist[poffset].pid = pid;
4133 parlist[poffset].fd = pfd[pipe_read];
4134 parlist[poffset].done = FALSE;
4135 parlist[poffset].msg = NULL;
4136 parlist[poffset].return_path = return_path;
4138 /* If the process we've just started is sending a message down an existing
4139 channel, wait for it now. This ensures that only one such process runs at
4140 once, whatever the value of remote_max parallel. Otherwise, we might try to
4141 send two or more messages simultaneously down the same channel. This could
4142 happen if there are different domains that include the same host in otherwise
4143 different host lists.
4145 Also, if the transport closes down the channel, this information gets back
4146 (continue_transport gets set to NULL) before we consider any other addresses
4149 if (continue_transport != NULL) par_reduce(0, fallback);
4151 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4152 newly created process get going before we create another process. This should
4153 ensure repeatability in the tests. We only need to wait a tad. */
4155 else if (running_in_test_harness) millisleep(500);
4158 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4159 are still running and post-process their addresses. */
4161 par_reduce(0, fallback);
4168 /*************************************************
4169 * Split an address into local part and domain *
4170 *************************************************/
4172 /* This function initializes an address for routing by splitting it up into a
4173 local part and a domain. The local part is set up twice - once in its original
4174 casing, and once in lower case, and it is dequoted. We also do the "percent
4175 hack" for configured domains. This may lead to a DEFER result if a lookup
4176 defers. When a percent-hacking takes place, we insert a copy of the original
4177 address as a new parent of this address, as if we have had a redirection.
4180 addr points to an addr_item block containing the address
4183 DEFER - could not determine if domain is %-hackable
4187 deliver_split_address(address_item *addr)
4189 uschar *address = addr->address;
4190 uschar *domain = Ustrrchr(address, '@');
4192 int len = domain - address;
4194 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4196 /* The implication in the RFCs (though I can't say I've seen it spelled out
4197 explicitly) is that quoting should be removed from local parts at the point
4198 where they are locally interpreted. [The new draft "821" is more explicit on
4199 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4200 removing quoting backslashes and any unquoted doublequotes. */
4202 t = addr->cc_local_part = store_get(len+1);
4205 register int c = *address++;
4206 if (c == '\"') continue;
4216 /* We do the percent hack only for those domains that are listed in
4217 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4219 if (percent_hack_domains != NULL)
4222 uschar *new_address = NULL;
4223 uschar *local_part = addr->cc_local_part;
4225 deliver_domain = addr->domain; /* set $domain */
4227 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4228 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4230 (t = Ustrrchr(local_part, '%')) != NULL)
4232 new_address = string_copy(local_part);
4233 new_address[t - local_part] = '@';
4234 deliver_domain = string_copylc(t+1);
4235 local_part = string_copyn(local_part, t - local_part);
4238 if (rc == DEFER) return DEFER; /* lookup deferred */
4240 /* If hackery happened, set up new parent and alter the current address. */
4242 if (new_address != NULL)
4244 address_item *new_parent = store_get(sizeof(address_item));
4245 *new_parent = *addr;
4246 addr->parent = new_parent;
4247 addr->address = new_address;
4248 addr->unique = string_copy(new_address);
4249 addr->domain = deliver_domain;
4250 addr->cc_local_part = local_part;
4251 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4256 /* Create the lowercased version of the final local part, and make that the
4257 default one to be used. */
4259 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4266 /*************************************************
4267 * Get next error message text *
4268 *************************************************/
4270 /* If f is not NULL, read the next "paragraph", from a customized error message
4271 text file, terminated by a line containing ****, and expand it.
4274 f NULL or a file to read from
4275 which string indicating which string (for errors)
4277 Returns: NULL or an expanded string
4281 next_emf(FILE *f, uschar *which)
4285 uschar *para, *yield;
4288 if (f == NULL) return NULL;
4290 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4291 Ustrcmp(buffer, "****\n") == 0) return NULL;
4293 para = store_get(size);
4296 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4297 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4298 Ustrcmp(buffer, "****\n") == 0) break;
4302 yield = expand_string(para);
4303 if (yield != NULL) return yield;
4305 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4306 "bounce_message_file or warn_message_file (%s): %s", which,
4307 expand_string_message);
4314 /*************************************************
4315 * Close down a passed transport channel *
4316 *************************************************/
4318 /* This function is called when a passed transport channel cannot be used.
4319 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4320 so that the function call can be the argument of a "return" statement.
4323 Returns: DELIVER_NOT_ATTEMPTED
4327 continue_closedown(void)
4329 if (continue_transport != NULL)
4331 transport_instance *t;
4332 for (t = transports; t != NULL; t = t->next)
4334 if (Ustrcmp(t->name, continue_transport) == 0)
4336 if (t->info->closedown != NULL) (t->info->closedown)(t);
4341 return DELIVER_NOT_ATTEMPTED;
4347 /*************************************************
4348 * Print address information *
4349 *************************************************/
4351 /* This function is called to output an address, or information about an
4352 address, for bounce or defer messages. If the hide_child flag is set, all we
4353 output is the original ancestor address.
4356 addr points to the address
4357 f the FILE to print to
4358 si an initial string
4359 sc a continuation string for before "generated"
4362 Returns: TRUE if the address is not hidden
4366 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4370 uschar *printed = US"";
4371 address_item *ancestor = addr;
4372 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4374 fprintf(f, "%s", CS si);
4376 if (addr->parent != NULL && testflag(addr, af_hide_child))
4378 printed = US"an undisclosed address";
4381 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4382 printed = addr->address;
4386 uschar *s = addr->address;
4389 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4390 else if (addr->address[0] == '|') ss = US"pipe";
4393 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4394 printed = addr->parent->address;
4397 fprintf(f, "%s", CS string_printing(printed));
4399 if (ancestor != addr)
4401 uschar *original = (ancestor->onetime_parent == NULL)?
4402 ancestor->address : ancestor->onetime_parent;
4403 if (strcmpic(original, printed) != 0)
4404 fprintf(f, "%s(%sgenerated from %s)", sc,
4405 (ancestor != addr->parent)? "ultimately " : "",
4406 string_printing(original));
4409 fprintf(f, "%s", CS se);
4417 /*************************************************
4418 * Print error for an address *
4419 *************************************************/
4421 /* This function is called to print the error information out of an address for
4422 a bounce or a warning message. It tries to format the message reasonably by
4423 introducing newlines. All lines are indented by 4; the initial printing
4424 position must be set before calling.
4426 This function used always to print the error. Nowadays we want to restrict it
4427 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4428 and filter "fail". We no longer pass other information willy-nilly in bounce
4429 and warning messages. Text in user_message is always output; text in message
4430 only if the af_pass_message flag is set.
4434 f the FILE to print on
4441 print_address_error(address_item *addr, FILE *f, uschar *t)
4443 int count = Ustrlen(t);
4444 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4448 if (addr->user_message != NULL) s = addr->user_message; else return;
4451 fprintf(f, "\n %s", t);
4455 if (*s == '\\' && s[1] == 'n')
4465 if (*s++ == ':' && isspace(*s) && count > 45)
4467 fprintf(f, "\n "); /* sic (because space follows) */
4479 /*************************************************
4480 * Check list of addresses for duplication *
4481 *************************************************/
4483 /* This function was introduced when the test for duplicate addresses that are
4484 not pipes, files, or autoreplies was moved from the middle of routing to when
4485 routing was complete. That was to fix obscure cases when the routing history
4486 affects the subsequent routing of identical addresses. This function is called
4487 after routing, to check that the final routed addresses are not duplicates.
4489 If we detect a duplicate, we remember what it is a duplicate of. Note that
4490 pipe, file, and autoreply de-duplication is handled during routing, so we must
4491 leave such "addresses" alone here, as otherwise they will incorrectly be
4494 Argument: address of list anchor
4499 do_duplicate_check(address_item **anchor)
4502 while ((addr = *anchor) != NULL)
4505 if (testflag(addr, af_pfr))
4507 anchor = &(addr->next);
4509 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4511 DEBUG(D_deliver|D_route)
4512 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4513 *anchor = addr->next;
4514 addr->dupof = tnode->data.ptr;
4515 addr->next = addr_duplicate;
4516 addr_duplicate = addr;
4520 tree_add_duplicate(addr->unique, addr);
4521 anchor = &(addr->next);
4529 /*************************************************
4530 * Deliver one message *
4531 *************************************************/
4533 /* This is the function which is called when a message is to be delivered. It
4534 is passed the id of the message. It is possible that the message no longer
4535 exists, if some other process has delivered it, and it is also possible that
4536 the message is being worked on by another process, in which case the data file
4539 If no delivery is attempted for any of the above reasons, the function returns
4540 DELIVER_NOT_ATTEMPTED.
4542 If the give_up flag is set true, do not attempt any deliveries, but instead
4543 fail all outstanding addresses and return the message to the sender (or
4546 A delivery operation has a process all to itself; we never deliver more than
4547 one message in the same process. Therefore we needn't worry too much about
4551 id the id of the message to be delivered
4552 forced TRUE if delivery was forced by an administrator; this overrides
4553 retry delays and causes a delivery to be tried regardless
4554 give_up TRUE if an administrator has requested that delivery attempts
4557 Returns: When the global variable mua_wrapper is FALSE:
4558 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4559 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4560 When the global variable mua_wrapper is TRUE:
4561 DELIVER_MUA_SUCCEEDED if delivery succeeded
4562 DELIVER_MUA_FAILED if delivery failed
4563 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4567 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4570 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4571 time_t now = time(NULL);
4572 address_item *addr_last = NULL;
4573 uschar *filter_message = NULL;
4575 int process_recipients = RECIP_ACCEPT;
4578 extern int acl_where;
4580 uschar *info = (queue_run_pid == (pid_t)0)?
4581 string_sprintf("delivering %s", id) :
4582 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4584 /* If the D_process_info bit is on, set_process_info() will output debugging
4585 information. If not, we want to show this initial information if D_deliver or
4586 D_queue_run is set or in verbose mode. */
4588 set_process_info("%s", info);
4590 if ((debug_selector & D_process_info) == 0 &&
4591 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4592 debug_printf("%s\n", info);
4594 /* Ensure that we catch any subprocesses that are created. Although Exim
4595 sets SIG_DFL as its initial default, some routes through the code end up
4596 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4597 has been forked, but no re-exec has been done. We use sigaction rather than
4598 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4599 sure it is turned off. (There was a problem on AIX with this.) */
4603 struct sigaction act;
4604 act.sa_handler = SIG_DFL;
4605 sigemptyset(&(act.sa_mask));
4607 sigaction(SIGCHLD, &act, NULL);
4610 signal(SIGCHLD, SIG_DFL);
4613 /* Make the forcing flag available for routers and transports, set up the
4614 global message id field, and initialize the count for returned files and the
4615 message size. This use of strcpy() is OK because the length id is checked when
4616 it is obtained from a command line (the -M or -q options), and otherwise it is
4617 known to be a valid message id. */
4619 Ustrcpy(message_id, id);
4620 deliver_force = forced;
4624 /* Initialize some flags */
4626 update_spool = FALSE;
4627 remove_journal = TRUE;
4629 /* Set a known context for any ACLs we call via expansions */
4630 acl_where = ACL_WHERE_DELIVERY;
4632 /* Reset the random number generator, so that if several delivery processes are
4633 started from a queue runner that has already used random numbers (for sorting),
4634 they don't all get the same sequence. */
4638 /* Open and lock the message's data file. Exim locks on this one because the
4639 header file may get replaced as it is re-written during the delivery process.
4640 Any failures cause messages to be written to the log, except for missing files
4641 while queue running - another process probably completed delivery. As part of
4642 opening the data file, message_subdir gets set. */
4644 if (!spool_open_datafile(id))
4645 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4647 /* The value of message_size at this point has been set to the data length,
4648 plus one for the blank line that notionally precedes the data. */
4650 /* Now read the contents of the header file, which will set up the headers in
4651 store, and also the list of recipients and the tree of non-recipients and
4652 assorted flags. It updates message_size. If there is a reading or format error,
4653 give up; if the message has been around for sufficiently long, remove it. */
4655 sprintf(CS spoolname, "%s-H", id);
4656 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4658 if (errno == ERRNO_SPOOLFORMAT)
4660 struct stat statbuf;
4661 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4663 if (Ustat(big_buffer, &statbuf) == 0)
4664 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4665 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4666 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4669 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4672 /* If we managed to read the envelope data, received_time contains the
4673 time the message was received. Otherwise, we can calculate it from the
4676 if (rc != spool_read_hdrerror)
4679 for (i = 0; i < 6; i++)
4680 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4683 /* If we've had this malformed message too long, sling it. */
4685 if (now - received_time > keep_malformed)
4687 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4689 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4691 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4693 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4695 log_write(0, LOG_MAIN, "Message removed because older than %s",
4696 readconf_printtime(keep_malformed));
4699 (void)close(deliver_datafile);
4700 deliver_datafile = -1;
4701 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4704 /* The spool header file has been read. Look to see if there is an existing
4705 journal file for this message. If there is, it means that a previous delivery
4706 attempt crashed (program or host) before it could update the spool header file.
4707 Read the list of delivered addresses from the journal and add them to the
4708 nonrecipients tree. Then update the spool file. We can leave the journal in
4709 existence, as it will get further successful deliveries added to it in this
4710 run, and it will be deleted if this function gets to its end successfully.
4711 Otherwise it might be needed again. */
4713 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4714 jread = Ufopen(spoolname, "rb");
4717 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4719 int n = Ustrlen(big_buffer);
4720 big_buffer[n-1] = 0;
4721 tree_add_nonrecipient(big_buffer);
4722 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4723 "journal file\n", big_buffer);
4725 (void)fclose(jread);
4726 /* Panic-dies on error */
4727 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4729 else if (errno != ENOENT)
4731 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4732 "%s", strerror(errno));
4733 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4736 /* A null recipients list indicates some kind of disaster. */
4738 if (recipients_list == NULL)
4740 (void)close(deliver_datafile);
4741 deliver_datafile = -1;
4742 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4743 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4747 /* Handle a message that is frozen. There are a number of different things that
4748 can happen, but in the default situation, unless forced, no delivery is
4753 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4754 /* Moving to another directory removes the message from Exim's view. Other
4755 tools must be used to deal with it. Logging of this action happens in
4756 spool_move_message() and its subfunctions. */
4758 if (move_frozen_messages &&
4759 spool_move_message(id, message_subdir, US"", US"F"))
4760 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4763 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4764 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4765 flag causing all recipients to be failed. The time is the age of the
4766 message, not the time since freezing. */
4768 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4770 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4771 process_recipients = RECIP_FAIL_TIMEOUT;
4774 /* For bounce messages (and others with no sender), thaw if the error message
4775 ignore timer is exceeded. The message will be discarded if this delivery
4778 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4780 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4783 /* If this is a bounce message, or there's no auto thaw, or we haven't
4784 reached the auto thaw time yet, and this delivery is not forced by an admin
4785 user, do not attempt delivery of this message. Note that forced is set for
4786 continuing messages down the same channel, in order to skip load checking and
4787 ignore hold domains, but we don't want unfreezing in that case. */
4791 if ((sender_address[0] == 0 ||
4793 now <= deliver_frozen_at + auto_thaw
4796 (!forced || !deliver_force_thaw || !admin_user ||
4797 continue_hostname != NULL
4800 (void)close(deliver_datafile);
4801 deliver_datafile = -1;
4802 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4803 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4806 /* If delivery was forced (by an admin user), assume a manual thaw.
4807 Otherwise it's an auto thaw. */
4811 deliver_manual_thaw = TRUE;
4812 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4814 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4817 /* We get here if any of the rules for unfreezing have triggered. */
4819 deliver_freeze = FALSE;
4820 update_spool = TRUE;
4824 /* Open the message log file if we are using them. This records details of
4825 deliveries, deferments, and failures for the benefit of the mail administrator.
4826 The log is not used by exim itself to track the progress of a message; that is
4827 done by rewriting the header spool file. */
4834 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4835 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4839 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4840 spoolname, strerror(errno));
4841 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4844 /* Make a C stream out of it. */
4846 message_log = fdopen(fd, "a");
4847 if (message_log == NULL)
4849 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4850 spoolname, strerror(errno));
4851 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4856 /* If asked to give up on a message, log who did it, and set the action for all
4861 struct passwd *pw = getpwuid(real_uid);
4862 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4863 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4864 process_recipients = RECIP_FAIL;
4867 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4869 else if (received_count > received_headers_max)
4870 process_recipients = RECIP_FAIL_LOOP;
4872 /* Otherwise, if a system-wide, address-independent message filter is
4873 specified, run it now, except in the case when we are failing all recipients as
4874 a result of timeout_frozen_after. If the system filter yields "delivered", then
4875 ignore the true recipients of the message. Failure of the filter file is
4876 logged, and the delivery attempt fails. */
4878 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4883 redirect_block redirect;
4885 if (system_filter_uid_set)
4887 ugid.uid = system_filter_uid;
4888 ugid.gid = system_filter_gid;
4889 ugid.uid_set = ugid.gid_set = TRUE;
4893 ugid.uid_set = ugid.gid_set = FALSE;
4896 return_path = sender_address;
4897 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4898 system_filtering = TRUE;
4900 /* Any error in the filter file causes a delivery to be abandoned. */
4902 redirect.string = system_filter;
4903 redirect.isfile = TRUE;
4904 redirect.check_owner = redirect.check_group = FALSE;
4905 redirect.owners = NULL;
4906 redirect.owngroups = NULL;
4908 redirect.modemask = 0;
4910 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4913 &redirect, /* Where the data is */
4914 RDO_DEFER | /* Turn on all the enabling options */
4915 RDO_FAIL | /* Leave off all the disabling options */
4920 NULL, /* No :include: restriction (not used in filter) */
4921 NULL, /* No sieve vacation directory (not sieve!) */
4922 NULL, /* No sieve enotify mailto owner (not sieve!) */
4923 NULL, /* No sieve user address (not sieve!) */
4924 NULL, /* No sieve subaddress (not sieve!) */
4925 &ugid, /* uid/gid data */
4926 &addr_new, /* Where to hang generated addresses */
4927 &filter_message, /* Where to put error message */
4928 NULL, /* Don't skip syntax errors */
4929 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4930 US"system filter"); /* For error messages */
4932 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4934 if (rc == FF_ERROR || rc == FF_NONEXIST)
4936 (void)close(deliver_datafile);
4937 deliver_datafile = -1;
4938 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4939 string_printing(filter_message));
4940 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4943 /* Reset things. If the filter message is an empty string, which can happen
4944 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4946 system_filtering = FALSE;
4947 enable_dollar_recipients = FALSE;
4948 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4950 /* Save the values of the system filter variables so that user filters
4953 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4955 /* The filter can request that delivery of the original addresses be
4960 process_recipients = RECIP_DEFER;
4961 deliver_msglog("Delivery deferred by system filter\n");
4962 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4965 /* The filter can request that a message be frozen, but this does not
4966 take place if the message has been manually thawed. In that case, we must
4967 unset "delivered", which is forced by the "freeze" command to make -bF
4970 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4972 deliver_freeze = TRUE;
4973 deliver_frozen_at = time(NULL);
4974 process_recipients = RECIP_DEFER;
4975 frozen_info = string_sprintf(" by the system filter%s%s",
4976 (filter_message == NULL)? US"" : US": ",
4977 (filter_message == NULL)? US"" : filter_message);
4980 /* The filter can request that a message be failed. The error message may be
4981 quite long - it is sent back to the sender in the bounce - but we don't want
4982 to fill up the log with repetitions of it. If it starts with << then the text
4983 between << and >> is written to the log, with the rest left for the bounce
4986 else if (rc == FF_FAIL)
4988 uschar *colon = US"";
4989 uschar *logmsg = US"";
4992 process_recipients = RECIP_FAIL_FILTER;
4994 if (filter_message != NULL)
4998 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4999 (logend = Ustrstr(filter_message, ">>")) != NULL)
5001 logmsg = filter_message + 2;
5002 loglen = logend - logmsg;
5003 filter_message = logend + 2;
5004 if (filter_message[0] == 0) filter_message = NULL;
5008 logmsg = filter_message;
5009 loglen = Ustrlen(filter_message);
5013 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5017 /* Delivery can be restricted only to those recipients (if any) that the
5018 filter specified. */
5020 else if (rc == FF_DELIVERED)
5022 process_recipients = RECIP_IGNORE;
5023 if (addr_new == NULL)
5024 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5026 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5029 /* If any new addresses were created by the filter, fake up a "parent"
5030 for them. This is necessary for pipes, etc., which are expected to have
5031 parents, and it also gives some sensible logging for others. Allow
5032 pipes, files, and autoreplies, and run them as the filter uid if set,
5033 otherwise as the current uid. */
5035 if (addr_new != NULL)
5037 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5038 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5040 /* The text "system-filter" is tested in transport_set_up_command() and in
5041 set_up_shell_command() in the pipe transport, to enable them to permit
5042 $recipients, so don't change it here without also changing it there. */
5044 address_item *p = addr_new;
5045 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5047 parent->domain = string_copylc(qualify_domain_recipient);
5048 parent->local_part = US"system-filter";
5050 /* As part of this loop, we arrange for addr_last to end up pointing
5051 at the final address. This is used if we go on to add addresses for the
5052 original recipients. */
5056 if (parent->child_count == SHRT_MAX)
5057 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5058 "than %d delivery addresses", SHRT_MAX);
5059 parent->child_count++;
5062 if (testflag(p, af_pfr))
5068 setflag(p, af_uid_set |
5074 /* Find the name of the system filter's appropriate pfr transport */
5076 if (p->address[0] == '|')
5079 tpname = system_filter_pipe_transport;
5080 address_pipe = p->address;
5082 else if (p->address[0] == '>')
5085 tpname = system_filter_reply_transport;
5089 if (p->address[Ustrlen(p->address)-1] == '/')
5091 type = US"directory";
5092 tpname = system_filter_directory_transport;
5097 tpname = system_filter_file_transport;
5099 address_file = p->address;
5102 /* Now find the actual transport, first expanding the name. We have
5103 set address_file or address_pipe above. */
5107 uschar *tmp = expand_string(tpname);
5108 address_file = address_pipe = NULL;
5110 p->message = string_sprintf("failed to expand \"%s\" as a "
5111 "system filter transport name", tpname);
5116 p->message = string_sprintf("system_filter_%s_transport is unset",
5122 transport_instance *tp;
5123 for (tp = transports; tp != NULL; tp = tp->next)
5125 if (Ustrcmp(tp->name, tpname) == 0)
5132 p->message = string_sprintf("failed to find \"%s\" transport "
5133 "for system filter delivery", tpname);
5136 /* If we couldn't set up a transport, defer the delivery, putting the
5137 error on the panic log as well as the main log. */
5139 if (p->transport == NULL)
5141 address_item *badp = p;
5143 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5144 badp->local_part = badp->address; /* Needed for log line */
5145 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5148 } /* End of pfr handling */
5150 /* Either a non-pfr delivery, or we found a transport */
5152 DEBUG(D_deliver|D_filter)
5153 debug_printf("system filter added %s\n", p->address);
5157 } /* Loop through all addr_new addresses */
5162 /* Scan the recipients list, and for every one that is not in the non-
5163 recipients tree, add an addr item to the chain of new addresses. If the pno
5164 value is non-negative, we must set the onetime parent from it. This which
5165 points to the relevant entry in the recipients list.
5167 This processing can be altered by the setting of the process_recipients
5168 variable, which is changed if recipients are to be ignored, failed, or
5169 deferred. This can happen as a result of system filter activity, or if the -Mg
5170 option is used to fail all of them.
5172 Duplicate addresses are handled later by a different tree structure; we can't
5173 just extend the non-recipients tree, because that will be re-written to the
5174 spool if the message is deferred, and in any case there are casing
5175 complications for local addresses. */
5177 if (process_recipients != RECIP_IGNORE)
5179 for (i = 0; i < recipients_count; i++)
5181 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5183 recipient_item *r = recipients_list + i;
5184 address_item *new = deliver_make_addr(r->address, FALSE);
5185 new->p.errors_address = r->errors_to;
5188 new->onetime_parent = recipients_list[r->pno].address;
5190 switch (process_recipients)
5192 /* RECIP_DEFER is set when a system filter freezes a message. */
5195 new->next = addr_defer;
5200 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5203 case RECIP_FAIL_FILTER:
5205 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5206 setflag(new, af_pass_message);
5207 goto RECIP_QUEUE_FAILED; /* below */
5210 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5211 than the value in timeout_frozen_after. Treat non-bounce messages
5212 similarly to -Mg; for bounce messages we just want to discard, so
5213 don't put the address on the failed list. The timeout has already
5216 case RECIP_FAIL_TIMEOUT:
5217 new->message = US"delivery cancelled; message timed out";
5218 goto RECIP_QUEUE_FAILED; /* below */
5221 /* RECIP_FAIL is set when -Mg has been used. */
5224 new->message = US"delivery cancelled by administrator";
5227 /* Common code for the failure cases above. If this is not a bounce
5228 message, put the address on the failed list so that it is used to
5229 create a bounce. Otherwise do nothing - this just discards the address.
5230 The incident has already been logged. */
5233 if (sender_address[0] != 0)
5235 new->next = addr_failed;
5241 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5242 in the message. Process each address as a routing failure; if this
5243 is a bounce message, it will get frozen. */
5245 case RECIP_FAIL_LOOP:
5246 new->message = US"Too many \"Received\" headers - suspected mail loop";
5247 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5251 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5254 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5264 address_item *p = addr_new;
5265 debug_printf("Delivery address list:\n");
5268 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5274 /* Set up the buffers used for copying over the file when delivering. */
5276 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5277 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5281 /* Until there are no more new addresses, handle each one as follows:
5283 . If this is a generated address (indicated by the presence of a parent
5284 pointer) then check to see whether it is a pipe, file, or autoreply, and
5285 if so, handle it directly here. The router that produced the address will
5286 have set the allow flags into the address, and also set the uid/gid required.
5287 Having the routers generate new addresses and then checking them here at
5288 the outer level is tidier than making each router do the checking, and
5289 means that routers don't need access to the failed address queue.
5291 . Break up the address into local part and domain, and make lowercased
5292 versions of these strings. We also make unquoted versions of the local part.
5294 . Handle the percent hack for those domains for which it is valid.
5296 . For child addresses, determine if any of the parents have the same address.
5297 If so, generate a different string for previous delivery checking. Without
5298 this code, if the address spqr generates spqr via a forward or alias file,
5299 delivery of the generated spqr stops further attempts at the top level spqr,
5300 which is not what is wanted - it may have generated other addresses.
5302 . Check on the retry database to see if routing was previously deferred, but
5303 only if in a queue run. Addresses that are to be routed are put on the
5304 addr_route chain. Addresses that are to be deferred are put on the
5305 addr_defer chain. We do all the checking first, so as not to keep the
5306 retry database open any longer than necessary.
5308 . Now we run the addresses through the routers. A router may put the address
5309 on either the addr_local or the addr_remote chain for local or remote
5310 delivery, respectively, or put it on the addr_failed chain if it is
5311 undeliveable, or it may generate child addresses and put them on the
5312 addr_new chain, or it may defer an address. All the chain anchors are
5313 passed as arguments so that the routers can be called for verification
5316 . If new addresses have been generated by the routers, da capo.
5319 header_rewritten = FALSE; /* No headers rewritten yet */
5320 while (addr_new != NULL) /* Loop until all addresses dealt with */
5322 address_item *addr, *parent;
5323 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5325 /* Failure to open the retry database is treated the same as if it does
5326 not exist. In both cases, dbm_file is NULL. */
5328 if (dbm_file == NULL)
5330 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5331 debug_printf("no retry data available\n");
5334 /* Scan the current batch of new addresses, to handle pipes, files and
5335 autoreplies, and determine which others are ready for routing. */
5337 while (addr_new != NULL)
5342 dbdata_retry *domain_retry_record;
5343 dbdata_retry *address_retry_record;
5346 addr_new = addr->next;
5348 DEBUG(D_deliver|D_retry|D_route)
5350 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5351 debug_printf("Considering: %s\n", addr->address);
5354 /* Handle generated address that is a pipe or a file or an autoreply. */
5356 if (testflag(addr, af_pfr))
5358 /* If an autoreply in a filter could not generate a syntactically valid
5359 address, give up forthwith. Set af_ignore_error so that we don't try to
5360 generate a bounce. */
5362 if (testflag(addr, af_bad_reply))
5364 addr->basic_errno = ERRNO_BADADDRESS2;
5365 addr->local_part = addr->address;
5367 US"filter autoreply generated syntactically invalid recipient";
5368 setflag(addr, af_ignore_error);
5369 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5370 continue; /* with the next new address */
5373 /* If two different users specify delivery to the same pipe or file or
5374 autoreply, there should be two different deliveries, so build a unique
5375 string that incorporates the original address, and use this for
5376 duplicate testing and recording delivery, and also for retrying. */
5379 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5380 (testflag(addr->parent, af_homonym)? 3:0));
5382 addr->address_retry_key = addr->domain_retry_key =
5383 string_sprintf("T:%s", addr->unique);
5385 /* If a filter file specifies two deliveries to the same pipe or file,
5386 we want to de-duplicate, but this is probably not wanted for two mail
5387 commands to the same address, where probably both should be delivered.
5388 So, we have to invent a different unique string in that case. Just
5389 keep piling '>' characters on the front. */
5391 if (addr->address[0] == '>')
5393 while (tree_search(tree_duplicates, addr->unique) != NULL)
5394 addr->unique = string_sprintf(">%s", addr->unique);
5397 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5399 DEBUG(D_deliver|D_route)
5400 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5401 addr->dupof = tnode->data.ptr;
5402 addr->next = addr_duplicate;
5403 addr_duplicate = addr;
5407 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5409 /* Check for previous delivery */
5411 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5413 DEBUG(D_deliver|D_route)
5414 debug_printf("%s was previously delivered: discarded\n", addr->address);
5415 child_done(addr, tod_stamp(tod_log));
5419 /* Save for checking future duplicates */
5421 tree_add_duplicate(addr->unique, addr);
5423 /* Set local part and domain */
5425 addr->local_part = addr->address;
5426 addr->domain = addr->parent->domain;
5428 /* Ensure that the delivery is permitted. */
5430 if (testflag(addr, af_file))
5432 if (!testflag(addr, af_allow_file))
5434 addr->basic_errno = ERRNO_FORBIDFILE;
5435 addr->message = US"delivery to file forbidden";
5436 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5437 continue; /* with the next new address */
5440 else if (addr->address[0] == '|')
5442 if (!testflag(addr, af_allow_pipe))
5444 addr->basic_errno = ERRNO_FORBIDPIPE;
5445 addr->message = US"delivery to pipe forbidden";
5446 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5447 continue; /* with the next new address */
5450 else if (!testflag(addr, af_allow_reply))
5452 addr->basic_errno = ERRNO_FORBIDREPLY;
5453 addr->message = US"autoreply forbidden";
5454 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5455 continue; /* with the next new address */
5458 /* If the errno field is already set to BADTRANSPORT, it indicates
5459 failure to expand a transport string, or find the associated transport,
5460 or an unset transport when one is required. Leave this test till now so
5461 that the forbid errors are given in preference. */
5463 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5465 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5469 /* Treat /dev/null as a special case and abandon the delivery. This
5470 avoids having to specify a uid on the transport just for this case.
5471 Arrange for the transport name to be logged as "**bypassed**". */
5473 if (Ustrcmp(addr->address, "/dev/null") == 0)
5475 uschar *save = addr->transport->name;
5476 addr->transport->name = US"**bypassed**";
5477 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5478 addr->transport->name = save;
5479 continue; /* with the next new address */
5482 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5485 DEBUG(D_deliver|D_route)
5486 debug_printf("queued for %s transport\n", addr->transport->name);
5487 addr->next = addr_local;
5489 continue; /* with the next new address */
5492 /* Handle normal addresses. First, split up into local part and domain,
5493 handling the %-hack if necessary. There is the possibility of a defer from
5494 a lookup in percent_hack_domains. */
5496 if ((rc = deliver_split_address(addr)) == DEFER)
5498 addr->message = US"cannot check percent_hack_domains";
5499 addr->basic_errno = ERRNO_LISTDEFER;
5500 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5504 /* Check to see if the domain is held. If so, proceed only if the
5505 delivery was forced by hand. */
5507 deliver_domain = addr->domain; /* set $domain */
5508 if (!forced && hold_domains != NULL &&
5509 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5510 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5515 addr->message = US"hold_domains lookup deferred";
5516 addr->basic_errno = ERRNO_LISTDEFER;
5520 addr->message = US"domain is held";
5521 addr->basic_errno = ERRNO_HELD;
5523 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5527 /* Now we can check for duplicates and previously delivered addresses. In
5528 order to do this, we have to generate a "unique" value for each address,
5529 because there may be identical actual addresses in a line of descendents.
5530 The "unique" field is initialized to the same value as the "address" field,
5531 but gets changed here to cope with identically-named descendents. */
5533 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5534 if (strcmpic(addr->address, parent->address) == 0) break;
5536 /* If there's an ancestor with the same name, set the homonym flag. This
5537 influences how deliveries are recorded. Then add a prefix on the front of
5538 the unique address. We use \n\ where n starts at 0 and increases each time.
5539 It is unlikely to pass 9, but if it does, it may look odd but will still
5540 work. This means that siblings or cousins with the same names are treated
5541 as duplicates, which is what we want. */
5545 setflag(addr, af_homonym);
5546 if (parent->unique[0] != '\\')
5547 addr->unique = string_sprintf("\\0\\%s", addr->address);
5549 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5553 /* Ensure that the domain in the unique field is lower cased, because
5554 domains are always handled caselessly. */
5556 p = Ustrrchr(addr->unique, '@');
5557 while (*p != 0) { *p = tolower(*p); p++; }
5559 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5561 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5563 DEBUG(D_deliver|D_route)
5564 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5565 child_done(addr, tod_stamp(tod_log));
5569 /* Get the routing retry status, saving the two retry keys (with and
5570 without the local part) for subsequent use. If there is no retry record for
5571 the standard address routing retry key, we look for the same key with the
5572 sender attached, because this form is used by the smtp transport after a
5573 4xx response to RCPT when address_retry_include_sender is true. */
5575 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5576 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5579 if (dbm_file == NULL)
5580 domain_retry_record = address_retry_record = NULL;
5583 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5584 if (domain_retry_record != NULL &&
5585 now - domain_retry_record->time_stamp > retry_data_expire)
5586 domain_retry_record = NULL; /* Ignore if too old */
5588 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5589 if (address_retry_record != NULL &&
5590 now - address_retry_record->time_stamp > retry_data_expire)
5591 address_retry_record = NULL; /* Ignore if too old */
5593 if (address_retry_record == NULL)
5595 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5597 address_retry_record = dbfn_read(dbm_file, altkey);
5598 if (address_retry_record != NULL &&
5599 now - address_retry_record->time_stamp > retry_data_expire)
5600 address_retry_record = NULL; /* Ignore if too old */
5604 DEBUG(D_deliver|D_retry)
5606 if (domain_retry_record == NULL)
5607 debug_printf("no domain retry record\n");
5608 if (address_retry_record == NULL)
5609 debug_printf("no address retry record\n");
5612 /* If we are sending a message down an existing SMTP connection, we must
5613 assume that the message which created the connection managed to route
5614 an address to that connection. We do not want to run the risk of taking
5615 a long time over routing here, because if we do, the server at the other
5616 end of the connection may time it out. This is especially true for messages
5617 with lots of addresses. For this kind of delivery, queue_running is not
5618 set, so we would normally route all addresses. We take a pragmatic approach
5619 and defer routing any addresses that have any kind of domain retry record.
5620 That is, we don't even look at their retry times. It doesn't matter if this
5621 doesn't work occasionally. This is all just an optimization, after all.
5623 The reason for not doing the same for address retries is that they normally
5624 arise from 4xx responses, not DNS timeouts. */
5626 if (continue_hostname != NULL && domain_retry_record != NULL)
5628 addr->message = US"reusing SMTP connection skips previous routing defer";
5629 addr->basic_errno = ERRNO_RRETRY;
5630 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5633 /* If we are in a queue run, defer routing unless there is no retry data or
5634 we've passed the next retry time, or this message is forced. In other
5635 words, ignore retry data when not in a queue run.
5637 However, if the domain retry time has expired, always allow the routing
5638 attempt. If it fails again, the address will be failed. This ensures that
5639 each address is routed at least once, even after long-term routing
5642 If there is an address retry, check that too; just wait for the next
5643 retry time. This helps with the case when the temporary error on the
5644 address was really message-specific rather than address specific, since
5645 it allows other messages through.
5647 We also wait for the next retry time if this is a message sent down an
5648 existing SMTP connection (even though that will be forced). Otherwise there
5649 will be far too many attempts for an address that gets a 4xx error. In
5650 fact, after such an error, we should not get here because, the host should
5651 not be remembered as one this message needs. However, there was a bug that
5652 used to cause this to happen, so it is best to be on the safe side.
5654 Even if we haven't reached the retry time in the hints, there is one more
5655 check to do, which is for the ultimate address timeout. We only do this
5656 check if there is an address retry record and there is not a domain retry
5657 record; this implies that previous attempts to handle the address had the
5658 retry_use_local_parts option turned on. We use this as an approximation
5659 for the destination being like a local delivery, for example delivery over
5660 LMTP to an IMAP message store. In this situation users are liable to bump
5661 into their quota and thereby have intermittently successful deliveries,
5662 which keep the retry record fresh, which can lead to us perpetually
5663 deferring messages. */
5665 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5667 ((domain_retry_record != NULL &&
5668 now < domain_retry_record->next_try &&
5669 !domain_retry_record->expired)
5671 (address_retry_record != NULL &&
5672 now < address_retry_record->next_try))
5674 (domain_retry_record != NULL ||
5675 address_retry_record == NULL ||
5676 !retry_ultimate_address_timeout(addr->address_retry_key,
5677 addr->domain, address_retry_record, now)))
5679 addr->message = US"retry time not reached";
5680 addr->basic_errno = ERRNO_RRETRY;
5681 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5684 /* The domain is OK for routing. Remember if retry data exists so it
5685 can be cleaned up after a successful delivery. */
5689 if (domain_retry_record != NULL || address_retry_record != NULL)
5690 setflag(addr, af_dr_retry_exists);
5691 addr->next = addr_route;
5693 DEBUG(D_deliver|D_route)
5694 debug_printf("%s: queued for routing\n", addr->address);
5698 /* The database is closed while routing is actually happening. Requests to
5699 update it are put on a chain and all processed together at the end. */
5701 if (dbm_file != NULL) dbfn_close(dbm_file);
5703 /* If queue_domains is set, we don't even want to try routing addresses in
5704 those domains. During queue runs, queue_domains is forced to be unset.
5705 Optimize by skipping this pass through the addresses if nothing is set. */
5707 if (!deliver_force && queue_domains != NULL)
5709 address_item *okaddr = NULL;
5710 while (addr_route != NULL)
5712 address_item *addr = addr_route;
5713 addr_route = addr->next;
5715 deliver_domain = addr->domain; /* set $domain */
5716 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5717 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5722 addr->basic_errno = ERRNO_LISTDEFER;
5723 addr->message = US"queue_domains lookup deferred";
5724 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5728 addr->next = okaddr;
5734 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5735 addr->message = US"domain is in queue_domains";
5736 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5740 addr_route = okaddr;
5743 /* Now route those addresses that are not deferred. */
5745 while (addr_route != NULL)
5748 address_item *addr = addr_route;
5749 uschar *old_domain = addr->domain;
5750 uschar *old_unique = addr->unique;
5751 addr_route = addr->next;
5754 /* Just in case some router parameter refers to it. */
5756 return_path = (addr->p.errors_address != NULL)?
5757 addr->p.errors_address : sender_address;
5759 /* If a router defers an address, add a retry item. Whether or not to
5760 use the local part in the key is a property of the router. */
5762 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5763 &addr_succeed, v_none)) == DEFER)
5764 retry_add_item(addr, (addr->router->retry_use_local_part)?
5765 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5766 string_sprintf("R:%s", addr->domain), 0);
5768 /* Otherwise, if there is an existing retry record in the database, add
5769 retry items to delete both forms. We must also allow for the possibility
5770 of a routing retry that includes the sender address. Since the domain might
5771 have been rewritten (expanded to fully qualified) as a result of routing,
5772 ensure that the rewritten form is also deleted. */
5774 else if (testflag(addr, af_dr_retry_exists))
5776 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5778 retry_add_item(addr, altkey, rf_delete);
5779 retry_add_item(addr, addr->address_retry_key, rf_delete);
5780 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5781 if (Ustrcmp(addr->domain, old_domain) != 0)
5782 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5785 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5786 logged, but we need to ensure the address (and maybe parents) is marked
5791 address_done(addr, tod_stamp(tod_log));
5792 continue; /* route next address */
5795 /* The address is finished with (failed or deferred). */
5799 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5800 continue; /* route next address */
5803 /* The address has been routed. If the router changed the domain, it will
5804 also have changed the unique address. We have to test whether this address
5805 has already been delivered, because it's the unique address that finally
5808 if (addr->unique != old_unique &&
5809 tree_search(tree_nonrecipients, addr->unique) != 0)
5811 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5812 "discarded\n", addr->address);
5813 if (addr_remote == addr) addr_remote = addr->next;
5814 else if (addr_local == addr) addr_local = addr->next;
5817 /* If the router has same_domain_copy_routing set, we are permitted to copy
5818 the routing for any other addresses with the same domain. This is an
5819 optimisation to save repeated DNS lookups for "standard" remote domain
5820 routing. The option is settable only on routers that generate host lists.
5821 We play it very safe, and do the optimization only if the address is routed
5822 to a remote transport, there are no header changes, and the domain was not
5823 modified by the router. */
5825 if (addr_remote == addr &&
5826 addr->router->same_domain_copy_routing &&
5827 addr->p.extra_headers == NULL &&
5828 addr->p.remove_headers == NULL &&
5829 old_domain == addr->domain)
5831 address_item **chain = &addr_route;
5832 while (*chain != NULL)
5834 address_item *addr2 = *chain;
5835 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5837 chain = &(addr2->next);
5841 /* Found a suitable address; take it off the routing list and add it to
5842 the remote delivery list. */
5844 *chain = addr2->next;
5845 addr2->next = addr_remote;
5846 addr_remote = addr2;
5848 /* Copy the routing data */
5850 addr2->domain = addr->domain;
5851 addr2->router = addr->router;
5852 addr2->transport = addr->transport;
5853 addr2->host_list = addr->host_list;
5854 addr2->fallback_hosts = addr->fallback_hosts;
5855 addr2->p.errors_address = addr->p.errors_address;
5856 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5858 DEBUG(D_deliver|D_route)
5860 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5862 "Routing for %s copied from %s\n",
5863 addr2->address, addr2->address, addr->address);
5867 } /* Continue with routing the next address. */
5868 } /* Loop to process any child addresses that the routers created, and
5869 any rerouted addresses that got put back on the new chain. */
5872 /* Debugging: show the results of the routing */
5874 DEBUG(D_deliver|D_retry|D_route)
5876 address_item *p = addr_local;
5877 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5878 debug_printf("After routing:\n Local deliveries:\n");
5881 debug_printf(" %s\n", p->address);
5886 debug_printf(" Remote deliveries:\n");
5889 debug_printf(" %s\n", p->address);
5894 debug_printf(" Failed addresses:\n");
5897 debug_printf(" %s\n", p->address);
5902 debug_printf(" Deferred addresses:\n");
5905 debug_printf(" %s\n", p->address);
5910 /* Free any resources that were cached during routing. */
5915 /* These two variables are set only during routing, after check_local_user.
5916 Ensure they are not set in transports. */
5918 local_user_gid = (gid_t)(-1);
5919 local_user_uid = (uid_t)(-1);
5921 /* Check for any duplicate addresses. This check is delayed until after
5922 routing, because the flexibility of the routing configuration means that
5923 identical addresses with different parentage may end up being redirected to
5924 different addresses. Checking for duplicates too early (as we previously used
5925 to) makes this kind of thing not work. */
5927 do_duplicate_check(&addr_local);
5928 do_duplicate_check(&addr_remote);
5930 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5931 remote transport. The check that they all end up in one transaction happens in
5932 the do_remote_deliveries() function. */
5934 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5935 addr_defer != NULL))
5938 uschar *which, *colon, *msg;
5940 if (addr_local != NULL)
5945 else if (addr_defer != NULL)
5948 which = US"deferred";
5956 while (addr->parent != NULL) addr = addr->parent;
5958 if (addr->message != NULL)
5961 msg = addr->message;
5963 else colon = msg = US"";
5965 /* We don't need to log here for a forced failure as it will already
5966 have been logged. Defer will also have been logged, but as a defer, so we do
5967 need to do the failure logging. */
5969 if (addr != addr_failed)
5970 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5971 addr->address, which);
5973 /* Always write an error to the caller */
5975 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5978 final_yield = DELIVER_MUA_FAILED;
5979 addr_failed = addr_defer = NULL; /* So that we remove the message */
5980 goto DELIVERY_TIDYUP;
5984 /* If this is a run to continue deliveries to an external channel that is
5985 already set up, defer any local deliveries. */
5987 if (continue_transport != NULL)
5989 if (addr_defer == NULL) addr_defer = addr_local; else
5991 address_item *addr = addr_defer;
5992 while (addr->next != NULL) addr = addr->next;
5993 addr->next = addr_local;
5999 /* Because address rewriting can happen in the routers, we should not really do
6000 ANY deliveries until all addresses have been routed, so that all recipients of
6001 the message get the same headers. However, this is in practice not always
6002 possible, since sometimes remote addresses give DNS timeouts for days on end.
6003 The pragmatic approach is to deliver what we can now, saving any rewritten
6004 headers so that at least the next lot of recipients benefit from the rewriting
6005 that has already been done.
6007 If any headers have been rewritten during routing, update the spool file to
6008 remember them for all subsequent deliveries. This can be delayed till later if
6009 there is only address to be delivered - if it succeeds the spool write need not
6012 if (header_rewritten &&
6013 ((addr_local != NULL &&
6014 (addr_local->next != NULL || addr_remote != NULL)) ||
6015 (addr_remote != NULL && addr_remote->next != NULL)))
6017 /* Panic-dies on error */
6018 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6019 header_rewritten = FALSE;
6023 /* If there are any deliveries to be done, open the journal file. This is used
6024 to record successful deliveries as soon as possible after each delivery is
6025 known to be complete. A file opened with O_APPEND is used so that several
6026 processes can run simultaneously.
6028 The journal is just insurance against crashes. When the spool file is
6029 ultimately updated at the end of processing, the journal is deleted. If a
6030 journal is found to exist at the start of delivery, the addresses listed
6031 therein are added to the non-recipients. */
6033 if (addr_local != NULL || addr_remote != NULL)
6035 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6036 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6040 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6041 spoolname, strerror(errno));
6042 return DELIVER_NOT_ATTEMPTED;
6045 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6046 that the mode is correct - the group setting doesn't always seem to get
6047 set automatically. */
6049 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6050 || fchown(journal_fd, exim_uid, exim_gid)
6051 || fchmod(journal_fd, SPOOL_MODE)
6054 int ret = Uunlink(spoolname);
6055 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6056 spoolname, strerror(errno));
6057 if(ret && errno != ENOENT)
6058 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6059 spoolname, strerror(errno));
6060 return DELIVER_NOT_ATTEMPTED;
6066 /* Now we can get down to the business of actually doing deliveries. Local
6067 deliveries are done first, then remote ones. If ever the problems of how to
6068 handle fallback transports are figured out, this section can be put into a loop
6069 for handling fallbacks, though the uid switching will have to be revised. */
6071 /* Precompile a regex that is used to recognize a parameter in response
6072 to an LHLO command, if is isn't already compiled. This may be used on both
6073 local and remote LMTP deliveries. */
6075 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6076 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6078 /* Handle local deliveries */
6080 if (addr_local != NULL)
6082 DEBUG(D_deliver|D_transport)
6083 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6084 do_local_deliveries();
6085 disable_logging = FALSE;
6088 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6089 so just queue them all. */
6091 if (queue_run_local)
6093 while (addr_remote != NULL)
6095 address_item *addr = addr_remote;
6096 addr_remote = addr->next;
6098 addr->basic_errno = ERRNO_LOCAL_ONLY;
6099 addr->message = US"remote deliveries suppressed";
6100 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6104 /* Handle remote deliveries */
6106 if (addr_remote != NULL)
6108 DEBUG(D_deliver|D_transport)
6109 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6111 /* Precompile some regex that are used to recognize parameters in response
6112 to an EHLO command, if they aren't already compiled. */
6114 if (regex_PIPELINING == NULL) regex_PIPELINING =
6115 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6117 if (regex_SIZE == NULL) regex_SIZE =
6118 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6120 if (regex_AUTH == NULL) regex_AUTH =
6121 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6125 if (regex_STARTTLS == NULL) regex_STARTTLS =
6126 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6129 #ifdef EXPERIMENTAL_PRDR
6130 if (regex_PRDR == NULL) regex_PRDR =
6131 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6134 /* Now sort the addresses if required, and do the deliveries. The yield of
6135 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6136 cannot be delivered in one transaction. */
6138 if (remote_sort_domains != NULL) sort_remote_deliveries();
6139 if (!do_remote_deliveries(FALSE))
6141 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6142 "be delivered in one transaction");
6143 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6145 final_yield = DELIVER_MUA_FAILED;
6146 addr_failed = addr_defer = NULL; /* So that we remove the message */
6147 goto DELIVERY_TIDYUP;
6150 /* See if any of the addresses that failed got put on the queue for delivery
6151 to their fallback hosts. We do it this way because often the same fallback
6152 host is used for many domains, so all can be sent in a single transaction
6153 (if appropriately configured). */
6155 if (addr_fallback != NULL && !mua_wrapper)
6157 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6158 addr_remote = addr_fallback;
6159 addr_fallback = NULL;
6160 if (remote_sort_domains != NULL) sort_remote_deliveries();
6161 do_remote_deliveries(TRUE);
6163 disable_logging = FALSE;
6167 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6168 phase, to minimize cases of half-done things. */
6171 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6173 /* Root privilege is no longer needed */
6175 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6177 set_process_info("tidying up after delivering %s", message_id);
6178 signal(SIGTERM, SIG_IGN);
6180 /* When we are acting as an MUA wrapper, the smtp transport will either have
6181 succeeded for all addresses, or failed them all in normal cases. However, there
6182 are some setup situations (e.g. when a named port does not exist) that cause an
6183 immediate exit with deferral of all addresses. Convert those into failures. We
6184 do not ever want to retry, nor do we want to send a bounce message. */
6188 if (addr_defer != NULL)
6190 address_item *addr, *nextaddr;
6191 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6193 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6194 "delivery", addr->address);
6195 nextaddr = addr->next;
6196 addr->next = addr_failed;
6202 /* Now all should either have succeeded or failed. */
6204 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6206 uschar *s = (addr_failed->user_message != NULL)?
6207 addr_failed->user_message : addr_failed->message;
6209 fprintf(stderr, "Delivery failed: ");
6210 if (addr_failed->basic_errno > 0)
6212 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6213 if (s != NULL) fprintf(stderr, ": ");
6217 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6219 else fprintf(stderr, "%s", CS s);
6220 fprintf(stderr, "\n");
6222 final_yield = DELIVER_MUA_FAILED;
6227 /* In a normal configuration, we now update the retry database. This is done in
6228 one fell swoop at the end in order not to keep opening and closing (and
6229 locking) the database. The code for handling retries is hived off into a
6230 separate module for convenience. We pass it the addresses of the various
6231 chains, because deferred addresses can get moved onto the failed chain if the
6232 retry cutoff time has expired for all alternative destinations. Bypass the
6233 updating of the database if the -N flag is set, which is a debugging thing that
6234 prevents actual delivery. */
6236 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6238 /* If any addresses failed, we must send a message to somebody, unless
6239 af_ignore_error is set, in which case no action is taken. It is possible for
6240 several messages to get sent if there are addresses with different
6243 while (addr_failed != NULL)
6247 uschar *logtod = tod_stamp(tod_log);
6249 address_item *handled_addr = NULL;
6250 address_item **paddr;
6251 address_item *msgchain = NULL;
6252 address_item **pmsgchain = &msgchain;
6254 /* There are weird cases when logging is disabled in the transport. However,
6255 there may not be a transport (address failed by a router). */
6257 disable_logging = FALSE;
6258 if (addr_failed->transport != NULL)
6259 disable_logging = addr_failed->transport->disable_logging;
6262 debug_printf("processing failed address %s\n", addr_failed->address);
6264 /* There are only two ways an address in a bounce message can get here:
6266 (1) When delivery was initially deferred, but has now timed out (in the call
6267 to retry_update() above). We can detect this by testing for
6268 af_retry_timedout. If the address does not have its own errors address,
6269 we arrange to ignore the error.
6271 (2) If delivery failures for bounce messages are being ignored. We can detect
6272 this by testing for af_ignore_error. This will also be set if a bounce
6273 message has been autothawed and the ignore_bounce_errors_after time has
6274 passed. It might also be set if a router was explicitly configured to
6275 ignore errors (errors_to = "").
6277 If neither of these cases obtains, something has gone wrong. Log the
6278 incident, but then ignore the error. */
6280 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6282 if (!testflag(addr_failed, af_retry_timedout) &&
6283 !testflag(addr_failed, af_ignore_error))
6285 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6286 "failure is neither frozen nor ignored (it's been ignored)");
6288 setflag(addr_failed, af_ignore_error);
6291 /* If the first address on the list has af_ignore_error set, just remove
6292 it from the list, throw away any saved message file, log it, and
6293 mark the recipient done. */
6295 if (testflag(addr_failed, af_ignore_error))
6298 addr_failed = addr->next;
6299 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6301 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6303 (addr->parent == NULL)? US"" : US" <",
6304 (addr->parent == NULL)? US"" : addr->parent->address,
6305 (addr->parent == NULL)? US"" : US">");
6307 address_done(addr, logtod);
6308 child_done(addr, logtod);
6309 /* Panic-dies on error */
6310 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6313 /* Otherwise, handle the sending of a message. Find the error address for
6314 the first address, then send a message that includes all failed addresses
6315 that have the same error address. Note the bounce_recipient is a global so
6316 that it can be accesssed by $bounce_recipient while creating a customized
6321 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6322 sender_address : addr_failed->p.errors_address;
6324 /* Make a subprocess to send a message */
6326 pid = child_open_exim(&fd);
6328 /* Creation of child failed */
6331 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6332 "create child process to send failure message: %s", getpid(),
6333 getppid(), strerror(errno));
6335 /* Creation of child succeeded */
6342 uschar *bcc, *emf_text;
6343 FILE *f = fdopen(fd, "wb");
6345 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6346 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6347 DELIVER_IN_BUFFER_SIZE;
6350 debug_printf("sending error message to: %s\n", bounce_recipient);
6352 /* Scan the addresses for all that have the same errors address, removing
6353 them from the addr_failed chain, and putting them on msgchain. */
6355 paddr = &addr_failed;
6356 for (addr = addr_failed; addr != NULL; addr = *paddr)
6358 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6359 sender_address : addr->p.errors_address) != 0)
6361 paddr = &(addr->next); /* Not the same; skip */
6363 else /* The same - dechain */
6365 *paddr = addr->next;
6368 pmsgchain = &(addr->next);
6372 /* Include X-Failed-Recipients: for automatic interpretation, but do
6373 not let any one header line get too long. We do this by starting a
6374 new header every 50 recipients. Omit any addresses for which the
6375 "hide_child" flag is set. */
6377 for (addr = msgchain; addr != NULL; addr = addr->next)
6379 if (testflag(addr, af_hide_child)) continue;
6386 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6387 (testflag(addr, af_pfr) && addr->parent != NULL)?
6388 string_printing(addr->parent->address) :
6389 string_printing(addr->address));
6391 if (rcount > 0) fprintf(f, "\n");
6393 /* Output the standard headers */
6395 if (errors_reply_to != NULL)
6396 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6397 fprintf(f, "Auto-Submitted: auto-replied\n");
6399 fprintf(f, "To: %s\n", bounce_recipient);
6401 /* Open a template file if one is provided. Log failure to open, but
6402 carry on - default texts will be used. */
6404 if (bounce_message_file != NULL)
6406 emf = Ufopen(bounce_message_file, "rb");
6408 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6409 "message texts: %s", bounce_message_file, strerror(errno));
6412 /* Quietly copy to configured additional addresses if required. */
6414 bcc = moan_check_errorcopy(bounce_recipient);
6415 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6417 /* The texts for the message can be read from a template file; if there
6418 isn't one, or if it is too short, built-in texts are used. The first
6419 emf text is a Subject: and any other headers. */
6421 emf_text = next_emf(emf, US"header");
6422 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6424 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6425 to_sender? ": returning message to sender" : "");
6428 emf_text = next_emf(emf, US"intro");
6429 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6432 /* This message has been reworded several times. It seems to be confusing to
6433 somebody, however it is worded. I have retreated to the original, simple
6435 "This message was created automatically by mail delivery software.\n");
6436 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6440 "\nA message that you sent could not be delivered to one or more of its\n"
6441 "recipients. This is a permanent error. The following address(es) failed:\n");
6446 "\nA message sent by\n\n <%s>\n\n"
6447 "could not be delivered to one or more of its recipients. The following\n"
6448 "address(es) failed:\n", sender_address);
6453 /* Process the addresses, leaving them on the msgchain if they have a
6454 file name for a return message. (There has already been a check in
6455 post_process_one() for the existence of data in the message file.) A TRUE
6456 return from print_address_information() means that the address is not
6460 for (addr = msgchain; addr != NULL; addr = *paddr)
6462 if (print_address_information(addr, f, US" ", US"\n ", US""))
6463 print_address_error(addr, f, US"");
6465 /* End the final line for the address */
6469 /* Leave on msgchain if there's a return file. */
6471 if (addr->return_file >= 0)
6473 paddr = &(addr->next);
6477 /* Else save so that we can tick off the recipient when the
6482 *paddr = addr->next;
6483 addr->next = handled_addr;
6484 handled_addr = addr;
6490 /* Get the next text, whether we need it or not, so as to be
6491 positioned for the one after. */
6493 emf_text = next_emf(emf, US"generated text");
6495 /* If there were any file messages passed by the local transports,
6496 include them in the message. Then put the address on the handled chain.
6497 In the case of a batch of addresses that were all sent to the same
6498 transport, the return_file field in all of them will contain the same
6499 fd, and the return_filename field in the *last* one will be set (to the
6500 name of the file). */
6502 if (msgchain != NULL)
6504 address_item *nextaddr;
6506 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6508 "The following text was generated during the delivery "
6509 "attempt%s:\n", (filecount > 1)? "s" : "");
6511 for (addr = msgchain; addr != NULL; addr = nextaddr)
6514 address_item *topaddr = addr;
6516 /* List all the addresses that relate to this file */
6519 while(addr != NULL) /* Insurance */
6521 print_address_information(addr, f, US"------ ", US"\n ",
6523 if (addr->return_filename != NULL) break;
6528 /* Now copy the file */
6530 fm = Ufopen(addr->return_filename, "rb");
6533 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6537 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6540 Uunlink(addr->return_filename);
6542 /* Can now add to handled chain, first fishing off the next
6543 address on the msgchain. */
6545 nextaddr = addr->next;
6546 addr->next = handled_addr;
6547 handled_addr = topaddr;
6552 /* Now copy the message, trying to give an intelligible comment if
6553 it is too long for it all to be copied. The limit isn't strictly
6554 applied because of the buffering. There is, however, an option
6555 to suppress copying altogether. */
6557 emf_text = next_emf(emf, US"copy");
6559 if (bounce_return_message)
6561 int topt = topt_add_return_path;
6562 if (!bounce_return_body) topt |= topt_no_body;
6564 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6566 if (bounce_return_body) fprintf(f,
6567 "------ This is a copy of the message, including all the headers. ------\n");
6569 "------ This is a copy of the message's headers. ------\n");
6572 /* While reading the "truncated" message, set return_size_limit to
6573 the actual max testing value, rounded. We need to read the message
6574 whether we are going to use it or not. */
6577 int temp = bounce_return_size_limit;
6578 bounce_return_size_limit = (max/1000)*1000;
6579 emf_text = next_emf(emf, US"truncated");
6580 bounce_return_size_limit = temp;
6583 if (bounce_return_body && bounce_return_size_limit > 0)
6585 struct stat statbuf;
6586 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6588 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6591 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6592 "------ %d or so are included here.\n", statbuf.st_size, max);
6599 transport_filter_argv = NULL; /* Just in case */
6600 return_path = sender_address; /* In case not previously set */
6601 transport_write_message(NULL, fileno(f), topt,
6602 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6605 /* Write final text and close the template file if one is open */
6609 emf_text = next_emf(emf, US"final");
6610 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6614 /* Close the file, which should send an EOF to the child process
6615 that is receiving the message. Wait for it to finish. */
6618 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6620 /* In the test harness, let the child do it's thing first. */
6622 if (running_in_test_harness) millisleep(500);
6624 /* If the process failed, there was some disaster in setting up the
6625 error message. Unless the message is very old, ensure that addr_defer
6626 is non-null, which will have the effect of leaving the message on the
6627 spool. The failed addresses will get tried again next time. However, we
6628 don't really want this to happen too often, so freeze the message unless
6629 there are some genuine deferred addresses to try. To do this we have
6630 to call spool_write_header() here, because with no genuine deferred
6631 addresses the normal code below doesn't get run. */
6636 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6638 addr_defer = (address_item *)(+1);
6639 deliver_freeze = TRUE;
6640 deliver_frozen_at = time(NULL);
6641 /* Panic-dies on error */
6642 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6645 deliver_msglog("Process failed (%d) when writing error message "
6646 "to %s%s", rc, bounce_recipient, s);
6647 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6648 "to %s%s", rc, bounce_recipient, s);
6651 /* The message succeeded. Ensure that the recipients that failed are
6652 now marked finished with on the spool and their parents updated. */
6656 for (addr = handled_addr; addr != NULL; addr = addr->next)
6658 address_done(addr, logtod);
6659 child_done(addr, logtod);
6661 /* Panic-dies on error */
6662 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6668 disable_logging = FALSE; /* In case left set */
6670 /* Come here from the mua_wrapper case if routing goes wrong */
6674 /* If there are now no deferred addresses, we are done. Preserve the
6675 message log if so configured, and we are using them. Otherwise, sling it.
6676 Then delete the message itself. */
6678 if (addr_defer == NULL)
6682 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6684 if (preserve_message_logs)
6687 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6688 if ((rc = Urename(spoolname, big_buffer)) < 0)
6690 (void)directory_make(spool_directory, US"msglog.OLD",
6691 MSGLOG_DIRECTORY_MODE, TRUE);
6692 rc = Urename(spoolname, big_buffer);
6695 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6696 "msglog.OLD directory", spoolname);
6700 if (Uunlink(spoolname) < 0)
6701 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6702 spoolname, strerror(errno));
6706 /* Remove the two message files. */
6708 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6709 if (Uunlink(spoolname) < 0)
6710 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6711 spoolname, strerror(errno));
6712 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6713 if (Uunlink(spoolname) < 0)
6714 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6715 spoolname, strerror(errno));
6717 /* Log the end of this message, with queue time if requested. */
6719 if ((log_extra_selector & LX_queue_time_overall) != 0)
6720 log_write(0, LOG_MAIN, "Completed QT=%s",
6721 readconf_printtime(time(NULL) - received_time));
6723 log_write(0, LOG_MAIN, "Completed");
6725 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6726 deliver_freeze = FALSE;
6729 /* If there are deferred addresses, we are keeping this message because it is
6730 not yet completed. Lose any temporary files that were catching output from
6731 pipes for any of the deferred addresses, handle one-time aliases, and see if
6732 the message has been on the queue for so long that it is time to send a warning
6733 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6734 have the same domain, we can set deliver_domain for the expansion of
6735 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6736 the parent's domain.
6738 If all the deferred addresses have an error number that indicates "retry time
6739 not reached", skip sending the warning message, because it won't contain the
6740 reason for the delay. It will get sent at the next real delivery attempt.
6741 However, if at least one address has tried, we'd better include all of them in
6744 If we can't make a process to send the message, don't worry.
6746 For mailing list expansions we want to send the warning message to the
6747 mailing list manager. We can't do a perfect job here, as some addresses may
6748 have different errors addresses, but if we take the errors address from
6749 each deferred address it will probably be right in most cases.
6751 If addr_defer == +1, it means there was a problem sending an error message
6752 for failed addresses, and there were no "real" deferred addresses. The value
6753 was set just to keep the message on the spool, so there is nothing to do here.
6756 else if (addr_defer != (address_item *)(+1))
6759 uschar *recipients = US"";
6760 BOOL delivery_attempted = FALSE;
6762 deliver_domain = testflag(addr_defer, af_pfr)?
6763 addr_defer->parent->domain : addr_defer->domain;
6765 for (addr = addr_defer; addr != NULL; addr = addr->next)
6767 address_item *otaddr;
6769 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6771 if (deliver_domain != NULL)
6773 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6775 /* The domain may be unset for an address that has never been routed
6776 because the system filter froze the message. */
6778 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6781 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6783 /* Handle the case of one-time aliases. If any address in the ancestry
6784 of this one is flagged, ensure it is in the recipients list, suitably
6785 flagged, and that its parent is marked delivered. */
6787 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6788 if (otaddr->onetime_parent != NULL) break;
6793 int t = recipients_count;
6795 for (i = 0; i < recipients_count; i++)
6797 uschar *r = recipients_list[i].address;
6798 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6799 if (Ustrcmp(otaddr->address, r) == 0) break;
6802 /* Didn't find the address already in the list, and did find the
6803 ultimate parent's address in the list. After adding the recipient,
6804 update the errors address in the recipients list. */
6806 if (i >= recipients_count && t < recipients_count)
6808 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6809 otaddr->address, otaddr->parent->address);
6810 receive_add_recipient(otaddr->address, t);
6811 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6812 tree_add_nonrecipient(otaddr->parent->address);
6813 update_spool = TRUE;
6817 /* Except for error messages, ensure that either the errors address for
6818 this deferred address or, if there is none, the sender address, is on the
6819 list of recipients for a warning message. */
6821 if (sender_address[0] != 0)
6823 if (addr->p.errors_address == NULL)
6825 if (Ustrstr(recipients, sender_address) == NULL)
6826 recipients = string_sprintf("%s%s%s", recipients,
6827 (recipients[0] == 0)? "" : ",", sender_address);
6831 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6832 recipients = string_sprintf("%s%s%s", recipients,
6833 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6838 /* Send a warning message if the conditions are right. If the condition check
6839 fails because of a lookup defer, there is nothing we can do. The warning
6840 is not sent. Another attempt will be made at the next delivery attempt (if
6843 if (!queue_2stage && delivery_attempted &&
6844 delay_warning[1] > 0 && sender_address[0] != 0 &&
6845 (delay_warning_condition == NULL ||
6846 expand_check_condition(delay_warning_condition,
6847 US"delay_warning", US"option")))
6851 int queue_time = time(NULL) - received_time;
6853 /* When running in the test harness, there's an option that allows us to
6854 fudge this time so as to get repeatability of the tests. Take the first
6855 time off the list. In queue runs, the list pointer gets updated in the
6858 if (running_in_test_harness && fudged_queue_times[0] != 0)
6860 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6863 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6864 fudged_queue_times);
6869 /* See how many warnings we should have sent by now */
6871 for (count = 0; count < delay_warning[1]; count++)
6872 if (queue_time < delay_warning[count+2]) break;
6874 show_time = delay_warning[count+1];
6876 if (count >= delay_warning[1])
6879 int last_gap = show_time;
6880 if (count > 1) last_gap -= delay_warning[count];
6881 extra = (queue_time - delay_warning[count+1])/last_gap;
6882 show_time += last_gap * extra;
6888 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6889 debug_printf("warning counts: required %d done %d\n", count,
6893 /* We have computed the number of warnings there should have been by now.
6894 If there haven't been enough, send one, and up the count to what it should
6897 if (warning_count < count)
6901 pid_t pid = child_open_exim(&fd);
6907 FILE *f = fdopen(fd, "wb");
6909 if (warn_message_file != NULL)
6911 wmf = Ufopen(warn_message_file, "rb");
6913 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6914 "message texts: %s", warn_message_file, strerror(errno));
6917 warnmsg_recipients = recipients;
6918 warnmsg_delay = (queue_time < 120*60)?
6919 string_sprintf("%d minutes", show_time/60):
6920 string_sprintf("%d hours", show_time/3600);
6922 if (errors_reply_to != NULL)
6923 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6924 fprintf(f, "Auto-Submitted: auto-replied\n");
6926 fprintf(f, "To: %s\n", recipients);
6928 wmf_text = next_emf(wmf, US"header");
6929 if (wmf_text != NULL)
6930 fprintf(f, "%s\n", wmf_text);
6932 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6933 message_id, warnmsg_delay);
6935 wmf_text = next_emf(wmf, US"intro");
6936 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6939 "This message was created automatically by mail delivery software.\n");
6941 if (Ustrcmp(recipients, sender_address) == 0)
6943 "A message that you sent has not yet been delivered to one or more of its\n"
6944 "recipients after more than ");
6947 "A message sent by\n\n <%s>\n\n"
6948 "has not yet been delivered to one or more of its recipients after more than \n",
6951 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6953 fprintf(f, "The message identifier is: %s\n", message_id);
6955 for (h = header_list; h != NULL; h = h->next)
6957 if (strncmpic(h->text, US"Subject:", 8) == 0)
6958 fprintf(f, "The subject of the message is: %s", h->text + 9);
6959 else if (strncmpic(h->text, US"Date:", 5) == 0)
6960 fprintf(f, "The date of the message is: %s", h->text + 6);
6964 fprintf(f, "The address%s to which the message has not yet been "
6966 (addr_defer->next == NULL)? "" : "es",
6967 (addr_defer->next == NULL)? "is": "are");
6970 /* List the addresses, with error information if allowed */
6973 while (addr_defer != NULL)
6975 address_item *addr = addr_defer;
6976 addr_defer = addr->next;
6977 if (print_address_information(addr, f, US" ", US"\n ", US""))
6978 print_address_error(addr, f, US"Delay reason: ");
6987 wmf_text = next_emf(wmf, US"final");
6988 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6994 "No action is required on your part. Delivery attempts will continue for\n"
6995 "some time, and this warning may be repeated at intervals if the message\n"
6996 "remains undelivered. Eventually the mail delivery software will give up,\n"
6997 "and when that happens, the message will be returned to you.\n");
7000 /* Close and wait for child process to complete, without a timeout.
7001 If there's an error, don't update the count. */
7004 if (child_close(pid, 0) == 0)
7006 warning_count = count;
7007 update_spool = TRUE; /* Ensure spool rewritten */
7013 /* Clear deliver_domain */
7015 deliver_domain = NULL;
7017 /* If this was a first delivery attempt, unset the first time flag, and
7018 ensure that the spool gets updated. */
7020 if (deliver_firsttime)
7022 deliver_firsttime = FALSE;
7023 update_spool = TRUE;
7026 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7027 message, unless the message is a local error message (to avoid loops). Then
7028 log the freezing. If the text in "frozen_info" came from a system filter,
7029 it has been escaped into printing characters so as not to mess up log lines.
7030 For the "tell" message, we turn \n back into newline. Also, insert a newline
7031 near the start instead of the ": " string. */
7035 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7037 uschar *s = string_copy(frozen_info);
7038 uschar *ss = Ustrstr(s, " by the system filter: ");
7049 if (*ss == '\\' && ss[1] == 'n')
7056 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7057 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7061 /* Log freezing just before we update the -H file, to minimize the chance
7062 of a race problem. */
7064 deliver_msglog("*** Frozen%s\n", frozen_info);
7065 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7068 /* If there have been any updates to the non-recipients list, or other things
7069 that get written to the spool, we must now update the spool header file so
7070 that it has the right information for the next delivery attempt. If there
7071 was more than one address being delivered, the header_change update is done
7072 earlier, in case one succeeds and then something crashes. */
7075 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7076 update_spool, header_rewritten);
7078 if (update_spool || header_rewritten)
7079 /* Panic-dies on error */
7080 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7083 /* Finished with the message log. If the message is complete, it will have
7084 been unlinked or renamed above. */
7086 if (message_logs) (void)fclose(message_log);
7088 /* Now we can close and remove the journal file. Its only purpose is to record
7089 successfully completed deliveries asap so that this information doesn't get
7090 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7091 not serious, as trying it again is not harmful. The journal might not be open
7092 if all addresses were deferred at routing or directing. Nevertheless, we must
7093 remove it if it exists (may have been lying around from a crash during the
7094 previous delivery attempt). We don't remove the journal if a delivery
7095 subprocess failed to pass back delivery information; this is controlled by
7096 the remove_journal flag. When the journal is left, we also don't move the
7097 message off the main spool if frozen and the option is set. It should get moved
7098 at the next attempt, after the journal has been inspected. */
7100 if (journal_fd >= 0) (void)close(journal_fd);
7104 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7105 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7106 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7109 /* Move the message off the spool if reqested */
7111 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7112 if (deliver_freeze && move_frozen_messages)
7113 (void)spool_move_message(id, message_subdir, US"", US"F");
7117 /* Closing the data file frees the lock; if the file has been unlinked it
7118 will go away. Otherwise the message becomes available for another process
7121 (void)close(deliver_datafile);
7122 deliver_datafile = -1;
7123 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7125 /* It is unlikely that there will be any cached resources, since they are
7126 released after routing, and in the delivery subprocesses. However, it's
7127 possible for an expansion for something afterwards (for example,
7128 expand_check_condition) to do a lookup. We must therefore be sure everything is
7132 acl_where = ACL_WHERE_UNKNOWN;
7136 /* End of deliver.c */