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">");
717 /* You might think that the return path must always be set for a successful
718 delivery; indeed, I did for some time, until this statement crashed. The case
719 when it is not set is for a delivery to /dev/null which is optimised by not
722 if (used_return_path != NULL &&
723 (log_extra_selector & LX_return_path_on_delivery) != 0)
724 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
727 s = string_append(s, &size, &ptr, 2, US" ", msg);
729 /* For a delivery from a system filter, there may not be a router */
730 if (addr->router != NULL)
731 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
733 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
735 if ((log_extra_selector & LX_delivery_size) != 0)
736 s = string_append(s, &size, &ptr, 2, US" S=",
737 string_sprintf("%d", transport_count));
741 if (addr->transport->info->local)
743 if (addr->host_list != NULL)
744 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
745 if (addr->shadow_message != NULL)
746 s = string_cat(s, &size, &ptr, addr->shadow_message,
747 Ustrlen(addr->shadow_message));
750 /* Remote delivery */
754 if (addr->host_used != NULL)
756 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
757 US" [", addr->host_used->address, US"]");
758 if ((log_extra_selector & LX_outgoing_port) != 0)
759 s = string_append(s, &size, &ptr, 2, US":", string_sprintf("%d",
760 addr->host_used->port));
761 if (continue_sequence > 1)
762 s = string_cat(s, &size, &ptr, US"*", 1);
766 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
767 s = string_append(s, &size, &ptr, 2, US" X=", addr->cipher);
768 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
769 addr->cipher != NULL)
770 s = string_append(s, &size, &ptr, 2, US" CV=",
771 testflag(addr, af_cert_verified)? "yes":"no");
772 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
773 s = string_append(s, &size, &ptr, 3, US" DN=\"",
774 string_printing(addr->peerdn), US"\"");
777 if (smtp_authenticated)
779 s = string_append(s, &size, &ptr, 2, US" A=", client_authenticator);
780 if (client_authenticated_id)
782 s = string_append(s, &size, &ptr, 2, US":", client_authenticated_id);
783 if (log_extra_selector & LX_smtp_mailauth && client_authenticated_sender)
784 s = string_append(s, &size, &ptr, 2, US":", client_authenticated_sender);
788 if ((log_extra_selector & LX_smtp_confirmation) != 0 &&
789 addr->message != NULL)
792 uschar *p = big_buffer;
793 uschar *ss = addr->message;
795 for (i = 0; i < 100 && ss[i] != 0; i++)
797 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\';
802 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
806 /* Time on queue and actual time taken to deliver */
808 if ((log_extra_selector & LX_queue_time) != 0)
810 s = string_append(s, &size, &ptr, 2, US" QT=",
811 readconf_printtime(time(NULL) - received_time));
814 if ((log_extra_selector & LX_deliver_time) != 0)
816 s = string_append(s, &size, &ptr, 2, US" DT=",
817 readconf_printtime(addr->more_errno));
820 /* string_cat() always leaves room for the terminator. Release the
821 store we used to build the line after writing it. */
824 log_write(0, flags, "%s", s);
825 store_reset(reset_point);
831 /*************************************************
832 * Actions at the end of handling an address *
833 *************************************************/
835 /* This is a function for processing a single address when all that can be done
836 with it has been done.
839 addr points to the address block
840 result the result of the delivery attempt
841 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
842 driver_type indicates which type of driver (transport, or router) was last
843 to process the address
844 logchar '=' or '-' for use when logging deliveries with => or ->
850 post_process_one(address_item *addr, int result, int logflags, int driver_type,
853 uschar *now = tod_stamp(tod_log);
854 uschar *driver_kind = NULL;
855 uschar *driver_name = NULL;
858 int size = 256; /* Used for a temporary, */
859 int ptr = 0; /* expanding buffer, for */
860 uschar *s; /* building log lines; */
861 void *reset_point; /* released afterwards. */
864 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
866 /* Set up driver kind and name for logging. Disable logging if the router or
867 transport has disabled it. */
869 if (driver_type == DTYPE_TRANSPORT)
871 if (addr->transport != NULL)
873 driver_name = addr->transport->name;
874 driver_kind = US" transport";
875 disable_logging = addr->transport->disable_logging;
877 else driver_kind = US"transporting";
879 else if (driver_type == DTYPE_ROUTER)
881 if (addr->router != NULL)
883 driver_name = addr->router->name;
884 driver_kind = US" router";
885 disable_logging = addr->router->disable_logging;
887 else driver_kind = US"routing";
890 /* If there's an error message set, ensure that it contains only printing
891 characters - it should, but occasionally things slip in and this at least
892 stops the log format from getting wrecked. We also scan the message for an LDAP
893 expansion item that has a password setting, and flatten the password. This is a
894 fudge, but I don't know a cleaner way of doing this. (If the item is badly
895 malformed, it won't ever have gone near LDAP.) */
897 if (addr->message != NULL)
899 addr->message = string_printing(addr->message);
900 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
901 (Ustrstr(addr->message, "mysql") != NULL ||
902 Ustrstr(addr->message, "pgsql") != NULL ||
903 Ustrstr(addr->message, "sqlite") != NULL ||
904 Ustrstr(addr->message, "ldap:") != NULL ||
905 Ustrstr(addr->message, "ldapdn:") != NULL ||
906 Ustrstr(addr->message, "ldapm:") != NULL))
908 addr->message = string_sprintf("Temporary internal error");
912 /* If we used a transport that has one of the "return_output" options set, and
913 if it did in fact generate some output, then for return_output we treat the
914 message as failed if it was not already set that way, so that the output gets
915 returned to the sender, provided there is a sender to send it to. For
916 return_fail_output, do this only if the delivery failed. Otherwise we just
917 unlink the file, and remove the name so that if the delivery failed, we don't
918 try to send back an empty or unwanted file. The log_output options operate only
921 In any case, we close the message file, because we cannot afford to leave a
922 file-descriptor for one address while processing (maybe very many) others. */
924 if (addr->return_file >= 0 && addr->return_filename != NULL)
926 BOOL return_output = FALSE;
928 (void)EXIMfsync(addr->return_file);
930 /* If there is no output, do nothing. */
932 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
934 transport_instance *tb = addr->transport;
936 /* Handle logging options */
938 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
939 (result == DEFER && tb->log_defer_output))
942 FILE *f = Ufopen(addr->return_filename, "rb");
944 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
945 "from %s transport: %s", addr->return_filename, tb->name,
949 s = US Ufgets(big_buffer, big_buffer_size, f);
952 uschar *p = big_buffer + Ustrlen(big_buffer);
953 while (p > big_buffer && isspace(p[-1])) p--;
955 s = string_printing(big_buffer);
956 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
957 addr->address, tb->name, s);
963 /* Handle returning options, but only if there is an address to return
966 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
968 if (tb->return_output)
970 addr->transport_return = result = FAIL;
971 if (addr->basic_errno == 0 && addr->message == NULL)
972 addr->message = US"return message generated";
973 return_output = TRUE;
976 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
980 /* Get rid of the file unless it might be returned, but close it in
985 Uunlink(addr->return_filename);
986 addr->return_filename = NULL;
987 addr->return_file = -1;
990 (void)close(addr->return_file);
993 /* The sucess case happens only after delivery by a transport. */
997 addr->next = addr_succeed;
1000 /* Call address_done() to ensure that we don't deliver to this address again,
1001 and write appropriate things to the message log. If it is a child address, we
1002 call child_done() to scan the ancestors and mark them complete if this is the
1003 last child to complete. */
1005 address_done(addr, now);
1006 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1008 if (addr->parent == NULL)
1010 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1011 driver_name, driver_kind);
1015 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1016 addr->parent->address, driver_name, driver_kind);
1017 child_done(addr, now);
1020 delivery_log(LOG_MAIN, addr, logchar, NULL);
1024 /* Soft failure, or local delivery process failed; freezing may be
1027 else if (result == DEFER || result == PANIC)
1029 if (result == PANIC) logflags |= LOG_PANIC;
1031 /* This puts them on the chain in reverse order. Do not change this, because
1032 the code for handling retries assumes that the one with the retry
1033 information is last. */
1035 addr->next = addr_defer;
1038 /* The only currently implemented special action is to freeze the
1039 message. Logging of this is done later, just before the -H file is
1042 if (addr->special_action == SPECIAL_FREEZE)
1044 deliver_freeze = TRUE;
1045 deliver_frozen_at = time(NULL);
1046 update_spool = TRUE;
1049 /* If doing a 2-stage queue run, we skip writing to either the message
1050 log or the main log for SMTP defers. */
1052 if (!queue_2stage || addr->basic_errno != 0)
1056 /* For errors of the type "retry time not reached" (also remotes skipped
1057 on queue run), logging is controlled by L_retry_defer. Note that this kind
1058 of error number is negative, and all the retry ones are less than any
1061 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1064 /* Build up the line that is used for both the message log and the main
1067 s = reset_point = store_get(size);
1069 /* Create the address string for logging. Must not do this earlier, because
1070 an OK result may be changed to FAIL when a pipe returns text. */
1072 log_address = string_log_address(addr,
1073 (log_write_selector & L_all_parents) != 0, result == OK);
1075 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1077 /* Either driver_name contains something and driver_kind contains
1078 " router" or " transport" (note the leading space), or driver_name is
1079 a null string and driver_kind contains "routing" without the leading
1080 space, if all routing has been deferred. When a domain has been held,
1081 so nothing has been done at all, both variables contain null strings. */
1083 if (driver_name == NULL)
1085 if (driver_kind != NULL)
1086 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1090 if (driver_kind[1] == 't' && addr->router != NULL)
1091 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1093 ss[1] = toupper(driver_kind[1]);
1094 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1097 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1098 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1100 if (addr->basic_errno > 0)
1101 s = string_append(s, &size, &ptr, 2, US": ",
1102 US strerror(addr->basic_errno));
1104 if (addr->message != NULL)
1105 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1109 /* Log the deferment in the message log, but don't clutter it
1110 up with retry-time defers after the first delivery attempt. */
1112 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1113 deliver_msglog("%s %s\n", now, s);
1115 /* Write the main log and reset the store */
1117 log_write(use_log_selector, logflags, "== %s", s);
1118 store_reset(reset_point);
1123 /* Hard failure. If there is an address to which an error message can be sent,
1124 put this address on the failed list. If not, put it on the deferred list and
1125 freeze the mail message for human attention. The latter action can also be
1126 explicitly requested by a router or transport. */
1130 /* If this is a delivery error, or a message for which no replies are
1131 wanted, and the message's age is greater than ignore_bounce_errors_after,
1132 force the af_ignore_error flag. This will cause the address to be discarded
1133 later (with a log entry). */
1135 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1136 setflag(addr, af_ignore_error);
1138 /* Freeze the message if requested, or if this is a bounce message (or other
1139 message with null sender) and this address does not have its own errors
1140 address. However, don't freeze if errors are being ignored. The actual code
1141 to ignore occurs later, instead of sending a message. Logging of freezing
1142 occurs later, just before writing the -H file. */
1144 if (!testflag(addr, af_ignore_error) &&
1145 (addr->special_action == SPECIAL_FREEZE ||
1146 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1149 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1150 (sender_local && !local_error_message)?
1151 US" (message created with -f <>)" : US" (delivery error message)";
1152 deliver_freeze = TRUE;
1153 deliver_frozen_at = time(NULL);
1154 update_spool = TRUE;
1156 /* The address is put on the defer rather than the failed queue, because
1157 the message is being retained. */
1159 addr->next = addr_defer;
1163 /* Don't put the address on the nonrecipients tree yet; wait until an
1164 error message has been successfully sent. */
1168 addr->next = addr_failed;
1172 /* Build up the log line for the message and main logs */
1174 s = reset_point = store_get(size);
1176 /* Create the address string for logging. Must not do this earlier, because
1177 an OK result may be changed to FAIL when a pipe returns text. */
1179 log_address = string_log_address(addr,
1180 (log_write_selector & L_all_parents) != 0, result == OK);
1182 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1184 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1185 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1187 /* Return path may not be set if no delivery actually happened */
1189 if (used_return_path != NULL &&
1190 (log_extra_selector & LX_return_path_on_delivery) != 0)
1192 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1195 if (addr->router != NULL)
1196 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1197 if (addr->transport != NULL)
1198 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1200 if (addr->host_used != NULL)
1201 s = string_append(s, &size, &ptr, 5, US" H=", addr->host_used->name,
1202 US" [", addr->host_used->address, US"]");
1204 if (addr->basic_errno > 0)
1205 s = string_append(s, &size, &ptr, 2, US": ",
1206 US strerror(addr->basic_errno));
1208 if (addr->message != NULL)
1209 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1213 /* Do the logging. For the message log, "routing failed" for those cases,
1214 just to make it clearer. */
1216 if (driver_name == NULL)
1217 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1219 deliver_msglog("%s %s\n", now, s);
1221 log_write(0, LOG_MAIN, "** %s", s);
1222 store_reset(reset_point);
1225 /* Ensure logging is turned on again in all cases */
1227 disable_logging = FALSE;
1233 /*************************************************
1234 * Address-independent error *
1235 *************************************************/
1237 /* This function is called when there's an error that is not dependent on a
1238 particular address, such as an expansion string failure. It puts the error into
1239 all the addresses in a batch, logs the incident on the main and panic logs, and
1240 clears the expansions. It is mostly called from local_deliver(), but can be
1241 called for a remote delivery via findugid().
1244 logit TRUE if (MAIN+PANIC) logging required
1245 addr the first of the chain of addresses
1247 format format string for error message, or NULL if already set in addr
1248 ... arguments for the format
1254 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1256 address_item *addr2;
1257 addr->basic_errno = code;
1263 va_start(ap, format);
1264 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1265 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1266 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1268 addr->message = string_copy(buffer);
1271 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1273 addr2->basic_errno = code;
1274 addr2->message = addr->message;
1277 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1278 deliver_set_expansions(NULL);
1284 /*************************************************
1285 * Check a "never users" list *
1286 *************************************************/
1288 /* This function is called to check whether a uid is on one of the two "never
1292 uid the uid to be checked
1293 nusers the list to be scanned; the first item in the list is the count
1295 Returns: TRUE if the uid is on the list
1299 check_never_users(uid_t uid, uid_t *nusers)
1302 if (nusers == NULL) return FALSE;
1303 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1309 /*************************************************
1310 * Find uid and gid for a transport *
1311 *************************************************/
1313 /* This function is called for both local and remote deliveries, to find the
1314 uid/gid under which to run the delivery. The values are taken preferentially
1315 from the transport (either explicit or deliver_as_creator), then from the
1316 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1317 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1318 panic error is logged, and the function fails (which normally leads to delivery
1322 addr the address (possibly a chain)
1324 uidp pointer to uid field
1325 gidp pointer to gid field
1326 igfp pointer to the use_initgroups field
1328 Returns: FALSE if failed - error has been set in address(es)
1332 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1335 uschar *nuname = NULL;
1336 BOOL gid_set = FALSE;
1338 /* Default initgroups flag comes from the transport */
1340 *igfp = tp->initgroups;
1342 /* First see if there's a gid on the transport, either fixed or expandable.
1343 The expanding function always logs failure itself. */
1350 else if (tp->expand_gid != NULL)
1352 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1353 &(addr->message))) gid_set = TRUE;
1356 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1361 /* If the transport did not set a group, see if the router did. */
1363 if (!gid_set && testflag(addr, af_gid_set))
1369 /* Pick up a uid from the transport if one is set. */
1371 if (tp->uid_set) *uidp = tp->uid;
1373 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1374 it does not provide a passwd value from which a gid can be taken. */
1376 else if (tp->expand_uid != NULL)
1379 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1380 uidp, &(addr->message)))
1382 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1385 if (!gid_set && pw != NULL)
1392 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1394 else if (tp->deliver_as_creator)
1396 *uidp = originator_uid;
1399 *gidp = originator_gid;
1404 /* Otherwise see if the address specifies the uid and if so, take it and its
1407 else if (testflag(addr, af_uid_set))
1410 *igfp = testflag(addr, af_initgroups);
1413 /* Nothing has specified the uid - default to the Exim user, and group if the
1426 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1427 defaulting to the Exim uid. In other words, if the configuration has specified
1428 a uid, it must also provide a gid. */
1432 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1433 "%s transport", tp->name);
1437 /* Check that the uid is not on the lists of banned uids that may not be used
1438 for delivery processes. */
1440 if (check_never_users(*uidp, never_users))
1441 nuname = US"never_users";
1442 else if (check_never_users(*uidp, fixed_never_users))
1443 nuname = US"fixed_never_users";
1447 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1448 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1460 /*************************************************
1461 * Check the size of a message for a transport *
1462 *************************************************/
1464 /* Checks that the message isn't too big for the selected transport.
1465 This is called only when it is known that the limit is set.
1469 addr the (first) address being delivered
1472 DEFER expansion failed or did not yield an integer
1473 FAIL message too big
1477 check_message_size(transport_instance *tp, address_item *addr)
1482 deliver_set_expansions(addr);
1483 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1484 deliver_set_expansions(NULL);
1486 if (expand_string_message != NULL)
1489 if (size_limit == -1)
1490 addr->message = string_sprintf("failed to expand message_size_limit "
1491 "in %s transport: %s", tp->name, expand_string_message);
1493 addr->message = string_sprintf("invalid message_size_limit "
1494 "in %s transport: %s", tp->name, expand_string_message);
1496 else if (size_limit > 0 && message_size > size_limit)
1500 string_sprintf("message is too big (transport limit = %d)",
1509 /*************************************************
1510 * Transport-time check for a previous delivery *
1511 *************************************************/
1513 /* Check that this base address hasn't previously been delivered to its routed
1514 transport. If it has been delivered, mark it done. The check is necessary at
1515 delivery time in order to handle homonymic addresses correctly in cases where
1516 the pattern of redirection changes between delivery attempts (so the unique
1517 fields change). Non-homonymic previous delivery is detected earlier, at routing
1518 time (which saves unnecessary routing).
1521 addr the address item
1522 testing TRUE if testing wanted only, without side effects
1524 Returns: TRUE if previously delivered by the transport
1528 previously_transported(address_item *addr, BOOL testing)
1530 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1531 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1533 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1535 DEBUG(D_deliver|D_route|D_transport)
1536 debug_printf("%s was previously delivered (%s transport): discarded\n",
1537 addr->address, addr->transport->name);
1538 if (!testing) child_done(addr, tod_stamp(tod_log));
1547 /******************************************************
1548 * Check for a given header in a header string *
1549 ******************************************************/
1551 /* This function is used when generating quota warnings. The configuration may
1552 specify any header lines it likes in quota_warn_message. If certain of them are
1553 missing, defaults are inserted, so we need to be able to test for the presence
1557 hdr the required header name
1558 hstring the header string
1560 Returns: TRUE the header is in the string
1561 FALSE the header is not in the string
1565 contains_header(uschar *hdr, uschar *hstring)
1567 int len = Ustrlen(hdr);
1568 uschar *p = hstring;
1571 if (strncmpic(p, hdr, len) == 0)
1574 while (*p == ' ' || *p == '\t') p++;
1575 if (*p == ':') return TRUE;
1577 while (*p != 0 && *p != '\n') p++;
1578 if (*p == '\n') p++;
1586 /*************************************************
1587 * Perform a local delivery *
1588 *************************************************/
1590 /* Each local delivery is performed in a separate process which sets its
1591 uid and gid as specified. This is a safer way than simply changing and
1592 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1593 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1594 all systems have seteuid().
1596 If the uid/gid are specified in the transport_instance, they are used; the
1597 transport initialization must ensure that either both or neither are set.
1598 Otherwise, the values associated with the address are used. If neither are set,
1599 it is a configuration error.
1601 The transport or the address may specify a home directory (transport over-
1602 rides), and if they do, this is set as $home. If neither have set a working
1603 directory, this value is used for that as well. Otherwise $home is left unset
1604 and the cwd is set to "/" - a directory that should be accessible to all users.
1606 Using a separate process makes it more complicated to get error information
1607 back. We use a pipe to pass the return code and also an error code and error
1608 text string back to the parent process.
1611 addr points to an address block for this delivery; for "normal" local
1612 deliveries this is the only address to be delivered, but for
1613 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1614 a number of addresses can be handled simultaneously, and in this
1615 case addr will point to a chain of addresses with the same
1618 shadowing TRUE if running a shadow transport; this causes output from pipes
1625 deliver_local(address_item *addr, BOOL shadowing)
1627 BOOL use_initgroups;
1630 int status, len, rc;
1633 uschar *working_directory;
1634 address_item *addr2;
1635 transport_instance *tp = addr->transport;
1637 /* Set up the return path from the errors or sender address. If the transport
1638 has its own return path setting, expand it and replace the existing value. */
1640 if(addr->p.errors_address != NULL)
1641 return_path = addr->p.errors_address;
1642 #ifdef EXPERIMENTAL_SRS
1643 else if(addr->p.srs_sender != NULL)
1644 return_path = addr->p.srs_sender;
1647 return_path = sender_address;
1649 if (tp->return_path != NULL)
1651 uschar *new_return_path = expand_string(tp->return_path);
1652 if (new_return_path == NULL)
1654 if (!expand_string_forcedfail)
1656 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1657 US"Failed to expand return path \"%s\" in %s transport: %s",
1658 tp->return_path, tp->name, expand_string_message);
1662 else return_path = new_return_path;
1665 /* For local deliveries, one at a time, the value used for logging can just be
1666 set directly, once and for all. */
1668 used_return_path = return_path;
1670 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1671 gets put into the address(es), and the expansions are unset, so we can just
1674 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1676 /* See if either the transport or the address specifies a home directory. A
1677 home directory set in the address may already be expanded; a flag is set to
1678 indicate that. In other cases we must expand it. */
1680 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1681 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1682 !testflag(addr, af_home_expanded))) /* not expanded */
1684 uschar *rawhome = deliver_home;
1685 deliver_home = NULL; /* in case it contains $home */
1686 deliver_home = expand_string(rawhome);
1687 if (deliver_home == NULL)
1689 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1690 "to expand for %s transport: %s", rawhome, tp->name,
1691 expand_string_message);
1694 if (*deliver_home != '/')
1696 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1697 "is not absolute for %s transport", deliver_home, tp->name);
1702 /* See if either the transport or the address specifies a current directory,
1703 and if so, expand it. If nothing is set, use the home directory, unless it is
1704 also unset in which case use "/", which is assumed to be a directory to which
1705 all users have access. It is necessary to be in a visible directory for some
1706 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1707 2.5) require this. */
1709 working_directory = (tp->current_dir != NULL)?
1710 tp->current_dir : addr->current_dir;
1712 if (working_directory != NULL)
1714 uschar *raw = working_directory;
1715 working_directory = expand_string(raw);
1716 if (working_directory == NULL)
1718 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1719 "failed to expand for %s transport: %s", raw, tp->name,
1720 expand_string_message);
1723 if (*working_directory != '/')
1725 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1726 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1730 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1732 /* If one of the return_output flags is set on the transport, create and open a
1733 file in the message log directory for the transport to write its output onto.
1734 This is mainly used by pipe transports. The file needs to be unique to the
1735 address. This feature is not available for shadow transports. */
1737 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1738 tp->log_output || tp->log_fail_output))
1741 addr->return_filename =
1742 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1743 message_id, getpid(), return_count++);
1744 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1745 if (addr->return_file < 0)
1747 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1748 "to return message: %s", error, tp->name, strerror(errno));
1753 /* Create the pipe for inter-process communication. */
1757 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1762 /* Now fork the process to do the real work in the subprocess, but first
1763 ensure that all cached resources are freed so that the subprocess starts with
1764 a clean slate and doesn't interfere with the parent process. */
1768 if ((pid = fork()) == 0)
1770 BOOL replicate = TRUE;
1772 /* Prevent core dumps, as we don't want them in users' home directories.
1773 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1774 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1775 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1776 complain if the error is "not supported".
1778 There are two scenarios where changing the max limit has an effect. In one,
1779 the user is using a .forward and invoking a command of their choice via pipe;
1780 for these, we do need the max limit to be 0 unless the admin chooses to
1781 permit an increased limit. In the other, the command is invoked directly by
1782 the transport and is under administrator control, thus being able to raise
1783 the limit aids in debugging. So there's no general always-right answer.
1785 Thus we inhibit core-dumps completely but let individual transports, while
1786 still root, re-raise the limits back up to aid debugging. We make the
1787 default be no core-dumps -- few enough people can use core dumps in
1788 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1795 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1797 #ifdef SETRLIMIT_NOT_SUPPORTED
1798 if (errno != ENOSYS && errno != ENOTSUP)
1800 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1805 /* Reset the random number generator, so different processes don't all
1806 have the same sequence. */
1810 /* If the transport has a setup entry, call this first, while still
1811 privileged. (Appendfile uses this to expand quota, for example, while
1812 able to read private files.) */
1814 if (addr->transport->setup != NULL)
1816 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1820 addr->transport_return = DEFER;
1824 addr->transport_return = PANIC;
1829 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1830 when the process becomes unprivileged, it won't be able to write to the
1831 process log. SIGHUP is ignored throughout exim, except when it is being
1834 signal(SIGINT, SIG_IGN);
1835 signal(SIGTERM, SIG_IGN);
1836 signal(SIGUSR1, SIG_IGN);
1838 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1839 half - for transports that exec things (e.g. pipe). Then set the required
1842 (void)close(pfd[pipe_read]);
1843 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
1845 exim_setugid(uid, gid, use_initgroups,
1846 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
1847 addr->address, addr->transport->name));
1851 address_item *batched;
1852 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
1853 for (batched = addr->next; batched != NULL; batched = batched->next)
1854 debug_printf("additional batched address: %s\n", batched->address);
1857 /* Set an appropriate working directory. */
1859 if (Uchdir(working_directory) < 0)
1861 addr->transport_return = DEFER;
1862 addr->basic_errno = errno;
1863 addr->message = string_sprintf("failed to chdir to %s", working_directory);
1866 /* If successful, call the transport */
1871 set_process_info("delivering %s to %s using %s", message_id,
1872 addr->local_part, addr->transport->name);
1874 /* If a transport filter has been specified, set up its argument list.
1875 Any errors will get put into the address, and FALSE yielded. */
1877 if (addr->transport->filter_command != NULL)
1879 ok = transport_set_up_command(&transport_filter_argv,
1880 addr->transport->filter_command,
1881 TRUE, PANIC, addr, US"transport filter", NULL);
1882 transport_filter_timeout = addr->transport->filter_timeout;
1884 else transport_filter_argv = NULL;
1888 debug_print_string(addr->transport->debug_string);
1889 replicate = !(addr->transport->info->code)(addr->transport, addr);
1893 /* Pass the results back down the pipe. If necessary, first replicate the
1894 status in the top address to the others in the batch. The label is the
1895 subject of a goto when a call to the transport's setup function fails. We
1896 pass the pointer to the transport back in case it got changed as a result of
1897 file_format in appendfile. */
1901 if (replicate) replicate_status(addr);
1902 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1905 int local_part_length = Ustrlen(addr2->local_part);
1908 (void)write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int));
1909 (void)write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count));
1910 (void)write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags));
1911 (void)write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int));
1912 (void)write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int));
1913 (void)write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int));
1914 (void)write(pfd[pipe_write], (void *)&(addr2->transport),
1915 sizeof(transport_instance *));
1917 /* For a file delivery, pass back the local part, in case the original
1918 was only part of the final delivery path. This gives more complete
1921 if (testflag(addr2, af_file))
1923 (void)write(pfd[pipe_write], (void *)&local_part_length, sizeof(int));
1924 (void)write(pfd[pipe_write], addr2->local_part, local_part_length);
1927 /* Now any messages */
1929 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
1931 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
1932 (void)write(pfd[pipe_write], (void *)&message_length, sizeof(int));
1933 if (message_length > 0) (void)write(pfd[pipe_write], s, message_length);
1937 /* OK, this process is now done. Free any cached resources that it opened,
1938 and close the pipe we were writing down before exiting. */
1940 (void)close(pfd[pipe_write]);
1945 /* Back in the main process: panic if the fork did not succeed. This seems
1946 better than returning an error - if forking is failing it is probably best
1947 not to try other deliveries for this message. */
1950 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
1953 /* Read the pipe to get the delivery status codes and error messages. Our copy
1954 of the writing end must be closed first, as otherwise read() won't return zero
1955 on an empty pipe. We check that a status exists for each address before
1956 overwriting the address structure. If data is missing, the default DEFER status
1957 will remain. Afterwards, close the reading end. */
1959 (void)close(pfd[pipe_write]);
1961 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
1963 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
1969 addr2->transport_return = status;
1970 len = read(pfd[pipe_read], (void *)&transport_count,
1971 sizeof(transport_count));
1972 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
1973 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
1974 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
1975 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
1976 len = read(pfd[pipe_read], (void *)&(addr2->transport),
1977 sizeof(transport_instance *));
1979 if (testflag(addr2, af_file))
1981 int local_part_length;
1982 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
1983 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
1984 big_buffer[local_part_length] = 0;
1985 addr2->local_part = string_copy(big_buffer);
1988 for (i = 0, sptr = &(addr2->message); i < 2;
1989 i++, sptr = &(addr2->user_message))
1992 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
1993 if (message_length > 0)
1995 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
1996 if (len > 0) *sptr = string_copy(big_buffer);
2003 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2004 "from delivery subprocess", addr2->unique);
2009 (void)close(pfd[pipe_read]);
2011 /* Unless shadowing, write all successful addresses immediately to the journal
2012 file, to ensure they are recorded asap. For homonymic addresses, use the base
2013 address plus the transport name. Failure to write the journal is panic-worthy,
2014 but don't stop, as it may prove possible subsequently to update the spool file
2015 in order to record the delivery. */
2019 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2021 if (addr2->transport_return != OK) continue;
2023 if (testflag(addr2, af_homonym))
2024 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2026 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2028 /* In the test harness, wait just a bit to let the subprocess finish off
2029 any debug output etc first. */
2031 if (running_in_test_harness) millisleep(300);
2033 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2034 len = Ustrlen(big_buffer);
2035 if (write(journal_fd, big_buffer, len) != len)
2036 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2037 big_buffer, strerror(errno));
2040 /* Ensure the journal file is pushed out to disk. */
2042 if (EXIMfsync(journal_fd) < 0)
2043 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2047 /* Wait for the process to finish. If it terminates with a non-zero code,
2048 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2049 status values of all the addresses as they are. Take care to handle the case
2050 when the subprocess doesn't seem to exist. This has been seen on one system
2051 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2052 happens, wait() doesn't recognize the termination of child processes. Exim now
2053 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2055 while ((rc = wait(&status)) != pid)
2057 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2059 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2060 addr->transport->driver_name);
2066 if ((status & 0xffff) != 0)
2068 int msb = (status >> 8) & 255;
2069 int lsb = status & 255;
2070 int code = (msb == 0)? (lsb & 0x7f) : msb;
2071 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2072 addr->special_action = SPECIAL_FREEZE;
2073 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2074 "status 0x%04x: %s %d",
2075 addr->transport->driver_name,
2077 (msb == 0)? "terminated by signal" : "exit code",
2081 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2083 if (addr->special_action == SPECIAL_WARN &&
2084 addr->transport->warn_message != NULL)
2087 uschar *warn_message;
2089 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2091 warn_message = expand_string(addr->transport->warn_message);
2092 if (warn_message == NULL)
2093 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2094 "message for %s transport): %s", addr->transport->warn_message,
2095 addr->transport->name, expand_string_message);
2098 pid_t pid = child_open_exim(&fd);
2101 FILE *f = fdopen(fd, "wb");
2102 if (errors_reply_to != NULL &&
2103 !contains_header(US"Reply-To", warn_message))
2104 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2105 fprintf(f, "Auto-Submitted: auto-replied\n");
2106 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2107 fprintf(f, "%s", CS warn_message);
2109 /* Close and wait for child process to complete, without a timeout. */
2112 (void)child_close(pid, 0);
2116 addr->special_action = SPECIAL_NONE;
2122 /*************************************************
2123 * Do local deliveries *
2124 *************************************************/
2126 /* This function processes the list of addresses in addr_local. True local
2127 deliveries are always done one address at a time. However, local deliveries can
2128 be batched up in some cases. Typically this is when writing batched SMTP output
2129 files for use by some external transport mechanism, or when running local
2130 deliveries over LMTP.
2137 do_local_deliveries(void)
2140 open_db *dbm_file = NULL;
2141 time_t now = time(NULL);
2143 /* Loop until we have exhausted the supply of local deliveries */
2145 while (addr_local != NULL)
2147 time_t delivery_start;
2149 address_item *addr2, *addr3, *nextaddr;
2150 int logflags = LOG_MAIN;
2151 int logchar = dont_deliver? '*' : '=';
2152 transport_instance *tp;
2154 /* Pick the first undelivered address off the chain */
2156 address_item *addr = addr_local;
2157 addr_local = addr->next;
2160 DEBUG(D_deliver|D_transport)
2161 debug_printf("--------> %s <--------\n", addr->address);
2163 /* An internal disaster if there is no transport. Should not occur! */
2165 if ((tp = addr->transport) == NULL)
2167 logflags |= LOG_PANIC;
2168 disable_logging = FALSE; /* Jic */
2170 (addr->router != NULL)?
2171 string_sprintf("No transport set by %s router", addr->router->name)
2173 string_sprintf("No transport set by system filter");
2174 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2178 /* Check that this base address hasn't previously been delivered to this
2179 transport. The check is necessary at this point to handle homonymic addresses
2180 correctly in cases where the pattern of redirection changes between delivery
2181 attempts. Non-homonymic previous delivery is detected earlier, at routing
2184 if (previously_transported(addr, FALSE)) continue;
2186 /* There are weird cases where logging is disabled */
2188 disable_logging = tp->disable_logging;
2190 /* Check for batched addresses and possible amalgamation. Skip all the work
2191 if either batch_max <= 1 or there aren't any other addresses for local
2194 if (tp->batch_max > 1 && addr_local != NULL)
2196 int batch_count = 1;
2197 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2198 BOOL uses_lp = (testflag(addr, af_pfr) &&
2199 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2200 readconf_depends((driver_instance *)tp, US"local_part");
2201 uschar *batch_id = NULL;
2202 address_item **anchor = &addr_local;
2203 address_item *last = addr;
2206 /* Expand the batch_id string for comparison with other addresses.
2207 Expansion failure suppresses batching. */
2209 if (tp->batch_id != NULL)
2211 deliver_set_expansions(addr);
2212 batch_id = expand_string(tp->batch_id);
2213 deliver_set_expansions(NULL);
2214 if (batch_id == NULL)
2216 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2217 "in %s transport (%s): %s", tp->name, addr->address,
2218 expand_string_message);
2219 batch_count = tp->batch_max;
2223 /* Until we reach the batch_max limit, pick off addresses which have the
2224 same characteristics. These are:
2227 not previously delivered (see comment about 50 lines above)
2228 same local part if the transport's configuration contains $local_part
2229 or if this is a file or pipe delivery from a redirection
2230 same domain if the transport's configuration contains $domain
2232 same additional headers
2233 same headers to be removed
2234 same uid/gid for running the transport
2235 same first host if a host list is set
2238 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2241 tp == next->transport &&
2242 !previously_transported(next, TRUE) &&
2243 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2244 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2245 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2246 same_strings(next->p.errors_address, addr->p.errors_address) &&
2247 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2248 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2249 same_ugid(tp, addr, next) &&
2250 ((addr->host_list == NULL && next->host_list == NULL) ||
2251 (addr->host_list != NULL && next->host_list != NULL &&
2252 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2254 /* If the transport has a batch_id setting, batch_id will be non-NULL
2255 from the expansion outside the loop. Expand for this address and compare.
2256 Expansion failure makes this address ineligible for batching. */
2258 if (ok && batch_id != NULL)
2261 address_item *save_nextnext = next->next;
2262 next->next = NULL; /* Expansion for a single address */
2263 deliver_set_expansions(next);
2264 next->next = save_nextnext;
2265 bid = expand_string(tp->batch_id);
2266 deliver_set_expansions(NULL);
2269 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2270 "in %s transport (%s): %s", tp->name, next->address,
2271 expand_string_message);
2274 else ok = (Ustrcmp(batch_id, bid) == 0);
2277 /* Take address into batch if OK. */
2281 *anchor = next->next; /* Include the address */
2287 else anchor = &(next->next); /* Skip the address */
2291 /* We now have one or more addresses that can be delivered in a batch. Check
2292 whether the transport is prepared to accept a message of this size. If not,
2293 fail them all forthwith. If the expansion fails, or does not yield an
2294 integer, defer delivery. */
2296 if (tp->message_size_limit != NULL)
2298 int rc = check_message_size(tp, addr);
2301 replicate_status(addr);
2302 while (addr != NULL)
2305 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2308 continue; /* With next batch of addresses */
2312 /* If we are not running the queue, or if forcing, all deliveries will be
2313 attempted. Otherwise, we must respect the retry times for each address. Even
2314 when not doing this, we need to set up the retry key string, and determine
2315 whether a retry record exists, because after a successful delivery, a delete
2316 retry item must be set up. Keep the retry database open only for the duration
2317 of these checks, rather than for all local deliveries, because some local
2318 deliveries (e.g. to pipes) can take a substantial time. */
2320 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2321 if (dbm_file == NULL)
2323 DEBUG(D_deliver|D_retry|D_hints_lookup)
2324 debug_printf("no retry data available\n");
2329 while (addr2 != NULL)
2331 BOOL ok = TRUE; /* to deliver this address */
2334 /* Set up the retry key to include the domain or not, and change its
2335 leading character from "R" to "T". Must make a copy before doing this,
2336 because the old key may be pointed to from a "delete" retry item after
2339 retry_key = string_copy(
2340 (tp->retry_use_local_part)? addr2->address_retry_key :
2341 addr2->domain_retry_key);
2344 /* Inspect the retry data. If there is no hints file, delivery happens. */
2346 if (dbm_file != NULL)
2348 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2350 /* If there is no retry record, delivery happens. If there is,
2351 remember it exists so it can be deleted after a successful delivery. */
2353 if (retry_record != NULL)
2355 setflag(addr2, af_lt_retry_exists);
2357 /* A retry record exists for this address. If queue running and not
2358 forcing, inspect its contents. If the record is too old, or if its
2359 retry time has come, or if it has passed its cutoff time, delivery
2364 debug_printf("retry record exists: age=%s ",
2365 readconf_printtime(now - retry_record->time_stamp));
2366 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2367 debug_printf(" time to retry = %s expired = %d\n",
2368 readconf_printtime(retry_record->next_try - now),
2369 retry_record->expired);
2372 if (queue_running && !deliver_force)
2374 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2375 (now >= retry_record->next_try) ||
2376 retry_record->expired;
2378 /* If we haven't reached the retry time, there is one more check
2379 to do, which is for the ultimate address timeout. */
2383 retry_config *retry =
2384 retry_find_config(retry_key+2, addr2->domain,
2385 retry_record->basic_errno,
2386 retry_record->more_errno);
2388 DEBUG(D_deliver|D_retry)
2390 debug_printf("retry time not reached for %s: "
2391 "checking ultimate address timeout\n", addr2->address);
2392 debug_printf(" now=%d first_failed=%d next_try=%d expired=%d\n",
2393 (int)now, (int)retry_record->first_failed,
2394 (int)retry_record->next_try, retry_record->expired);
2397 if (retry != NULL && retry->rules != NULL)
2399 retry_rule *last_rule;
2400 for (last_rule = retry->rules;
2401 last_rule->next != NULL;
2402 last_rule = last_rule->next);
2403 DEBUG(D_deliver|D_retry)
2404 debug_printf(" received_time=%d diff=%d timeout=%d\n",
2405 received_time, (int)now - received_time, last_rule->timeout);
2406 if (now - received_time > last_rule->timeout) ok = TRUE;
2410 DEBUG(D_deliver|D_retry)
2411 debug_printf("no retry rule found: assume timed out\n");
2412 ok = TRUE; /* No rule => timed out */
2415 DEBUG(D_deliver|D_retry)
2417 if (ok) debug_printf("on queue longer than maximum retry for "
2418 "address - allowing delivery\n");
2423 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2426 /* This address is to be delivered. Leave it on the chain. */
2431 addr2 = addr2->next;
2434 /* This address is to be deferred. Take it out of the chain, and
2435 post-process it as complete. Must take it out of the chain first,
2436 because post processing puts it on another chain. */
2440 address_item *this = addr2;
2441 this->message = US"Retry time not yet reached";
2442 this->basic_errno = ERRNO_LRETRY;
2443 if (addr3 == NULL) addr2 = addr = addr2->next;
2444 else addr2 = addr3->next = addr2->next;
2445 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2449 if (dbm_file != NULL) dbfn_close(dbm_file);
2451 /* If there are no addresses left on the chain, they all deferred. Loop
2452 for the next set of addresses. */
2454 if (addr == NULL) continue;
2456 /* So, finally, we do have some addresses that can be passed to the
2457 transport. Before doing so, set up variables that are relevant to a
2460 deliver_set_expansions(addr);
2461 delivery_start = time(NULL);
2462 deliver_local(addr, FALSE);
2463 deliver_time = (int)(time(NULL) - delivery_start);
2465 /* If a shadow transport (which must perforce be another local transport), is
2466 defined, and its condition is met, we must pass the message to the shadow
2467 too, but only those addresses that succeeded. We do this by making a new
2468 chain of addresses - also to keep the original chain uncontaminated. We must
2469 use a chain rather than doing it one by one, because the shadow transport may
2472 NOTE: if the condition fails because of a lookup defer, there is nothing we
2475 if (tp->shadow != NULL &&
2476 (tp->shadow_condition == NULL ||
2477 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2479 transport_instance *stp;
2480 address_item *shadow_addr = NULL;
2481 address_item **last = &shadow_addr;
2483 for (stp = transports; stp != NULL; stp = stp->next)
2484 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2487 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2490 /* Pick off the addresses that have succeeded, and make clones. Put into
2491 the shadow_message field a pointer to the shadow_message field of the real
2494 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2496 if (addr2->transport_return != OK) continue;
2497 addr3 = store_get(sizeof(address_item));
2500 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2501 addr3->transport = stp;
2502 addr3->transport_return = DEFER;
2503 addr3->return_filename = NULL;
2504 addr3->return_file = -1;
2506 last = &(addr3->next);
2509 /* If we found any addresses to shadow, run the delivery, and stick any
2510 message back into the shadow_message field in the original. */
2512 if (shadow_addr != NULL)
2514 int save_count = transport_count;
2516 DEBUG(D_deliver|D_transport)
2517 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2518 deliver_local(shadow_addr, TRUE);
2520 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2522 int sresult = shadow_addr->transport_return;
2523 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2524 string_sprintf(" ST=%s", stp->name) :
2525 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2526 (shadow_addr->basic_errno <= 0)?
2527 US"" : US strerror(shadow_addr->basic_errno),
2528 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2530 (shadow_addr->message != NULL)? shadow_addr->message :
2531 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2533 DEBUG(D_deliver|D_transport)
2534 debug_printf("%s shadow transport returned %s for %s\n",
2536 (sresult == OK)? "OK" :
2537 (sresult == DEFER)? "DEFER" :
2538 (sresult == FAIL)? "FAIL" :
2539 (sresult == PANIC)? "PANIC" : "?",
2540 shadow_addr->address);
2543 DEBUG(D_deliver|D_transport)
2544 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2546 transport_count = save_count; /* Restore original transport count */
2550 /* Cancel the expansions that were set up for the delivery. */
2552 deliver_set_expansions(NULL);
2554 /* Now we can process the results of the real transport. We must take each
2555 address off the chain first, because post_process_one() puts it on another
2558 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2560 int result = addr2->transport_return;
2561 nextaddr = addr2->next;
2563 DEBUG(D_deliver|D_transport)
2564 debug_printf("%s transport returned %s for %s\n",
2566 (result == OK)? "OK" :
2567 (result == DEFER)? "DEFER" :
2568 (result == FAIL)? "FAIL" :
2569 (result == PANIC)? "PANIC" : "?",
2572 /* If there is a retry_record, or if delivery is deferred, build a retry
2573 item for setting a new retry time or deleting the old retry record from
2574 the database. These items are handled all together after all addresses
2575 have been handled (so the database is open just for a short time for
2578 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2580 int flags = (result == DEFER)? 0 : rf_delete;
2581 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2582 addr2->address_retry_key : addr2->domain_retry_key);
2584 retry_add_item(addr2, retry_key, flags);
2587 /* Done with this address */
2589 if (result == OK) addr2->more_errno = deliver_time;
2590 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2592 /* If a pipe delivery generated text to be sent back, the result may be
2593 changed to FAIL, and we must copy this for subsequent addresses in the
2596 if (addr2->transport_return != result)
2598 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2600 addr3->transport_return = addr2->transport_return;
2601 addr3->basic_errno = addr2->basic_errno;
2602 addr3->message = addr2->message;
2604 result = addr2->transport_return;
2607 /* Whether or not the result was changed to FAIL, we need to copy the
2608 return_file value from the first address into all the addresses of the
2609 batch, so they are all listed in the error message. */
2611 addr2->return_file = addr->return_file;
2613 /* Change log character for recording successful deliveries. */
2615 if (result == OK) logchar = '-';
2617 } /* Loop back for next batch of addresses */
2623 /*************************************************
2624 * Sort remote deliveries *
2625 *************************************************/
2627 /* This function is called if remote_sort_domains is set. It arranges that the
2628 chain of addresses for remote deliveries is ordered according to the strings
2629 specified. Try to make this shuffling reasonably efficient by handling
2630 sequences of addresses rather than just single ones.
2637 sort_remote_deliveries(void)
2640 address_item **aptr = &addr_remote;
2641 uschar *listptr = remote_sort_domains;
2645 while (*aptr != NULL &&
2646 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2649 address_item *moved = NULL;
2650 address_item **bptr = &moved;
2652 while (*aptr != NULL)
2654 address_item **next;
2655 deliver_domain = (*aptr)->domain; /* set $domain */
2656 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2657 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2659 aptr = &((*aptr)->next);
2663 next = &((*aptr)->next);
2664 while (*next != NULL &&
2665 (deliver_domain = (*next)->domain, /* Set $domain */
2666 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2667 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2668 next = &((*next)->next);
2670 /* If the batch of non-matchers is at the end, add on any that were
2671 extracted further up the chain, and end this iteration. Otherwise,
2672 extract them from the chain and hang on the moved chain. */
2684 aptr = &((*aptr)->next);
2687 /* If the loop ended because the final address matched, *aptr will
2688 be NULL. Add on to the end any extracted non-matching addresses. If
2689 *aptr is not NULL, the loop ended via "break" when *next is null, that
2690 is, there was a string of non-matching addresses at the end. In this
2691 case the extracted addresses have already been added on the end. */
2693 if (*aptr == NULL) *aptr = moved;
2699 debug_printf("remote addresses after sorting:\n");
2700 for (addr = addr_remote; addr != NULL; addr = addr->next)
2701 debug_printf(" %s\n", addr->address);
2707 /*************************************************
2708 * Read from pipe for remote delivery subprocess *
2709 *************************************************/
2711 /* This function is called when the subprocess is complete, but can also be
2712 called before it is complete, in order to empty a pipe that is full (to prevent
2713 deadlock). It must therefore keep track of its progress in the parlist data
2716 We read the pipe to get the delivery status codes and a possible error message
2717 for each address, optionally preceded by unusability data for the hosts and
2718 also by optional retry data.
2720 Read in large chunks into the big buffer and then scan through, interpreting
2721 the data therein. In most cases, only a single read will be necessary. No
2722 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2723 that we read the next chunk when there is less than 2500 bytes left in the
2724 non-final chunk, we can assume each item is complete in the buffer before
2725 handling it. Each item is written using a single write(), which is atomic for
2726 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2727 often bigger) so even if we are reading while the subprocess is still going, we
2728 should never have only a partial item in the buffer.
2731 poffset the offset of the parlist item
2732 eop TRUE if the process has completed
2734 Returns: TRUE if the terminating 'Z' item has been read,
2735 or there has been a disaster (i.e. no more data needed);
2740 par_read_pipe(int poffset, BOOL eop)
2743 pardata *p = parlist + poffset;
2744 address_item *addrlist = p->addrlist;
2745 address_item *addr = p->addr;
2748 uschar *endptr = big_buffer;
2749 uschar *ptr = endptr;
2750 uschar *msg = p->msg;
2751 BOOL done = p->done;
2752 BOOL unfinished = TRUE;
2754 /* Loop through all items, reading from the pipe when necessary. The pipe
2755 is set up to be non-blocking, but there are two different Unix mechanisms in
2756 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2757 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2758 which returns 0 for both end of file and no more data. We distinguish the
2759 two cases by taking 0 as end of file only when we know the process has
2762 Each separate item is written to the pipe in a single write(), and as they are
2763 all short items, the writes will all be atomic and we should never find
2764 ourselves in the position of having read an incomplete item. "Short" in this
2765 case can mean up to about 1K in the case when there is a long error message
2766 associated with an address. */
2768 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2769 (int)p->pid, eop? "ended" : "not ended");
2773 retry_item *r, **rp;
2774 int remaining = endptr - ptr;
2776 /* Read (first time) or top up the chars in the buffer if necessary.
2777 There will be only one read if we get all the available data (i.e. don't
2778 fill the buffer completely). */
2780 if (remaining < 2500 && unfinished)
2783 int available = big_buffer_size - remaining;
2785 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2788 endptr = big_buffer + remaining;
2789 len = read(fd, endptr, available);
2791 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2793 /* If the result is EAGAIN and the process is not complete, just
2794 stop reading any more and process what we have already. */
2798 if (!eop && errno == EAGAIN) len = 0; else
2800 msg = string_sprintf("failed to read pipe from transport process "
2801 "%d for transport %s: %s", pid, addr->transport->driver_name,
2807 /* If the length is zero (eof or no-more-data), just process what we
2808 already have. Note that if the process is still running and we have
2809 read all the data in the pipe (but less that "available") then we
2810 won't read any more, as "unfinished" will get set FALSE. */
2813 unfinished = len == available;
2816 /* If we are at the end of the available data, exit the loop. */
2818 if (ptr >= endptr) break;
2820 /* Handle each possible type of item, assuming the complete item is
2821 available in store. */
2825 /* Host items exist only if any hosts were marked unusable. Match
2826 up by checking the IP address. */
2829 for (h = addrlist->host_list; h != NULL; h = h->next)
2831 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2839 /* Retry items are sent in a preceding R item for each address. This is
2840 kept separate to keep each message short enough to guarantee it won't
2841 be split in the pipe. Hopefully, in the majority of cases, there won't in
2842 fact be any retry items at all.
2844 The complete set of retry items might include an item to delete a
2845 routing retry if there was a previous routing delay. However, routing
2846 retries are also used when a remote transport identifies an address error.
2847 In that case, there may also be an "add" item for the same key. Arrange
2848 that a "delete" item is dropped in favour of an "add" item. */
2851 if (addr == NULL) goto ADDR_MISMATCH;
2853 DEBUG(D_deliver|D_retry)
2854 debug_printf("reading retry information for %s from subprocess\n",
2857 /* Cut out any "delete" items on the list. */
2859 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2861 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2863 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2864 *rp = r->next; /* Excise a delete item */
2865 DEBUG(D_deliver|D_retry)
2866 debug_printf(" existing delete item dropped\n");
2870 /* We want to add a delete item only if there is no non-delete item;
2871 however we still have to step ptr through the data. */
2873 if (r == NULL || (*ptr & rf_delete) == 0)
2875 r = store_get(sizeof(retry_item));
2876 r->next = addr->retries;
2879 r->key = string_copy(ptr);
2881 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
2882 ptr += sizeof(r->basic_errno);
2883 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
2884 ptr += sizeof(r->more_errno);
2885 r->message = (*ptr)? string_copy(ptr) : NULL;
2886 DEBUG(D_deliver|D_retry)
2887 debug_printf(" added %s item\n",
2888 ((r->flags & rf_delete) == 0)? "retry" : "delete");
2893 DEBUG(D_deliver|D_retry)
2894 debug_printf(" delete item not added: non-delete item exists\n");
2897 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
2903 /* Put the amount of data written into the parlist block */
2906 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
2907 ptr += sizeof(transport_count);
2910 /* Address items are in the order of items on the address chain. We
2911 remember the current address value in case this function is called
2912 several times to empty the pipe in stages. Information about delivery
2913 over TLS is sent in a preceding X item for each address. We don't put
2914 it in with the other info, in order to keep each message short enough to
2915 guarantee it won't be split in the pipe. */
2919 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
2920 addr->cipher = (*ptr)? string_copy(ptr) : NULL;
2922 addr->peerdn = (*ptr)? string_copy(ptr) : NULL;
2927 case 'C': /* client authenticator information */
2931 smtp_authenticated = TRUE;
2932 client_authenticator = (*ptr)? string_copy(ptr) : NULL;
2935 client_authenticated_id = (*ptr)? string_copy(ptr) : NULL;
2938 client_authenticated_sender = (*ptr)? string_copy(ptr) : NULL;
2948 msg = string_sprintf("address count mismatch for data read from pipe "
2949 "for transport process %d for transport %s", pid,
2950 addrlist->transport->driver_name);
2955 addr->transport_return = *ptr++;
2956 addr->special_action = *ptr++;
2957 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
2958 ptr += sizeof(addr->basic_errno);
2959 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
2960 ptr += sizeof(addr->more_errno);
2961 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
2962 ptr += sizeof(addr->flags);
2963 addr->message = (*ptr)? string_copy(ptr) : NULL;
2965 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
2968 /* Always two strings for host information, followed by the port number */
2972 h = store_get(sizeof(host_item));
2973 h->name = string_copy(ptr);
2975 h->address = string_copy(ptr);
2977 memcpy(&(h->port), ptr, sizeof(h->port));
2978 ptr += sizeof(h->port);
2979 addr->host_used = h;
2983 /* Finished with this address */
2988 /* Z marks the logical end of the data. It is followed by '0' if
2989 continue_transport was NULL at the end of transporting, otherwise '1'.
2990 We need to know when it becomes NULL during a delivery down a passed SMTP
2991 channel so that we don't try to pass anything more down it. Of course, for
2992 most normal messages it will remain NULL all the time. */
2997 continue_transport = NULL;
2998 continue_hostname = NULL;
3001 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3004 /* Anything else is a disaster. */
3007 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3008 "process %d for transport %s", ptr[-1], pid,
3009 addr->transport->driver_name);
3015 /* The done flag is inspected externally, to determine whether or not to
3016 call the function again when the process finishes. */
3020 /* If the process hadn't finished, and we haven't seen the end of the data
3021 or suffered a disaster, update the rest of the state, and return FALSE to
3022 indicate "not finished". */
3031 /* Close our end of the pipe, to prevent deadlock if the far end is still
3032 pushing stuff into it. */
3037 /* If we have finished without error, but haven't had data for every address,
3038 something is wrong. */
3040 if (msg == NULL && addr != NULL)
3041 msg = string_sprintf("insufficient address data read from pipe "
3042 "for transport process %d for transport %s", pid,
3043 addr->transport->driver_name);
3045 /* If an error message is set, something has gone wrong in getting back
3046 the delivery data. Put the message into each address and freeze it. */
3050 for (addr = addrlist; addr != NULL; addr = addr->next)
3052 addr->transport_return = DEFER;
3053 addr->special_action = SPECIAL_FREEZE;
3054 addr->message = msg;
3058 /* Return TRUE to indicate we have got all we need from this process, even
3059 if it hasn't actually finished yet. */
3066 /*************************************************
3067 * Post-process a set of remote addresses *
3068 *************************************************/
3070 /* Do what has to be done immediately after a remote delivery for each set of
3071 addresses, then re-write the spool if necessary. Note that post_process_one
3072 puts the address on an appropriate queue; hence we must fish off the next
3073 one first. This function is also called if there is a problem with setting
3074 up a subprocess to do a remote delivery in parallel. In this case, the final
3075 argument contains a message, and the action must be forced to DEFER.
3078 addr pointer to chain of address items
3079 logflags flags for logging
3080 msg NULL for normal cases; -> error message for unexpected problems
3081 fallback TRUE if processing fallback hosts
3087 remote_post_process(address_item *addr, int logflags, uschar *msg,
3092 /* If any host addresses were found to be unusable, add them to the unusable
3093 tree so that subsequent deliveries don't try them. */
3095 for (h = addr->host_list; h != NULL; h = h->next)
3097 if (h->address == NULL) continue;
3098 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3101 /* Now handle each address on the chain. The transport has placed '=' or '-'
3102 into the special_action field for each successful delivery. */
3104 while (addr != NULL)
3106 address_item *next = addr->next;
3108 /* If msg == NULL (normal processing) and the result is DEFER and we are
3109 processing the main hosts and there are fallback hosts available, put the
3110 address on the list for fallback delivery. */
3112 if (addr->transport_return == DEFER &&
3113 addr->fallback_hosts != NULL &&
3117 addr->host_list = addr->fallback_hosts;
3118 addr->next = addr_fallback;
3119 addr_fallback = addr;
3120 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3123 /* If msg is set (=> unexpected problem), set it in the address before
3124 doing the ordinary post processing. */
3130 addr->message = msg;
3131 addr->transport_return = DEFER;
3133 (void)post_process_one(addr, addr->transport_return, logflags,
3134 DTYPE_TRANSPORT, addr->special_action);
3142 /* If we have just delivered down a passed SMTP channel, and that was
3143 the last address, the channel will have been closed down. Now that
3144 we have logged that delivery, set continue_sequence to 1 so that
3145 any subsequent deliveries don't get "*" incorrectly logged. */
3147 if (continue_transport == NULL) continue_sequence = 1;
3152 /*************************************************
3153 * Wait for one remote delivery subprocess *
3154 *************************************************/
3156 /* This function is called while doing remote deliveries when either the
3157 maximum number of processes exist and we need one to complete so that another
3158 can be created, or when waiting for the last ones to complete. It must wait for
3159 the completion of one subprocess, empty the control block slot, and return a
3160 pointer to the address chain.
3163 Returns: pointer to the chain of addresses handled by the process;
3164 NULL if no subprocess found - this is an unexpected error
3167 static address_item *
3170 int poffset, status;
3171 address_item *addr, *addrlist;
3174 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3175 "to finish", message_id);
3177 /* Loop until either a subprocess completes, or there are no subprocesses in
3178 existence - in which case give an error return. We cannot proceed just by
3179 waiting for a completion, because a subprocess may have filled up its pipe, and
3180 be waiting for it to be emptied. Therefore, if no processes have finished, we
3181 wait for one of the pipes to acquire some data by calling select(), with a
3182 timeout just in case.
3184 The simple approach is just to iterate after reading data from a ready pipe.
3185 This leads to non-ideal behaviour when the subprocess has written its final Z
3186 item, closed the pipe, and is in the process of exiting (the common case). A
3187 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3188 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3191 To avoid this, if all the data that is needed has been read from a subprocess
3192 after select(), an explicit wait() for it is done. We know that all it is doing
3193 is writing to the pipe and then exiting, so the wait should not be long.
3195 The non-blocking waitpid() is to some extent just insurance; if we could
3196 reliably detect end-of-file on the pipe, we could always know when to do a
3197 blocking wait() for a completed process. However, because some systems use
3198 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3199 use code that functions without the need to recognize EOF.
3201 There's a double loop here just in case we end up with a process that is not in
3202 the list of remote delivery processes. Something has obviously gone wrong if
3203 this is the case. (For example, a process that is incorrectly left over from
3204 routing or local deliveries might be found.) The damage can be minimized by
3205 looping back and looking for another process. If there aren't any, the error
3206 return will happen. */
3208 for (;;) /* Normally we do not repeat this loop */
3210 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3213 fd_set select_pipes;
3214 int maxpipe, readycount;
3216 /* A return value of -1 can mean several things. If errno != ECHILD, it
3217 either means invalid options (which we discount), or that this process was
3218 interrupted by a signal. Just loop to try the waitpid() again.
3220 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3221 in existence. This should never happen, and is an unexpected error.
3222 However, there is a nasty complication when running under Linux. If "strace
3223 -f" is being used under Linux to trace this process and its children,
3224 subprocesses are "stolen" from their parents and become the children of the
3225 tracing process. A general wait such as the one we've just obeyed returns
3226 as if there are no children while subprocesses are running. Once a
3227 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3228 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3231 This does not happen using "truss" on Solaris, nor (I think) with other
3232 tracing facilities on other OS. It seems to be specific to Linux.
3234 What we do to get round this is to use kill() to see if any of our
3235 subprocesses are still in existence. If kill() gives an OK return, we know
3236 it must be for one of our processes - it can't be for a re-use of the pid,
3237 because if our process had finished, waitpid() would have found it. If any
3238 of our subprocesses are in existence, we proceed to use select() as if
3239 waitpid() had returned zero. I think this is safe. */
3243 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3246 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3247 "for process existence\n");
3249 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3251 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3253 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3254 "stolen by strace\n", (int)pid);
3255 break; /* With poffset set */
3259 if (poffset >= remote_max_parallel)
3261 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3262 return NULL; /* This is the error return */
3266 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3267 been handled above. A return value of zero means that there is at least one
3268 subprocess, but there are no completed subprocesses. See if any pipes are
3269 ready with any data for reading. */
3271 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3274 FD_ZERO(&select_pipes);
3275 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3277 if (parlist[poffset].pid != 0)
3279 int fd = parlist[poffset].fd;
3280 FD_SET(fd, &select_pipes);
3281 if (fd > maxpipe) maxpipe = fd;
3285 /* Stick in a 60-second timeout, just in case. */
3290 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3293 /* Scan through the pipes and read any that are ready; use the count
3294 returned by select() to stop when there are no more. Select() can return
3295 with no processes (e.g. if interrupted). This shouldn't matter.
3297 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3298 read, or there was a disaster. In either case, we are finished with this
3299 process. Do an explicit wait() for the process and break the main loop if
3302 It turns out that we have to deal with the case of an interrupted system
3303 call, which can happen on some operating systems if the signal handling is
3304 set up to do that by default. */
3307 readycount > 0 && poffset < remote_max_parallel;
3310 if ((pid = parlist[poffset].pid) != 0 &&
3311 FD_ISSET(parlist[poffset].fd, &select_pipes))
3314 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3316 for (;;) /* Loop for signals */
3318 pid_t endedpid = waitpid(pid, &status, 0);
3319 if (endedpid == pid) goto PROCESS_DONE;
3320 if (endedpid != (pid_t)(-1) || errno != EINTR)
3321 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3322 "%d (errno = %d) from waitpid() for process %d",
3323 (int)endedpid, errno, (int)pid);
3329 /* Now go back and look for a completed subprocess again. */
3332 /* A completed process was detected by the non-blocking waitpid(). Find the
3333 data block that corresponds to this subprocess. */
3335 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3336 if (pid == parlist[poffset].pid) break;
3338 /* Found the data block; this is a known remote delivery process. We don't
3339 need to repeat the outer loop. This should be what normally happens. */
3341 if (poffset < remote_max_parallel) break;
3343 /* This situation is an error, but it's probably better to carry on looking
3344 for another process than to give up (as we used to do). */
3346 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3347 "transport process list", pid);
3348 } /* End of the "for" loop */
3350 /* Come here when all the data was completely read after a select(), and
3351 the process in pid has been wait()ed for. */
3358 debug_printf("remote delivery process %d ended\n", (int)pid);
3360 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3364 set_process_info("delivering %s", message_id);
3366 /* Get the chain of processed addresses */
3368 addrlist = parlist[poffset].addrlist;
3370 /* If the process did not finish cleanly, record an error and freeze (except
3371 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3372 in case the delivery did actually happen. */
3374 if ((status & 0xffff) != 0)
3377 int msb = (status >> 8) & 255;
3378 int lsb = status & 255;
3379 int code = (msb == 0)? (lsb & 0x7f) : msb;
3381 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3383 addrlist->transport->driver_name,
3385 (msb == 0)? "terminated by signal" : "exit code",
3388 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3389 addrlist->special_action = SPECIAL_FREEZE;
3391 for (addr = addrlist; addr != NULL; addr = addr->next)
3393 addr->transport_return = DEFER;
3394 addr->message = msg;
3397 remove_journal = FALSE;
3400 /* Else complete reading the pipe to get the result of the delivery, if all
3401 the data has not yet been obtained. */
3403 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3405 /* Put the data count and return path into globals, mark the data slot unused,
3406 decrement the count of subprocesses, and return the address chain. */
3408 transport_count = parlist[poffset].transport_count;
3409 used_return_path = parlist[poffset].return_path;
3410 parlist[poffset].pid = 0;
3417 /*************************************************
3418 * Wait for subprocesses and post-process *
3419 *************************************************/
3421 /* This function waits for subprocesses until the number that are still running
3422 is below a given threshold. For each complete subprocess, the addresses are
3423 post-processed. If we can't find a running process, there is some shambles.
3424 Better not bomb out, as that might lead to multiple copies of the message. Just
3425 log and proceed as if all done.
3428 max maximum number of subprocesses to leave running
3429 fallback TRUE if processing fallback hosts
3435 par_reduce(int max, BOOL fallback)
3437 while (parcount > max)
3439 address_item *doneaddr = par_wait();
3440 if (doneaddr == NULL)
3442 log_write(0, LOG_MAIN|LOG_PANIC,
3443 "remote delivery process count got out of step");
3446 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3453 /*************************************************
3454 * Do remote deliveries *
3455 *************************************************/
3457 /* This function is called to process the addresses in addr_remote. We must
3458 pick off the queue all addresses that have the same transport, remote
3459 destination, and errors address, and hand them to the transport in one go,
3460 subject to some configured limitations. If this is a run to continue delivering
3461 to an existing delivery channel, skip all but those addresses that can go to
3462 that channel. The skipped addresses just get deferred.
3464 If mua_wrapper is set, all addresses must be able to be sent in a single
3465 transaction. If not, this function yields FALSE.
3467 In Exim 4, remote deliveries are always done in separate processes, even
3468 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3469 is so that the base process can retain privilege. This makes the
3470 implementation of fallback transports feasible (though not initially done.)
3472 We create up to the configured number of subprocesses, each of which passes
3473 back the delivery state via a pipe. (However, when sending down an existing
3474 connection, remote_max_parallel is forced to 1.)
3477 fallback TRUE if processing fallback hosts
3479 Returns: TRUE normally
3480 FALSE if mua_wrapper is set and the addresses cannot all be sent
3485 do_remote_deliveries(BOOL fallback)
3491 parcount = 0; /* Number of executing subprocesses */
3493 /* When sending down an existing channel, only do one delivery at a time.
3494 We use a local variable (parmax) to hold the maximum number of processes;
3495 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3497 if (continue_transport != NULL) remote_max_parallel = 1;
3498 parmax = remote_max_parallel;
3500 /* If the data for keeping a list of processes hasn't yet been
3503 if (parlist == NULL)
3505 parlist = store_get(remote_max_parallel * sizeof(pardata));
3506 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3507 parlist[poffset].pid = 0;
3510 /* Now loop for each remote delivery */
3512 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3518 int address_count = 1;
3519 int address_count_max;
3521 BOOL use_initgroups;
3522 BOOL pipe_done = FALSE;
3523 transport_instance *tp;
3524 address_item **anchor = &addr_remote;
3525 address_item *addr = addr_remote;
3526 address_item *last = addr;
3529 /* Pull the first address right off the list. */
3531 addr_remote = addr->next;
3534 DEBUG(D_deliver|D_transport)
3535 debug_printf("--------> %s <--------\n", addr->address);
3537 /* If no transport has been set, there has been a big screw-up somewhere. */
3539 if ((tp = addr->transport) == NULL)
3541 disable_logging = FALSE; /* Jic */
3542 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3543 US"No transport set by router", fallback);
3547 /* Check that this base address hasn't previously been delivered to this
3548 transport. The check is necessary at this point to handle homonymic addresses
3549 correctly in cases where the pattern of redirection changes between delivery
3550 attempts. Non-homonymic previous delivery is detected earlier, at routing
3553 if (previously_transported(addr, FALSE)) continue;
3555 /* Force failure if the message is too big. */
3557 if (tp->message_size_limit != NULL)
3559 int rc = check_message_size(tp, addr);
3562 addr->transport_return = rc;
3563 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3568 /* Get the flag which specifies whether the transport can handle different
3569 domains that nevertheless resolve to the same set of hosts. */
3571 multi_domain = tp->multi_domain;
3573 /* Get the maximum it can handle in one envelope, with zero meaning
3574 unlimited, which is forced for the MUA wrapper case. */
3576 address_count_max = tp->max_addresses;
3577 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3580 /************************************************************************/
3581 /***** This is slightly experimental code, but should be safe. *****/
3583 /* The address_count_max value is the maximum number of addresses that the
3584 transport can send in one envelope. However, the transport must be capable of
3585 dealing with any number of addresses. If the number it gets exceeds its
3586 envelope limitation, it must send multiple copies of the message. This can be
3587 done over a single connection for SMTP, so uses less resources than making
3588 multiple connections. On the other hand, if remote_max_parallel is greater
3589 than one, it is perhaps a good idea to use parallel processing to move the
3590 message faster, even if that results in multiple simultaneous connections to
3593 How can we come to some compromise between these two ideals? What we do is to
3594 limit the number of addresses passed to a single instance of a transport to
3595 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3596 number of addresses routed to remote transports divided by
3597 remote_max_parallel. For example, if the message has 100 remote recipients,
3598 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3599 once. But if rcpt_max is 100, we could send up to 100.
3601 Of course, not all the remotely addresses in a message are going to go to the
3602 same set of hosts (except in smarthost configurations), so this is just a
3603 heuristic way of dividing up the work.
3605 Furthermore (1), because this may not be wanted in some cases, and also to
3606 cope with really pathological cases, there is also a limit to the number of
3607 messages that are sent over one connection. This is the same limit that is
3608 used when sending several different messages over the same connection.
3609 Continue_sequence is set when in this situation, to the number sent so
3610 far, including this message.
3612 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3613 is probably because they are using VERP, in which case they want to pass only
3614 one address at a time to the transport, in order to be able to use
3615 $local_part and $domain in constructing a new return path. We could test for
3616 the use of these variables, but as it is so likely they will be used when the
3617 maximum is 1, we don't bother. Just leave the value alone. */
3619 if (address_count_max != 1 &&
3620 address_count_max < remote_delivery_count/remote_max_parallel)
3622 int new_max = remote_delivery_count/remote_max_parallel;
3623 int message_max = tp->connection_max_messages;
3624 if (connection_max_messages >= 0) message_max = connection_max_messages;
3625 message_max -= continue_sequence - 1;
3626 if (message_max > 0 && new_max > address_count_max * message_max)
3627 new_max = address_count_max * message_max;
3628 address_count_max = new_max;
3631 /************************************************************************/
3634 /* Pick off all addresses which have the same transport, errors address,
3635 destination, and extra headers. In some cases they point to the same host
3636 list, but we also need to check for identical host lists generated from
3637 entirely different domains. The host list pointers can be NULL in the case
3638 where the hosts are defined in the transport. There is also a configured
3639 maximum limit of addresses that can be handled at once (see comments above
3640 for how it is computed). */
3642 while ((next = *anchor) != NULL && address_count < address_count_max)
3644 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3646 tp == next->transport
3648 same_hosts(next->host_list, addr->host_list)
3650 same_strings(next->p.errors_address, addr->p.errors_address)
3652 same_headers(next->p.extra_headers, addr->p.extra_headers)
3654 same_ugid(tp, next, addr)
3656 (next->p.remove_headers == addr->p.remove_headers ||
3657 (next->p.remove_headers != NULL &&
3658 addr->p.remove_headers != NULL &&
3659 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3661 *anchor = next->next;
3663 next->first = addr; /* remember top one (for retry processing) */
3668 else anchor = &(next->next);
3671 /* If we are acting as an MUA wrapper, all addresses must go in a single
3672 transaction. If not, put them back on the chain and yield FALSE. */
3674 if (mua_wrapper && addr_remote != NULL)
3676 last->next = addr_remote;
3681 /* Set up the expansion variables for this set of addresses */
3683 deliver_set_expansions(addr);
3685 /* Compute the return path, expanding a new one if required. The old one
3686 must be set first, as it might be referred to in the expansion. */
3688 if(addr->p.errors_address != NULL)
3689 return_path = addr->p.errors_address;
3690 #ifdef EXPERIMENTAL_SRS
3691 else if(addr->p.srs_sender != NULL)
3692 return_path = addr->p.srs_sender;
3695 return_path = sender_address;
3697 if (tp->return_path != NULL)
3699 uschar *new_return_path = expand_string(tp->return_path);
3700 if (new_return_path == NULL)
3702 if (!expand_string_forcedfail)
3704 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3705 string_sprintf("Failed to expand return path \"%s\": %s",
3706 tp->return_path, expand_string_message), fallback);
3710 else return_path = new_return_path;
3713 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3714 logs and sets up error messages, so we just post-process and continue with
3715 the next address. */
3717 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3719 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3723 /* If this transport has a setup function, call it now so that it gets
3724 run in this process and not in any subprocess. That way, the results of
3725 any setup that are retained by the transport can be reusable. One of the
3726 things the setup does is to set the fallback host lists in the addresses.
3727 That is why it is called at this point, before the continue delivery
3728 processing, because that might use the fallback hosts. */
3730 if (tp->setup != NULL)
3731 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3733 /* If this is a run to continue delivery down an already-established
3734 channel, check that this set of addresses matches the transport and
3735 the channel. If it does not, defer the addresses. If a host list exists,
3736 we must check that the continue host is on the list. Otherwise, the
3737 host is set in the transport. */
3739 continue_more = FALSE; /* In case got set for the last lot */
3740 if (continue_transport != NULL)
3742 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3743 if (ok && addr->host_list != NULL)
3747 for (h = addr->host_list; h != NULL; h = h->next)
3749 if (Ustrcmp(h->name, continue_hostname) == 0)
3750 { ok = TRUE; break; }
3754 /* Addresses not suitable; defer or queue for fallback hosts (which
3755 might be the continue host) and skip to next address. */
3759 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3762 if (addr->fallback_hosts != NULL && !fallback)
3766 next->host_list = next->fallback_hosts;
3767 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3768 if (next->next == NULL) break;
3771 next->next = addr_fallback;
3772 addr_fallback = addr;
3777 while (next->next != NULL) next = next->next;
3778 next->next = addr_defer;
3785 /* Set a flag indicating whether there are further addresses that list
3786 the continued host. This tells the transport to leave the channel open,
3787 but not to pass it to another delivery process. */
3789 for (next = addr_remote; next != NULL; next = next->next)
3792 for (h = next->host_list; h != NULL; h = h->next)
3794 if (Ustrcmp(h->name, continue_hostname) == 0)
3795 { continue_more = TRUE; break; }
3800 /* The transports set up the process info themselves as they may connect
3801 to more than one remote machine. They also have to set up the filter
3802 arguments, if required, so that the host name and address are available
3805 transport_filter_argv = NULL;
3807 /* Create the pipe for inter-process communication. If pipe creation
3808 fails, it is probably because the value of remote_max_parallel is so
3809 large that too many file descriptors for pipes have been created. Arrange
3810 to wait for a process to finish, and then try again. If we still can't
3811 create a pipe when all processes have finished, break the retry loop. */
3815 if (pipe(pfd) == 0) pipe_done = TRUE;
3816 else if (parcount > 0) parmax = parcount;
3819 /* We need to make the reading end of the pipe non-blocking. There are
3820 two different options for this. Exim is cunningly (I hope!) coded so
3821 that it can use either of them, though it prefers O_NONBLOCK, which
3822 distinguishes between EOF and no-more-data. */
3825 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
3827 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
3830 /* If the maximum number of subprocesses already exist, wait for a process
3831 to finish. If we ran out of file descriptors, parmax will have been reduced
3832 from its initial value of remote_max_parallel. */
3834 par_reduce(parmax - 1, fallback);
3837 /* If we failed to create a pipe and there were no processes to wait
3838 for, we have to give up on this one. Do this outside the above loop
3839 so that we can continue the main loop. */
3843 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3844 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
3848 /* Find a free slot in the pardata list. Must do this after the possible
3849 waiting for processes to finish, because a terminating process will free
3852 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3853 if (parlist[poffset].pid == 0) break;
3855 /* If there isn't one, there has been a horrible disaster. */
3857 if (poffset >= remote_max_parallel)
3859 (void)close(pfd[pipe_write]);
3860 (void)close(pfd[pipe_read]);
3861 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3862 US"Unexpectedly no free subprocess slot", fallback);
3866 /* Now fork a subprocess to do the remote delivery, but before doing so,
3867 ensure that any cached resourses are released so as not to interfere with
3868 what happens in the subprocess. */
3872 if ((pid = fork()) == 0)
3874 int fd = pfd[pipe_write];
3877 /* There are weird circumstances in which logging is disabled */
3879 disable_logging = tp->disable_logging;
3881 /* Show pids on debug output if parallelism possible */
3883 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
3885 DEBUG(D_any|D_v) debug_selector |= D_pid;
3886 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
3889 /* Reset the random number generator, so different processes don't all
3890 have the same sequence. In the test harness we want different, but
3891 predictable settings for each delivery process, so do something explicit
3892 here rather they rely on the fixed reset in the random number function. */
3894 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
3896 /* Set close-on-exec on the pipe so that it doesn't get passed on to
3897 a new process that may be forked to do another delivery down the same
3900 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
3902 /* Close open file descriptors for the pipes of other processes
3903 that are running in parallel. */
3905 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3906 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
3908 /* This process has inherited a copy of the file descriptor
3909 for the data file, but its file pointer is shared with all the
3910 other processes running in parallel. Therefore, we have to re-open
3911 the file in order to get a new file descriptor with its own
3912 file pointer. We don't need to lock it, as the lock is held by
3913 the parent process. There doesn't seem to be any way of doing
3914 a dup-with-new-file-pointer. */
3916 (void)close(deliver_datafile);
3917 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
3919 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
3921 if (deliver_datafile < 0)
3922 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
3923 "parallel delivery: %s", spoolname, strerror(errno));
3925 /* Set the close-on-exec flag */
3927 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
3930 /* Set the uid/gid of this process; bombs out on failure. */
3932 exim_setugid(uid, gid, use_initgroups,
3933 string_sprintf("remote delivery to %s with transport=%s",
3934 addr->address, tp->name));
3936 /* Close the unwanted half of this process' pipe, set the process state,
3937 and run the transport. Afterwards, transport_count will contain the number
3938 of bytes written. */
3940 (void)close(pfd[pipe_read]);
3941 set_process_info("delivering %s using %s", message_id, tp->name);
3942 debug_print_string(tp->debug_string);
3943 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
3945 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
3946 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
3948 /* Ensure any cached resources that we used are now released */
3952 /* Pass the result back down the pipe. This is a lot more information
3953 than is needed for a local delivery. We have to send back the error
3954 status for each address, the usability status for each host that is
3955 flagged as unusable, and all the retry items. When TLS is in use, we
3956 send also the cipher and peerdn information. Each type of information
3957 is flagged by an identifying byte, and is then in a fixed format (with
3958 strings terminated by zeros), and there is a final terminator at the
3959 end. The host information and retry information is all attached to
3960 the first address, so that gets sent at the start. */
3962 /* Host unusability information: for most success cases this will
3965 for (h = addr->host_list; h != NULL; h = h->next)
3967 if (h->address == NULL || h->status < hstatus_unusable) continue;
3968 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
3969 (void)write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
3972 /* The number of bytes written. This is the same for each address. Even
3973 if we sent several copies of the message down the same connection, the
3974 size of each one is the same, and it's that value we have got because
3975 transport_count gets reset before calling transport_write_message(). */
3977 big_buffer[0] = 'S';
3978 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
3979 (void)write(fd, big_buffer, sizeof(transport_count) + 1);
3981 /* Information about what happened to each address. Four item types are
3982 used: an optional 'X' item first, for TLS information, then an optional "C"
3983 item for any client-auth info followed by 'R' items for any retry settings,
3984 and finally an 'A' item for the remaining data. */
3986 for(; addr != NULL; addr = addr->next)
3991 /* The certificate verification status goes into the flags */
3993 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
3995 /* Use an X item only if there's something to send */
3998 if (addr->cipher != NULL)
4001 sprintf(CS ptr, "X%.128s", addr->cipher);
4003 if (addr->peerdn == NULL) *ptr++ = 0; else
4005 sprintf(CS ptr, "%.512s", addr->peerdn);
4008 (void)write(fd, big_buffer, ptr - big_buffer);
4012 if (client_authenticator)
4015 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4017 (void)write(fd, big_buffer, ptr - big_buffer);
4019 if (client_authenticated_id)
4022 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4024 (void)write(fd, big_buffer, ptr - big_buffer);
4026 if (client_authenticated_sender)
4029 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4031 (void)write(fd, big_buffer, ptr - big_buffer);
4034 /* Retry information: for most success cases this will be null. */
4036 for (r = addr->retries; r != NULL; r = r->next)
4039 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4040 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4041 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4042 ptr += sizeof(r->basic_errno);
4043 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4044 ptr += sizeof(r->more_errno);
4045 if (r->message == NULL) *ptr++ = 0; else
4047 sprintf(CS ptr, "%.512s", r->message);
4050 (void)write(fd, big_buffer, ptr - big_buffer);
4053 /* The rest of the information goes in an 'A' item. */
4055 ptr = big_buffer + 3;
4056 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4057 addr->special_action);
4058 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4059 ptr += sizeof(addr->basic_errno);
4060 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4061 ptr += sizeof(addr->more_errno);
4062 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4063 ptr += sizeof(addr->flags);
4065 if (addr->message == NULL) *ptr++ = 0; else
4067 sprintf(CS ptr, "%.1024s", addr->message);
4071 if (addr->user_message == NULL) *ptr++ = 0; else
4073 sprintf(CS ptr, "%.1024s", addr->user_message);
4077 if (addr->host_used == NULL) *ptr++ = 0; else
4079 sprintf(CS ptr, "%.256s", addr->host_used->name);
4081 sprintf(CS ptr, "%.64s", addr->host_used->address);
4083 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4084 ptr += sizeof(addr->host_used->port);
4086 (void)write(fd, big_buffer, ptr - big_buffer);
4089 /* Add termination flag, close the pipe, and that's it. The character
4090 after 'Z' indicates whether continue_transport is now NULL or not.
4091 A change from non-NULL to NULL indicates a problem with a continuing
4094 big_buffer[0] = 'Z';
4095 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4096 (void)write(fd, big_buffer, 2);
4101 /* Back in the mainline: close the unwanted half of the pipe. */
4103 (void)close(pfd[pipe_write]);
4105 /* Fork failed; defer with error message */
4109 (void)close(pfd[pipe_read]);
4110 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4111 string_sprintf("fork failed for remote delivery to %s: %s",
4112 addr->domain, strerror(errno)), fallback);
4116 /* Fork succeeded; increment the count, and remember relevant data for
4117 when the process finishes. */
4120 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4121 parlist[poffset].pid = pid;
4122 parlist[poffset].fd = pfd[pipe_read];
4123 parlist[poffset].done = FALSE;
4124 parlist[poffset].msg = NULL;
4125 parlist[poffset].return_path = return_path;
4127 /* If the process we've just started is sending a message down an existing
4128 channel, wait for it now. This ensures that only one such process runs at
4129 once, whatever the value of remote_max parallel. Otherwise, we might try to
4130 send two or more messages simultaneously down the same channel. This could
4131 happen if there are different domains that include the same host in otherwise
4132 different host lists.
4134 Also, if the transport closes down the channel, this information gets back
4135 (continue_transport gets set to NULL) before we consider any other addresses
4138 if (continue_transport != NULL) par_reduce(0, fallback);
4140 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4141 newly created process get going before we create another process. This should
4142 ensure repeatability in the tests. We only need to wait a tad. */
4144 else if (running_in_test_harness) millisleep(500);
4147 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4148 are still running and post-process their addresses. */
4150 par_reduce(0, fallback);
4157 /*************************************************
4158 * Split an address into local part and domain *
4159 *************************************************/
4161 /* This function initializes an address for routing by splitting it up into a
4162 local part and a domain. The local part is set up twice - once in its original
4163 casing, and once in lower case, and it is dequoted. We also do the "percent
4164 hack" for configured domains. This may lead to a DEFER result if a lookup
4165 defers. When a percent-hacking takes place, we insert a copy of the original
4166 address as a new parent of this address, as if we have had a redirection.
4169 addr points to an addr_item block containing the address
4172 DEFER - could not determine if domain is %-hackable
4176 deliver_split_address(address_item *addr)
4178 uschar *address = addr->address;
4179 uschar *domain = Ustrrchr(address, '@');
4181 int len = domain - address;
4183 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4185 /* The implication in the RFCs (though I can't say I've seen it spelled out
4186 explicitly) is that quoting should be removed from local parts at the point
4187 where they are locally interpreted. [The new draft "821" is more explicit on
4188 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4189 removing quoting backslashes and any unquoted doublequotes. */
4191 t = addr->cc_local_part = store_get(len+1);
4194 register int c = *address++;
4195 if (c == '\"') continue;
4205 /* We do the percent hack only for those domains that are listed in
4206 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4208 if (percent_hack_domains != NULL)
4211 uschar *new_address = NULL;
4212 uschar *local_part = addr->cc_local_part;
4214 deliver_domain = addr->domain; /* set $domain */
4216 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4217 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4219 (t = Ustrrchr(local_part, '%')) != NULL)
4221 new_address = string_copy(local_part);
4222 new_address[t - local_part] = '@';
4223 deliver_domain = string_copylc(t+1);
4224 local_part = string_copyn(local_part, t - local_part);
4227 if (rc == DEFER) return DEFER; /* lookup deferred */
4229 /* If hackery happened, set up new parent and alter the current address. */
4231 if (new_address != NULL)
4233 address_item *new_parent = store_get(sizeof(address_item));
4234 *new_parent = *addr;
4235 addr->parent = new_parent;
4236 addr->address = new_address;
4237 addr->unique = string_copy(new_address);
4238 addr->domain = deliver_domain;
4239 addr->cc_local_part = local_part;
4240 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4245 /* Create the lowercased version of the final local part, and make that the
4246 default one to be used. */
4248 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4255 /*************************************************
4256 * Get next error message text *
4257 *************************************************/
4259 /* If f is not NULL, read the next "paragraph", from a customized error message
4260 text file, terminated by a line containing ****, and expand it.
4263 f NULL or a file to read from
4264 which string indicating which string (for errors)
4266 Returns: NULL or an expanded string
4270 next_emf(FILE *f, uschar *which)
4274 uschar *para, *yield;
4277 if (f == NULL) return NULL;
4279 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4280 Ustrcmp(buffer, "****\n") == 0) return NULL;
4282 para = store_get(size);
4285 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4286 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4287 Ustrcmp(buffer, "****\n") == 0) break;
4291 yield = expand_string(para);
4292 if (yield != NULL) return yield;
4294 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4295 "bounce_message_file or warn_message_file (%s): %s", which,
4296 expand_string_message);
4303 /*************************************************
4304 * Close down a passed transport channel *
4305 *************************************************/
4307 /* This function is called when a passed transport channel cannot be used.
4308 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4309 so that the function call can be the argument of a "return" statement.
4312 Returns: DELIVER_NOT_ATTEMPTED
4316 continue_closedown(void)
4318 if (continue_transport != NULL)
4320 transport_instance *t;
4321 for (t = transports; t != NULL; t = t->next)
4323 if (Ustrcmp(t->name, continue_transport) == 0)
4325 if (t->info->closedown != NULL) (t->info->closedown)(t);
4330 return DELIVER_NOT_ATTEMPTED;
4336 /*************************************************
4337 * Print address information *
4338 *************************************************/
4340 /* This function is called to output an address, or information about an
4341 address, for bounce or defer messages. If the hide_child flag is set, all we
4342 output is the original ancestor address.
4345 addr points to the address
4346 f the FILE to print to
4347 si an initial string
4348 sc a continuation string for before "generated"
4351 Returns: TRUE if the address is not hidden
4355 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4359 uschar *printed = US"";
4360 address_item *ancestor = addr;
4361 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4363 fprintf(f, "%s", CS si);
4365 if (addr->parent != NULL && testflag(addr, af_hide_child))
4367 printed = US"an undisclosed address";
4370 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4371 printed = addr->address;
4375 uschar *s = addr->address;
4378 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4379 else if (addr->address[0] == '|') ss = US"pipe";
4382 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4383 printed = addr->parent->address;
4386 fprintf(f, "%s", CS string_printing(printed));
4388 if (ancestor != addr)
4390 uschar *original = (ancestor->onetime_parent == NULL)?
4391 ancestor->address : ancestor->onetime_parent;
4392 if (strcmpic(original, printed) != 0)
4393 fprintf(f, "%s(%sgenerated from %s)", sc,
4394 (ancestor != addr->parent)? "ultimately " : "",
4395 string_printing(original));
4398 fprintf(f, "%s", CS se);
4406 /*************************************************
4407 * Print error for an address *
4408 *************************************************/
4410 /* This function is called to print the error information out of an address for
4411 a bounce or a warning message. It tries to format the message reasonably by
4412 introducing newlines. All lines are indented by 4; the initial printing
4413 position must be set before calling.
4415 This function used always to print the error. Nowadays we want to restrict it
4416 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4417 and filter "fail". We no longer pass other information willy-nilly in bounce
4418 and warning messages. Text in user_message is always output; text in message
4419 only if the af_pass_message flag is set.
4423 f the FILE to print on
4430 print_address_error(address_item *addr, FILE *f, uschar *t)
4432 int count = Ustrlen(t);
4433 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4437 if (addr->user_message != NULL) s = addr->user_message; else return;
4440 fprintf(f, "\n %s", t);
4444 if (*s == '\\' && s[1] == 'n')
4454 if (*s++ == ':' && isspace(*s) && count > 45)
4456 fprintf(f, "\n "); /* sic (because space follows) */
4468 /*************************************************
4469 * Check list of addresses for duplication *
4470 *************************************************/
4472 /* This function was introduced when the test for duplicate addresses that are
4473 not pipes, files, or autoreplies was moved from the middle of routing to when
4474 routing was complete. That was to fix obscure cases when the routing history
4475 affects the subsequent routing of identical addresses. This function is called
4476 after routing, to check that the final routed addresses are not duplicates.
4478 If we detect a duplicate, we remember what it is a duplicate of. Note that
4479 pipe, file, and autoreply de-duplication is handled during routing, so we must
4480 leave such "addresses" alone here, as otherwise they will incorrectly be
4483 Argument: address of list anchor
4488 do_duplicate_check(address_item **anchor)
4491 while ((addr = *anchor) != NULL)
4494 if (testflag(addr, af_pfr))
4496 anchor = &(addr->next);
4498 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4500 DEBUG(D_deliver|D_route)
4501 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4502 *anchor = addr->next;
4503 addr->dupof = tnode->data.ptr;
4504 addr->next = addr_duplicate;
4505 addr_duplicate = addr;
4509 tree_add_duplicate(addr->unique, addr);
4510 anchor = &(addr->next);
4518 /*************************************************
4519 * Deliver one message *
4520 *************************************************/
4522 /* This is the function which is called when a message is to be delivered. It
4523 is passed the id of the message. It is possible that the message no longer
4524 exists, if some other process has delivered it, and it is also possible that
4525 the message is being worked on by another process, in which case the data file
4528 If no delivery is attempted for any of the above reasons, the function returns
4529 DELIVER_NOT_ATTEMPTED.
4531 If the give_up flag is set true, do not attempt any deliveries, but instead
4532 fail all outstanding addresses and return the message to the sender (or
4535 A delivery operation has a process all to itself; we never deliver more than
4536 one message in the same process. Therefore we needn't worry too much about
4540 id the id of the message to be delivered
4541 forced TRUE if delivery was forced by an administrator; this overrides
4542 retry delays and causes a delivery to be tried regardless
4543 give_up TRUE if an administrator has requested that delivery attempts
4546 Returns: When the global variable mua_wrapper is FALSE:
4547 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4548 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4549 When the global variable mua_wrapper is TRUE:
4550 DELIVER_MUA_SUCCEEDED if delivery succeeded
4551 DELIVER_MUA_FAILED if delivery failed
4552 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4556 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4559 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4560 time_t now = time(NULL);
4561 address_item *addr_last = NULL;
4562 uschar *filter_message = NULL;
4564 int process_recipients = RECIP_ACCEPT;
4567 extern int acl_where;
4569 uschar *info = (queue_run_pid == (pid_t)0)?
4570 string_sprintf("delivering %s", id) :
4571 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4573 /* If the D_process_info bit is on, set_process_info() will output debugging
4574 information. If not, we want to show this initial information if D_deliver or
4575 D_queue_run is set or in verbose mode. */
4577 set_process_info("%s", info);
4579 if ((debug_selector & D_process_info) == 0 &&
4580 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4581 debug_printf("%s\n", info);
4583 /* Ensure that we catch any subprocesses that are created. Although Exim
4584 sets SIG_DFL as its initial default, some routes through the code end up
4585 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4586 has been forked, but no re-exec has been done. We use sigaction rather than
4587 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4588 sure it is turned off. (There was a problem on AIX with this.) */
4592 struct sigaction act;
4593 act.sa_handler = SIG_DFL;
4594 sigemptyset(&(act.sa_mask));
4596 sigaction(SIGCHLD, &act, NULL);
4599 signal(SIGCHLD, SIG_DFL);
4602 /* Make the forcing flag available for routers and transports, set up the
4603 global message id field, and initialize the count for returned files and the
4604 message size. This use of strcpy() is OK because the length id is checked when
4605 it is obtained from a command line (the -M or -q options), and otherwise it is
4606 known to be a valid message id. */
4608 Ustrcpy(message_id, id);
4609 deliver_force = forced;
4613 /* Initialize some flags */
4615 update_spool = FALSE;
4616 remove_journal = TRUE;
4618 /* Set a known context for any ACLs we call via expansions */
4619 acl_where = ACL_WHERE_DELIVERY;
4621 /* Reset the random number generator, so that if several delivery processes are
4622 started from a queue runner that has already used random numbers (for sorting),
4623 they don't all get the same sequence. */
4627 /* Open and lock the message's data file. Exim locks on this one because the
4628 header file may get replaced as it is re-written during the delivery process.
4629 Any failures cause messages to be written to the log, except for missing files
4630 while queue running - another process probably completed delivery. As part of
4631 opening the data file, message_subdir gets set. */
4633 if (!spool_open_datafile(id))
4634 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4636 /* The value of message_size at this point has been set to the data length,
4637 plus one for the blank line that notionally precedes the data. */
4639 /* Now read the contents of the header file, which will set up the headers in
4640 store, and also the list of recipients and the tree of non-recipients and
4641 assorted flags. It updates message_size. If there is a reading or format error,
4642 give up; if the message has been around for sufficiently long, remove it. */
4644 sprintf(CS spoolname, "%s-H", id);
4645 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4647 if (errno == ERRNO_SPOOLFORMAT)
4649 struct stat statbuf;
4650 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4652 if (Ustat(big_buffer, &statbuf) == 0)
4653 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4654 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4655 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4658 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4661 /* If we managed to read the envelope data, received_time contains the
4662 time the message was received. Otherwise, we can calculate it from the
4665 if (rc != spool_read_hdrerror)
4668 for (i = 0; i < 6; i++)
4669 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4672 /* If we've had this malformed message too long, sling it. */
4674 if (now - received_time > keep_malformed)
4676 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4678 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4680 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4682 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4684 log_write(0, LOG_MAIN, "Message removed because older than %s",
4685 readconf_printtime(keep_malformed));
4688 (void)close(deliver_datafile);
4689 deliver_datafile = -1;
4690 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4693 /* The spool header file has been read. Look to see if there is an existing
4694 journal file for this message. If there is, it means that a previous delivery
4695 attempt crashed (program or host) before it could update the spool header file.
4696 Read the list of delivered addresses from the journal and add them to the
4697 nonrecipients tree. Then update the spool file. We can leave the journal in
4698 existence, as it will get further successful deliveries added to it in this
4699 run, and it will be deleted if this function gets to its end successfully.
4700 Otherwise it might be needed again. */
4702 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4703 jread = Ufopen(spoolname, "rb");
4706 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4708 int n = Ustrlen(big_buffer);
4709 big_buffer[n-1] = 0;
4710 tree_add_nonrecipient(big_buffer);
4711 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4712 "journal file\n", big_buffer);
4714 (void)fclose(jread);
4715 /* Panic-dies on error */
4716 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4718 else if (errno != ENOENT)
4720 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4721 "%s", strerror(errno));
4722 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4725 /* A null recipients list indicates some kind of disaster. */
4727 if (recipients_list == NULL)
4729 (void)close(deliver_datafile);
4730 deliver_datafile = -1;
4731 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4732 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4736 /* Handle a message that is frozen. There are a number of different things that
4737 can happen, but in the default situation, unless forced, no delivery is
4742 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4743 /* Moving to another directory removes the message from Exim's view. Other
4744 tools must be used to deal with it. Logging of this action happens in
4745 spool_move_message() and its subfunctions. */
4747 if (move_frozen_messages &&
4748 spool_move_message(id, message_subdir, US"", US"F"))
4749 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4752 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4753 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4754 flag causing all recipients to be failed. The time is the age of the
4755 message, not the time since freezing. */
4757 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
4759 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
4760 process_recipients = RECIP_FAIL_TIMEOUT;
4763 /* For bounce messages (and others with no sender), thaw if the error message
4764 ignore timer is exceeded. The message will be discarded if this delivery
4767 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
4769 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
4772 /* If this is a bounce message, or there's no auto thaw, or we haven't
4773 reached the auto thaw time yet, and this delivery is not forced by an admin
4774 user, do not attempt delivery of this message. Note that forced is set for
4775 continuing messages down the same channel, in order to skip load checking and
4776 ignore hold domains, but we don't want unfreezing in that case. */
4780 if ((sender_address[0] == 0 ||
4782 now <= deliver_frozen_at + auto_thaw
4785 (!forced || !deliver_force_thaw || !admin_user ||
4786 continue_hostname != NULL
4789 (void)close(deliver_datafile);
4790 deliver_datafile = -1;
4791 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
4792 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4795 /* If delivery was forced (by an admin user), assume a manual thaw.
4796 Otherwise it's an auto thaw. */
4800 deliver_manual_thaw = TRUE;
4801 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
4803 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
4806 /* We get here if any of the rules for unfreezing have triggered. */
4808 deliver_freeze = FALSE;
4809 update_spool = TRUE;
4813 /* Open the message log file if we are using them. This records details of
4814 deliveries, deferments, and failures for the benefit of the mail administrator.
4815 The log is not used by exim itself to track the progress of a message; that is
4816 done by rewriting the header spool file. */
4823 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4824 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
4828 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
4829 spoolname, strerror(errno));
4830 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4833 /* Make a C stream out of it. */
4835 message_log = fdopen(fd, "a");
4836 if (message_log == NULL)
4838 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
4839 spoolname, strerror(errno));
4840 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4845 /* If asked to give up on a message, log who did it, and set the action for all
4850 struct passwd *pw = getpwuid(real_uid);
4851 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
4852 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
4853 process_recipients = RECIP_FAIL;
4856 /* Otherwise, if there are too many Received: headers, fail all recipients. */
4858 else if (received_count > received_headers_max)
4859 process_recipients = RECIP_FAIL_LOOP;
4861 /* Otherwise, if a system-wide, address-independent message filter is
4862 specified, run it now, except in the case when we are failing all recipients as
4863 a result of timeout_frozen_after. If the system filter yields "delivered", then
4864 ignore the true recipients of the message. Failure of the filter file is
4865 logged, and the delivery attempt fails. */
4867 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
4872 redirect_block redirect;
4874 if (system_filter_uid_set)
4876 ugid.uid = system_filter_uid;
4877 ugid.gid = system_filter_gid;
4878 ugid.uid_set = ugid.gid_set = TRUE;
4882 ugid.uid_set = ugid.gid_set = FALSE;
4885 return_path = sender_address;
4886 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
4887 system_filtering = TRUE;
4889 /* Any error in the filter file causes a delivery to be abandoned. */
4891 redirect.string = system_filter;
4892 redirect.isfile = TRUE;
4893 redirect.check_owner = redirect.check_group = FALSE;
4894 redirect.owners = NULL;
4895 redirect.owngroups = NULL;
4897 redirect.modemask = 0;
4899 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
4902 &redirect, /* Where the data is */
4903 RDO_DEFER | /* Turn on all the enabling options */
4904 RDO_FAIL | /* Leave off all the disabling options */
4909 NULL, /* No :include: restriction (not used in filter) */
4910 NULL, /* No sieve vacation directory (not sieve!) */
4911 NULL, /* No sieve enotify mailto owner (not sieve!) */
4912 NULL, /* No sieve user address (not sieve!) */
4913 NULL, /* No sieve subaddress (not sieve!) */
4914 &ugid, /* uid/gid data */
4915 &addr_new, /* Where to hang generated addresses */
4916 &filter_message, /* Where to put error message */
4917 NULL, /* Don't skip syntax errors */
4918 &filtertype, /* Will always be set to FILTER_EXIM for this call */
4919 US"system filter"); /* For error messages */
4921 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
4923 if (rc == FF_ERROR || rc == FF_NONEXIST)
4925 (void)close(deliver_datafile);
4926 deliver_datafile = -1;
4927 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
4928 string_printing(filter_message));
4929 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4932 /* Reset things. If the filter message is an empty string, which can happen
4933 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
4935 system_filtering = FALSE;
4936 enable_dollar_recipients = FALSE;
4937 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
4939 /* Save the values of the system filter variables so that user filters
4942 memcpy(filter_sn, filter_n, sizeof(filter_sn));
4944 /* The filter can request that delivery of the original addresses be
4949 process_recipients = RECIP_DEFER;
4950 deliver_msglog("Delivery deferred by system filter\n");
4951 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
4954 /* The filter can request that a message be frozen, but this does not
4955 take place if the message has been manually thawed. In that case, we must
4956 unset "delivered", which is forced by the "freeze" command to make -bF
4959 else if (rc == FF_FREEZE && !deliver_manual_thaw)
4961 deliver_freeze = TRUE;
4962 deliver_frozen_at = time(NULL);
4963 process_recipients = RECIP_DEFER;
4964 frozen_info = string_sprintf(" by the system filter%s%s",
4965 (filter_message == NULL)? US"" : US": ",
4966 (filter_message == NULL)? US"" : filter_message);
4969 /* The filter can request that a message be failed. The error message may be
4970 quite long - it is sent back to the sender in the bounce - but we don't want
4971 to fill up the log with repetitions of it. If it starts with << then the text
4972 between << and >> is written to the log, with the rest left for the bounce
4975 else if (rc == FF_FAIL)
4977 uschar *colon = US"";
4978 uschar *logmsg = US"";
4981 process_recipients = RECIP_FAIL_FILTER;
4983 if (filter_message != NULL)
4987 if (filter_message[0] == '<' && filter_message[1] == '<' &&
4988 (logend = Ustrstr(filter_message, ">>")) != NULL)
4990 logmsg = filter_message + 2;
4991 loglen = logend - logmsg;
4992 filter_message = logend + 2;
4993 if (filter_message[0] == 0) filter_message = NULL;
4997 logmsg = filter_message;
4998 loglen = Ustrlen(filter_message);
5002 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5006 /* Delivery can be restricted only to those recipients (if any) that the
5007 filter specified. */
5009 else if (rc == FF_DELIVERED)
5011 process_recipients = RECIP_IGNORE;
5012 if (addr_new == NULL)
5013 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5015 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5018 /* If any new addresses were created by the filter, fake up a "parent"
5019 for them. This is necessary for pipes, etc., which are expected to have
5020 parents, and it also gives some sensible logging for others. Allow
5021 pipes, files, and autoreplies, and run them as the filter uid if set,
5022 otherwise as the current uid. */
5024 if (addr_new != NULL)
5026 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5027 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5029 /* The text "system-filter" is tested in transport_set_up_command() and in
5030 set_up_shell_command() in the pipe transport, to enable them to permit
5031 $recipients, so don't change it here without also changing it there. */
5033 address_item *p = addr_new;
5034 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5036 parent->domain = string_copylc(qualify_domain_recipient);
5037 parent->local_part = US"system-filter";
5039 /* As part of this loop, we arrange for addr_last to end up pointing
5040 at the final address. This is used if we go on to add addresses for the
5041 original recipients. */
5045 if (parent->child_count == SHRT_MAX)
5046 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5047 "than %d delivery addresses", SHRT_MAX);
5048 parent->child_count++;
5051 if (testflag(p, af_pfr))
5057 setflag(p, af_uid_set |
5063 /* Find the name of the system filter's appropriate pfr transport */
5065 if (p->address[0] == '|')
5068 tpname = system_filter_pipe_transport;
5069 address_pipe = p->address;
5071 else if (p->address[0] == '>')
5074 tpname = system_filter_reply_transport;
5078 if (p->address[Ustrlen(p->address)-1] == '/')
5080 type = US"directory";
5081 tpname = system_filter_directory_transport;
5086 tpname = system_filter_file_transport;
5088 address_file = p->address;
5091 /* Now find the actual transport, first expanding the name. We have
5092 set address_file or address_pipe above. */
5096 uschar *tmp = expand_string(tpname);
5097 address_file = address_pipe = NULL;
5099 p->message = string_sprintf("failed to expand \"%s\" as a "
5100 "system filter transport name", tpname);
5105 p->message = string_sprintf("system_filter_%s_transport is unset",
5111 transport_instance *tp;
5112 for (tp = transports; tp != NULL; tp = tp->next)
5114 if (Ustrcmp(tp->name, tpname) == 0)
5121 p->message = string_sprintf("failed to find \"%s\" transport "
5122 "for system filter delivery", tpname);
5125 /* If we couldn't set up a transport, defer the delivery, putting the
5126 error on the panic log as well as the main log. */
5128 if (p->transport == NULL)
5130 address_item *badp = p;
5132 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5133 badp->local_part = badp->address; /* Needed for log line */
5134 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5137 } /* End of pfr handling */
5139 /* Either a non-pfr delivery, or we found a transport */
5141 DEBUG(D_deliver|D_filter)
5142 debug_printf("system filter added %s\n", p->address);
5146 } /* Loop through all addr_new addresses */
5151 /* Scan the recipients list, and for every one that is not in the non-
5152 recipients tree, add an addr item to the chain of new addresses. If the pno
5153 value is non-negative, we must set the onetime parent from it. This which
5154 points to the relevant entry in the recipients list.
5156 This processing can be altered by the setting of the process_recipients
5157 variable, which is changed if recipients are to be ignored, failed, or
5158 deferred. This can happen as a result of system filter activity, or if the -Mg
5159 option is used to fail all of them.
5161 Duplicate addresses are handled later by a different tree structure; we can't
5162 just extend the non-recipients tree, because that will be re-written to the
5163 spool if the message is deferred, and in any case there are casing
5164 complications for local addresses. */
5166 if (process_recipients != RECIP_IGNORE)
5168 for (i = 0; i < recipients_count; i++)
5170 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5172 recipient_item *r = recipients_list + i;
5173 address_item *new = deliver_make_addr(r->address, FALSE);
5174 new->p.errors_address = r->errors_to;
5177 new->onetime_parent = recipients_list[r->pno].address;
5179 switch (process_recipients)
5181 /* RECIP_DEFER is set when a system filter freezes a message. */
5184 new->next = addr_defer;
5189 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5192 case RECIP_FAIL_FILTER:
5194 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5195 setflag(new, af_pass_message);
5196 goto RECIP_QUEUE_FAILED; /* below */
5199 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5200 than the value in timeout_frozen_after. Treat non-bounce messages
5201 similarly to -Mg; for bounce messages we just want to discard, so
5202 don't put the address on the failed list. The timeout has already
5205 case RECIP_FAIL_TIMEOUT:
5206 new->message = US"delivery cancelled; message timed out";
5207 goto RECIP_QUEUE_FAILED; /* below */
5210 /* RECIP_FAIL is set when -Mg has been used. */
5213 new->message = US"delivery cancelled by administrator";
5216 /* Common code for the failure cases above. If this is not a bounce
5217 message, put the address on the failed list so that it is used to
5218 create a bounce. Otherwise do nothing - this just discards the address.
5219 The incident has already been logged. */
5222 if (sender_address[0] != 0)
5224 new->next = addr_failed;
5230 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5231 in the message. Process each address as a routing failure; if this
5232 is a bounce message, it will get frozen. */
5234 case RECIP_FAIL_LOOP:
5235 new->message = US"Too many \"Received\" headers - suspected mail loop";
5236 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5240 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5243 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5253 address_item *p = addr_new;
5254 debug_printf("Delivery address list:\n");
5257 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5263 /* Set up the buffers used for copying over the file when delivering. */
5265 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5266 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5270 /* Until there are no more new addresses, handle each one as follows:
5272 . If this is a generated address (indicated by the presence of a parent
5273 pointer) then check to see whether it is a pipe, file, or autoreply, and
5274 if so, handle it directly here. The router that produced the address will
5275 have set the allow flags into the address, and also set the uid/gid required.
5276 Having the routers generate new addresses and then checking them here at
5277 the outer level is tidier than making each router do the checking, and
5278 means that routers don't need access to the failed address queue.
5280 . Break up the address into local part and domain, and make lowercased
5281 versions of these strings. We also make unquoted versions of the local part.
5283 . Handle the percent hack for those domains for which it is valid.
5285 . For child addresses, determine if any of the parents have the same address.
5286 If so, generate a different string for previous delivery checking. Without
5287 this code, if the address spqr generates spqr via a forward or alias file,
5288 delivery of the generated spqr stops further attempts at the top level spqr,
5289 which is not what is wanted - it may have generated other addresses.
5291 . Check on the retry database to see if routing was previously deferred, but
5292 only if in a queue run. Addresses that are to be routed are put on the
5293 addr_route chain. Addresses that are to be deferred are put on the
5294 addr_defer chain. We do all the checking first, so as not to keep the
5295 retry database open any longer than necessary.
5297 . Now we run the addresses through the routers. A router may put the address
5298 on either the addr_local or the addr_remote chain for local or remote
5299 delivery, respectively, or put it on the addr_failed chain if it is
5300 undeliveable, or it may generate child addresses and put them on the
5301 addr_new chain, or it may defer an address. All the chain anchors are
5302 passed as arguments so that the routers can be called for verification
5305 . If new addresses have been generated by the routers, da capo.
5308 header_rewritten = FALSE; /* No headers rewritten yet */
5309 while (addr_new != NULL) /* Loop until all addresses dealt with */
5311 address_item *addr, *parent;
5312 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5314 /* Failure to open the retry database is treated the same as if it does
5315 not exist. In both cases, dbm_file is NULL. */
5317 if (dbm_file == NULL)
5319 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5320 debug_printf("no retry data available\n");
5323 /* Scan the current batch of new addresses, to handle pipes, files and
5324 autoreplies, and determine which others are ready for routing. */
5326 while (addr_new != NULL)
5331 dbdata_retry *domain_retry_record;
5332 dbdata_retry *address_retry_record;
5335 addr_new = addr->next;
5337 DEBUG(D_deliver|D_retry|D_route)
5339 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5340 debug_printf("Considering: %s\n", addr->address);
5343 /* Handle generated address that is a pipe or a file or an autoreply. */
5345 if (testflag(addr, af_pfr))
5347 /* If an autoreply in a filter could not generate a syntactically valid
5348 address, give up forthwith. Set af_ignore_error so that we don't try to
5349 generate a bounce. */
5351 if (testflag(addr, af_bad_reply))
5353 addr->basic_errno = ERRNO_BADADDRESS2;
5354 addr->local_part = addr->address;
5356 US"filter autoreply generated syntactically invalid recipient";
5357 setflag(addr, af_ignore_error);
5358 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5359 continue; /* with the next new address */
5362 /* If two different users specify delivery to the same pipe or file or
5363 autoreply, there should be two different deliveries, so build a unique
5364 string that incorporates the original address, and use this for
5365 duplicate testing and recording delivery, and also for retrying. */
5368 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5369 (testflag(addr->parent, af_homonym)? 3:0));
5371 addr->address_retry_key = addr->domain_retry_key =
5372 string_sprintf("T:%s", addr->unique);
5374 /* If a filter file specifies two deliveries to the same pipe or file,
5375 we want to de-duplicate, but this is probably not wanted for two mail
5376 commands to the same address, where probably both should be delivered.
5377 So, we have to invent a different unique string in that case. Just
5378 keep piling '>' characters on the front. */
5380 if (addr->address[0] == '>')
5382 while (tree_search(tree_duplicates, addr->unique) != NULL)
5383 addr->unique = string_sprintf(">%s", addr->unique);
5386 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5388 DEBUG(D_deliver|D_route)
5389 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5390 addr->dupof = tnode->data.ptr;
5391 addr->next = addr_duplicate;
5392 addr_duplicate = addr;
5396 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5398 /* Check for previous delivery */
5400 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5402 DEBUG(D_deliver|D_route)
5403 debug_printf("%s was previously delivered: discarded\n", addr->address);
5404 child_done(addr, tod_stamp(tod_log));
5408 /* Save for checking future duplicates */
5410 tree_add_duplicate(addr->unique, addr);
5412 /* Set local part and domain */
5414 addr->local_part = addr->address;
5415 addr->domain = addr->parent->domain;
5417 /* Ensure that the delivery is permitted. */
5419 if (testflag(addr, af_file))
5421 if (!testflag(addr, af_allow_file))
5423 addr->basic_errno = ERRNO_FORBIDFILE;
5424 addr->message = US"delivery to file forbidden";
5425 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5426 continue; /* with the next new address */
5429 else if (addr->address[0] == '|')
5431 if (!testflag(addr, af_allow_pipe))
5433 addr->basic_errno = ERRNO_FORBIDPIPE;
5434 addr->message = US"delivery to pipe forbidden";
5435 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5436 continue; /* with the next new address */
5439 else if (!testflag(addr, af_allow_reply))
5441 addr->basic_errno = ERRNO_FORBIDREPLY;
5442 addr->message = US"autoreply forbidden";
5443 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5444 continue; /* with the next new address */
5447 /* If the errno field is already set to BADTRANSPORT, it indicates
5448 failure to expand a transport string, or find the associated transport,
5449 or an unset transport when one is required. Leave this test till now so
5450 that the forbid errors are given in preference. */
5452 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5454 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5458 /* Treat /dev/null as a special case and abandon the delivery. This
5459 avoids having to specify a uid on the transport just for this case.
5460 Arrange for the transport name to be logged as "**bypassed**". */
5462 if (Ustrcmp(addr->address, "/dev/null") == 0)
5464 uschar *save = addr->transport->name;
5465 addr->transport->name = US"**bypassed**";
5466 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5467 addr->transport->name = save;
5468 continue; /* with the next new address */
5471 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5474 DEBUG(D_deliver|D_route)
5475 debug_printf("queued for %s transport\n", addr->transport->name);
5476 addr->next = addr_local;
5478 continue; /* with the next new address */
5481 /* Handle normal addresses. First, split up into local part and domain,
5482 handling the %-hack if necessary. There is the possibility of a defer from
5483 a lookup in percent_hack_domains. */
5485 if ((rc = deliver_split_address(addr)) == DEFER)
5487 addr->message = US"cannot check percent_hack_domains";
5488 addr->basic_errno = ERRNO_LISTDEFER;
5489 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5493 /* Check to see if the domain is held. If so, proceed only if the
5494 delivery was forced by hand. */
5496 deliver_domain = addr->domain; /* set $domain */
5497 if (!forced && hold_domains != NULL &&
5498 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5499 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5504 addr->message = US"hold_domains lookup deferred";
5505 addr->basic_errno = ERRNO_LISTDEFER;
5509 addr->message = US"domain is held";
5510 addr->basic_errno = ERRNO_HELD;
5512 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5516 /* Now we can check for duplicates and previously delivered addresses. In
5517 order to do this, we have to generate a "unique" value for each address,
5518 because there may be identical actual addresses in a line of descendents.
5519 The "unique" field is initialized to the same value as the "address" field,
5520 but gets changed here to cope with identically-named descendents. */
5522 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5523 if (strcmpic(addr->address, parent->address) == 0) break;
5525 /* If there's an ancestor with the same name, set the homonym flag. This
5526 influences how deliveries are recorded. Then add a prefix on the front of
5527 the unique address. We use \n\ where n starts at 0 and increases each time.
5528 It is unlikely to pass 9, but if it does, it may look odd but will still
5529 work. This means that siblings or cousins with the same names are treated
5530 as duplicates, which is what we want. */
5534 setflag(addr, af_homonym);
5535 if (parent->unique[0] != '\\')
5536 addr->unique = string_sprintf("\\0\\%s", addr->address);
5538 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5542 /* Ensure that the domain in the unique field is lower cased, because
5543 domains are always handled caselessly. */
5545 p = Ustrrchr(addr->unique, '@');
5546 while (*p != 0) { *p = tolower(*p); p++; }
5548 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5550 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5552 DEBUG(D_deliver|D_route)
5553 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5554 child_done(addr, tod_stamp(tod_log));
5558 /* Get the routing retry status, saving the two retry keys (with and
5559 without the local part) for subsequent use. If there is no retry record for
5560 the standard address routing retry key, we look for the same key with the
5561 sender attached, because this form is used by the smtp transport after a
5562 4xx response to RCPT when address_retry_include_sender is true. */
5564 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5565 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5568 if (dbm_file == NULL)
5569 domain_retry_record = address_retry_record = NULL;
5572 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5573 if (domain_retry_record != NULL &&
5574 now - domain_retry_record->time_stamp > retry_data_expire)
5575 domain_retry_record = NULL; /* Ignore if too old */
5577 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5578 if (address_retry_record != NULL &&
5579 now - address_retry_record->time_stamp > retry_data_expire)
5580 address_retry_record = NULL; /* Ignore if too old */
5582 if (address_retry_record == NULL)
5584 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5586 address_retry_record = dbfn_read(dbm_file, altkey);
5587 if (address_retry_record != NULL &&
5588 now - address_retry_record->time_stamp > retry_data_expire)
5589 address_retry_record = NULL; /* Ignore if too old */
5593 DEBUG(D_deliver|D_retry)
5595 if (domain_retry_record == NULL)
5596 debug_printf("no domain retry record\n");
5597 if (address_retry_record == NULL)
5598 debug_printf("no address retry record\n");
5601 /* If we are sending a message down an existing SMTP connection, we must
5602 assume that the message which created the connection managed to route
5603 an address to that connection. We do not want to run the risk of taking
5604 a long time over routing here, because if we do, the server at the other
5605 end of the connection may time it out. This is especially true for messages
5606 with lots of addresses. For this kind of delivery, queue_running is not
5607 set, so we would normally route all addresses. We take a pragmatic approach
5608 and defer routing any addresses that have any kind of domain retry record.
5609 That is, we don't even look at their retry times. It doesn't matter if this
5610 doesn't work occasionally. This is all just an optimization, after all.
5612 The reason for not doing the same for address retries is that they normally
5613 arise from 4xx responses, not DNS timeouts. */
5615 if (continue_hostname != NULL && domain_retry_record != NULL)
5617 addr->message = US"reusing SMTP connection skips previous routing defer";
5618 addr->basic_errno = ERRNO_RRETRY;
5619 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5622 /* If we are in a queue run, defer routing unless there is no retry data or
5623 we've passed the next retry time, or this message is forced. In other
5624 words, ignore retry data when not in a queue run.
5626 However, if the domain retry time has expired, always allow the routing
5627 attempt. If it fails again, the address will be failed. This ensures that
5628 each address is routed at least once, even after long-term routing
5631 If there is an address retry, check that too; just wait for the next
5632 retry time. This helps with the case when the temporary error on the
5633 address was really message-specific rather than address specific, since
5634 it allows other messages through.
5636 We also wait for the next retry time if this is a message sent down an
5637 existing SMTP connection (even though that will be forced). Otherwise there
5638 will be far too many attempts for an address that gets a 4xx error. In
5639 fact, after such an error, we should not get here because, the host should
5640 not be remembered as one this message needs. However, there was a bug that
5641 used to cause this to happen, so it is best to be on the safe side. */
5643 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5645 ((domain_retry_record != NULL &&
5646 now < domain_retry_record->next_try &&
5647 !domain_retry_record->expired)
5649 (address_retry_record != NULL &&
5650 now < address_retry_record->next_try))
5653 addr->message = US"retry time not reached";
5654 addr->basic_errno = ERRNO_RRETRY;
5655 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5658 /* The domain is OK for routing. Remember if retry data exists so it
5659 can be cleaned up after a successful delivery. */
5663 if (domain_retry_record != NULL || address_retry_record != NULL)
5664 setflag(addr, af_dr_retry_exists);
5665 addr->next = addr_route;
5667 DEBUG(D_deliver|D_route)
5668 debug_printf("%s: queued for routing\n", addr->address);
5672 /* The database is closed while routing is actually happening. Requests to
5673 update it are put on a chain and all processed together at the end. */
5675 if (dbm_file != NULL) dbfn_close(dbm_file);
5677 /* If queue_domains is set, we don't even want to try routing addresses in
5678 those domains. During queue runs, queue_domains is forced to be unset.
5679 Optimize by skipping this pass through the addresses if nothing is set. */
5681 if (!deliver_force && queue_domains != NULL)
5683 address_item *okaddr = NULL;
5684 while (addr_route != NULL)
5686 address_item *addr = addr_route;
5687 addr_route = addr->next;
5689 deliver_domain = addr->domain; /* set $domain */
5690 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5691 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5696 addr->basic_errno = ERRNO_LISTDEFER;
5697 addr->message = US"queue_domains lookup deferred";
5698 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5702 addr->next = okaddr;
5708 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5709 addr->message = US"domain is in queue_domains";
5710 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5714 addr_route = okaddr;
5717 /* Now route those addresses that are not deferred. */
5719 while (addr_route != NULL)
5722 address_item *addr = addr_route;
5723 uschar *old_domain = addr->domain;
5724 uschar *old_unique = addr->unique;
5725 addr_route = addr->next;
5728 /* Just in case some router parameter refers to it. */
5730 return_path = (addr->p.errors_address != NULL)?
5731 addr->p.errors_address : sender_address;
5733 /* If a router defers an address, add a retry item. Whether or not to
5734 use the local part in the key is a property of the router. */
5736 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
5737 &addr_succeed, v_none)) == DEFER)
5738 retry_add_item(addr, (addr->router->retry_use_local_part)?
5739 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
5740 string_sprintf("R:%s", addr->domain), 0);
5742 /* Otherwise, if there is an existing retry record in the database, add
5743 retry items to delete both forms. We must also allow for the possibility
5744 of a routing retry that includes the sender address. Since the domain might
5745 have been rewritten (expanded to fully qualified) as a result of routing,
5746 ensure that the rewritten form is also deleted. */
5748 else if (testflag(addr, af_dr_retry_exists))
5750 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5752 retry_add_item(addr, altkey, rf_delete);
5753 retry_add_item(addr, addr->address_retry_key, rf_delete);
5754 retry_add_item(addr, addr->domain_retry_key, rf_delete);
5755 if (Ustrcmp(addr->domain, old_domain) != 0)
5756 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
5759 /* DISCARD is given for :blackhole: and "seen finish". The event has been
5760 logged, but we need to ensure the address (and maybe parents) is marked
5765 address_done(addr, tod_stamp(tod_log));
5766 continue; /* route next address */
5769 /* The address is finished with (failed or deferred). */
5773 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
5774 continue; /* route next address */
5777 /* The address has been routed. If the router changed the domain, it will
5778 also have changed the unique address. We have to test whether this address
5779 has already been delivered, because it's the unique address that finally
5782 if (addr->unique != old_unique &&
5783 tree_search(tree_nonrecipients, addr->unique) != 0)
5785 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
5786 "discarded\n", addr->address);
5787 if (addr_remote == addr) addr_remote = addr->next;
5788 else if (addr_local == addr) addr_local = addr->next;
5791 /* If the router has same_domain_copy_routing set, we are permitted to copy
5792 the routing for any other addresses with the same domain. This is an
5793 optimisation to save repeated DNS lookups for "standard" remote domain
5794 routing. The option is settable only on routers that generate host lists.
5795 We play it very safe, and do the optimization only if the address is routed
5796 to a remote transport, there are no header changes, and the domain was not
5797 modified by the router. */
5799 if (addr_remote == addr &&
5800 addr->router->same_domain_copy_routing &&
5801 addr->p.extra_headers == NULL &&
5802 addr->p.remove_headers == NULL &&
5803 old_domain == addr->domain)
5805 address_item **chain = &addr_route;
5806 while (*chain != NULL)
5808 address_item *addr2 = *chain;
5809 if (Ustrcmp(addr2->domain, addr->domain) != 0)
5811 chain = &(addr2->next);
5815 /* Found a suitable address; take it off the routing list and add it to
5816 the remote delivery list. */
5818 *chain = addr2->next;
5819 addr2->next = addr_remote;
5820 addr_remote = addr2;
5822 /* Copy the routing data */
5824 addr2->domain = addr->domain;
5825 addr2->router = addr->router;
5826 addr2->transport = addr->transport;
5827 addr2->host_list = addr->host_list;
5828 addr2->fallback_hosts = addr->fallback_hosts;
5829 addr2->p.errors_address = addr->p.errors_address;
5830 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
5832 DEBUG(D_deliver|D_route)
5834 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
5836 "Routing for %s copied from %s\n",
5837 addr2->address, addr2->address, addr->address);
5841 } /* Continue with routing the next address. */
5842 } /* Loop to process any child addresses that the routers created, and
5843 any rerouted addresses that got put back on the new chain. */
5846 /* Debugging: show the results of the routing */
5848 DEBUG(D_deliver|D_retry|D_route)
5850 address_item *p = addr_local;
5851 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5852 debug_printf("After routing:\n Local deliveries:\n");
5855 debug_printf(" %s\n", p->address);
5860 debug_printf(" Remote deliveries:\n");
5863 debug_printf(" %s\n", p->address);
5868 debug_printf(" Failed addresses:\n");
5871 debug_printf(" %s\n", p->address);
5876 debug_printf(" Deferred addresses:\n");
5879 debug_printf(" %s\n", p->address);
5884 /* Free any resources that were cached during routing. */
5889 /* These two variables are set only during routing, after check_local_user.
5890 Ensure they are not set in transports. */
5892 local_user_gid = (gid_t)(-1);
5893 local_user_uid = (uid_t)(-1);
5895 /* Check for any duplicate addresses. This check is delayed until after
5896 routing, because the flexibility of the routing configuration means that
5897 identical addresses with different parentage may end up being redirected to
5898 different addresses. Checking for duplicates too early (as we previously used
5899 to) makes this kind of thing not work. */
5901 do_duplicate_check(&addr_local);
5902 do_duplicate_check(&addr_remote);
5904 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
5905 remote transport. The check that they all end up in one transaction happens in
5906 the do_remote_deliveries() function. */
5908 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
5909 addr_defer != NULL))
5912 uschar *which, *colon, *msg;
5914 if (addr_local != NULL)
5919 else if (addr_defer != NULL)
5922 which = US"deferred";
5930 while (addr->parent != NULL) addr = addr->parent;
5932 if (addr->message != NULL)
5935 msg = addr->message;
5937 else colon = msg = US"";
5939 /* We don't need to log here for a forced failure as it will already
5940 have been logged. Defer will also have been logged, but as a defer, so we do
5941 need to do the failure logging. */
5943 if (addr != addr_failed)
5944 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
5945 addr->address, which);
5947 /* Always write an error to the caller */
5949 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
5952 final_yield = DELIVER_MUA_FAILED;
5953 addr_failed = addr_defer = NULL; /* So that we remove the message */
5954 goto DELIVERY_TIDYUP;
5958 /* If this is a run to continue deliveries to an external channel that is
5959 already set up, defer any local deliveries. */
5961 if (continue_transport != NULL)
5963 if (addr_defer == NULL) addr_defer = addr_local; else
5965 address_item *addr = addr_defer;
5966 while (addr->next != NULL) addr = addr->next;
5967 addr->next = addr_local;
5973 /* Because address rewriting can happen in the routers, we should not really do
5974 ANY deliveries until all addresses have been routed, so that all recipients of
5975 the message get the same headers. However, this is in practice not always
5976 possible, since sometimes remote addresses give DNS timeouts for days on end.
5977 The pragmatic approach is to deliver what we can now, saving any rewritten
5978 headers so that at least the next lot of recipients benefit from the rewriting
5979 that has already been done.
5981 If any headers have been rewritten during routing, update the spool file to
5982 remember them for all subsequent deliveries. This can be delayed till later if
5983 there is only address to be delivered - if it succeeds the spool write need not
5986 if (header_rewritten &&
5987 ((addr_local != NULL &&
5988 (addr_local->next != NULL || addr_remote != NULL)) ||
5989 (addr_remote != NULL && addr_remote->next != NULL)))
5991 /* Panic-dies on error */
5992 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5993 header_rewritten = FALSE;
5997 /* If there are any deliveries to be done, open the journal file. This is used
5998 to record successful deliveries as soon as possible after each delivery is
5999 known to be complete. A file opened with O_APPEND is used so that several
6000 processes can run simultaneously.
6002 The journal is just insurance against crashes. When the spool file is
6003 ultimately updated at the end of processing, the journal is deleted. If a
6004 journal is found to exist at the start of delivery, the addresses listed
6005 therein are added to the non-recipients. */
6007 if (addr_local != NULL || addr_remote != NULL)
6009 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6010 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6014 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6015 spoolname, strerror(errno));
6016 return DELIVER_NOT_ATTEMPTED;
6019 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6020 that the mode is correct - the group setting doesn't always seem to get
6021 set automatically. */
6023 (void)fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC);
6024 (void)fchown(journal_fd, exim_uid, exim_gid);
6025 (void)fchmod(journal_fd, SPOOL_MODE);
6029 /* Now we can get down to the business of actually doing deliveries. Local
6030 deliveries are done first, then remote ones. If ever the problems of how to
6031 handle fallback transports are figured out, this section can be put into a loop
6032 for handling fallbacks, though the uid switching will have to be revised. */
6034 /* Precompile a regex that is used to recognize a parameter in response
6035 to an LHLO command, if is isn't already compiled. This may be used on both
6036 local and remote LMTP deliveries. */
6038 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6039 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6041 /* Handle local deliveries */
6043 if (addr_local != NULL)
6045 DEBUG(D_deliver|D_transport)
6046 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6047 do_local_deliveries();
6048 disable_logging = FALSE;
6051 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6052 so just queue them all. */
6054 if (queue_run_local)
6056 while (addr_remote != NULL)
6058 address_item *addr = addr_remote;
6059 addr_remote = addr->next;
6061 addr->basic_errno = ERRNO_LOCAL_ONLY;
6062 addr->message = US"remote deliveries suppressed";
6063 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6067 /* Handle remote deliveries */
6069 if (addr_remote != NULL)
6071 DEBUG(D_deliver|D_transport)
6072 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6074 /* Precompile some regex that are used to recognize parameters in response
6075 to an EHLO command, if they aren't already compiled. */
6077 if (regex_PIPELINING == NULL) regex_PIPELINING =
6078 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6080 if (regex_SIZE == NULL) regex_SIZE =
6081 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6083 if (regex_AUTH == NULL) regex_AUTH =
6084 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6088 if (regex_STARTTLS == NULL) regex_STARTTLS =
6089 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6092 /* Now sort the addresses if required, and do the deliveries. The yield of
6093 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6094 cannot be delivered in one transaction. */
6096 if (remote_sort_domains != NULL) sort_remote_deliveries();
6097 if (!do_remote_deliveries(FALSE))
6099 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6100 "be delivered in one transaction");
6101 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6103 final_yield = DELIVER_MUA_FAILED;
6104 addr_failed = addr_defer = NULL; /* So that we remove the message */
6105 goto DELIVERY_TIDYUP;
6108 /* See if any of the addresses that failed got put on the queue for delivery
6109 to their fallback hosts. We do it this way because often the same fallback
6110 host is used for many domains, so all can be sent in a single transaction
6111 (if appropriately configured). */
6113 if (addr_fallback != NULL && !mua_wrapper)
6115 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6116 addr_remote = addr_fallback;
6117 addr_fallback = NULL;
6118 if (remote_sort_domains != NULL) sort_remote_deliveries();
6119 do_remote_deliveries(TRUE);
6121 disable_logging = FALSE;
6125 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6126 phase, to minimize cases of half-done things. */
6129 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6131 /* Root privilege is no longer needed */
6133 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6135 set_process_info("tidying up after delivering %s", message_id);
6136 signal(SIGTERM, SIG_IGN);
6138 /* When we are acting as an MUA wrapper, the smtp transport will either have
6139 succeeded for all addresses, or failed them all in normal cases. However, there
6140 are some setup situations (e.g. when a named port does not exist) that cause an
6141 immediate exit with deferral of all addresses. Convert those into failures. We
6142 do not ever want to retry, nor do we want to send a bounce message. */
6146 if (addr_defer != NULL)
6148 address_item *addr, *nextaddr;
6149 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6151 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6152 "delivery", addr->address);
6153 nextaddr = addr->next;
6154 addr->next = addr_failed;
6160 /* Now all should either have succeeded or failed. */
6162 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6164 uschar *s = (addr_failed->user_message != NULL)?
6165 addr_failed->user_message : addr_failed->message;
6167 fprintf(stderr, "Delivery failed: ");
6168 if (addr_failed->basic_errno > 0)
6170 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6171 if (s != NULL) fprintf(stderr, ": ");
6175 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6177 else fprintf(stderr, "%s", CS s);
6178 fprintf(stderr, "\n");
6180 final_yield = DELIVER_MUA_FAILED;
6185 /* In a normal configuration, we now update the retry database. This is done in
6186 one fell swoop at the end in order not to keep opening and closing (and
6187 locking) the database. The code for handling retries is hived off into a
6188 separate module for convenience. We pass it the addresses of the various
6189 chains, because deferred addresses can get moved onto the failed chain if the
6190 retry cutoff time has expired for all alternative destinations. Bypass the
6191 updating of the database if the -N flag is set, which is a debugging thing that
6192 prevents actual delivery. */
6194 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6196 /* If any addresses failed, we must send a message to somebody, unless
6197 af_ignore_error is set, in which case no action is taken. It is possible for
6198 several messages to get sent if there are addresses with different
6201 while (addr_failed != NULL)
6205 uschar *logtod = tod_stamp(tod_log);
6207 address_item *handled_addr = NULL;
6208 address_item **paddr;
6209 address_item *msgchain = NULL;
6210 address_item **pmsgchain = &msgchain;
6212 /* There are weird cases when logging is disabled in the transport. However,
6213 there may not be a transport (address failed by a router). */
6215 disable_logging = FALSE;
6216 if (addr_failed->transport != NULL)
6217 disable_logging = addr_failed->transport->disable_logging;
6220 debug_printf("processing failed address %s\n", addr_failed->address);
6222 /* There are only two ways an address in a bounce message can get here:
6224 (1) When delivery was initially deferred, but has now timed out (in the call
6225 to retry_update() above). We can detect this by testing for
6226 af_retry_timedout. If the address does not have its own errors address,
6227 we arrange to ignore the error.
6229 (2) If delivery failures for bounce messages are being ignored. We can detect
6230 this by testing for af_ignore_error. This will also be set if a bounce
6231 message has been autothawed and the ignore_bounce_errors_after time has
6232 passed. It might also be set if a router was explicitly configured to
6233 ignore errors (errors_to = "").
6235 If neither of these cases obtains, something has gone wrong. Log the
6236 incident, but then ignore the error. */
6238 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6240 if (!testflag(addr_failed, af_retry_timedout) &&
6241 !testflag(addr_failed, af_ignore_error))
6243 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6244 "failure is neither frozen nor ignored (it's been ignored)");
6246 setflag(addr_failed, af_ignore_error);
6249 /* If the first address on the list has af_ignore_error set, just remove
6250 it from the list, throw away any saved message file, log it, and
6251 mark the recipient done. */
6253 if (testflag(addr_failed, af_ignore_error))
6256 addr_failed = addr->next;
6257 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6259 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6261 (addr->parent == NULL)? US"" : US" <",
6262 (addr->parent == NULL)? US"" : addr->parent->address,
6263 (addr->parent == NULL)? US"" : US">");
6265 address_done(addr, logtod);
6266 child_done(addr, logtod);
6267 /* Panic-dies on error */
6268 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6271 /* Otherwise, handle the sending of a message. Find the error address for
6272 the first address, then send a message that includes all failed addresses
6273 that have the same error address. Note the bounce_recipient is a global so
6274 that it can be accesssed by $bounce_recipient while creating a customized
6279 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6280 sender_address : addr_failed->p.errors_address;
6282 /* Make a subprocess to send a message */
6284 pid = child_open_exim(&fd);
6286 /* Creation of child failed */
6289 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6290 "create child process to send failure message: %s", getpid(),
6291 getppid(), strerror(errno));
6293 /* Creation of child succeeded */
6300 uschar *bcc, *emf_text;
6301 FILE *f = fdopen(fd, "wb");
6303 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6304 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6305 DELIVER_IN_BUFFER_SIZE;
6308 debug_printf("sending error message to: %s\n", bounce_recipient);
6310 /* Scan the addresses for all that have the same errors address, removing
6311 them from the addr_failed chain, and putting them on msgchain. */
6313 paddr = &addr_failed;
6314 for (addr = addr_failed; addr != NULL; addr = *paddr)
6316 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6317 sender_address : addr->p.errors_address) != 0)
6319 paddr = &(addr->next); /* Not the same; skip */
6321 else /* The same - dechain */
6323 *paddr = addr->next;
6326 pmsgchain = &(addr->next);
6330 /* Include X-Failed-Recipients: for automatic interpretation, but do
6331 not let any one header line get too long. We do this by starting a
6332 new header every 50 recipients. Omit any addresses for which the
6333 "hide_child" flag is set. */
6335 for (addr = msgchain; addr != NULL; addr = addr->next)
6337 if (testflag(addr, af_hide_child)) continue;
6344 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6345 (testflag(addr, af_pfr) && addr->parent != NULL)?
6346 string_printing(addr->parent->address) :
6347 string_printing(addr->address));
6349 if (rcount > 0) fprintf(f, "\n");
6351 /* Output the standard headers */
6353 if (errors_reply_to != NULL)
6354 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6355 fprintf(f, "Auto-Submitted: auto-replied\n");
6357 fprintf(f, "To: %s\n", bounce_recipient);
6359 /* Open a template file if one is provided. Log failure to open, but
6360 carry on - default texts will be used. */
6362 if (bounce_message_file != NULL)
6364 emf = Ufopen(bounce_message_file, "rb");
6366 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6367 "message texts: %s", bounce_message_file, strerror(errno));
6370 /* Quietly copy to configured additional addresses if required. */
6372 bcc = moan_check_errorcopy(bounce_recipient);
6373 if (bcc != NULL) fprintf(f, "Bcc: %s\n", bcc);
6375 /* The texts for the message can be read from a template file; if there
6376 isn't one, or if it is too short, built-in texts are used. The first
6377 emf text is a Subject: and any other headers. */
6379 emf_text = next_emf(emf, US"header");
6380 if (emf_text != NULL) fprintf(f, "%s\n", emf_text); else
6382 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6383 to_sender? ": returning message to sender" : "");
6386 emf_text = next_emf(emf, US"intro");
6387 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6390 /* This message has been reworded several times. It seems to be confusing to
6391 somebody, however it is worded. I have retreated to the original, simple
6393 "This message was created automatically by mail delivery software.\n");
6394 if (bounce_message_text != NULL) fprintf(f, "%s", CS bounce_message_text);
6398 "\nA message that you sent could not be delivered to one or more of its\n"
6399 "recipients. This is a permanent error. The following address(es) failed:\n");
6404 "\nA message sent by\n\n <%s>\n\n"
6405 "could not be delivered to one or more of its recipients. The following\n"
6406 "address(es) failed:\n", sender_address);
6411 /* Process the addresses, leaving them on the msgchain if they have a
6412 file name for a return message. (There has already been a check in
6413 post_process_one() for the existence of data in the message file.) A TRUE
6414 return from print_address_information() means that the address is not
6418 for (addr = msgchain; addr != NULL; addr = *paddr)
6420 if (print_address_information(addr, f, US" ", US"\n ", US""))
6421 print_address_error(addr, f, US"");
6423 /* End the final line for the address */
6427 /* Leave on msgchain if there's a return file. */
6429 if (addr->return_file >= 0)
6431 paddr = &(addr->next);
6435 /* Else save so that we can tick off the recipient when the
6440 *paddr = addr->next;
6441 addr->next = handled_addr;
6442 handled_addr = addr;
6448 /* Get the next text, whether we need it or not, so as to be
6449 positioned for the one after. */
6451 emf_text = next_emf(emf, US"generated text");
6453 /* If there were any file messages passed by the local transports,
6454 include them in the message. Then put the address on the handled chain.
6455 In the case of a batch of addresses that were all sent to the same
6456 transport, the return_file field in all of them will contain the same
6457 fd, and the return_filename field in the *last* one will be set (to the
6458 name of the file). */
6460 if (msgchain != NULL)
6462 address_item *nextaddr;
6464 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6466 "The following text was generated during the delivery "
6467 "attempt%s:\n", (filecount > 1)? "s" : "");
6469 for (addr = msgchain; addr != NULL; addr = nextaddr)
6472 address_item *topaddr = addr;
6474 /* List all the addresses that relate to this file */
6477 while(addr != NULL) /* Insurance */
6479 print_address_information(addr, f, US"------ ", US"\n ",
6481 if (addr->return_filename != NULL) break;
6486 /* Now copy the file */
6488 fm = Ufopen(addr->return_filename, "rb");
6491 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6495 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6498 Uunlink(addr->return_filename);
6500 /* Can now add to handled chain, first fishing off the next
6501 address on the msgchain. */
6503 nextaddr = addr->next;
6504 addr->next = handled_addr;
6505 handled_addr = topaddr;
6510 /* Now copy the message, trying to give an intelligible comment if
6511 it is too long for it all to be copied. The limit isn't strictly
6512 applied because of the buffering. There is, however, an option
6513 to suppress copying altogether. */
6515 emf_text = next_emf(emf, US"copy");
6517 if (bounce_return_message)
6519 int topt = topt_add_return_path;
6520 if (!bounce_return_body) topt |= topt_no_body;
6522 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6524 if (bounce_return_body) fprintf(f,
6525 "------ This is a copy of the message, including all the headers. ------\n");
6527 "------ This is a copy of the message's headers. ------\n");
6530 /* While reading the "truncated" message, set return_size_limit to
6531 the actual max testing value, rounded. We need to read the message
6532 whether we are going to use it or not. */
6535 int temp = bounce_return_size_limit;
6536 bounce_return_size_limit = (max/1000)*1000;
6537 emf_text = next_emf(emf, US"truncated");
6538 bounce_return_size_limit = temp;
6541 if (bounce_return_body && bounce_return_size_limit > 0)
6543 struct stat statbuf;
6544 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
6546 if (emf_text != NULL) fprintf(f, "%s", CS emf_text); else
6549 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
6550 "------ %d or so are included here.\n", statbuf.st_size, max);
6557 transport_filter_argv = NULL; /* Just in case */
6558 return_path = sender_address; /* In case not previously set */
6559 transport_write_message(NULL, fileno(f), topt,
6560 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
6563 /* Write final text and close the template file if one is open */
6567 emf_text = next_emf(emf, US"final");
6568 if (emf_text != NULL) fprintf(f, "%s", CS emf_text);
6572 /* Close the file, which should send an EOF to the child process
6573 that is receiving the message. Wait for it to finish. */
6576 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6578 /* In the test harness, let the child do it's thing first. */
6580 if (running_in_test_harness) millisleep(500);
6582 /* If the process failed, there was some disaster in setting up the
6583 error message. Unless the message is very old, ensure that addr_defer
6584 is non-null, which will have the effect of leaving the message on the
6585 spool. The failed addresses will get tried again next time. However, we
6586 don't really want this to happen too often, so freeze the message unless
6587 there are some genuine deferred addresses to try. To do this we have
6588 to call spool_write_header() here, because with no genuine deferred
6589 addresses the normal code below doesn't get run. */
6594 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
6596 addr_defer = (address_item *)(+1);
6597 deliver_freeze = TRUE;
6598 deliver_frozen_at = time(NULL);
6599 /* Panic-dies on error */
6600 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6603 deliver_msglog("Process failed (%d) when writing error message "
6604 "to %s%s", rc, bounce_recipient, s);
6605 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6606 "to %s%s", rc, bounce_recipient, s);
6609 /* The message succeeded. Ensure that the recipients that failed are
6610 now marked finished with on the spool and their parents updated. */
6614 for (addr = handled_addr; addr != NULL; addr = addr->next)
6616 address_done(addr, logtod);
6617 child_done(addr, logtod);
6619 /* Panic-dies on error */
6620 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6626 disable_logging = FALSE; /* In case left set */
6628 /* Come here from the mua_wrapper case if routing goes wrong */
6632 /* If there are now no deferred addresses, we are done. Preserve the
6633 message log if so configured, and we are using them. Otherwise, sling it.
6634 Then delete the message itself. */
6636 if (addr_defer == NULL)
6640 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
6642 if (preserve_message_logs)
6645 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
6646 if ((rc = Urename(spoolname, big_buffer)) < 0)
6648 (void)directory_make(spool_directory, US"msglog.OLD",
6649 MSGLOG_DIRECTORY_MODE, TRUE);
6650 rc = Urename(spoolname, big_buffer);
6653 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
6654 "msglog.OLD directory", spoolname);
6658 if (Uunlink(spoolname) < 0)
6659 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6660 spoolname, strerror(errno));
6664 /* Remove the two message files. */
6666 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
6667 if (Uunlink(spoolname) < 0)
6668 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6669 spoolname, strerror(errno));
6670 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
6671 if (Uunlink(spoolname) < 0)
6672 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6673 spoolname, strerror(errno));
6675 /* Log the end of this message, with queue time if requested. */
6677 if ((log_extra_selector & LX_queue_time_overall) != 0)
6678 log_write(0, LOG_MAIN, "Completed QT=%s",
6679 readconf_printtime(time(NULL) - received_time));
6681 log_write(0, LOG_MAIN, "Completed");
6683 /* Unset deliver_freeze so that we won't try to move the spool files further down */
6684 deliver_freeze = FALSE;
6687 /* If there are deferred addresses, we are keeping this message because it is
6688 not yet completed. Lose any temporary files that were catching output from
6689 pipes for any of the deferred addresses, handle one-time aliases, and see if
6690 the message has been on the queue for so long that it is time to send a warning
6691 message to the sender, unless it is a mailer-daemon. If all deferred addresses
6692 have the same domain, we can set deliver_domain for the expansion of
6693 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
6694 the parent's domain.
6696 If all the deferred addresses have an error number that indicates "retry time
6697 not reached", skip sending the warning message, because it won't contain the
6698 reason for the delay. It will get sent at the next real delivery attempt.
6699 However, if at least one address has tried, we'd better include all of them in
6702 If we can't make a process to send the message, don't worry.
6704 For mailing list expansions we want to send the warning message to the
6705 mailing list manager. We can't do a perfect job here, as some addresses may
6706 have different errors addresses, but if we take the errors address from
6707 each deferred address it will probably be right in most cases.
6709 If addr_defer == +1, it means there was a problem sending an error message
6710 for failed addresses, and there were no "real" deferred addresses. The value
6711 was set just to keep the message on the spool, so there is nothing to do here.
6714 else if (addr_defer != (address_item *)(+1))
6717 uschar *recipients = US"";
6718 BOOL delivery_attempted = FALSE;
6720 deliver_domain = testflag(addr_defer, af_pfr)?
6721 addr_defer->parent->domain : addr_defer->domain;
6723 for (addr = addr_defer; addr != NULL; addr = addr->next)
6725 address_item *otaddr;
6727 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
6729 if (deliver_domain != NULL)
6731 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
6733 /* The domain may be unset for an address that has never been routed
6734 because the system filter froze the message. */
6736 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
6739 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6741 /* Handle the case of one-time aliases. If any address in the ancestry
6742 of this one is flagged, ensure it is in the recipients list, suitably
6743 flagged, and that its parent is marked delivered. */
6745 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
6746 if (otaddr->onetime_parent != NULL) break;
6751 int t = recipients_count;
6753 for (i = 0; i < recipients_count; i++)
6755 uschar *r = recipients_list[i].address;
6756 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
6757 if (Ustrcmp(otaddr->address, r) == 0) break;
6760 /* Didn't find the address already in the list, and did find the
6761 ultimate parent's address in the list. After adding the recipient,
6762 update the errors address in the recipients list. */
6764 if (i >= recipients_count && t < recipients_count)
6766 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
6767 otaddr->address, otaddr->parent->address);
6768 receive_add_recipient(otaddr->address, t);
6769 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
6770 tree_add_nonrecipient(otaddr->parent->address);
6771 update_spool = TRUE;
6775 /* Except for error messages, ensure that either the errors address for
6776 this deferred address or, if there is none, the sender address, is on the
6777 list of recipients for a warning message. */
6779 if (sender_address[0] != 0)
6781 if (addr->p.errors_address == NULL)
6783 if (Ustrstr(recipients, sender_address) == NULL)
6784 recipients = string_sprintf("%s%s%s", recipients,
6785 (recipients[0] == 0)? "" : ",", sender_address);
6789 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
6790 recipients = string_sprintf("%s%s%s", recipients,
6791 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
6796 /* Send a warning message if the conditions are right. If the condition check
6797 fails because of a lookup defer, there is nothing we can do. The warning
6798 is not sent. Another attempt will be made at the next delivery attempt (if
6801 if (!queue_2stage && delivery_attempted &&
6802 delay_warning[1] > 0 && sender_address[0] != 0 &&
6803 (delay_warning_condition == NULL ||
6804 expand_check_condition(delay_warning_condition,
6805 US"delay_warning", US"option")))
6809 int queue_time = time(NULL) - received_time;
6811 /* When running in the test harness, there's an option that allows us to
6812 fudge this time so as to get repeatability of the tests. Take the first
6813 time off the list. In queue runs, the list pointer gets updated in the
6816 if (running_in_test_harness && fudged_queue_times[0] != 0)
6818 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
6821 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
6822 fudged_queue_times);
6827 /* See how many warnings we should have sent by now */
6829 for (count = 0; count < delay_warning[1]; count++)
6830 if (queue_time < delay_warning[count+2]) break;
6832 show_time = delay_warning[count+1];
6834 if (count >= delay_warning[1])
6837 int last_gap = show_time;
6838 if (count > 1) last_gap -= delay_warning[count];
6839 extra = (queue_time - delay_warning[count+1])/last_gap;
6840 show_time += last_gap * extra;
6846 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
6847 debug_printf("warning counts: required %d done %d\n", count,
6851 /* We have computed the number of warnings there should have been by now.
6852 If there haven't been enough, send one, and up the count to what it should
6855 if (warning_count < count)
6859 pid_t pid = child_open_exim(&fd);
6865 FILE *f = fdopen(fd, "wb");
6867 if (warn_message_file != NULL)
6869 wmf = Ufopen(warn_message_file, "rb");
6871 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
6872 "message texts: %s", warn_message_file, strerror(errno));
6875 warnmsg_recipients = recipients;
6876 warnmsg_delay = (queue_time < 120*60)?
6877 string_sprintf("%d minutes", show_time/60):
6878 string_sprintf("%d hours", show_time/3600);
6880 if (errors_reply_to != NULL)
6881 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6882 fprintf(f, "Auto-Submitted: auto-replied\n");
6884 fprintf(f, "To: %s\n", recipients);
6886 wmf_text = next_emf(wmf, US"header");
6887 if (wmf_text != NULL)
6888 fprintf(f, "%s\n", wmf_text);
6890 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6891 message_id, warnmsg_delay);
6893 wmf_text = next_emf(wmf, US"intro");
6894 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text); else
6897 "This message was created automatically by mail delivery software.\n");
6899 if (Ustrcmp(recipients, sender_address) == 0)
6901 "A message that you sent has not yet been delivered to one or more of its\n"
6902 "recipients after more than ");
6905 "A message sent by\n\n <%s>\n\n"
6906 "has not yet been delivered to one or more of its recipients after more than \n",
6909 fprintf(f, "%s on the queue on %s.\n\n", warnmsg_delay,
6911 fprintf(f, "The message identifier is: %s\n", message_id);
6913 for (h = header_list; h != NULL; h = h->next)
6915 if (strncmpic(h->text, US"Subject:", 8) == 0)
6916 fprintf(f, "The subject of the message is: %s", h->text + 9);
6917 else if (strncmpic(h->text, US"Date:", 5) == 0)
6918 fprintf(f, "The date of the message is: %s", h->text + 6);
6922 fprintf(f, "The address%s to which the message has not yet been "
6924 (addr_defer->next == NULL)? "" : "es",
6925 (addr_defer->next == NULL)? "is": "are");
6928 /* List the addresses, with error information if allowed */
6931 while (addr_defer != NULL)
6933 address_item *addr = addr_defer;
6934 addr_defer = addr->next;
6935 if (print_address_information(addr, f, US" ", US"\n ", US""))
6936 print_address_error(addr, f, US"Delay reason: ");
6945 wmf_text = next_emf(wmf, US"final");
6946 if (wmf_text != NULL) fprintf(f, "%s", CS wmf_text);
6952 "No action is required on your part. Delivery attempts will continue for\n"
6953 "some time, and this warning may be repeated at intervals if the message\n"
6954 "remains undelivered. Eventually the mail delivery software will give up,\n"
6955 "and when that happens, the message will be returned to you.\n");
6958 /* Close and wait for child process to complete, without a timeout.
6959 If there's an error, don't update the count. */
6962 if (child_close(pid, 0) == 0)
6964 warning_count = count;
6965 update_spool = TRUE; /* Ensure spool rewritten */
6971 /* Clear deliver_domain */
6973 deliver_domain = NULL;
6975 /* If this was a first delivery attempt, unset the first time flag, and
6976 ensure that the spool gets updated. */
6978 if (deliver_firsttime)
6980 deliver_firsttime = FALSE;
6981 update_spool = TRUE;
6984 /* If delivery was frozen and freeze_tell is set, generate an appropriate
6985 message, unless the message is a local error message (to avoid loops). Then
6986 log the freezing. If the text in "frozen_info" came from a system filter,
6987 it has been escaped into printing characters so as not to mess up log lines.
6988 For the "tell" message, we turn \n back into newline. Also, insert a newline
6989 near the start instead of the ": " string. */
6993 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
6995 uschar *s = string_copy(frozen_info);
6996 uschar *ss = Ustrstr(s, " by the system filter: ");
7007 if (*ss == '\\' && ss[1] == 'n')
7014 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7015 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7019 /* Log freezing just before we update the -H file, to minimize the chance
7020 of a race problem. */
7022 deliver_msglog("*** Frozen%s\n", frozen_info);
7023 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7026 /* If there have been any updates to the non-recipients list, or other things
7027 that get written to the spool, we must now update the spool header file so
7028 that it has the right information for the next delivery attempt. If there
7029 was more than one address being delivered, the header_change update is done
7030 earlier, in case one succeeds and then something crashes. */
7033 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7034 update_spool, header_rewritten);
7036 if (update_spool || header_rewritten)
7037 /* Panic-dies on error */
7038 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7041 /* Finished with the message log. If the message is complete, it will have
7042 been unlinked or renamed above. */
7044 if (message_logs) (void)fclose(message_log);
7046 /* Now we can close and remove the journal file. Its only purpose is to record
7047 successfully completed deliveries asap so that this information doesn't get
7048 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7049 not serious, as trying it again is not harmful. The journal might not be open
7050 if all addresses were deferred at routing or directing. Nevertheless, we must
7051 remove it if it exists (may have been lying around from a crash during the
7052 previous delivery attempt). We don't remove the journal if a delivery
7053 subprocess failed to pass back delivery information; this is controlled by
7054 the remove_journal flag. When the journal is left, we also don't move the
7055 message off the main spool if frozen and the option is set. It should get moved
7056 at the next attempt, after the journal has been inspected. */
7058 if (journal_fd >= 0) (void)close(journal_fd);
7062 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7063 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7064 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7067 /* Move the message off the spool if reqested */
7069 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7070 if (deliver_freeze && move_frozen_messages)
7071 (void)spool_move_message(id, message_subdir, US"", US"F");
7075 /* Closing the data file frees the lock; if the file has been unlinked it
7076 will go away. Otherwise the message becomes available for another process
7079 (void)close(deliver_datafile);
7080 deliver_datafile = -1;
7081 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7083 /* It is unlikely that there will be any cached resources, since they are
7084 released after routing, and in the delivery subprocesses. However, it's
7085 possible for an expansion for something afterwards (for example,
7086 expand_check_condition) to do a lookup. We must therefore be sure everything is
7090 acl_where = ACL_WHERE_UNKNOWN;
7094 /* End of deliver.c */