1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
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;
66 #ifdef EXPERIMENTAL_DSN
67 static address_item *addr_dsntmp = NULL;
68 static address_item *addr_senddsn = NULL;
71 static FILE *message_log = NULL;
72 static BOOL update_spool;
73 static BOOL remove_journal;
74 static int parcount = 0;
75 static pardata *parlist = NULL;
76 static int return_count;
77 static uschar *frozen_info = US"";
78 static uschar *used_return_path = NULL;
80 static uschar spoolname[PATH_MAX];
84 /*************************************************
85 * Make a new address item *
86 *************************************************/
88 /* This function gets the store and initializes with default values. The
89 transport_return value defaults to DEFER, so that any unexpected failure to
90 deliver does not wipe out the message. The default unique string is set to a
91 copy of the address, so that its domain can be lowercased.
94 address the RFC822 address string
95 copy force a copy of the address
97 Returns: a pointer to an initialized address_item
101 deliver_make_addr(uschar *address, BOOL copy)
103 address_item *addr = store_get(sizeof(address_item));
104 *addr = address_defaults;
105 if (copy) address = string_copy(address);
106 addr->address = address;
107 addr->unique = string_copy(address);
114 /*************************************************
115 * Set expansion values for an address *
116 *************************************************/
118 /* Certain expansion variables are valid only when handling an address or
119 address list. This function sets them up or clears the values, according to its
123 addr the address in question, or NULL to clear values
128 deliver_set_expansions(address_item *addr)
132 uschar ***p = address_expansions;
133 while (*p != NULL) **p++ = NULL;
137 /* Exactly what gets set depends on whether there is one or more addresses, and
138 what they contain. These first ones are always set, taking their values from
139 the first address. */
141 if (addr->host_list == NULL)
143 deliver_host = deliver_host_address = US"";
144 deliver_host_port = 0;
148 deliver_host = addr->host_list->name;
149 deliver_host_address = addr->host_list->address;
150 deliver_host_port = addr->host_list->port;
153 deliver_recipients = addr;
154 deliver_address_data = addr->p.address_data;
155 deliver_domain_data = addr->p.domain_data;
156 deliver_localpart_data = addr->p.localpart_data;
158 /* These may be unset for multiple addresses */
160 deliver_domain = addr->domain;
161 self_hostname = addr->self_hostname;
163 #ifdef EXPERIMENTAL_BRIGHTMAIL
164 bmi_deliver = 1; /* deliver by default */
165 bmi_alt_location = NULL;
166 bmi_base64_verdict = NULL;
167 bmi_base64_tracker_verdict = NULL;
170 /* If there's only one address we can set everything. */
172 if (addr->next == NULL)
174 address_item *addr_orig;
176 deliver_localpart = addr->local_part;
177 deliver_localpart_prefix = addr->prefix;
178 deliver_localpart_suffix = addr->suffix;
180 for (addr_orig = addr; addr_orig->parent != NULL;
181 addr_orig = addr_orig->parent);
182 deliver_domain_orig = addr_orig->domain;
184 /* Re-instate any prefix and suffix in the original local part. In all
185 normal cases, the address will have a router associated with it, and we can
186 choose the caseful or caseless version accordingly. However, when a system
187 filter sets up a pipe, file, or autoreply delivery, no router is involved.
188 In this case, though, there won't be any prefix or suffix to worry about. */
190 deliver_localpart_orig = (addr_orig->router == NULL)? addr_orig->local_part :
191 addr_orig->router->caseful_local_part?
192 addr_orig->cc_local_part : addr_orig->lc_local_part;
194 /* If there's a parent, make its domain and local part available, and if
195 delivering to a pipe or file, or sending an autoreply, get the local
196 part from the parent. For pipes and files, put the pipe or file string
197 into address_pipe and address_file. */
199 if (addr->parent != NULL)
201 deliver_domain_parent = addr->parent->domain;
202 deliver_localpart_parent = (addr->parent->router == NULL)?
203 addr->parent->local_part :
204 addr->parent->router->caseful_local_part?
205 addr->parent->cc_local_part : addr->parent->lc_local_part;
207 /* File deliveries have their own flag because they need to be picked out
208 as special more often. */
210 if (testflag(addr, af_pfr))
212 if (testflag(addr, af_file)) address_file = addr->local_part;
213 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
214 deliver_localpart = addr->parent->local_part;
215 deliver_localpart_prefix = addr->parent->prefix;
216 deliver_localpart_suffix = addr->parent->suffix;
220 #ifdef EXPERIMENTAL_BRIGHTMAIL
221 /* Set expansion variables related to Brightmail AntiSpam */
222 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
223 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
224 /* get message delivery status (0 - don't deliver | 1 - deliver) */
225 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
226 /* if message is to be delivered, get eventual alternate location */
227 if (bmi_deliver == 1) {
228 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
234 /* For multiple addresses, don't set local part, and leave the domain and
235 self_hostname set only if it is the same for all of them. It is possible to
236 have multiple pipe and file addresses, but only when all addresses have routed
237 to the same pipe or file. */
242 if (testflag(addr, af_pfr))
244 if (testflag(addr, af_file)) address_file = addr->local_part;
245 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
247 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
249 if (deliver_domain != NULL &&
250 Ustrcmp(deliver_domain, addr2->domain) != 0)
251 deliver_domain = NULL;
252 if (self_hostname != NULL && (addr2->self_hostname == NULL ||
253 Ustrcmp(self_hostname, addr2->self_hostname) != 0))
254 self_hostname = NULL;
255 if (deliver_domain == NULL && self_hostname == NULL) break;
263 /*************************************************
264 * Open a msglog file *
265 *************************************************/
267 /* This function is used both for normal message logs, and for files in the
268 msglog directory that are used to catch output from pipes. Try to create the
269 directory if it does not exist. From release 4.21, normal message logs should
270 be created when the message is received.
273 filename the file name
274 mode the mode required
275 error used for saying what failed
277 Returns: a file descriptor, or -1 (with errno set)
281 open_msglog_file(uschar *filename, int mode, uschar **error)
283 int fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
285 if (fd < 0 && errno == ENOENT)
288 sprintf(CS temp, "msglog/%s", message_subdir);
289 if (message_subdir[0] == 0) temp[6] = 0;
290 (void)directory_make(spool_directory, temp, MSGLOG_DIRECTORY_MODE, TRUE);
291 fd = Uopen(filename, O_WRONLY|O_APPEND|O_CREAT, mode);
294 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
295 function is called as root). Double check the mode, because the group setting
296 doesn't always get set automatically. */
300 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
301 if (fchown(fd, exim_uid, exim_gid) < 0)
306 if (fchmod(fd, mode) < 0)
312 else *error = US"create";
320 /*************************************************
321 * Write to msglog if required *
322 *************************************************/
324 /* Write to the message log, if configured. This function may also be called
328 format a string format
334 deliver_msglog(const char *format, ...)
337 if (!message_logs) return;
338 va_start(ap, format);
339 vfprintf(message_log, format, ap);
347 /*************************************************
348 * Replicate status for batch *
349 *************************************************/
351 /* When a transport handles a batch of addresses, it may treat them
352 individually, or it may just put the status in the first one, and return FALSE,
353 requesting that the status be copied to all the others externally. This is the
354 replication function. As well as the status, it copies the transport pointer,
355 which may have changed if appendfile passed the addresses on to a different
358 Argument: pointer to the first address in a chain
363 replicate_status(address_item *addr)
366 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
368 addr2->transport = addr->transport;
369 addr2->transport_return = addr->transport_return;
370 addr2->basic_errno = addr->basic_errno;
371 addr2->more_errno = addr->more_errno;
372 addr2->special_action = addr->special_action;
373 addr2->message = addr->message;
374 addr2->user_message = addr->user_message;
380 /*************************************************
381 * Compare lists of hosts *
382 *************************************************/
384 /* This function is given two pointers to chains of host items, and it yields
385 TRUE if the lists refer to the same hosts in the same order, except that
387 (1) Multiple hosts with the same non-negative MX values are permitted to appear
388 in different orders. Round-robinning nameservers can cause this to happen.
390 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
391 permitted to appear in different orders. This is caused by randomizing
394 This enables Exim to use a single SMTP transaction for sending to two entirely
395 different domains that happen to end up pointing at the same hosts.
398 one points to the first host list
399 two points to the second host list
401 Returns: TRUE if the lists refer to the same host set
405 same_hosts(host_item *one, host_item *two)
407 while (one != NULL && two != NULL)
409 if (Ustrcmp(one->name, two->name) != 0)
412 host_item *end_one = one;
413 host_item *end_two = two;
415 /* Batch up only if there was no MX and the list was not randomized */
417 if (mx == MX_NONE) return FALSE;
419 /* Find the ends of the shortest sequence of identical MX values */
421 while (end_one->next != NULL && end_one->next->mx == mx &&
422 end_two->next != NULL && end_two->next->mx == mx)
424 end_one = end_one->next;
425 end_two = end_two->next;
428 /* If there aren't any duplicates, there's no match. */
430 if (end_one == one) return FALSE;
432 /* For each host in the 'one' sequence, check that it appears in the 'two'
433 sequence, returning FALSE if not. */
438 for (hi = two; hi != end_two->next; hi = hi->next)
439 if (Ustrcmp(one->name, hi->name) == 0) break;
440 if (hi == end_two->next) return FALSE;
441 if (one == end_one) break;
445 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
446 Ensure both are pointing at the last host, and carry on as for equality. */
457 /* True if both are NULL */
464 /*************************************************
465 * Compare header lines *
466 *************************************************/
468 /* This function is given two pointers to chains of header items, and it yields
469 TRUE if they are the same header texts in the same order.
472 one points to the first header list
473 two points to the second header list
475 Returns: TRUE if the lists refer to the same header set
479 same_headers(header_line *one, header_line *two)
483 if (one == two) return TRUE; /* Includes the case where both NULL */
484 if (one == NULL || two == NULL) return FALSE;
485 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
493 /*************************************************
494 * Compare string settings *
495 *************************************************/
497 /* This function is given two pointers to strings, and it returns
498 TRUE if they are the same pointer, or if the two strings are the same.
501 one points to the first string
502 two points to the second string
504 Returns: TRUE or FALSE
508 same_strings(uschar *one, uschar *two)
510 if (one == two) return TRUE; /* Includes the case where both NULL */
511 if (one == NULL || two == NULL) return FALSE;
512 return (Ustrcmp(one, two) == 0);
517 /*************************************************
518 * Compare uid/gid for addresses *
519 *************************************************/
521 /* This function is given a transport and two addresses. It yields TRUE if the
522 uid/gid/initgroups settings for the two addresses are going to be the same when
527 addr1 the first address
528 addr2 the second address
530 Returns: TRUE or FALSE
534 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
536 if (!tp->uid_set && tp->expand_uid == NULL && !tp->deliver_as_creator)
538 if (testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set) ||
539 (testflag(addr1, af_uid_set) &&
540 (addr1->uid != addr2->uid ||
541 testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups))))
545 if (!tp->gid_set && tp->expand_gid == NULL)
547 if (testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set) ||
548 (testflag(addr1, af_gid_set) && addr1->gid != addr2->gid))
558 /*************************************************
559 * Record that an address is complete *
560 *************************************************/
562 /* This function records that an address is complete. This is straightforward
563 for most addresses, where the unique address is just the full address with the
564 domain lower cased. For homonyms (addresses that are the same as one of their
565 ancestors) their are complications. Their unique addresses have \x\ prepended
566 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
569 Exim used to record the unique addresses of homonyms as "complete". This,
570 however, fails when the pattern of redirection varies over time (e.g. if taking
571 unseen copies at only some times of day) because the prepended numbers may vary
572 from one delivery run to the next. This problem is solved by never recording
573 prepended unique addresses as complete. Instead, when a homonymic address has
574 actually been delivered via a transport, we record its basic unique address
575 followed by the name of the transport. This is checked in subsequent delivery
576 runs whenever an address is routed to a transport.
578 If the completed address is a top-level one (has no parent, which means it
579 cannot be homonymic) we also add the original address to the non-recipients
580 tree, so that it gets recorded in the spool file and therefore appears as
581 "done" in any spool listings. The original address may differ from the unique
582 address in the case of the domain.
584 Finally, this function scans the list of duplicates, marks as done any that
585 match this address, and calls child_done() for their ancestors.
588 addr address item that has been completed
589 now current time as a string
595 address_done(address_item *addr, uschar *now)
599 update_spool = TRUE; /* Ensure spool gets updated */
601 /* Top-level address */
603 if (addr->parent == NULL)
605 tree_add_nonrecipient(addr->unique);
606 tree_add_nonrecipient(addr->address);
609 /* Homonymous child address */
611 else if (testflag(addr, af_homonym))
613 if (addr->transport != NULL)
615 tree_add_nonrecipient(
616 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
620 /* Non-homonymous child address */
622 else tree_add_nonrecipient(addr->unique);
624 /* Check the list of duplicate addresses and ensure they are now marked
627 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
629 if (Ustrcmp(addr->unique, dup->unique) == 0)
631 tree_add_nonrecipient(dup->unique);
632 child_done(dup, now);
640 /*************************************************
641 * Decrease counts in parents and mark done *
642 *************************************************/
644 /* This function is called when an address is complete. If there is a parent
645 address, its count of children is decremented. If there are still other
646 children outstanding, the function exits. Otherwise, if the count has become
647 zero, address_done() is called to mark the parent and its duplicates complete.
648 Then loop for any earlier ancestors.
651 addr points to the completed address item
652 now the current time as a string, for writing to the message log
658 child_done(address_item *addr, uschar *now)
661 while (addr->parent != NULL)
664 if ((addr->child_count -= 1) > 0) return; /* Incomplete parent */
665 address_done(addr, now);
667 /* Log the completion of all descendents only when there is no ancestor with
668 the same original address. */
670 for (aa = addr->parent; aa != NULL; aa = aa->parent)
671 if (Ustrcmp(aa->address, addr->address) == 0) break;
672 if (aa != NULL) continue;
674 deliver_msglog("%s %s: children all complete\n", now, addr->address);
675 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
683 d_hostlog(uschar * s, int * sizep, int * ptrp, address_item * addr)
685 s = string_append(s, sizep, ptrp, 5, US" H=", addr->host_used->name,
686 US" [", addr->host_used->address, US"]");
687 if ((log_extra_selector & LX_outgoing_port) != 0)
688 s = string_append(s, sizep, ptrp, 2, US":", string_sprintf("%d",
689 addr->host_used->port));
695 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
697 if ((log_extra_selector & LX_tls_cipher) != 0 && addr->cipher != NULL)
698 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
699 if ((log_extra_selector & LX_tls_certificate_verified) != 0 &&
700 addr->cipher != NULL)
701 s = string_append(s, sizep, ptrp, 2, US" CV=",
702 testflag(addr, af_cert_verified)
704 #ifdef EXPERIMENTAL_DANE
705 testflag(addr, af_dane_verified)
711 if ((log_extra_selector & LX_tls_peerdn) != 0 && addr->peerdn != NULL)
712 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
713 string_printing(addr->peerdn), US"\"");
721 #ifdef EXPERIMENTAL_TPDA
723 tpda_raise_event(uschar * action, uschar * event, uschar * ev_data)
729 debug_printf("TPDA(%s): tpda_event_action=|%s| tpda_delivery_IP=%s\n",
731 action, deliver_host_address);
736 if (!(s = expand_string(action)) && *expand_string_message)
737 log_write(0, LOG_MAIN|LOG_PANIC,
738 "failed to expand tpda_event_action %s in %s: %s\n",
739 event, transport_name, expand_string_message);
741 tpda_event = tpda_data = NULL;
743 /* If the expansion returns anything but an empty string, flag for
744 the caller to modify his normal processing
749 debug_printf("TPDA(%s): event_action returned \"%s\"\n", event, s);
757 tpda_msg_event(uschar * event, address_item * addr)
759 uschar * save_domain = deliver_domain;
760 uschar * save_local = deliver_localpart;
762 if (!addr->transport)
765 router_name = addr->router ? addr->router->name : NULL;
766 transport_name = addr->transport->name;
767 deliver_domain = addr->domain;
768 deliver_localpart = addr->local_part;
770 (void) tpda_raise_event(addr->transport->tpda_event_action, event,
771 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
772 ? addr->message : NULL);
774 deliver_localpart = save_local;
775 deliver_domain = save_domain;
776 router_name = transport_name = NULL;
778 #endif /*EXPERIMENTAL_TPDA*/
782 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
783 this is a nonstandard call; no two-character delivery flag is written
784 but sender-host and sender are prefixed and "msg" is inserted in the log line.
787 flags passed to log_write()
790 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
793 int size = 256; /* Used for a temporary, */
794 int ptr = 0; /* expanding buffer, for */
795 uschar *s; /* building log lines; */
796 void *reset_point; /* released afterwards. */
799 /* Log the delivery on the main log. We use an extensible string to build up
800 the log line, and reset the store afterwards. Remote deliveries should always
801 have a pointer to the host item that succeeded; local deliveries can have a
802 pointer to a single host item in their host list, for use by the transport. */
804 #ifdef EXPERIMENTAL_TPDA
805 /* presume no successful remote delivery */
806 lookup_dnssec_authenticated = NULL;
809 s = reset_point = store_get(size);
811 log_address = string_log_address(addr, (log_write_selector & L_all_parents) != 0, TRUE);
813 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
817 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
820 if ((log_extra_selector & LX_sender_on_delivery) != 0 || msg)
821 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
823 #ifdef EXPERIMENTAL_SRS
824 if(addr->p.srs_sender)
825 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->p.srs_sender, US">");
828 /* You might think that the return path must always be set for a successful
829 delivery; indeed, I did for some time, until this statement crashed. The case
830 when it is not set is for a delivery to /dev/null which is optimised by not
833 if (used_return_path != NULL &&
834 (log_extra_selector & LX_return_path_on_delivery) != 0)
835 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
838 s = string_append(s, &size, &ptr, 2, US" ", msg);
840 /* For a delivery from a system filter, there may not be a router */
841 if (addr->router != NULL)
842 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
844 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
846 if ((log_extra_selector & LX_delivery_size) != 0)
847 s = string_append(s, &size, &ptr, 2, US" S=",
848 string_sprintf("%d", transport_count));
852 if (addr->transport->info->local)
855 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
856 if (addr->shadow_message != NULL)
857 s = string_cat(s, &size, &ptr, addr->shadow_message,
858 Ustrlen(addr->shadow_message));
861 /* Remote delivery */
867 s = d_hostlog(s, &size, &ptr, addr);
868 if (continue_sequence > 1)
869 s = string_cat(s, &size, &ptr, US"*", 1);
871 #ifdef EXPERIMENTAL_TPDA
872 deliver_host_address = addr->host_used->address;
873 deliver_host_port = addr->host_used->port;
875 /* DNS lookup status */
876 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
877 : addr->host_used->dnssec==DS_NO ? US"no"
883 s = d_tlslog(s, &size, &ptr, addr);
886 if (addr->authenticator)
888 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
891 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
892 if (log_extra_selector & LX_smtp_mailauth && addr->auth_sndr)
893 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
898 if (addr->flags & af_prdr_used)
899 s = string_append(s, &size, &ptr, 1, US" PRDR");
903 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
905 if (log_extra_selector & LX_smtp_confirmation &&
907 (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0))
910 uschar *p = big_buffer;
911 uschar *ss = addr->message;
913 for (i = 0; i < 256 && ss[i] != 0; i++) /* limit logged amount */
915 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
920 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
923 /* Time on queue and actual time taken to deliver */
925 if ((log_extra_selector & LX_queue_time) != 0)
926 s = string_append(s, &size, &ptr, 2, US" QT=",
927 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
929 if ((log_extra_selector & LX_deliver_time) != 0)
930 s = string_append(s, &size, &ptr, 2, US" DT=",
931 readconf_printtime(addr->more_errno));
933 /* string_cat() always leaves room for the terminator. Release the
934 store we used to build the line after writing it. */
937 log_write(0, flags, "%s", s);
939 #ifdef EXPERIMENTAL_TPDA
940 /*XXX cutthrough calls this also for non-delivery...*/
941 tpda_msg_event(US"msg:delivery", addr);
944 store_reset(reset_point);
950 /*************************************************
951 * Actions at the end of handling an address *
952 *************************************************/
954 /* This is a function for processing a single address when all that can be done
955 with it has been done.
958 addr points to the address block
959 result the result of the delivery attempt
960 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
961 driver_type indicates which type of driver (transport, or router) was last
962 to process the address
963 logchar '=' or '-' for use when logging deliveries with => or ->
969 post_process_one(address_item *addr, int result, int logflags, int driver_type,
972 uschar *now = tod_stamp(tod_log);
973 uschar *driver_kind = NULL;
974 uschar *driver_name = NULL;
977 int size = 256; /* Used for a temporary, */
978 int ptr = 0; /* expanding buffer, for */
979 uschar *s; /* building log lines; */
980 void *reset_point; /* released afterwards. */
983 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
985 /* Set up driver kind and name for logging. Disable logging if the router or
986 transport has disabled it. */
988 if (driver_type == DTYPE_TRANSPORT)
990 if (addr->transport != NULL)
992 driver_name = addr->transport->name;
993 driver_kind = US" transport";
994 disable_logging = addr->transport->disable_logging;
996 else driver_kind = US"transporting";
998 else if (driver_type == DTYPE_ROUTER)
1000 if (addr->router != NULL)
1002 driver_name = addr->router->name;
1003 driver_kind = US" router";
1004 disable_logging = addr->router->disable_logging;
1006 else driver_kind = US"routing";
1009 /* If there's an error message set, ensure that it contains only printing
1010 characters - it should, but occasionally things slip in and this at least
1011 stops the log format from getting wrecked. We also scan the message for an LDAP
1012 expansion item that has a password setting, and flatten the password. This is a
1013 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1014 malformed, it won't ever have gone near LDAP.) */
1016 if (addr->message != NULL)
1018 addr->message = string_printing(addr->message);
1019 if (((Ustrstr(addr->message, "failed to expand") != NULL) || (Ustrstr(addr->message, "expansion of ") != NULL)) &&
1020 (Ustrstr(addr->message, "mysql") != NULL ||
1021 Ustrstr(addr->message, "pgsql") != NULL ||
1022 #ifdef EXPERIMENTAL_REDIS
1023 Ustrstr(addr->message, "redis") != NULL ||
1025 Ustrstr(addr->message, "sqlite") != NULL ||
1026 Ustrstr(addr->message, "ldap:") != NULL ||
1027 Ustrstr(addr->message, "ldapdn:") != NULL ||
1028 Ustrstr(addr->message, "ldapm:") != NULL))
1030 addr->message = string_sprintf("Temporary internal error");
1034 /* If we used a transport that has one of the "return_output" options set, and
1035 if it did in fact generate some output, then for return_output we treat the
1036 message as failed if it was not already set that way, so that the output gets
1037 returned to the sender, provided there is a sender to send it to. For
1038 return_fail_output, do this only if the delivery failed. Otherwise we just
1039 unlink the file, and remove the name so that if the delivery failed, we don't
1040 try to send back an empty or unwanted file. The log_output options operate only
1041 on a non-empty file.
1043 In any case, we close the message file, because we cannot afford to leave a
1044 file-descriptor for one address while processing (maybe very many) others. */
1046 if (addr->return_file >= 0 && addr->return_filename != NULL)
1048 BOOL return_output = FALSE;
1049 struct stat statbuf;
1050 (void)EXIMfsync(addr->return_file);
1052 /* If there is no output, do nothing. */
1054 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1056 transport_instance *tb = addr->transport;
1058 /* Handle logging options */
1060 if (tb->log_output || (result == FAIL && tb->log_fail_output) ||
1061 (result == DEFER && tb->log_defer_output))
1064 FILE *f = Ufopen(addr->return_filename, "rb");
1066 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1067 "from %s transport: %s", addr->return_filename, tb->name,
1071 s = US Ufgets(big_buffer, big_buffer_size, f);
1074 uschar *p = big_buffer + Ustrlen(big_buffer);
1075 while (p > big_buffer && isspace(p[-1])) p--;
1077 s = string_printing(big_buffer);
1078 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1079 addr->address, tb->name, s);
1085 /* Handle returning options, but only if there is an address to return
1088 if (sender_address[0] != 0 || addr->p.errors_address != NULL)
1090 if (tb->return_output)
1092 addr->transport_return = result = FAIL;
1093 if (addr->basic_errno == 0 && addr->message == NULL)
1094 addr->message = US"return message generated";
1095 return_output = TRUE;
1098 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1102 /* Get rid of the file unless it might be returned, but close it in
1107 Uunlink(addr->return_filename);
1108 addr->return_filename = NULL;
1109 addr->return_file = -1;
1112 (void)close(addr->return_file);
1115 /* The success case happens only after delivery by a transport. */
1119 addr->next = addr_succeed;
1120 addr_succeed = addr;
1122 /* Call address_done() to ensure that we don't deliver to this address again,
1123 and write appropriate things to the message log. If it is a child address, we
1124 call child_done() to scan the ancestors and mark them complete if this is the
1125 last child to complete. */
1127 address_done(addr, now);
1128 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1130 if (addr->parent == NULL)
1131 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1132 driver_name, driver_kind);
1135 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1136 addr->parent->address, driver_name, driver_kind);
1137 child_done(addr, now);
1140 /* Certificates for logging (via TPDA) */
1142 tls_out.ourcert = addr->ourcert;
1143 addr->ourcert = NULL;
1144 tls_out.peercert = addr->peercert;
1145 addr->peercert = NULL;
1147 tls_out.cipher = addr->cipher;
1148 tls_out.peerdn = addr->peerdn;
1149 tls_out.ocsp = addr->ocsp;
1150 # ifdef EXPERIMENTAL_DANE
1151 tls_out.dane_verified = testflag(addr, af_dane_verified);
1155 delivery_log(LOG_MAIN, addr, logchar, NULL);
1158 if (tls_out.ourcert)
1160 tls_free_cert(tls_out.ourcert);
1161 tls_out.ourcert = NULL;
1163 if (tls_out.peercert)
1165 tls_free_cert(tls_out.peercert);
1166 tls_out.peercert = NULL;
1168 tls_out.cipher = NULL;
1169 tls_out.peerdn = NULL;
1170 tls_out.ocsp = OCSP_NOT_REQ;
1171 # ifdef EXPERIMENTAL_DANE
1172 tls_out.dane_verified = FALSE;
1178 /* Soft failure, or local delivery process failed; freezing may be
1181 else if (result == DEFER || result == PANIC)
1183 if (result == PANIC) logflags |= LOG_PANIC;
1185 /* This puts them on the chain in reverse order. Do not change this, because
1186 the code for handling retries assumes that the one with the retry
1187 information is last. */
1189 addr->next = addr_defer;
1192 /* The only currently implemented special action is to freeze the
1193 message. Logging of this is done later, just before the -H file is
1196 if (addr->special_action == SPECIAL_FREEZE)
1198 deliver_freeze = TRUE;
1199 deliver_frozen_at = time(NULL);
1200 update_spool = TRUE;
1203 /* If doing a 2-stage queue run, we skip writing to either the message
1204 log or the main log for SMTP defers. */
1206 if (!queue_2stage || addr->basic_errno != 0)
1210 /* For errors of the type "retry time not reached" (also remotes skipped
1211 on queue run), logging is controlled by L_retry_defer. Note that this kind
1212 of error number is negative, and all the retry ones are less than any
1215 unsigned int use_log_selector = (addr->basic_errno <= ERRNO_RETRY_BASE)?
1218 /* Build up the line that is used for both the message log and the main
1221 s = reset_point = store_get(size);
1223 /* Create the address string for logging. Must not do this earlier, because
1224 an OK result may be changed to FAIL when a pipe returns text. */
1226 log_address = string_log_address(addr,
1227 (log_write_selector & L_all_parents) != 0, result == OK);
1229 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1231 /* Either driver_name contains something and driver_kind contains
1232 " router" or " transport" (note the leading space), or driver_name is
1233 a null string and driver_kind contains "routing" without the leading
1234 space, if all routing has been deferred. When a domain has been held,
1235 so nothing has been done at all, both variables contain null strings. */
1237 if (driver_name == NULL)
1239 if (driver_kind != NULL)
1240 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1244 if (driver_kind[1] == 't' && addr->router != NULL)
1245 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1247 ss[1] = toupper(driver_kind[1]);
1248 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1251 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1252 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1254 if (addr->basic_errno > 0)
1255 s = string_append(s, &size, &ptr, 2, US": ",
1256 US strerror(addr->basic_errno));
1258 if (addr->message != NULL)
1259 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1263 /* Log the deferment in the message log, but don't clutter it
1264 up with retry-time defers after the first delivery attempt. */
1266 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1267 deliver_msglog("%s %s\n", now, s);
1269 /* Write the main log and reset the store */
1271 log_write(use_log_selector, logflags, "== %s", s);
1272 store_reset(reset_point);
1277 /* Hard failure. If there is an address to which an error message can be sent,
1278 put this address on the failed list. If not, put it on the deferred list and
1279 freeze the mail message for human attention. The latter action can also be
1280 explicitly requested by a router or transport. */
1284 /* If this is a delivery error, or a message for which no replies are
1285 wanted, and the message's age is greater than ignore_bounce_errors_after,
1286 force the af_ignore_error flag. This will cause the address to be discarded
1287 later (with a log entry). */
1289 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1290 setflag(addr, af_ignore_error);
1292 /* Freeze the message if requested, or if this is a bounce message (or other
1293 message with null sender) and this address does not have its own errors
1294 address. However, don't freeze if errors are being ignored. The actual code
1295 to ignore occurs later, instead of sending a message. Logging of freezing
1296 occurs later, just before writing the -H file. */
1298 if (!testflag(addr, af_ignore_error) &&
1299 (addr->special_action == SPECIAL_FREEZE ||
1300 (sender_address[0] == 0 && addr->p.errors_address == NULL)
1303 frozen_info = (addr->special_action == SPECIAL_FREEZE)? US"" :
1304 (sender_local && !local_error_message)?
1305 US" (message created with -f <>)" : US" (delivery error message)";
1306 deliver_freeze = TRUE;
1307 deliver_frozen_at = time(NULL);
1308 update_spool = TRUE;
1310 /* The address is put on the defer rather than the failed queue, because
1311 the message is being retained. */
1313 addr->next = addr_defer;
1317 /* Don't put the address on the nonrecipients tree yet; wait until an
1318 error message has been successfully sent. */
1322 addr->next = addr_failed;
1326 /* Build up the log line for the message and main logs */
1328 s = reset_point = store_get(size);
1330 /* Create the address string for logging. Must not do this earlier, because
1331 an OK result may be changed to FAIL when a pipe returns text. */
1333 log_address = string_log_address(addr,
1334 (log_write_selector & L_all_parents) != 0, result == OK);
1336 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1338 if ((log_extra_selector & LX_sender_on_delivery) != 0)
1339 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1341 /* Return path may not be set if no delivery actually happened */
1343 if (used_return_path != NULL &&
1344 (log_extra_selector & LX_return_path_on_delivery) != 0)
1345 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1347 if (addr->router != NULL)
1348 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1349 if (addr->transport != NULL)
1350 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1352 if (addr->host_used != NULL)
1353 s = d_hostlog(s, &size, &ptr, addr);
1356 s = d_tlslog(s, &size, &ptr, addr);
1359 if (addr->basic_errno > 0)
1360 s = string_append(s, &size, &ptr, 2, US": ",
1361 US strerror(addr->basic_errno));
1363 if (addr->message != NULL)
1364 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1368 /* Do the logging. For the message log, "routing failed" for those cases,
1369 just to make it clearer. */
1371 if (driver_name == NULL)
1372 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1374 deliver_msglog("%s %s\n", now, s);
1376 log_write(0, LOG_MAIN, "** %s", s);
1378 #ifdef EXPERIMENTAL_TPDA
1379 tpda_msg_event(US"msg:fail:delivery", addr);
1382 store_reset(reset_point);
1385 /* Ensure logging is turned on again in all cases */
1387 disable_logging = FALSE;
1393 /*************************************************
1394 * Address-independent error *
1395 *************************************************/
1397 /* This function is called when there's an error that is not dependent on a
1398 particular address, such as an expansion string failure. It puts the error into
1399 all the addresses in a batch, logs the incident on the main and panic logs, and
1400 clears the expansions. It is mostly called from local_deliver(), but can be
1401 called for a remote delivery via findugid().
1404 logit TRUE if (MAIN+PANIC) logging required
1405 addr the first of the chain of addresses
1407 format format string for error message, or NULL if already set in addr
1408 ... arguments for the format
1414 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1416 address_item *addr2;
1417 addr->basic_errno = code;
1423 va_start(ap, format);
1424 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1425 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1426 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1428 addr->message = string_copy(buffer);
1431 for (addr2 = addr->next; addr2 != NULL; addr2 = addr2->next)
1433 addr2->basic_errno = code;
1434 addr2->message = addr->message;
1437 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1438 deliver_set_expansions(NULL);
1444 /*************************************************
1445 * Check a "never users" list *
1446 *************************************************/
1448 /* This function is called to check whether a uid is on one of the two "never
1452 uid the uid to be checked
1453 nusers the list to be scanned; the first item in the list is the count
1455 Returns: TRUE if the uid is on the list
1459 check_never_users(uid_t uid, uid_t *nusers)
1462 if (nusers == NULL) return FALSE;
1463 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1469 /*************************************************
1470 * Find uid and gid for a transport *
1471 *************************************************/
1473 /* This function is called for both local and remote deliveries, to find the
1474 uid/gid under which to run the delivery. The values are taken preferentially
1475 from the transport (either explicit or deliver_as_creator), then from the
1476 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1477 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1478 panic error is logged, and the function fails (which normally leads to delivery
1482 addr the address (possibly a chain)
1484 uidp pointer to uid field
1485 gidp pointer to gid field
1486 igfp pointer to the use_initgroups field
1488 Returns: FALSE if failed - error has been set in address(es)
1492 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1495 uschar *nuname = NULL;
1496 BOOL gid_set = FALSE;
1498 /* Default initgroups flag comes from the transport */
1500 *igfp = tp->initgroups;
1502 /* First see if there's a gid on the transport, either fixed or expandable.
1503 The expanding function always logs failure itself. */
1510 else if (tp->expand_gid != NULL)
1512 if (route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1513 &(addr->message))) gid_set = TRUE;
1516 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1521 /* If the transport did not set a group, see if the router did. */
1523 if (!gid_set && testflag(addr, af_gid_set))
1529 /* Pick up a uid from the transport if one is set. */
1531 if (tp->uid_set) *uidp = tp->uid;
1533 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1534 it does not provide a passwd value from which a gid can be taken. */
1536 else if (tp->expand_uid != NULL)
1539 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1540 uidp, &(addr->message)))
1542 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1545 if (!gid_set && pw != NULL)
1552 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1554 else if (tp->deliver_as_creator)
1556 *uidp = originator_uid;
1559 *gidp = originator_gid;
1564 /* Otherwise see if the address specifies the uid and if so, take it and its
1567 else if (testflag(addr, af_uid_set))
1570 *igfp = testflag(addr, af_initgroups);
1573 /* Nothing has specified the uid - default to the Exim user, and group if the
1586 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1587 defaulting to the Exim uid. In other words, if the configuration has specified
1588 a uid, it must also provide a gid. */
1592 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1593 "%s transport", tp->name);
1597 /* Check that the uid is not on the lists of banned uids that may not be used
1598 for delivery processes. */
1600 if (check_never_users(*uidp, never_users))
1601 nuname = US"never_users";
1602 else if (check_never_users(*uidp, fixed_never_users))
1603 nuname = US"fixed_never_users";
1607 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1608 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1620 /*************************************************
1621 * Check the size of a message for a transport *
1622 *************************************************/
1624 /* Checks that the message isn't too big for the selected transport.
1625 This is called only when it is known that the limit is set.
1629 addr the (first) address being delivered
1632 DEFER expansion failed or did not yield an integer
1633 FAIL message too big
1637 check_message_size(transport_instance *tp, address_item *addr)
1642 deliver_set_expansions(addr);
1643 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1644 deliver_set_expansions(NULL);
1646 if (expand_string_message != NULL)
1649 if (size_limit == -1)
1650 addr->message = string_sprintf("failed to expand message_size_limit "
1651 "in %s transport: %s", tp->name, expand_string_message);
1653 addr->message = string_sprintf("invalid message_size_limit "
1654 "in %s transport: %s", tp->name, expand_string_message);
1656 else if (size_limit > 0 && message_size > size_limit)
1660 string_sprintf("message is too big (transport limit = %d)",
1669 /*************************************************
1670 * Transport-time check for a previous delivery *
1671 *************************************************/
1673 /* Check that this base address hasn't previously been delivered to its routed
1674 transport. If it has been delivered, mark it done. The check is necessary at
1675 delivery time in order to handle homonymic addresses correctly in cases where
1676 the pattern of redirection changes between delivery attempts (so the unique
1677 fields change). Non-homonymic previous delivery is detected earlier, at routing
1678 time (which saves unnecessary routing).
1681 addr the address item
1682 testing TRUE if testing wanted only, without side effects
1684 Returns: TRUE if previously delivered by the transport
1688 previously_transported(address_item *addr, BOOL testing)
1690 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1691 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1693 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1695 DEBUG(D_deliver|D_route|D_transport)
1696 debug_printf("%s was previously delivered (%s transport): discarded\n",
1697 addr->address, addr->transport->name);
1698 if (!testing) child_done(addr, tod_stamp(tod_log));
1707 /******************************************************
1708 * Check for a given header in a header string *
1709 ******************************************************/
1711 /* This function is used when generating quota warnings. The configuration may
1712 specify any header lines it likes in quota_warn_message. If certain of them are
1713 missing, defaults are inserted, so we need to be able to test for the presence
1717 hdr the required header name
1718 hstring the header string
1720 Returns: TRUE the header is in the string
1721 FALSE the header is not in the string
1725 contains_header(uschar *hdr, uschar *hstring)
1727 int len = Ustrlen(hdr);
1728 uschar *p = hstring;
1731 if (strncmpic(p, hdr, len) == 0)
1734 while (*p == ' ' || *p == '\t') p++;
1735 if (*p == ':') return TRUE;
1737 while (*p != 0 && *p != '\n') p++;
1738 if (*p == '\n') p++;
1746 /*************************************************
1747 * Perform a local delivery *
1748 *************************************************/
1750 /* Each local delivery is performed in a separate process which sets its
1751 uid and gid as specified. This is a safer way than simply changing and
1752 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1753 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1754 all systems have seteuid().
1756 If the uid/gid are specified in the transport_instance, they are used; the
1757 transport initialization must ensure that either both or neither are set.
1758 Otherwise, the values associated with the address are used. If neither are set,
1759 it is a configuration error.
1761 The transport or the address may specify a home directory (transport over-
1762 rides), and if they do, this is set as $home. If neither have set a working
1763 directory, this value is used for that as well. Otherwise $home is left unset
1764 and the cwd is set to "/" - a directory that should be accessible to all users.
1766 Using a separate process makes it more complicated to get error information
1767 back. We use a pipe to pass the return code and also an error code and error
1768 text string back to the parent process.
1771 addr points to an address block for this delivery; for "normal" local
1772 deliveries this is the only address to be delivered, but for
1773 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1774 a number of addresses can be handled simultaneously, and in this
1775 case addr will point to a chain of addresses with the same
1778 shadowing TRUE if running a shadow transport; this causes output from pipes
1785 deliver_local(address_item *addr, BOOL shadowing)
1787 BOOL use_initgroups;
1790 int status, len, rc;
1793 uschar *working_directory;
1794 address_item *addr2;
1795 transport_instance *tp = addr->transport;
1797 /* Set up the return path from the errors or sender address. If the transport
1798 has its own return path setting, expand it and replace the existing value. */
1800 if(addr->p.errors_address != NULL)
1801 return_path = addr->p.errors_address;
1802 #ifdef EXPERIMENTAL_SRS
1803 else if(addr->p.srs_sender != NULL)
1804 return_path = addr->p.srs_sender;
1807 return_path = sender_address;
1809 if (tp->return_path != NULL)
1811 uschar *new_return_path = expand_string(tp->return_path);
1812 if (new_return_path == NULL)
1814 if (!expand_string_forcedfail)
1816 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1817 US"Failed to expand return path \"%s\" in %s transport: %s",
1818 tp->return_path, tp->name, expand_string_message);
1822 else return_path = new_return_path;
1825 /* For local deliveries, one at a time, the value used for logging can just be
1826 set directly, once and for all. */
1828 used_return_path = return_path;
1830 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1831 gets put into the address(es), and the expansions are unset, so we can just
1834 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1836 /* See if either the transport or the address specifies a home directory. A
1837 home directory set in the address may already be expanded; a flag is set to
1838 indicate that. In other cases we must expand it. */
1840 if ((deliver_home = tp->home_dir) != NULL || /* Set in transport, or */
1841 ((deliver_home = addr->home_dir) != NULL && /* Set in address and */
1842 !testflag(addr, af_home_expanded))) /* not expanded */
1844 uschar *rawhome = deliver_home;
1845 deliver_home = NULL; /* in case it contains $home */
1846 deliver_home = expand_string(rawhome);
1847 if (deliver_home == NULL)
1849 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1850 "to expand for %s transport: %s", rawhome, tp->name,
1851 expand_string_message);
1854 if (*deliver_home != '/')
1856 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1857 "is not absolute for %s transport", deliver_home, tp->name);
1862 /* See if either the transport or the address specifies a current directory,
1863 and if so, expand it. If nothing is set, use the home directory, unless it is
1864 also unset in which case use "/", which is assumed to be a directory to which
1865 all users have access. It is necessary to be in a visible directory for some
1866 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1867 2.5) require this. */
1869 working_directory = (tp->current_dir != NULL)?
1870 tp->current_dir : addr->current_dir;
1872 if (working_directory != NULL)
1874 uschar *raw = working_directory;
1875 working_directory = expand_string(raw);
1876 if (working_directory == NULL)
1878 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1879 "failed to expand for %s transport: %s", raw, tp->name,
1880 expand_string_message);
1883 if (*working_directory != '/')
1885 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1886 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1890 else working_directory = (deliver_home == NULL)? US"/" : deliver_home;
1892 /* If one of the return_output flags is set on the transport, create and open a
1893 file in the message log directory for the transport to write its output onto.
1894 This is mainly used by pipe transports. The file needs to be unique to the
1895 address. This feature is not available for shadow transports. */
1897 if (!shadowing && (tp->return_output || tp->return_fail_output ||
1898 tp->log_output || tp->log_fail_output))
1901 addr->return_filename =
1902 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1903 message_id, getpid(), return_count++);
1904 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1905 if (addr->return_file < 0)
1907 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1908 "to return message: %s", error, tp->name, strerror(errno));
1913 /* Create the pipe for inter-process communication. */
1917 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1922 /* Now fork the process to do the real work in the subprocess, but first
1923 ensure that all cached resources are freed so that the subprocess starts with
1924 a clean slate and doesn't interfere with the parent process. */
1928 if ((pid = fork()) == 0)
1930 BOOL replicate = TRUE;
1932 /* Prevent core dumps, as we don't want them in users' home directories.
1933 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1934 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1935 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1936 complain if the error is "not supported".
1938 There are two scenarios where changing the max limit has an effect. In one,
1939 the user is using a .forward and invoking a command of their choice via pipe;
1940 for these, we do need the max limit to be 0 unless the admin chooses to
1941 permit an increased limit. In the other, the command is invoked directly by
1942 the transport and is under administrator control, thus being able to raise
1943 the limit aids in debugging. So there's no general always-right answer.
1945 Thus we inhibit core-dumps completely but let individual transports, while
1946 still root, re-raise the limits back up to aid debugging. We make the
1947 default be no core-dumps -- few enough people can use core dumps in
1948 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1955 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1957 # ifdef SETRLIMIT_NOT_SUPPORTED
1958 if (errno != ENOSYS && errno != ENOTSUP)
1960 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1965 /* Reset the random number generator, so different processes don't all
1966 have the same sequence. */
1970 /* If the transport has a setup entry, call this first, while still
1971 privileged. (Appendfile uses this to expand quota, for example, while
1972 able to read private files.) */
1974 if (addr->transport->setup != NULL)
1976 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
1980 addr->transport_return = DEFER;
1984 addr->transport_return = PANIC;
1989 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
1990 when the process becomes unprivileged, it won't be able to write to the
1991 process log. SIGHUP is ignored throughout exim, except when it is being
1994 signal(SIGINT, SIG_IGN);
1995 signal(SIGTERM, SIG_IGN);
1996 signal(SIGUSR1, SIG_IGN);
1998 /* Close the unwanted half of the pipe, and set close-on-exec for the other
1999 half - for transports that exec things (e.g. pipe). Then set the required
2002 (void)close(pfd[pipe_read]);
2003 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2005 exim_setugid(uid, gid, use_initgroups,
2006 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2007 addr->address, addr->transport->name));
2011 address_item *batched;
2012 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2013 for (batched = addr->next; batched != NULL; batched = batched->next)
2014 debug_printf("additional batched address: %s\n", batched->address);
2017 /* Set an appropriate working directory. */
2019 if (Uchdir(working_directory) < 0)
2021 addr->transport_return = DEFER;
2022 addr->basic_errno = errno;
2023 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2026 /* If successful, call the transport */
2031 set_process_info("delivering %s to %s using %s", message_id,
2032 addr->local_part, addr->transport->name);
2034 /* Setting this global in the subprocess means we need never clear it */
2035 transport_name = addr->transport->name;
2037 /* If a transport filter has been specified, set up its argument list.
2038 Any errors will get put into the address, and FALSE yielded. */
2040 if (addr->transport->filter_command != NULL)
2042 ok = transport_set_up_command(&transport_filter_argv,
2043 addr->transport->filter_command,
2044 TRUE, PANIC, addr, US"transport filter", NULL);
2045 transport_filter_timeout = addr->transport->filter_timeout;
2047 else transport_filter_argv = NULL;
2051 debug_print_string(addr->transport->debug_string);
2052 replicate = !(addr->transport->info->code)(addr->transport, addr);
2056 /* Pass the results back down the pipe. If necessary, first replicate the
2057 status in the top address to the others in the batch. The label is the
2058 subject of a goto when a call to the transport's setup function fails. We
2059 pass the pointer to the transport back in case it got changed as a result of
2060 file_format in appendfile. */
2064 if (replicate) replicate_status(addr);
2065 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2068 int local_part_length = Ustrlen(addr2->local_part);
2072 if( (ret = write(pfd[pipe_write], (void *)&(addr2->transport_return), sizeof(int))) != sizeof(int)
2073 || (ret = write(pfd[pipe_write], (void *)&transport_count, sizeof(transport_count))) != sizeof(transport_count)
2074 || (ret = write(pfd[pipe_write], (void *)&(addr2->flags), sizeof(addr2->flags))) != sizeof(addr2->flags)
2075 || (ret = write(pfd[pipe_write], (void *)&(addr2->basic_errno), sizeof(int))) != sizeof(int)
2076 || (ret = write(pfd[pipe_write], (void *)&(addr2->more_errno), sizeof(int))) != sizeof(int)
2077 || (ret = write(pfd[pipe_write], (void *)&(addr2->special_action), sizeof(int))) != sizeof(int)
2078 || (ret = write(pfd[pipe_write], (void *)&(addr2->transport),
2079 sizeof(transport_instance *))) != sizeof(transport_instance *)
2081 /* For a file delivery, pass back the local part, in case the original
2082 was only part of the final delivery path. This gives more complete
2085 || (testflag(addr2, af_file)
2086 && ( (ret = write(pfd[pipe_write], (void *)&local_part_length, sizeof(int))) != sizeof(int)
2087 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2091 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2092 ret == -1 ? strerror(errno) : "short write");
2094 /* Now any messages */
2096 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2098 int message_length = (s == NULL)? 0 : Ustrlen(s) + 1;
2099 if( (ret = write(pfd[pipe_write], (void *)&message_length, sizeof(int))) != sizeof(int)
2100 || (message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length)
2102 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2103 ret == -1 ? strerror(errno) : "short write");
2107 /* OK, this process is now done. Free any cached resources that it opened,
2108 and close the pipe we were writing down before exiting. */
2110 (void)close(pfd[pipe_write]);
2115 /* Back in the main process: panic if the fork did not succeed. This seems
2116 better than returning an error - if forking is failing it is probably best
2117 not to try other deliveries for this message. */
2120 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2123 /* Read the pipe to get the delivery status codes and error messages. Our copy
2124 of the writing end must be closed first, as otherwise read() won't return zero
2125 on an empty pipe. We check that a status exists for each address before
2126 overwriting the address structure. If data is missing, the default DEFER status
2127 will remain. Afterwards, close the reading end. */
2129 (void)close(pfd[pipe_write]);
2131 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2133 len = read(pfd[pipe_read], (void *)&status, sizeof(int));
2139 addr2->transport_return = status;
2140 len = read(pfd[pipe_read], (void *)&transport_count,
2141 sizeof(transport_count));
2142 len = read(pfd[pipe_read], (void *)&(addr2->flags), sizeof(addr2->flags));
2143 len = read(pfd[pipe_read], (void *)&(addr2->basic_errno), sizeof(int));
2144 len = read(pfd[pipe_read], (void *)&(addr2->more_errno), sizeof(int));
2145 len = read(pfd[pipe_read], (void *)&(addr2->special_action), sizeof(int));
2146 len = read(pfd[pipe_read], (void *)&(addr2->transport),
2147 sizeof(transport_instance *));
2149 if (testflag(addr2, af_file))
2151 int local_part_length;
2152 len = read(pfd[pipe_read], (void *)&local_part_length, sizeof(int));
2153 len = read(pfd[pipe_read], (void *)big_buffer, local_part_length);
2154 big_buffer[local_part_length] = 0;
2155 addr2->local_part = string_copy(big_buffer);
2158 for (i = 0, sptr = &(addr2->message); i < 2;
2159 i++, sptr = &(addr2->user_message))
2162 len = read(pfd[pipe_read], (void *)&message_length, sizeof(int));
2163 if (message_length > 0)
2165 len = read(pfd[pipe_read], (void *)big_buffer, message_length);
2166 if (len > 0) *sptr = string_copy(big_buffer);
2173 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2174 "from delivery subprocess", addr2->unique);
2179 (void)close(pfd[pipe_read]);
2181 /* Unless shadowing, write all successful addresses immediately to the journal
2182 file, to ensure they are recorded asap. For homonymic addresses, use the base
2183 address plus the transport name. Failure to write the journal is panic-worthy,
2184 but don't stop, as it may prove possible subsequently to update the spool file
2185 in order to record the delivery. */
2189 for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2191 if (addr2->transport_return != OK) continue;
2193 if (testflag(addr2, af_homonym))
2194 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2196 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2198 /* In the test harness, wait just a bit to let the subprocess finish off
2199 any debug output etc first. */
2201 if (running_in_test_harness) millisleep(300);
2203 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2204 len = Ustrlen(big_buffer);
2205 if (write(journal_fd, big_buffer, len) != len)
2206 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2207 big_buffer, strerror(errno));
2210 /* Ensure the journal file is pushed out to disk. */
2212 if (EXIMfsync(journal_fd) < 0)
2213 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2217 /* Wait for the process to finish. If it terminates with a non-zero code,
2218 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2219 status values of all the addresses as they are. Take care to handle the case
2220 when the subprocess doesn't seem to exist. This has been seen on one system
2221 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2222 happens, wait() doesn't recognize the termination of child processes. Exim now
2223 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2225 while ((rc = wait(&status)) != pid)
2227 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2229 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2230 addr->transport->driver_name);
2236 if ((status & 0xffff) != 0)
2238 int msb = (status >> 8) & 255;
2239 int lsb = status & 255;
2240 int code = (msb == 0)? (lsb & 0x7f) : msb;
2241 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2242 addr->special_action = SPECIAL_FREEZE;
2243 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2244 "status 0x%04x: %s %d",
2245 addr->transport->driver_name,
2247 (msb == 0)? "terminated by signal" : "exit code",
2251 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2253 if (addr->special_action == SPECIAL_WARN &&
2254 addr->transport->warn_message != NULL)
2257 uschar *warn_message;
2259 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2261 warn_message = expand_string(addr->transport->warn_message);
2262 if (warn_message == NULL)
2263 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2264 "message for %s transport): %s", addr->transport->warn_message,
2265 addr->transport->name, expand_string_message);
2268 pid_t pid = child_open_exim(&fd);
2271 FILE *f = fdopen(fd, "wb");
2272 if (errors_reply_to != NULL &&
2273 !contains_header(US"Reply-To", warn_message))
2274 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2275 fprintf(f, "Auto-Submitted: auto-replied\n");
2276 if (!contains_header(US"From", warn_message)) moan_write_from(f);
2277 fprintf(f, "%s", CS warn_message);
2279 /* Close and wait for child process to complete, without a timeout. */
2282 (void)child_close(pid, 0);
2286 addr->special_action = SPECIAL_NONE;
2292 /*************************************************
2293 * Do local deliveries *
2294 *************************************************/
2296 /* This function processes the list of addresses in addr_local. True local
2297 deliveries are always done one address at a time. However, local deliveries can
2298 be batched up in some cases. Typically this is when writing batched SMTP output
2299 files for use by some external transport mechanism, or when running local
2300 deliveries over LMTP.
2307 do_local_deliveries(void)
2310 open_db *dbm_file = NULL;
2311 time_t now = time(NULL);
2313 /* Loop until we have exhausted the supply of local deliveries */
2315 while (addr_local != NULL)
2317 time_t delivery_start;
2319 address_item *addr2, *addr3, *nextaddr;
2320 int logflags = LOG_MAIN;
2321 int logchar = dont_deliver? '*' : '=';
2322 transport_instance *tp;
2324 /* Pick the first undelivered address off the chain */
2326 address_item *addr = addr_local;
2327 addr_local = addr->next;
2330 DEBUG(D_deliver|D_transport)
2331 debug_printf("--------> %s <--------\n", addr->address);
2333 /* An internal disaster if there is no transport. Should not occur! */
2335 if ((tp = addr->transport) == NULL)
2337 logflags |= LOG_PANIC;
2338 disable_logging = FALSE; /* Jic */
2340 (addr->router != NULL)?
2341 string_sprintf("No transport set by %s router", addr->router->name)
2343 string_sprintf("No transport set by system filter");
2344 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2348 /* Check that this base address hasn't previously been delivered to this
2349 transport. The check is necessary at this point to handle homonymic addresses
2350 correctly in cases where the pattern of redirection changes between delivery
2351 attempts. Non-homonymic previous delivery is detected earlier, at routing
2354 if (previously_transported(addr, FALSE)) continue;
2356 /* There are weird cases where logging is disabled */
2358 disable_logging = tp->disable_logging;
2360 /* Check for batched addresses and possible amalgamation. Skip all the work
2361 if either batch_max <= 1 or there aren't any other addresses for local
2364 if (tp->batch_max > 1 && addr_local != NULL)
2366 int batch_count = 1;
2367 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2368 BOOL uses_lp = (testflag(addr, af_pfr) &&
2369 (testflag(addr, af_file) || addr->local_part[0] == '|')) ||
2370 readconf_depends((driver_instance *)tp, US"local_part");
2371 uschar *batch_id = NULL;
2372 address_item **anchor = &addr_local;
2373 address_item *last = addr;
2376 /* Expand the batch_id string for comparison with other addresses.
2377 Expansion failure suppresses batching. */
2379 if (tp->batch_id != NULL)
2381 deliver_set_expansions(addr);
2382 batch_id = expand_string(tp->batch_id);
2383 deliver_set_expansions(NULL);
2384 if (batch_id == NULL)
2386 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2387 "in %s transport (%s): %s", tp->name, addr->address,
2388 expand_string_message);
2389 batch_count = tp->batch_max;
2393 /* Until we reach the batch_max limit, pick off addresses which have the
2394 same characteristics. These are:
2397 not previously delivered (see comment about 50 lines above)
2398 same local part if the transport's configuration contains $local_part
2399 or if this is a file or pipe delivery from a redirection
2400 same domain if the transport's configuration contains $domain
2402 same additional headers
2403 same headers to be removed
2404 same uid/gid for running the transport
2405 same first host if a host list is set
2408 while ((next = *anchor) != NULL && batch_count < tp->batch_max)
2411 tp == next->transport &&
2412 !previously_transported(next, TRUE) &&
2413 (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file)) &&
2414 (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0) &&
2415 (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0) &&
2416 same_strings(next->p.errors_address, addr->p.errors_address) &&
2417 same_headers(next->p.extra_headers, addr->p.extra_headers) &&
2418 same_strings(next->p.remove_headers, addr->p.remove_headers) &&
2419 same_ugid(tp, addr, next) &&
2420 ((addr->host_list == NULL && next->host_list == NULL) ||
2421 (addr->host_list != NULL && next->host_list != NULL &&
2422 Ustrcmp(addr->host_list->name, next->host_list->name) == 0));
2424 /* If the transport has a batch_id setting, batch_id will be non-NULL
2425 from the expansion outside the loop. Expand for this address and compare.
2426 Expansion failure makes this address ineligible for batching. */
2428 if (ok && batch_id != NULL)
2431 address_item *save_nextnext = next->next;
2432 next->next = NULL; /* Expansion for a single address */
2433 deliver_set_expansions(next);
2434 next->next = save_nextnext;
2435 bid = expand_string(tp->batch_id);
2436 deliver_set_expansions(NULL);
2439 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2440 "in %s transport (%s): %s", tp->name, next->address,
2441 expand_string_message);
2444 else ok = (Ustrcmp(batch_id, bid) == 0);
2447 /* Take address into batch if OK. */
2451 *anchor = next->next; /* Include the address */
2457 else anchor = &(next->next); /* Skip the address */
2461 /* We now have one or more addresses that can be delivered in a batch. Check
2462 whether the transport is prepared to accept a message of this size. If not,
2463 fail them all forthwith. If the expansion fails, or does not yield an
2464 integer, defer delivery. */
2466 if (tp->message_size_limit != NULL)
2468 int rc = check_message_size(tp, addr);
2471 replicate_status(addr);
2472 while (addr != NULL)
2475 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2478 continue; /* With next batch of addresses */
2482 /* If we are not running the queue, or if forcing, all deliveries will be
2483 attempted. Otherwise, we must respect the retry times for each address. Even
2484 when not doing this, we need to set up the retry key string, and determine
2485 whether a retry record exists, because after a successful delivery, a delete
2486 retry item must be set up. Keep the retry database open only for the duration
2487 of these checks, rather than for all local deliveries, because some local
2488 deliveries (e.g. to pipes) can take a substantial time. */
2490 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
2491 if (dbm_file == NULL)
2493 DEBUG(D_deliver|D_retry|D_hints_lookup)
2494 debug_printf("no retry data available\n");
2499 while (addr2 != NULL)
2501 BOOL ok = TRUE; /* to deliver this address */
2504 /* Set up the retry key to include the domain or not, and change its
2505 leading character from "R" to "T". Must make a copy before doing this,
2506 because the old key may be pointed to from a "delete" retry item after
2509 retry_key = string_copy(
2510 (tp->retry_use_local_part)? addr2->address_retry_key :
2511 addr2->domain_retry_key);
2514 /* Inspect the retry data. If there is no hints file, delivery happens. */
2516 if (dbm_file != NULL)
2518 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2520 /* If there is no retry record, delivery happens. If there is,
2521 remember it exists so it can be deleted after a successful delivery. */
2523 if (retry_record != NULL)
2525 setflag(addr2, af_lt_retry_exists);
2527 /* A retry record exists for this address. If queue running and not
2528 forcing, inspect its contents. If the record is too old, or if its
2529 retry time has come, or if it has passed its cutoff time, delivery
2534 debug_printf("retry record exists: age=%s ",
2535 readconf_printtime(now - retry_record->time_stamp));
2536 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2537 debug_printf(" time to retry = %s expired = %d\n",
2538 readconf_printtime(retry_record->next_try - now),
2539 retry_record->expired);
2542 if (queue_running && !deliver_force)
2544 ok = (now - retry_record->time_stamp > retry_data_expire) ||
2545 (now >= retry_record->next_try) ||
2546 retry_record->expired;
2548 /* If we haven't reached the retry time, there is one more check
2549 to do, which is for the ultimate address timeout. */
2552 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2556 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2559 /* This address is to be delivered. Leave it on the chain. */
2564 addr2 = addr2->next;
2567 /* This address is to be deferred. Take it out of the chain, and
2568 post-process it as complete. Must take it out of the chain first,
2569 because post processing puts it on another chain. */
2573 address_item *this = addr2;
2574 this->message = US"Retry time not yet reached";
2575 this->basic_errno = ERRNO_LRETRY;
2576 if (addr3 == NULL) addr2 = addr = addr2->next;
2577 else addr2 = addr3->next = addr2->next;
2578 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2582 if (dbm_file != NULL) dbfn_close(dbm_file);
2584 /* If there are no addresses left on the chain, they all deferred. Loop
2585 for the next set of addresses. */
2587 if (addr == NULL) continue;
2589 /* So, finally, we do have some addresses that can be passed to the
2590 transport. Before doing so, set up variables that are relevant to a
2593 deliver_set_expansions(addr);
2594 delivery_start = time(NULL);
2595 deliver_local(addr, FALSE);
2596 deliver_time = (int)(time(NULL) - delivery_start);
2598 /* If a shadow transport (which must perforce be another local transport), is
2599 defined, and its condition is met, we must pass the message to the shadow
2600 too, but only those addresses that succeeded. We do this by making a new
2601 chain of addresses - also to keep the original chain uncontaminated. We must
2602 use a chain rather than doing it one by one, because the shadow transport may
2605 NOTE: if the condition fails because of a lookup defer, there is nothing we
2608 if (tp->shadow != NULL &&
2609 (tp->shadow_condition == NULL ||
2610 expand_check_condition(tp->shadow_condition, tp->name, US"transport")))
2612 transport_instance *stp;
2613 address_item *shadow_addr = NULL;
2614 address_item **last = &shadow_addr;
2616 for (stp = transports; stp != NULL; stp = stp->next)
2617 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2620 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2623 /* Pick off the addresses that have succeeded, and make clones. Put into
2624 the shadow_message field a pointer to the shadow_message field of the real
2627 else for (addr2 = addr; addr2 != NULL; addr2 = addr2->next)
2629 if (addr2->transport_return != OK) continue;
2630 addr3 = store_get(sizeof(address_item));
2633 addr3->shadow_message = (uschar *)(&(addr2->shadow_message));
2634 addr3->transport = stp;
2635 addr3->transport_return = DEFER;
2636 addr3->return_filename = NULL;
2637 addr3->return_file = -1;
2639 last = &(addr3->next);
2642 /* If we found any addresses to shadow, run the delivery, and stick any
2643 message back into the shadow_message field in the original. */
2645 if (shadow_addr != NULL)
2647 int save_count = transport_count;
2649 DEBUG(D_deliver|D_transport)
2650 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2651 deliver_local(shadow_addr, TRUE);
2653 for(; shadow_addr != NULL; shadow_addr = shadow_addr->next)
2655 int sresult = shadow_addr->transport_return;
2656 *((uschar **)(shadow_addr->shadow_message)) = (sresult == OK)?
2657 string_sprintf(" ST=%s", stp->name) :
2658 string_sprintf(" ST=%s (%s%s%s)", stp->name,
2659 (shadow_addr->basic_errno <= 0)?
2660 US"" : US strerror(shadow_addr->basic_errno),
2661 (shadow_addr->basic_errno <= 0 || shadow_addr->message == NULL)?
2663 (shadow_addr->message != NULL)? shadow_addr->message :
2664 (shadow_addr->basic_errno <= 0)? US"unknown error" : US"");
2666 DEBUG(D_deliver|D_transport)
2667 debug_printf("%s shadow transport returned %s for %s\n",
2669 (sresult == OK)? "OK" :
2670 (sresult == DEFER)? "DEFER" :
2671 (sresult == FAIL)? "FAIL" :
2672 (sresult == PANIC)? "PANIC" : "?",
2673 shadow_addr->address);
2676 DEBUG(D_deliver|D_transport)
2677 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2679 transport_count = save_count; /* Restore original transport count */
2683 /* Cancel the expansions that were set up for the delivery. */
2685 deliver_set_expansions(NULL);
2687 /* Now we can process the results of the real transport. We must take each
2688 address off the chain first, because post_process_one() puts it on another
2691 for (addr2 = addr; addr2 != NULL; addr2 = nextaddr)
2693 int result = addr2->transport_return;
2694 nextaddr = addr2->next;
2696 DEBUG(D_deliver|D_transport)
2697 debug_printf("%s transport returned %s for %s\n",
2699 (result == OK)? "OK" :
2700 (result == DEFER)? "DEFER" :
2701 (result == FAIL)? "FAIL" :
2702 (result == PANIC)? "PANIC" : "?",
2705 /* If there is a retry_record, or if delivery is deferred, build a retry
2706 item for setting a new retry time or deleting the old retry record from
2707 the database. These items are handled all together after all addresses
2708 have been handled (so the database is open just for a short time for
2711 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2713 int flags = (result == DEFER)? 0 : rf_delete;
2714 uschar *retry_key = string_copy((tp->retry_use_local_part)?
2715 addr2->address_retry_key : addr2->domain_retry_key);
2717 retry_add_item(addr2, retry_key, flags);
2720 /* Done with this address */
2722 if (result == OK) addr2->more_errno = deliver_time;
2723 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2725 /* If a pipe delivery generated text to be sent back, the result may be
2726 changed to FAIL, and we must copy this for subsequent addresses in the
2729 if (addr2->transport_return != result)
2731 for (addr3 = nextaddr; addr3 != NULL; addr3 = addr3->next)
2733 addr3->transport_return = addr2->transport_return;
2734 addr3->basic_errno = addr2->basic_errno;
2735 addr3->message = addr2->message;
2737 result = addr2->transport_return;
2740 /* Whether or not the result was changed to FAIL, we need to copy the
2741 return_file value from the first address into all the addresses of the
2742 batch, so they are all listed in the error message. */
2744 addr2->return_file = addr->return_file;
2746 /* Change log character for recording successful deliveries. */
2748 if (result == OK) logchar = '-';
2750 } /* Loop back for next batch of addresses */
2756 /*************************************************
2757 * Sort remote deliveries *
2758 *************************************************/
2760 /* This function is called if remote_sort_domains is set. It arranges that the
2761 chain of addresses for remote deliveries is ordered according to the strings
2762 specified. Try to make this shuffling reasonably efficient by handling
2763 sequences of addresses rather than just single ones.
2770 sort_remote_deliveries(void)
2773 address_item **aptr = &addr_remote;
2774 uschar *listptr = remote_sort_domains;
2778 while (*aptr != NULL &&
2779 (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2782 address_item *moved = NULL;
2783 address_item **bptr = &moved;
2785 while (*aptr != NULL)
2787 address_item **next;
2788 deliver_domain = (*aptr)->domain; /* set $domain */
2789 if (match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2790 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2792 aptr = &((*aptr)->next);
2796 next = &((*aptr)->next);
2797 while (*next != NULL &&
2798 (deliver_domain = (*next)->domain, /* Set $domain */
2799 match_isinlist(deliver_domain, &pattern, UCHAR_MAX+1,
2800 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK)
2801 next = &((*next)->next);
2803 /* If the batch of non-matchers is at the end, add on any that were
2804 extracted further up the chain, and end this iteration. Otherwise,
2805 extract them from the chain and hang on the moved chain. */
2817 aptr = &((*aptr)->next);
2820 /* If the loop ended because the final address matched, *aptr will
2821 be NULL. Add on to the end any extracted non-matching addresses. If
2822 *aptr is not NULL, the loop ended via "break" when *next is null, that
2823 is, there was a string of non-matching addresses at the end. In this
2824 case the extracted addresses have already been added on the end. */
2826 if (*aptr == NULL) *aptr = moved;
2832 debug_printf("remote addresses after sorting:\n");
2833 for (addr = addr_remote; addr != NULL; addr = addr->next)
2834 debug_printf(" %s\n", addr->address);
2840 /*************************************************
2841 * Read from pipe for remote delivery subprocess *
2842 *************************************************/
2844 /* This function is called when the subprocess is complete, but can also be
2845 called before it is complete, in order to empty a pipe that is full (to prevent
2846 deadlock). It must therefore keep track of its progress in the parlist data
2849 We read the pipe to get the delivery status codes and a possible error message
2850 for each address, optionally preceded by unusability data for the hosts and
2851 also by optional retry data.
2853 Read in large chunks into the big buffer and then scan through, interpreting
2854 the data therein. In most cases, only a single read will be necessary. No
2855 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2856 that we read the next chunk when there is less than 2500 bytes left in the
2857 non-final chunk, we can assume each item is complete in the buffer before
2858 handling it. Each item is written using a single write(), which is atomic for
2859 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2860 often bigger) so even if we are reading while the subprocess is still going, we
2861 should never have only a partial item in the buffer.
2864 poffset the offset of the parlist item
2865 eop TRUE if the process has completed
2867 Returns: TRUE if the terminating 'Z' item has been read,
2868 or there has been a disaster (i.e. no more data needed);
2873 par_read_pipe(int poffset, BOOL eop)
2876 pardata *p = parlist + poffset;
2877 address_item *addrlist = p->addrlist;
2878 address_item *addr = p->addr;
2881 uschar *endptr = big_buffer;
2882 uschar *ptr = endptr;
2883 uschar *msg = p->msg;
2884 BOOL done = p->done;
2885 BOOL unfinished = TRUE;
2887 /* Loop through all items, reading from the pipe when necessary. The pipe
2888 is set up to be non-blocking, but there are two different Unix mechanisms in
2889 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2890 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2891 which returns 0 for both end of file and no more data. We distinguish the
2892 two cases by taking 0 as end of file only when we know the process has
2895 Each separate item is written to the pipe in a single write(), and as they are
2896 all short items, the writes will all be atomic and we should never find
2897 ourselves in the position of having read an incomplete item. "Short" in this
2898 case can mean up to about 1K in the case when there is a long error message
2899 associated with an address. */
2901 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
2902 (int)p->pid, eop? "ended" : "not ended");
2906 retry_item *r, **rp;
2907 int remaining = endptr - ptr;
2909 /* Read (first time) or top up the chars in the buffer if necessary.
2910 There will be only one read if we get all the available data (i.e. don't
2911 fill the buffer completely). */
2913 if (remaining < 2500 && unfinished)
2916 int available = big_buffer_size - remaining;
2918 if (remaining > 0) memmove(big_buffer, ptr, remaining);
2921 endptr = big_buffer + remaining;
2922 len = read(fd, endptr, available);
2924 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
2926 /* If the result is EAGAIN and the process is not complete, just
2927 stop reading any more and process what we have already. */
2931 if (!eop && errno == EAGAIN) len = 0; else
2933 msg = string_sprintf("failed to read pipe from transport process "
2934 "%d for transport %s: %s", pid, addr->transport->driver_name,
2940 /* If the length is zero (eof or no-more-data), just process what we
2941 already have. Note that if the process is still running and we have
2942 read all the data in the pipe (but less that "available") then we
2943 won't read any more, as "unfinished" will get set FALSE. */
2946 unfinished = len == available;
2949 /* If we are at the end of the available data, exit the loop. */
2951 if (ptr >= endptr) break;
2953 /* Handle each possible type of item, assuming the complete item is
2954 available in store. */
2958 /* Host items exist only if any hosts were marked unusable. Match
2959 up by checking the IP address. */
2962 for (h = addrlist->host_list; h != NULL; h = h->next)
2964 if (h->address == NULL || Ustrcmp(h->address, ptr+2) != 0) continue;
2972 /* Retry items are sent in a preceding R item for each address. This is
2973 kept separate to keep each message short enough to guarantee it won't
2974 be split in the pipe. Hopefully, in the majority of cases, there won't in
2975 fact be any retry items at all.
2977 The complete set of retry items might include an item to delete a
2978 routing retry if there was a previous routing delay. However, routing
2979 retries are also used when a remote transport identifies an address error.
2980 In that case, there may also be an "add" item for the same key. Arrange
2981 that a "delete" item is dropped in favour of an "add" item. */
2984 if (addr == NULL) goto ADDR_MISMATCH;
2986 DEBUG(D_deliver|D_retry)
2987 debug_printf("reading retry information for %s from subprocess\n",
2990 /* Cut out any "delete" items on the list. */
2992 for (rp = &(addr->retries); (r = *rp) != NULL; rp = &(r->next))
2994 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
2996 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
2997 *rp = r->next; /* Excise a delete item */
2998 DEBUG(D_deliver|D_retry)
2999 debug_printf(" existing delete item dropped\n");
3003 /* We want to add a delete item only if there is no non-delete item;
3004 however we still have to step ptr through the data. */
3006 if (r == NULL || (*ptr & rf_delete) == 0)
3008 r = store_get(sizeof(retry_item));
3009 r->next = addr->retries;
3012 r->key = string_copy(ptr);
3014 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3015 ptr += sizeof(r->basic_errno);
3016 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3017 ptr += sizeof(r->more_errno);
3018 r->message = (*ptr)? string_copy(ptr) : NULL;
3019 DEBUG(D_deliver|D_retry)
3020 debug_printf(" added %s item\n",
3021 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3026 DEBUG(D_deliver|D_retry)
3027 debug_printf(" delete item not added: non-delete item exists\n");
3030 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3036 /* Put the amount of data written into the parlist block */
3039 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3040 ptr += sizeof(transport_count);
3043 /* Address items are in the order of items on the address chain. We
3044 remember the current address value in case this function is called
3045 several times to empty the pipe in stages. Information about delivery
3046 over TLS is sent in a preceding X item for each address. We don't put
3047 it in with the other info, in order to keep each message short enough to
3048 guarantee it won't be split in the pipe. */
3052 if (addr == NULL) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3056 addr->cipher = NULL;
3057 addr->peerdn = NULL;
3060 addr->cipher = string_copy(ptr);
3063 addr->peerdn = string_copy(ptr);
3067 addr->peercert = NULL;
3069 (void) tls_import_cert(ptr, &addr->peercert);
3073 addr->ourcert = NULL;
3075 (void) tls_import_cert(ptr, &addr->ourcert);
3078 # ifndef DISABLE_OCSP
3080 addr->ocsp = OCSP_NOT_REQ;
3082 addr->ocsp = *ptr - '0';
3088 #endif /*SUPPORT_TLS*/
3090 case 'C': /* client authenticator information */
3094 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3097 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3100 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3106 #ifndef DISABLE_PRDR
3108 addr->flags |= af_prdr_used;
3112 #ifdef EXPERIMENTAL_DSN
3114 if (addr == NULL) break;
3115 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3116 ptr += sizeof(addr->dsn_aware);
3117 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3125 msg = string_sprintf("address count mismatch for data read from pipe "
3126 "for transport process %d for transport %s", pid,
3127 addrlist->transport->driver_name);
3132 addr->transport_return = *ptr++;
3133 addr->special_action = *ptr++;
3134 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3135 ptr += sizeof(addr->basic_errno);
3136 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3137 ptr += sizeof(addr->more_errno);
3138 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3139 ptr += sizeof(addr->flags);
3140 addr->message = (*ptr)? string_copy(ptr) : NULL;
3142 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3145 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3149 h = store_get(sizeof(host_item));
3150 h->name = string_copy(ptr);
3152 h->address = string_copy(ptr);
3154 memcpy(&(h->port), ptr, sizeof(h->port));
3155 ptr += sizeof(h->port);
3156 h->dnssec = *ptr == '2' ? DS_YES
3157 : *ptr == '1' ? DS_NO
3160 addr->host_used = h;
3164 /* Finished with this address */
3169 /* Z marks the logical end of the data. It is followed by '0' if
3170 continue_transport was NULL at the end of transporting, otherwise '1'.
3171 We need to know when it becomes NULL during a delivery down a passed SMTP
3172 channel so that we don't try to pass anything more down it. Of course, for
3173 most normal messages it will remain NULL all the time. */
3178 continue_transport = NULL;
3179 continue_hostname = NULL;
3182 DEBUG(D_deliver) debug_printf("Z%c item read\n", *ptr);
3185 /* Anything else is a disaster. */
3188 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3189 "process %d for transport %s", ptr[-1], pid,
3190 addr->transport->driver_name);
3196 /* The done flag is inspected externally, to determine whether or not to
3197 call the function again when the process finishes. */
3201 /* If the process hadn't finished, and we haven't seen the end of the data
3202 or suffered a disaster, update the rest of the state, and return FALSE to
3203 indicate "not finished". */
3212 /* Close our end of the pipe, to prevent deadlock if the far end is still
3213 pushing stuff into it. */
3218 /* If we have finished without error, but haven't had data for every address,
3219 something is wrong. */
3221 if (msg == NULL && addr != NULL)
3222 msg = string_sprintf("insufficient address data read from pipe "
3223 "for transport process %d for transport %s", pid,
3224 addr->transport->driver_name);
3226 /* If an error message is set, something has gone wrong in getting back
3227 the delivery data. Put the message into each address and freeze it. */
3231 for (addr = addrlist; addr != NULL; addr = addr->next)
3233 addr->transport_return = DEFER;
3234 addr->special_action = SPECIAL_FREEZE;
3235 addr->message = msg;
3239 /* Return TRUE to indicate we have got all we need from this process, even
3240 if it hasn't actually finished yet. */
3247 /*************************************************
3248 * Post-process a set of remote addresses *
3249 *************************************************/
3251 /* Do what has to be done immediately after a remote delivery for each set of
3252 addresses, then re-write the spool if necessary. Note that post_process_one
3253 puts the address on an appropriate queue; hence we must fish off the next
3254 one first. This function is also called if there is a problem with setting
3255 up a subprocess to do a remote delivery in parallel. In this case, the final
3256 argument contains a message, and the action must be forced to DEFER.
3259 addr pointer to chain of address items
3260 logflags flags for logging
3261 msg NULL for normal cases; -> error message for unexpected problems
3262 fallback TRUE if processing fallback hosts
3268 remote_post_process(address_item *addr, int logflags, uschar *msg,
3273 /* If any host addresses were found to be unusable, add them to the unusable
3274 tree so that subsequent deliveries don't try them. */
3276 for (h = addr->host_list; h != NULL; h = h->next)
3278 if (h->address == NULL) continue;
3279 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3282 /* Now handle each address on the chain. The transport has placed '=' or '-'
3283 into the special_action field for each successful delivery. */
3285 while (addr != NULL)
3287 address_item *next = addr->next;
3289 /* If msg == NULL (normal processing) and the result is DEFER and we are
3290 processing the main hosts and there are fallback hosts available, put the
3291 address on the list for fallback delivery. */
3293 if (addr->transport_return == DEFER &&
3294 addr->fallback_hosts != NULL &&
3298 addr->host_list = addr->fallback_hosts;
3299 addr->next = addr_fallback;
3300 addr_fallback = addr;
3301 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3304 /* If msg is set (=> unexpected problem), set it in the address before
3305 doing the ordinary post processing. */
3311 addr->message = msg;
3312 addr->transport_return = DEFER;
3314 (void)post_process_one(addr, addr->transport_return, logflags,
3315 DTYPE_TRANSPORT, addr->special_action);
3323 /* If we have just delivered down a passed SMTP channel, and that was
3324 the last address, the channel will have been closed down. Now that
3325 we have logged that delivery, set continue_sequence to 1 so that
3326 any subsequent deliveries don't get "*" incorrectly logged. */
3328 if (continue_transport == NULL) continue_sequence = 1;
3333 /*************************************************
3334 * Wait for one remote delivery subprocess *
3335 *************************************************/
3337 /* This function is called while doing remote deliveries when either the
3338 maximum number of processes exist and we need one to complete so that another
3339 can be created, or when waiting for the last ones to complete. It must wait for
3340 the completion of one subprocess, empty the control block slot, and return a
3341 pointer to the address chain.
3344 Returns: pointer to the chain of addresses handled by the process;
3345 NULL if no subprocess found - this is an unexpected error
3348 static address_item *
3351 int poffset, status;
3352 address_item *addr, *addrlist;
3355 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3356 "to finish", message_id);
3358 /* Loop until either a subprocess completes, or there are no subprocesses in
3359 existence - in which case give an error return. We cannot proceed just by
3360 waiting for a completion, because a subprocess may have filled up its pipe, and
3361 be waiting for it to be emptied. Therefore, if no processes have finished, we
3362 wait for one of the pipes to acquire some data by calling select(), with a
3363 timeout just in case.
3365 The simple approach is just to iterate after reading data from a ready pipe.
3366 This leads to non-ideal behaviour when the subprocess has written its final Z
3367 item, closed the pipe, and is in the process of exiting (the common case). A
3368 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3369 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3372 To avoid this, if all the data that is needed has been read from a subprocess
3373 after select(), an explicit wait() for it is done. We know that all it is doing
3374 is writing to the pipe and then exiting, so the wait should not be long.
3376 The non-blocking waitpid() is to some extent just insurance; if we could
3377 reliably detect end-of-file on the pipe, we could always know when to do a
3378 blocking wait() for a completed process. However, because some systems use
3379 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3380 use code that functions without the need to recognize EOF.
3382 There's a double loop here just in case we end up with a process that is not in
3383 the list of remote delivery processes. Something has obviously gone wrong if
3384 this is the case. (For example, a process that is incorrectly left over from
3385 routing or local deliveries might be found.) The damage can be minimized by
3386 looping back and looking for another process. If there aren't any, the error
3387 return will happen. */
3389 for (;;) /* Normally we do not repeat this loop */
3391 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3394 fd_set select_pipes;
3395 int maxpipe, readycount;
3397 /* A return value of -1 can mean several things. If errno != ECHILD, it
3398 either means invalid options (which we discount), or that this process was
3399 interrupted by a signal. Just loop to try the waitpid() again.
3401 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3402 in existence. This should never happen, and is an unexpected error.
3403 However, there is a nasty complication when running under Linux. If "strace
3404 -f" is being used under Linux to trace this process and its children,
3405 subprocesses are "stolen" from their parents and become the children of the
3406 tracing process. A general wait such as the one we've just obeyed returns
3407 as if there are no children while subprocesses are running. Once a
3408 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3409 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3412 This does not happen using "truss" on Solaris, nor (I think) with other
3413 tracing facilities on other OS. It seems to be specific to Linux.
3415 What we do to get round this is to use kill() to see if any of our
3416 subprocesses are still in existence. If kill() gives an OK return, we know
3417 it must be for one of our processes - it can't be for a re-use of the pid,
3418 because if our process had finished, waitpid() would have found it. If any
3419 of our subprocesses are in existence, we proceed to use select() as if
3420 waitpid() had returned zero. I think this is safe. */
3424 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3427 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3428 "for process existence\n");
3430 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3432 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3434 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3435 "stolen by strace\n", (int)pid);
3436 break; /* With poffset set */
3440 if (poffset >= remote_max_parallel)
3442 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3443 return NULL; /* This is the error return */
3447 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3448 been handled above. A return value of zero means that there is at least one
3449 subprocess, but there are no completed subprocesses. See if any pipes are
3450 ready with any data for reading. */
3452 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3455 FD_ZERO(&select_pipes);
3456 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3458 if (parlist[poffset].pid != 0)
3460 int fd = parlist[poffset].fd;
3461 FD_SET(fd, &select_pipes);
3462 if (fd > maxpipe) maxpipe = fd;
3466 /* Stick in a 60-second timeout, just in case. */
3471 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3474 /* Scan through the pipes and read any that are ready; use the count
3475 returned by select() to stop when there are no more. Select() can return
3476 with no processes (e.g. if interrupted). This shouldn't matter.
3478 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3479 read, or there was a disaster. In either case, we are finished with this
3480 process. Do an explicit wait() for the process and break the main loop if
3483 It turns out that we have to deal with the case of an interrupted system
3484 call, which can happen on some operating systems if the signal handling is
3485 set up to do that by default. */
3488 readycount > 0 && poffset < remote_max_parallel;
3491 if ((pid = parlist[poffset].pid) != 0 &&
3492 FD_ISSET(parlist[poffset].fd, &select_pipes))
3495 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3497 for (;;) /* Loop for signals */
3499 pid_t endedpid = waitpid(pid, &status, 0);
3500 if (endedpid == pid) goto PROCESS_DONE;
3501 if (endedpid != (pid_t)(-1) || errno != EINTR)
3502 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3503 "%d (errno = %d) from waitpid() for process %d",
3504 (int)endedpid, errno, (int)pid);
3510 /* Now go back and look for a completed subprocess again. */
3513 /* A completed process was detected by the non-blocking waitpid(). Find the
3514 data block that corresponds to this subprocess. */
3516 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3517 if (pid == parlist[poffset].pid) break;
3519 /* Found the data block; this is a known remote delivery process. We don't
3520 need to repeat the outer loop. This should be what normally happens. */
3522 if (poffset < remote_max_parallel) break;
3524 /* This situation is an error, but it's probably better to carry on looking
3525 for another process than to give up (as we used to do). */
3527 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3528 "transport process list", pid);
3529 } /* End of the "for" loop */
3531 /* Come here when all the data was completely read after a select(), and
3532 the process in pid has been wait()ed for. */
3539 debug_printf("remote delivery process %d ended\n", (int)pid);
3541 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
3545 set_process_info("delivering %s", message_id);
3547 /* Get the chain of processed addresses */
3549 addrlist = parlist[poffset].addrlist;
3551 /* If the process did not finish cleanly, record an error and freeze (except
3552 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
3553 in case the delivery did actually happen. */
3555 if ((status & 0xffff) != 0)
3558 int msb = (status >> 8) & 255;
3559 int lsb = status & 255;
3560 int code = (msb == 0)? (lsb & 0x7f) : msb;
3562 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
3564 addrlist->transport->driver_name,
3566 (msb == 0)? "terminated by signal" : "exit code",
3569 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
3570 addrlist->special_action = SPECIAL_FREEZE;
3572 for (addr = addrlist; addr != NULL; addr = addr->next)
3574 addr->transport_return = DEFER;
3575 addr->message = msg;
3578 remove_journal = FALSE;
3581 /* Else complete reading the pipe to get the result of the delivery, if all
3582 the data has not yet been obtained. */
3584 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
3586 /* Put the data count and return path into globals, mark the data slot unused,
3587 decrement the count of subprocesses, and return the address chain. */
3589 transport_count = parlist[poffset].transport_count;
3590 used_return_path = parlist[poffset].return_path;
3591 parlist[poffset].pid = 0;
3598 /*************************************************
3599 * Wait for subprocesses and post-process *
3600 *************************************************/
3602 /* This function waits for subprocesses until the number that are still running
3603 is below a given threshold. For each complete subprocess, the addresses are
3604 post-processed. If we can't find a running process, there is some shambles.
3605 Better not bomb out, as that might lead to multiple copies of the message. Just
3606 log and proceed as if all done.
3609 max maximum number of subprocesses to leave running
3610 fallback TRUE if processing fallback hosts
3616 par_reduce(int max, BOOL fallback)
3618 while (parcount > max)
3620 address_item *doneaddr = par_wait();
3621 if (doneaddr == NULL)
3623 log_write(0, LOG_MAIN|LOG_PANIC,
3624 "remote delivery process count got out of step");
3627 else remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
3635 rmt_dlv_checked_write(int fd, void * buf, int size)
3637 int ret = write(fd, buf, size);
3639 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed writing transport result to pipe: %s\n",
3640 ret == -1 ? strerror(errno) : "short write");
3643 /*************************************************
3644 * Do remote deliveries *
3645 *************************************************/
3647 /* This function is called to process the addresses in addr_remote. We must
3648 pick off the queue all addresses that have the same transport, remote
3649 destination, and errors address, and hand them to the transport in one go,
3650 subject to some configured limitations. If this is a run to continue delivering
3651 to an existing delivery channel, skip all but those addresses that can go to
3652 that channel. The skipped addresses just get deferred.
3654 If mua_wrapper is set, all addresses must be able to be sent in a single
3655 transaction. If not, this function yields FALSE.
3657 In Exim 4, remote deliveries are always done in separate processes, even
3658 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
3659 is so that the base process can retain privilege. This makes the
3660 implementation of fallback transports feasible (though not initially done.)
3662 We create up to the configured number of subprocesses, each of which passes
3663 back the delivery state via a pipe. (However, when sending down an existing
3664 connection, remote_max_parallel is forced to 1.)
3667 fallback TRUE if processing fallback hosts
3669 Returns: TRUE normally
3670 FALSE if mua_wrapper is set and the addresses cannot all be sent
3675 do_remote_deliveries(BOOL fallback)
3681 parcount = 0; /* Number of executing subprocesses */
3683 /* When sending down an existing channel, only do one delivery at a time.
3684 We use a local variable (parmax) to hold the maximum number of processes;
3685 this gets reduced from remote_max_parallel if we can't create enough pipes. */
3687 if (continue_transport != NULL) remote_max_parallel = 1;
3688 parmax = remote_max_parallel;
3690 /* If the data for keeping a list of processes hasn't yet been
3693 if (parlist == NULL)
3695 parlist = store_get(remote_max_parallel * sizeof(pardata));
3696 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3697 parlist[poffset].pid = 0;
3700 /* Now loop for each remote delivery */
3702 for (delivery_count = 0; addr_remote != NULL; delivery_count++)
3708 int address_count = 1;
3709 int address_count_max;
3711 BOOL use_initgroups;
3712 BOOL pipe_done = FALSE;
3713 transport_instance *tp;
3714 address_item **anchor = &addr_remote;
3715 address_item *addr = addr_remote;
3716 address_item *last = addr;
3719 /* Pull the first address right off the list. */
3721 addr_remote = addr->next;
3724 DEBUG(D_deliver|D_transport)
3725 debug_printf("--------> %s <--------\n", addr->address);
3727 /* If no transport has been set, there has been a big screw-up somewhere. */
3729 if ((tp = addr->transport) == NULL)
3731 disable_logging = FALSE; /* Jic */
3732 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3733 US"No transport set by router", fallback);
3737 /* Check that this base address hasn't previously been delivered to this
3738 transport. The check is necessary at this point to handle homonymic addresses
3739 correctly in cases where the pattern of redirection changes between delivery
3740 attempts. Non-homonymic previous delivery is detected earlier, at routing
3743 if (previously_transported(addr, FALSE)) continue;
3745 /* Force failure if the message is too big. */
3747 if (tp->message_size_limit != NULL)
3749 int rc = check_message_size(tp, addr);
3752 addr->transport_return = rc;
3753 remote_post_process(addr, LOG_MAIN, NULL, fallback);
3758 /* Get the flag which specifies whether the transport can handle different
3759 domains that nevertheless resolve to the same set of hosts. */
3761 multi_domain = tp->multi_domain;
3763 /* Get the maximum it can handle in one envelope, with zero meaning
3764 unlimited, which is forced for the MUA wrapper case. */
3766 address_count_max = tp->max_addresses;
3767 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
3770 /************************************************************************/
3771 /***** This is slightly experimental code, but should be safe. *****/
3773 /* The address_count_max value is the maximum number of addresses that the
3774 transport can send in one envelope. However, the transport must be capable of
3775 dealing with any number of addresses. If the number it gets exceeds its
3776 envelope limitation, it must send multiple copies of the message. This can be
3777 done over a single connection for SMTP, so uses less resources than making
3778 multiple connections. On the other hand, if remote_max_parallel is greater
3779 than one, it is perhaps a good idea to use parallel processing to move the
3780 message faster, even if that results in multiple simultaneous connections to
3783 How can we come to some compromise between these two ideals? What we do is to
3784 limit the number of addresses passed to a single instance of a transport to
3785 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
3786 number of addresses routed to remote transports divided by
3787 remote_max_parallel. For example, if the message has 100 remote recipients,
3788 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
3789 once. But if rcpt_max is 100, we could send up to 100.
3791 Of course, not all the remotely addresses in a message are going to go to the
3792 same set of hosts (except in smarthost configurations), so this is just a
3793 heuristic way of dividing up the work.
3795 Furthermore (1), because this may not be wanted in some cases, and also to
3796 cope with really pathological cases, there is also a limit to the number of
3797 messages that are sent over one connection. This is the same limit that is
3798 used when sending several different messages over the same connection.
3799 Continue_sequence is set when in this situation, to the number sent so
3800 far, including this message.
3802 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
3803 is probably because they are using VERP, in which case they want to pass only
3804 one address at a time to the transport, in order to be able to use
3805 $local_part and $domain in constructing a new return path. We could test for
3806 the use of these variables, but as it is so likely they will be used when the
3807 maximum is 1, we don't bother. Just leave the value alone. */
3809 if (address_count_max != 1 &&
3810 address_count_max < remote_delivery_count/remote_max_parallel)
3812 int new_max = remote_delivery_count/remote_max_parallel;
3813 int message_max = tp->connection_max_messages;
3814 if (connection_max_messages >= 0) message_max = connection_max_messages;
3815 message_max -= continue_sequence - 1;
3816 if (message_max > 0 && new_max > address_count_max * message_max)
3817 new_max = address_count_max * message_max;
3818 address_count_max = new_max;
3821 /************************************************************************/
3824 /* Pick off all addresses which have the same transport, errors address,
3825 destination, and extra headers. In some cases they point to the same host
3826 list, but we also need to check for identical host lists generated from
3827 entirely different domains. The host list pointers can be NULL in the case
3828 where the hosts are defined in the transport. There is also a configured
3829 maximum limit of addresses that can be handled at once (see comments above
3830 for how it is computed). */
3832 while ((next = *anchor) != NULL && address_count < address_count_max)
3834 if ((multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
3836 tp == next->transport
3838 same_hosts(next->host_list, addr->host_list)
3840 same_strings(next->p.errors_address, addr->p.errors_address)
3842 same_headers(next->p.extra_headers, addr->p.extra_headers)
3844 same_ugid(tp, next, addr)
3846 (next->p.remove_headers == addr->p.remove_headers ||
3847 (next->p.remove_headers != NULL &&
3848 addr->p.remove_headers != NULL &&
3849 Ustrcmp(next->p.remove_headers, addr->p.remove_headers) == 0)))
3851 *anchor = next->next;
3853 next->first = addr; /* remember top one (for retry processing) */
3858 else anchor = &(next->next);
3861 /* If we are acting as an MUA wrapper, all addresses must go in a single
3862 transaction. If not, put them back on the chain and yield FALSE. */
3864 if (mua_wrapper && addr_remote != NULL)
3866 last->next = addr_remote;
3871 /* Set up the expansion variables for this set of addresses */
3873 deliver_set_expansions(addr);
3875 /* Ensure any transport-set auth info is fresh */
3876 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
3878 /* Compute the return path, expanding a new one if required. The old one
3879 must be set first, as it might be referred to in the expansion. */
3881 if(addr->p.errors_address != NULL)
3882 return_path = addr->p.errors_address;
3883 #ifdef EXPERIMENTAL_SRS
3884 else if(addr->p.srs_sender != NULL)
3885 return_path = addr->p.srs_sender;
3888 return_path = sender_address;
3890 if (tp->return_path != NULL)
3892 uschar *new_return_path = expand_string(tp->return_path);
3893 if (new_return_path == NULL)
3895 if (!expand_string_forcedfail)
3897 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
3898 string_sprintf("Failed to expand return path \"%s\": %s",
3899 tp->return_path, expand_string_message), fallback);
3903 else return_path = new_return_path;
3906 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
3907 logs and sets up error messages, so we just post-process and continue with
3908 the next address. */
3910 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
3912 remote_post_process(addr, LOG_MAIN|LOG_PANIC, NULL, fallback);
3916 /* If this transport has a setup function, call it now so that it gets
3917 run in this process and not in any subprocess. That way, the results of
3918 any setup that are retained by the transport can be reusable. One of the
3919 things the setup does is to set the fallback host lists in the addresses.
3920 That is why it is called at this point, before the continue delivery
3921 processing, because that might use the fallback hosts. */
3923 if (tp->setup != NULL)
3924 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
3926 /* If this is a run to continue delivery down an already-established
3927 channel, check that this set of addresses matches the transport and
3928 the channel. If it does not, defer the addresses. If a host list exists,
3929 we must check that the continue host is on the list. Otherwise, the
3930 host is set in the transport. */
3932 continue_more = FALSE; /* In case got set for the last lot */
3933 if (continue_transport != NULL)
3935 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
3936 if (ok && addr->host_list != NULL)
3940 for (h = addr->host_list; h != NULL; h = h->next)
3942 if (Ustrcmp(h->name, continue_hostname) == 0)
3943 { ok = TRUE; break; }
3947 /* Addresses not suitable; defer or queue for fallback hosts (which
3948 might be the continue host) and skip to next address. */
3952 DEBUG(D_deliver) debug_printf("not suitable for continue_transport\n");
3955 if (addr->fallback_hosts != NULL && !fallback)
3959 next->host_list = next->fallback_hosts;
3960 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
3961 if (next->next == NULL) break;
3964 next->next = addr_fallback;
3965 addr_fallback = addr;
3970 while (next->next != NULL) next = next->next;
3971 next->next = addr_defer;
3978 /* Set a flag indicating whether there are further addresses that list
3979 the continued host. This tells the transport to leave the channel open,
3980 but not to pass it to another delivery process. */
3982 for (next = addr_remote; next != NULL; next = next->next)
3985 for (h = next->host_list; h != NULL; h = h->next)
3987 if (Ustrcmp(h->name, continue_hostname) == 0)
3988 { continue_more = TRUE; break; }
3993 /* The transports set up the process info themselves as they may connect
3994 to more than one remote machine. They also have to set up the filter
3995 arguments, if required, so that the host name and address are available
3998 transport_filter_argv = NULL;
4000 /* Create the pipe for inter-process communication. If pipe creation
4001 fails, it is probably because the value of remote_max_parallel is so
4002 large that too many file descriptors for pipes have been created. Arrange
4003 to wait for a process to finish, and then try again. If we still can't
4004 create a pipe when all processes have finished, break the retry loop. */
4008 if (pipe(pfd) == 0) pipe_done = TRUE;
4009 else if (parcount > 0) parmax = parcount;
4012 /* We need to make the reading end of the pipe non-blocking. There are
4013 two different options for this. Exim is cunningly (I hope!) coded so
4014 that it can use either of them, though it prefers O_NONBLOCK, which
4015 distinguishes between EOF and no-more-data. */
4018 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4020 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4023 /* If the maximum number of subprocesses already exist, wait for a process
4024 to finish. If we ran out of file descriptors, parmax will have been reduced
4025 from its initial value of remote_max_parallel. */
4027 par_reduce(parmax - 1, fallback);
4030 /* If we failed to create a pipe and there were no processes to wait
4031 for, we have to give up on this one. Do this outside the above loop
4032 so that we can continue the main loop. */
4036 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4037 string_sprintf("unable to create pipe: %s", strerror(errno)), fallback);
4041 /* Find a free slot in the pardata list. Must do this after the possible
4042 waiting for processes to finish, because a terminating process will free
4045 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4046 if (parlist[poffset].pid == 0) break;
4048 /* If there isn't one, there has been a horrible disaster. */
4050 if (poffset >= remote_max_parallel)
4052 (void)close(pfd[pipe_write]);
4053 (void)close(pfd[pipe_read]);
4054 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4055 US"Unexpectedly no free subprocess slot", fallback);
4059 /* Now fork a subprocess to do the remote delivery, but before doing so,
4060 ensure that any cached resourses are released so as not to interfere with
4061 what happens in the subprocess. */
4065 if ((pid = fork()) == 0)
4067 int fd = pfd[pipe_write];
4070 /* Setting this global in the subprocess means we need never clear it */
4071 transport_name = tp->name;
4073 /* There are weird circumstances in which logging is disabled */
4074 disable_logging = tp->disable_logging;
4076 /* Show pids on debug output if parallelism possible */
4078 if (parmax > 1 && (parcount > 0 || addr_remote != NULL))
4080 DEBUG(D_any|D_v) debug_selector |= D_pid;
4081 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4084 /* Reset the random number generator, so different processes don't all
4085 have the same sequence. In the test harness we want different, but
4086 predictable settings for each delivery process, so do something explicit
4087 here rather they rely on the fixed reset in the random number function. */
4089 random_seed = running_in_test_harness? 42 + 2*delivery_count : 0;
4091 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4092 a new process that may be forked to do another delivery down the same
4095 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4097 /* Close open file descriptors for the pipes of other processes
4098 that are running in parallel. */
4100 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4101 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4103 /* This process has inherited a copy of the file descriptor
4104 for the data file, but its file pointer is shared with all the
4105 other processes running in parallel. Therefore, we have to re-open
4106 the file in order to get a new file descriptor with its own
4107 file pointer. We don't need to lock it, as the lock is held by
4108 the parent process. There doesn't seem to be any way of doing
4109 a dup-with-new-file-pointer. */
4111 (void)close(deliver_datafile);
4112 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir,
4114 deliver_datafile = Uopen(spoolname, O_RDWR | O_APPEND, 0);
4116 if (deliver_datafile < 0)
4117 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4118 "parallel delivery: %s", spoolname, strerror(errno));
4120 /* Set the close-on-exec flag */
4122 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4125 /* Set the uid/gid of this process; bombs out on failure. */
4127 exim_setugid(uid, gid, use_initgroups,
4128 string_sprintf("remote delivery to %s with transport=%s",
4129 addr->address, tp->name));
4131 /* Close the unwanted half of this process' pipe, set the process state,
4132 and run the transport. Afterwards, transport_count will contain the number
4133 of bytes written. */
4135 (void)close(pfd[pipe_read]);
4136 set_process_info("delivering %s using %s", message_id, tp->name);
4137 debug_print_string(tp->debug_string);
4138 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4140 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4141 message_id, tp->name, addr->address, (addr->next == NULL)? "" : ", ...");
4143 /* Ensure any cached resources that we used are now released */
4147 /* Pass the result back down the pipe. This is a lot more information
4148 than is needed for a local delivery. We have to send back the error
4149 status for each address, the usability status for each host that is
4150 flagged as unusable, and all the retry items. When TLS is in use, we
4151 send also the cipher and peerdn information. Each type of information
4152 is flagged by an identifying byte, and is then in a fixed format (with
4153 strings terminated by zeros), and there is a final terminator at the
4154 end. The host information and retry information is all attached to
4155 the first address, so that gets sent at the start. */
4157 /* Host unusability information: for most success cases this will
4160 for (h = addr->host_list; h != NULL; h = h->next)
4162 if (h->address == NULL || h->status < hstatus_unusable) continue;
4163 sprintf(CS big_buffer, "H%c%c%s", h->status, h->why, h->address);
4164 rmt_dlv_checked_write(fd, big_buffer, Ustrlen(big_buffer+3) + 4);
4167 /* The number of bytes written. This is the same for each address. Even
4168 if we sent several copies of the message down the same connection, the
4169 size of each one is the same, and it's that value we have got because
4170 transport_count gets reset before calling transport_write_message(). */
4172 big_buffer[0] = 'S';
4173 memcpy(big_buffer+1, &transport_count, sizeof(transport_count));
4174 rmt_dlv_checked_write(fd, big_buffer, sizeof(transport_count) + 1);
4176 /* Information about what happened to each address. Four item types are
4177 used: an optional 'X' item first, for TLS information, then an optional "C"
4178 item for any client-auth info followed by 'R' items for any retry settings,
4179 and finally an 'A' item for the remaining data. */
4181 for(; addr != NULL; addr = addr->next)
4186 /* The certificate verification status goes into the flags */
4187 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4188 #ifdef EXPERIMENTAL_DANE
4189 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4192 /* Use an X item only if there's something to send */
4197 sprintf(CS ptr, "X1%.128s", addr->cipher);
4203 sprintf(CS ptr, "%.512s", addr->peerdn);
4207 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4212 *ptr++ = 'X'; *ptr++ = '2';
4213 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4217 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4222 *ptr++ = 'X'; *ptr++ = '3';
4223 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4227 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4229 # ifndef DISABLE_OCSP
4230 if (addr->ocsp > OCSP_NOT_REQ)
4233 sprintf(CS ptr, "X4%c", addr->ocsp + '0');
4235 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4238 #endif /*SUPPORT_TLS*/
4240 if (client_authenticator)
4243 sprintf(CS big_buffer, "C1%.64s", client_authenticator);
4245 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4247 if (client_authenticated_id)
4250 sprintf(CS big_buffer, "C2%.64s", client_authenticated_id);
4252 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4254 if (client_authenticated_sender)
4257 sprintf(CS big_buffer, "C3%.64s", client_authenticated_sender);
4259 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4262 #ifndef DISABLE_PRDR
4263 if (addr->flags & af_prdr_used)
4264 rmt_dlv_checked_write(fd, "P", 1);
4267 #ifdef EXPERIMENTAL_DSN
4268 big_buffer[0] = 'D';
4269 memcpy(big_buffer+1, &addr->dsn_aware, sizeof(addr->dsn_aware));
4270 rmt_dlv_checked_write(fd, big_buffer, sizeof(addr->dsn_aware) + 1);
4271 DEBUG(D_deliver) debug_printf("DSN write: addr->dsn_aware = %d\n", addr->dsn_aware);
4274 /* Retry information: for most success cases this will be null. */
4276 for (r = addr->retries; r != NULL; r = r->next)
4279 sprintf(CS big_buffer, "R%c%.500s", r->flags, r->key);
4280 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4281 memcpy(ptr, &(r->basic_errno), sizeof(r->basic_errno));
4282 ptr += sizeof(r->basic_errno);
4283 memcpy(ptr, &(r->more_errno), sizeof(r->more_errno));
4284 ptr += sizeof(r->more_errno);
4285 if (r->message == NULL) *ptr++ = 0; else
4287 sprintf(CS ptr, "%.512s", r->message);
4290 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4293 /* The rest of the information goes in an 'A' item. */
4295 ptr = big_buffer + 3;
4296 sprintf(CS big_buffer, "A%c%c", addr->transport_return,
4297 addr->special_action);
4298 memcpy(ptr, &(addr->basic_errno), sizeof(addr->basic_errno));
4299 ptr += sizeof(addr->basic_errno);
4300 memcpy(ptr, &(addr->more_errno), sizeof(addr->more_errno));
4301 ptr += sizeof(addr->more_errno);
4302 memcpy(ptr, &(addr->flags), sizeof(addr->flags));
4303 ptr += sizeof(addr->flags);
4305 if (addr->message == NULL) *ptr++ = 0; else
4307 sprintf(CS ptr, "%.1024s", addr->message);
4311 if (addr->user_message == NULL) *ptr++ = 0; else
4313 sprintf(CS ptr, "%.1024s", addr->user_message);
4317 if (addr->host_used == NULL) *ptr++ = 0; else
4319 sprintf(CS ptr, "%.256s", addr->host_used->name);
4321 sprintf(CS ptr, "%.64s", addr->host_used->address);
4323 memcpy(ptr, &(addr->host_used->port), sizeof(addr->host_used->port));
4324 ptr += sizeof(addr->host_used->port);
4326 /* DNS lookup status */
4327 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4328 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4331 rmt_dlv_checked_write(fd, big_buffer, ptr - big_buffer);
4334 /* Add termination flag, close the pipe, and that's it. The character
4335 after 'Z' indicates whether continue_transport is now NULL or not.
4336 A change from non-NULL to NULL indicates a problem with a continuing
4339 big_buffer[0] = 'Z';
4340 big_buffer[1] = (continue_transport == NULL)? '0' : '1';
4341 rmt_dlv_checked_write(fd, big_buffer, 2);
4346 /* Back in the mainline: close the unwanted half of the pipe. */
4348 (void)close(pfd[pipe_write]);
4350 /* Fork failed; defer with error message */
4354 (void)close(pfd[pipe_read]);
4355 remote_post_process(addr, LOG_MAIN|LOG_PANIC,
4356 string_sprintf("fork failed for remote delivery to %s: %s",
4357 addr->domain, strerror(errno)), fallback);
4361 /* Fork succeeded; increment the count, and remember relevant data for
4362 when the process finishes. */
4365 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4366 parlist[poffset].pid = pid;
4367 parlist[poffset].fd = pfd[pipe_read];
4368 parlist[poffset].done = FALSE;
4369 parlist[poffset].msg = NULL;
4370 parlist[poffset].return_path = return_path;
4372 /* If the process we've just started is sending a message down an existing
4373 channel, wait for it now. This ensures that only one such process runs at
4374 once, whatever the value of remote_max parallel. Otherwise, we might try to
4375 send two or more messages simultaneously down the same channel. This could
4376 happen if there are different domains that include the same host in otherwise
4377 different host lists.
4379 Also, if the transport closes down the channel, this information gets back
4380 (continue_transport gets set to NULL) before we consider any other addresses
4383 if (continue_transport != NULL) par_reduce(0, fallback);
4385 /* Otherwise, if we are running in the test harness, wait a bit, to let the
4386 newly created process get going before we create another process. This should
4387 ensure repeatability in the tests. We only need to wait a tad. */
4389 else if (running_in_test_harness) millisleep(500);
4392 /* Reached the end of the list of addresses. Wait for all the subprocesses that
4393 are still running and post-process their addresses. */
4395 par_reduce(0, fallback);
4402 /*************************************************
4403 * Split an address into local part and domain *
4404 *************************************************/
4406 /* This function initializes an address for routing by splitting it up into a
4407 local part and a domain. The local part is set up twice - once in its original
4408 casing, and once in lower case, and it is dequoted. We also do the "percent
4409 hack" for configured domains. This may lead to a DEFER result if a lookup
4410 defers. When a percent-hacking takes place, we insert a copy of the original
4411 address as a new parent of this address, as if we have had a redirection.
4414 addr points to an addr_item block containing the address
4417 DEFER - could not determine if domain is %-hackable
4421 deliver_split_address(address_item *addr)
4423 uschar *address = addr->address;
4424 uschar *domain = Ustrrchr(address, '@');
4426 int len = domain - address;
4428 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
4430 /* The implication in the RFCs (though I can't say I've seen it spelled out
4431 explicitly) is that quoting should be removed from local parts at the point
4432 where they are locally interpreted. [The new draft "821" is more explicit on
4433 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
4434 removing quoting backslashes and any unquoted doublequotes. */
4436 t = addr->cc_local_part = store_get(len+1);
4439 register int c = *address++;
4440 if (c == '\"') continue;
4450 /* We do the percent hack only for those domains that are listed in
4451 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
4453 if (percent_hack_domains != NULL)
4456 uschar *new_address = NULL;
4457 uschar *local_part = addr->cc_local_part;
4459 deliver_domain = addr->domain; /* set $domain */
4461 while ((rc = match_isinlist(deliver_domain, &percent_hack_domains, 0,
4462 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
4464 (t = Ustrrchr(local_part, '%')) != NULL)
4466 new_address = string_copy(local_part);
4467 new_address[t - local_part] = '@';
4468 deliver_domain = string_copylc(t+1);
4469 local_part = string_copyn(local_part, t - local_part);
4472 if (rc == DEFER) return DEFER; /* lookup deferred */
4474 /* If hackery happened, set up new parent and alter the current address. */
4476 if (new_address != NULL)
4478 address_item *new_parent = store_get(sizeof(address_item));
4479 *new_parent = *addr;
4480 addr->parent = new_parent;
4481 addr->address = new_address;
4482 addr->unique = string_copy(new_address);
4483 addr->domain = deliver_domain;
4484 addr->cc_local_part = local_part;
4485 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
4490 /* Create the lowercased version of the final local part, and make that the
4491 default one to be used. */
4493 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
4500 /*************************************************
4501 * Get next error message text *
4502 *************************************************/
4504 /* If f is not NULL, read the next "paragraph", from a customized error message
4505 text file, terminated by a line containing ****, and expand it.
4508 f NULL or a file to read from
4509 which string indicating which string (for errors)
4511 Returns: NULL or an expanded string
4515 next_emf(FILE *f, uschar *which)
4519 uschar *para, *yield;
4522 if (f == NULL) return NULL;
4524 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4525 Ustrcmp(buffer, "****\n") == 0) return NULL;
4527 para = store_get(size);
4530 para = string_cat(para, &size, &ptr, buffer, Ustrlen(buffer));
4531 if (Ufgets(buffer, sizeof(buffer), f) == NULL ||
4532 Ustrcmp(buffer, "****\n") == 0) break;
4536 yield = expand_string(para);
4537 if (yield != NULL) return yield;
4539 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
4540 "bounce_message_file or warn_message_file (%s): %s", which,
4541 expand_string_message);
4548 /*************************************************
4549 * Close down a passed transport channel *
4550 *************************************************/
4552 /* This function is called when a passed transport channel cannot be used.
4553 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
4554 so that the function call can be the argument of a "return" statement.
4557 Returns: DELIVER_NOT_ATTEMPTED
4561 continue_closedown(void)
4563 if (continue_transport != NULL)
4565 transport_instance *t;
4566 for (t = transports; t != NULL; t = t->next)
4568 if (Ustrcmp(t->name, continue_transport) == 0)
4570 if (t->info->closedown != NULL) (t->info->closedown)(t);
4575 return DELIVER_NOT_ATTEMPTED;
4581 /*************************************************
4582 * Print address information *
4583 *************************************************/
4585 /* This function is called to output an address, or information about an
4586 address, for bounce or defer messages. If the hide_child flag is set, all we
4587 output is the original ancestor address.
4590 addr points to the address
4591 f the FILE to print to
4592 si an initial string
4593 sc a continuation string for before "generated"
4596 Returns: TRUE if the address is not hidden
4600 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
4604 uschar *printed = US"";
4605 address_item *ancestor = addr;
4606 while (ancestor->parent != NULL) ancestor = ancestor->parent;
4608 fprintf(f, "%s", CS si);
4610 if (addr->parent != NULL && testflag(addr, af_hide_child))
4612 printed = US"an undisclosed address";
4615 else if (!testflag(addr, af_pfr) || addr->parent == NULL)
4616 printed = addr->address;
4620 uschar *s = addr->address;
4623 if (addr->address[0] == '>') { ss = US"mail"; s++; }
4624 else if (addr->address[0] == '|') ss = US"pipe";
4627 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
4628 printed = addr->parent->address;
4631 fprintf(f, "%s", CS string_printing(printed));
4633 if (ancestor != addr)
4635 uschar *original = (ancestor->onetime_parent == NULL)?
4636 ancestor->address : ancestor->onetime_parent;
4637 if (strcmpic(original, printed) != 0)
4638 fprintf(f, "%s(%sgenerated from %s)", sc,
4639 (ancestor != addr->parent)? "ultimately " : "",
4640 string_printing(original));
4643 fprintf(f, "%s", CS se);
4651 /*************************************************
4652 * Print error for an address *
4653 *************************************************/
4655 /* This function is called to print the error information out of an address for
4656 a bounce or a warning message. It tries to format the message reasonably by
4657 introducing newlines. All lines are indented by 4; the initial printing
4658 position must be set before calling.
4660 This function used always to print the error. Nowadays we want to restrict it
4661 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
4662 and filter "fail". We no longer pass other information willy-nilly in bounce
4663 and warning messages. Text in user_message is always output; text in message
4664 only if the af_pass_message flag is set.
4668 f the FILE to print on
4675 print_address_error(address_item *addr, FILE *f, uschar *t)
4677 int count = Ustrlen(t);
4678 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
4682 if (addr->user_message != NULL) s = addr->user_message; else return;
4685 fprintf(f, "\n %s", t);
4689 if (*s == '\\' && s[1] == 'n')
4699 if (*s++ == ':' && isspace(*s) && count > 45)
4701 fprintf(f, "\n "); /* sic (because space follows) */
4713 /*************************************************
4714 * Check list of addresses for duplication *
4715 *************************************************/
4717 /* This function was introduced when the test for duplicate addresses that are
4718 not pipes, files, or autoreplies was moved from the middle of routing to when
4719 routing was complete. That was to fix obscure cases when the routing history
4720 affects the subsequent routing of identical addresses. This function is called
4721 after routing, to check that the final routed addresses are not duplicates.
4723 If we detect a duplicate, we remember what it is a duplicate of. Note that
4724 pipe, file, and autoreply de-duplication is handled during routing, so we must
4725 leave such "addresses" alone here, as otherwise they will incorrectly be
4728 Argument: address of list anchor
4733 do_duplicate_check(address_item **anchor)
4736 while ((addr = *anchor) != NULL)
4739 if (testflag(addr, af_pfr))
4741 anchor = &(addr->next);
4743 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
4745 DEBUG(D_deliver|D_route)
4746 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
4747 *anchor = addr->next;
4748 addr->dupof = tnode->data.ptr;
4749 addr->next = addr_duplicate;
4750 addr_duplicate = addr;
4754 tree_add_duplicate(addr->unique, addr);
4755 anchor = &(addr->next);
4763 /*************************************************
4764 * Deliver one message *
4765 *************************************************/
4767 /* This is the function which is called when a message is to be delivered. It
4768 is passed the id of the message. It is possible that the message no longer
4769 exists, if some other process has delivered it, and it is also possible that
4770 the message is being worked on by another process, in which case the data file
4773 If no delivery is attempted for any of the above reasons, the function returns
4774 DELIVER_NOT_ATTEMPTED.
4776 If the give_up flag is set true, do not attempt any deliveries, but instead
4777 fail all outstanding addresses and return the message to the sender (or
4780 A delivery operation has a process all to itself; we never deliver more than
4781 one message in the same process. Therefore we needn't worry too much about
4785 id the id of the message to be delivered
4786 forced TRUE if delivery was forced by an administrator; this overrides
4787 retry delays and causes a delivery to be tried regardless
4788 give_up TRUE if an administrator has requested that delivery attempts
4791 Returns: When the global variable mua_wrapper is FALSE:
4792 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
4793 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
4794 When the global variable mua_wrapper is TRUE:
4795 DELIVER_MUA_SUCCEEDED if delivery succeeded
4796 DELIVER_MUA_FAILED if delivery failed
4797 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
4801 deliver_message(uschar *id, BOOL forced, BOOL give_up)
4804 int final_yield = DELIVER_ATTEMPTED_NORMAL;
4805 time_t now = time(NULL);
4806 address_item *addr_last = NULL;
4807 uschar *filter_message = NULL;
4809 int process_recipients = RECIP_ACCEPT;
4812 extern int acl_where;
4814 uschar *info = (queue_run_pid == (pid_t)0)?
4815 string_sprintf("delivering %s", id) :
4816 string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
4818 /* If the D_process_info bit is on, set_process_info() will output debugging
4819 information. If not, we want to show this initial information if D_deliver or
4820 D_queue_run is set or in verbose mode. */
4822 set_process_info("%s", info);
4824 if ((debug_selector & D_process_info) == 0 &&
4825 (debug_selector & (D_deliver|D_queue_run|D_v)) != 0)
4826 debug_printf("%s\n", info);
4828 /* Ensure that we catch any subprocesses that are created. Although Exim
4829 sets SIG_DFL as its initial default, some routes through the code end up
4830 here with it set to SIG_IGN - cases where a non-synchronous delivery process
4831 has been forked, but no re-exec has been done. We use sigaction rather than
4832 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
4833 sure it is turned off. (There was a problem on AIX with this.) */
4837 struct sigaction act;
4838 act.sa_handler = SIG_DFL;
4839 sigemptyset(&(act.sa_mask));
4841 sigaction(SIGCHLD, &act, NULL);
4844 signal(SIGCHLD, SIG_DFL);
4847 /* Make the forcing flag available for routers and transports, set up the
4848 global message id field, and initialize the count for returned files and the
4849 message size. This use of strcpy() is OK because the length id is checked when
4850 it is obtained from a command line (the -M or -q options), and otherwise it is
4851 known to be a valid message id. */
4853 Ustrcpy(message_id, id);
4854 deliver_force = forced;
4858 /* Initialize some flags */
4860 update_spool = FALSE;
4861 remove_journal = TRUE;
4863 /* Set a known context for any ACLs we call via expansions */
4864 acl_where = ACL_WHERE_DELIVERY;
4866 /* Reset the random number generator, so that if several delivery processes are
4867 started from a queue runner that has already used random numbers (for sorting),
4868 they don't all get the same sequence. */
4872 /* Open and lock the message's data file. Exim locks on this one because the
4873 header file may get replaced as it is re-written during the delivery process.
4874 Any failures cause messages to be written to the log, except for missing files
4875 while queue running - another process probably completed delivery. As part of
4876 opening the data file, message_subdir gets set. */
4878 if (!spool_open_datafile(id))
4879 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4881 /* The value of message_size at this point has been set to the data length,
4882 plus one for the blank line that notionally precedes the data. */
4884 /* Now read the contents of the header file, which will set up the headers in
4885 store, and also the list of recipients and the tree of non-recipients and
4886 assorted flags. It updates message_size. If there is a reading or format error,
4887 give up; if the message has been around for sufficiently long, remove it. */
4889 sprintf(CS spoolname, "%s-H", id);
4890 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
4892 if (errno == ERRNO_SPOOLFORMAT)
4894 struct stat statbuf;
4895 sprintf(CS big_buffer, "%s/input/%s/%s", spool_directory, message_subdir,
4897 if (Ustat(big_buffer, &statbuf) == 0)
4898 log_write(0, LOG_MAIN, "Format error in spool file %s: "
4899 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
4900 else log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
4903 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
4906 /* If we managed to read the envelope data, received_time contains the
4907 time the message was received. Otherwise, we can calculate it from the
4910 if (rc != spool_read_hdrerror)
4913 for (i = 0; i < 6; i++)
4914 received_time = received_time * BASE_62 + tab62[id[i] - '0'];
4917 /* If we've had this malformed message too long, sling it. */
4919 if (now - received_time > keep_malformed)
4921 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
4923 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
4925 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
4927 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4929 log_write(0, LOG_MAIN, "Message removed because older than %s",
4930 readconf_printtime(keep_malformed));
4933 (void)close(deliver_datafile);
4934 deliver_datafile = -1;
4935 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4938 /* The spool header file has been read. Look to see if there is an existing
4939 journal file for this message. If there is, it means that a previous delivery
4940 attempt crashed (program or host) before it could update the spool header file.
4941 Read the list of delivered addresses from the journal and add them to the
4942 nonrecipients tree. Then update the spool file. We can leave the journal in
4943 existence, as it will get further successful deliveries added to it in this
4944 run, and it will be deleted if this function gets to its end successfully.
4945 Otherwise it might be needed again. */
4947 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
4948 jread = Ufopen(spoolname, "rb");
4951 while (Ufgets(big_buffer, big_buffer_size, jread) != NULL)
4953 int n = Ustrlen(big_buffer);
4954 big_buffer[n-1] = 0;
4955 tree_add_nonrecipient(big_buffer);
4956 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
4957 "journal file\n", big_buffer);
4959 (void)fclose(jread);
4960 /* Panic-dies on error */
4961 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
4963 else if (errno != ENOENT)
4965 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
4966 "%s", strerror(errno));
4967 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4970 /* A null recipients list indicates some kind of disaster. */
4972 if (recipients_list == NULL)
4974 (void)close(deliver_datafile);
4975 deliver_datafile = -1;
4976 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", spoolname);
4977 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4981 /* Handle a message that is frozen. There are a number of different things that
4982 can happen, but in the default situation, unless forced, no delivery is
4987 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
4988 /* Moving to another directory removes the message from Exim's view. Other
4989 tools must be used to deal with it. Logging of this action happens in
4990 spool_move_message() and its subfunctions. */
4992 if (move_frozen_messages &&
4993 spool_move_message(id, message_subdir, US"", US"F"))
4994 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
4997 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
4998 maximum time to keep messages that are frozen. Thaw if we reach it, with a
4999 flag causing all recipients to be failed. The time is the age of the
5000 message, not the time since freezing. */
5002 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5004 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5005 process_recipients = RECIP_FAIL_TIMEOUT;
5008 /* For bounce messages (and others with no sender), thaw if the error message
5009 ignore timer is exceeded. The message will be discarded if this delivery
5012 else if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
5014 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5017 /* If this is a bounce message, or there's no auto thaw, or we haven't
5018 reached the auto thaw time yet, and this delivery is not forced by an admin
5019 user, do not attempt delivery of this message. Note that forced is set for
5020 continuing messages down the same channel, in order to skip load checking and
5021 ignore hold domains, but we don't want unfreezing in that case. */
5025 if ((sender_address[0] == 0 ||
5027 now <= deliver_frozen_at + auto_thaw
5030 (!forced || !deliver_force_thaw || !admin_user ||
5031 continue_hostname != NULL
5034 (void)close(deliver_datafile);
5035 deliver_datafile = -1;
5036 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5037 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5040 /* If delivery was forced (by an admin user), assume a manual thaw.
5041 Otherwise it's an auto thaw. */
5045 deliver_manual_thaw = TRUE;
5046 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5048 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5051 /* We get here if any of the rules for unfreezing have triggered. */
5053 deliver_freeze = FALSE;
5054 update_spool = TRUE;
5058 /* Open the message log file if we are using them. This records details of
5059 deliveries, deferments, and failures for the benefit of the mail administrator.
5060 The log is not used by exim itself to track the progress of a message; that is
5061 done by rewriting the header spool file. */
5068 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir, id);
5069 fd = open_msglog_file(spoolname, SPOOL_MODE, &error);
5073 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5074 spoolname, strerror(errno));
5075 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5078 /* Make a C stream out of it. */
5080 message_log = fdopen(fd, "a");
5081 if (message_log == NULL)
5083 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5084 spoolname, strerror(errno));
5085 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5090 /* If asked to give up on a message, log who did it, and set the action for all
5095 struct passwd *pw = getpwuid(real_uid);
5096 log_write(0, LOG_MAIN, "cancelled by %s", (pw != NULL)?
5097 US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5098 process_recipients = RECIP_FAIL;
5101 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5103 else if (received_count > received_headers_max)
5104 process_recipients = RECIP_FAIL_LOOP;
5106 /* Otherwise, if a system-wide, address-independent message filter is
5107 specified, run it now, except in the case when we are failing all recipients as
5108 a result of timeout_frozen_after. If the system filter yields "delivered", then
5109 ignore the true recipients of the message. Failure of the filter file is
5110 logged, and the delivery attempt fails. */
5112 else if (system_filter != NULL && process_recipients != RECIP_FAIL_TIMEOUT)
5117 redirect_block redirect;
5119 if (system_filter_uid_set)
5121 ugid.uid = system_filter_uid;
5122 ugid.gid = system_filter_gid;
5123 ugid.uid_set = ugid.gid_set = TRUE;
5127 ugid.uid_set = ugid.gid_set = FALSE;
5130 return_path = sender_address;
5131 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5132 system_filtering = TRUE;
5134 /* Any error in the filter file causes a delivery to be abandoned. */
5136 redirect.string = system_filter;
5137 redirect.isfile = TRUE;
5138 redirect.check_owner = redirect.check_group = FALSE;
5139 redirect.owners = NULL;
5140 redirect.owngroups = NULL;
5142 redirect.modemask = 0;
5144 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5147 &redirect, /* Where the data is */
5148 RDO_DEFER | /* Turn on all the enabling options */
5149 RDO_FAIL | /* Leave off all the disabling options */
5154 NULL, /* No :include: restriction (not used in filter) */
5155 NULL, /* No sieve vacation directory (not sieve!) */
5156 NULL, /* No sieve enotify mailto owner (not sieve!) */
5157 NULL, /* No sieve user address (not sieve!) */
5158 NULL, /* No sieve subaddress (not sieve!) */
5159 &ugid, /* uid/gid data */
5160 &addr_new, /* Where to hang generated addresses */
5161 &filter_message, /* Where to put error message */
5162 NULL, /* Don't skip syntax errors */
5163 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5164 US"system filter"); /* For error messages */
5166 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5168 if (rc == FF_ERROR || rc == FF_NONEXIST)
5170 (void)close(deliver_datafile);
5171 deliver_datafile = -1;
5172 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5173 string_printing(filter_message));
5174 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5177 /* Reset things. If the filter message is an empty string, which can happen
5178 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5180 system_filtering = FALSE;
5181 enable_dollar_recipients = FALSE;
5182 if (filter_message != NULL && filter_message[0] == 0) filter_message = NULL;
5184 /* Save the values of the system filter variables so that user filters
5187 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5189 /* The filter can request that delivery of the original addresses be
5194 process_recipients = RECIP_DEFER;
5195 deliver_msglog("Delivery deferred by system filter\n");
5196 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5199 /* The filter can request that a message be frozen, but this does not
5200 take place if the message has been manually thawed. In that case, we must
5201 unset "delivered", which is forced by the "freeze" command to make -bF
5204 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5206 deliver_freeze = TRUE;
5207 deliver_frozen_at = time(NULL);
5208 process_recipients = RECIP_DEFER;
5209 frozen_info = string_sprintf(" by the system filter%s%s",
5210 (filter_message == NULL)? US"" : US": ",
5211 (filter_message == NULL)? US"" : filter_message);
5214 /* The filter can request that a message be failed. The error message may be
5215 quite long - it is sent back to the sender in the bounce - but we don't want
5216 to fill up the log with repetitions of it. If it starts with << then the text
5217 between << and >> is written to the log, with the rest left for the bounce
5220 else if (rc == FF_FAIL)
5222 uschar *colon = US"";
5223 uschar *logmsg = US"";
5226 process_recipients = RECIP_FAIL_FILTER;
5228 if (filter_message != NULL)
5232 if (filter_message[0] == '<' && filter_message[1] == '<' &&
5233 (logend = Ustrstr(filter_message, ">>")) != NULL)
5235 logmsg = filter_message + 2;
5236 loglen = logend - logmsg;
5237 filter_message = logend + 2;
5238 if (filter_message[0] == 0) filter_message = NULL;
5242 logmsg = filter_message;
5243 loglen = Ustrlen(filter_message);
5247 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5251 /* Delivery can be restricted only to those recipients (if any) that the
5252 filter specified. */
5254 else if (rc == FF_DELIVERED)
5256 process_recipients = RECIP_IGNORE;
5257 if (addr_new == NULL)
5258 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5260 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5263 /* If any new addresses were created by the filter, fake up a "parent"
5264 for them. This is necessary for pipes, etc., which are expected to have
5265 parents, and it also gives some sensible logging for others. Allow
5266 pipes, files, and autoreplies, and run them as the filter uid if set,
5267 otherwise as the current uid. */
5269 if (addr_new != NULL)
5271 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5272 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5274 /* The text "system-filter" is tested in transport_set_up_command() and in
5275 set_up_shell_command() in the pipe transport, to enable them to permit
5276 $recipients, so don't change it here without also changing it there. */
5278 address_item *p = addr_new;
5279 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5281 parent->domain = string_copylc(qualify_domain_recipient);
5282 parent->local_part = US"system-filter";
5284 /* As part of this loop, we arrange for addr_last to end up pointing
5285 at the final address. This is used if we go on to add addresses for the
5286 original recipients. */
5290 if (parent->child_count == SHRT_MAX)
5291 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5292 "than %d delivery addresses", SHRT_MAX);
5293 parent->child_count++;
5296 if (testflag(p, af_pfr))
5302 setflag(p, af_uid_set |
5308 /* Find the name of the system filter's appropriate pfr transport */
5310 if (p->address[0] == '|')
5313 tpname = system_filter_pipe_transport;
5314 address_pipe = p->address;
5316 else if (p->address[0] == '>')
5319 tpname = system_filter_reply_transport;
5323 if (p->address[Ustrlen(p->address)-1] == '/')
5325 type = US"directory";
5326 tpname = system_filter_directory_transport;
5331 tpname = system_filter_file_transport;
5333 address_file = p->address;
5336 /* Now find the actual transport, first expanding the name. We have
5337 set address_file or address_pipe above. */
5341 uschar *tmp = expand_string(tpname);
5342 address_file = address_pipe = NULL;
5344 p->message = string_sprintf("failed to expand \"%s\" as a "
5345 "system filter transport name", tpname);
5350 p->message = string_sprintf("system_filter_%s_transport is unset",
5356 transport_instance *tp;
5357 for (tp = transports; tp != NULL; tp = tp->next)
5359 if (Ustrcmp(tp->name, tpname) == 0)
5366 p->message = string_sprintf("failed to find \"%s\" transport "
5367 "for system filter delivery", tpname);
5370 /* If we couldn't set up a transport, defer the delivery, putting the
5371 error on the panic log as well as the main log. */
5373 if (p->transport == NULL)
5375 address_item *badp = p;
5377 if (addr_last == NULL) addr_new = p; else addr_last->next = p;
5378 badp->local_part = badp->address; /* Needed for log line */
5379 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, DTYPE_ROUTER, 0);
5382 } /* End of pfr handling */
5384 /* Either a non-pfr delivery, or we found a transport */
5386 DEBUG(D_deliver|D_filter)
5387 debug_printf("system filter added %s\n", p->address);
5391 } /* Loop through all addr_new addresses */
5396 /* Scan the recipients list, and for every one that is not in the non-
5397 recipients tree, add an addr item to the chain of new addresses. If the pno
5398 value is non-negative, we must set the onetime parent from it. This which
5399 points to the relevant entry in the recipients list.
5401 This processing can be altered by the setting of the process_recipients
5402 variable, which is changed if recipients are to be ignored, failed, or
5403 deferred. This can happen as a result of system filter activity, or if the -Mg
5404 option is used to fail all of them.
5406 Duplicate addresses are handled later by a different tree structure; we can't
5407 just extend the non-recipients tree, because that will be re-written to the
5408 spool if the message is deferred, and in any case there are casing
5409 complications for local addresses. */
5411 if (process_recipients != RECIP_IGNORE)
5413 for (i = 0; i < recipients_count; i++)
5415 if (tree_search(tree_nonrecipients, recipients_list[i].address) == NULL)
5417 recipient_item *r = recipients_list + i;
5418 address_item *new = deliver_make_addr(r->address, FALSE);
5419 new->p.errors_address = r->errors_to;
5422 new->onetime_parent = recipients_list[r->pno].address;
5424 #ifdef EXPERIMENTAL_DSN
5425 /* If DSN support is enabled, set the dsn flags and the original receipt
5426 to be passed on to other DSN enabled MTAs */
5427 new->dsn_flags = r->dsn_flags & rf_dsnflags;
5428 new->dsn_orcpt = r->orcpt;
5429 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n", new->dsn_orcpt, new->dsn_flags);
5432 switch (process_recipients)
5434 /* RECIP_DEFER is set when a system filter freezes a message. */
5437 new->next = addr_defer;
5442 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
5445 case RECIP_FAIL_FILTER:
5447 (filter_message == NULL)? US"delivery cancelled" : filter_message;
5448 setflag(new, af_pass_message);
5449 goto RECIP_QUEUE_FAILED; /* below */
5452 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
5453 than the value in timeout_frozen_after. Treat non-bounce messages
5454 similarly to -Mg; for bounce messages we just want to discard, so
5455 don't put the address on the failed list. The timeout has already
5458 case RECIP_FAIL_TIMEOUT:
5459 new->message = US"delivery cancelled; message timed out";
5460 goto RECIP_QUEUE_FAILED; /* below */
5463 /* RECIP_FAIL is set when -Mg has been used. */
5466 new->message = US"delivery cancelled by administrator";
5469 /* Common code for the failure cases above. If this is not a bounce
5470 message, put the address on the failed list so that it is used to
5471 create a bounce. Otherwise do nothing - this just discards the address.
5472 The incident has already been logged. */
5475 if (sender_address[0] != 0)
5477 new->next = addr_failed;
5483 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
5484 in the message. Process each address as a routing failure; if this
5485 is a bounce message, it will get frozen. */
5487 case RECIP_FAIL_LOOP:
5488 new->message = US"Too many \"Received\" headers - suspected mail loop";
5489 post_process_one(new, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5493 /* Value should be RECIP_ACCEPT; take this as the safe default. */
5496 if (addr_new == NULL) addr_new = new; else addr_last->next = new;
5501 #ifdef EXPERIMENTAL_TPDA
5502 if (process_recipients != RECIP_ACCEPT)
5504 uschar * save_local = deliver_localpart;
5505 uschar * save_domain = deliver_domain;
5507 deliver_localpart = expand_string(
5508 string_sprintf("${local_part:%s}", new->address));
5509 deliver_domain = expand_string(
5510 string_sprintf("${domain:%s}", new->address));
5512 (void) tpda_raise_event(delivery_event_action,
5513 US"msg:fail:internal", new->message);
5515 deliver_localpart = save_local;
5516 deliver_domain = save_domain;
5525 address_item *p = addr_new;
5526 debug_printf("Delivery address list:\n");
5529 debug_printf(" %s %s\n", p->address, (p->onetime_parent == NULL)? US"" :
5535 /* Set up the buffers used for copying over the file when delivering. */
5537 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
5538 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
5542 /* Until there are no more new addresses, handle each one as follows:
5544 . If this is a generated address (indicated by the presence of a parent
5545 pointer) then check to see whether it is a pipe, file, or autoreply, and
5546 if so, handle it directly here. The router that produced the address will
5547 have set the allow flags into the address, and also set the uid/gid required.
5548 Having the routers generate new addresses and then checking them here at
5549 the outer level is tidier than making each router do the checking, and
5550 means that routers don't need access to the failed address queue.
5552 . Break up the address into local part and domain, and make lowercased
5553 versions of these strings. We also make unquoted versions of the local part.
5555 . Handle the percent hack for those domains for which it is valid.
5557 . For child addresses, determine if any of the parents have the same address.
5558 If so, generate a different string for previous delivery checking. Without
5559 this code, if the address spqr generates spqr via a forward or alias file,
5560 delivery of the generated spqr stops further attempts at the top level spqr,
5561 which is not what is wanted - it may have generated other addresses.
5563 . Check on the retry database to see if routing was previously deferred, but
5564 only if in a queue run. Addresses that are to be routed are put on the
5565 addr_route chain. Addresses that are to be deferred are put on the
5566 addr_defer chain. We do all the checking first, so as not to keep the
5567 retry database open any longer than necessary.
5569 . Now we run the addresses through the routers. A router may put the address
5570 on either the addr_local or the addr_remote chain for local or remote
5571 delivery, respectively, or put it on the addr_failed chain if it is
5572 undeliveable, or it may generate child addresses and put them on the
5573 addr_new chain, or it may defer an address. All the chain anchors are
5574 passed as arguments so that the routers can be called for verification
5577 . If new addresses have been generated by the routers, da capo.
5580 header_rewritten = FALSE; /* No headers rewritten yet */
5581 while (addr_new != NULL) /* Loop until all addresses dealt with */
5583 address_item *addr, *parent;
5584 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE);
5586 /* Failure to open the retry database is treated the same as if it does
5587 not exist. In both cases, dbm_file is NULL. */
5589 if (dbm_file == NULL)
5591 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
5592 debug_printf("no retry data available\n");
5595 /* Scan the current batch of new addresses, to handle pipes, files and
5596 autoreplies, and determine which others are ready for routing. */
5598 while (addr_new != NULL)
5603 dbdata_retry *domain_retry_record;
5604 dbdata_retry *address_retry_record;
5607 addr_new = addr->next;
5609 DEBUG(D_deliver|D_retry|D_route)
5611 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
5612 debug_printf("Considering: %s\n", addr->address);
5615 /* Handle generated address that is a pipe or a file or an autoreply. */
5617 if (testflag(addr, af_pfr))
5619 /* If an autoreply in a filter could not generate a syntactically valid
5620 address, give up forthwith. Set af_ignore_error so that we don't try to
5621 generate a bounce. */
5623 if (testflag(addr, af_bad_reply))
5625 addr->basic_errno = ERRNO_BADADDRESS2;
5626 addr->local_part = addr->address;
5628 US"filter autoreply generated syntactically invalid recipient";
5629 setflag(addr, af_ignore_error);
5630 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5631 continue; /* with the next new address */
5634 /* If two different users specify delivery to the same pipe or file or
5635 autoreply, there should be two different deliveries, so build a unique
5636 string that incorporates the original address, and use this for
5637 duplicate testing and recording delivery, and also for retrying. */
5640 string_sprintf("%s:%s", addr->address, addr->parent->unique +
5641 (testflag(addr->parent, af_homonym)? 3:0));
5643 addr->address_retry_key = addr->domain_retry_key =
5644 string_sprintf("T:%s", addr->unique);
5646 /* If a filter file specifies two deliveries to the same pipe or file,
5647 we want to de-duplicate, but this is probably not wanted for two mail
5648 commands to the same address, where probably both should be delivered.
5649 So, we have to invent a different unique string in that case. Just
5650 keep piling '>' characters on the front. */
5652 if (addr->address[0] == '>')
5654 while (tree_search(tree_duplicates, addr->unique) != NULL)
5655 addr->unique = string_sprintf(">%s", addr->unique);
5658 else if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
5660 DEBUG(D_deliver|D_route)
5661 debug_printf("%s is a duplicate address: discarded\n", addr->address);
5662 addr->dupof = tnode->data.ptr;
5663 addr->next = addr_duplicate;
5664 addr_duplicate = addr;
5668 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5670 /* Check for previous delivery */
5672 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5674 DEBUG(D_deliver|D_route)
5675 debug_printf("%s was previously delivered: discarded\n", addr->address);
5676 child_done(addr, tod_stamp(tod_log));
5680 /* Save for checking future duplicates */
5682 tree_add_duplicate(addr->unique, addr);
5684 /* Set local part and domain */
5686 addr->local_part = addr->address;
5687 addr->domain = addr->parent->domain;
5689 /* Ensure that the delivery is permitted. */
5691 if (testflag(addr, af_file))
5693 if (!testflag(addr, af_allow_file))
5695 addr->basic_errno = ERRNO_FORBIDFILE;
5696 addr->message = US"delivery to file forbidden";
5697 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5698 continue; /* with the next new address */
5701 else if (addr->address[0] == '|')
5703 if (!testflag(addr, af_allow_pipe))
5705 addr->basic_errno = ERRNO_FORBIDPIPE;
5706 addr->message = US"delivery to pipe forbidden";
5707 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5708 continue; /* with the next new address */
5711 else if (!testflag(addr, af_allow_reply))
5713 addr->basic_errno = ERRNO_FORBIDREPLY;
5714 addr->message = US"autoreply forbidden";
5715 (void)post_process_one(addr, FAIL, LOG_MAIN, DTYPE_ROUTER, 0);
5716 continue; /* with the next new address */
5719 /* If the errno field is already set to BADTRANSPORT, it indicates
5720 failure to expand a transport string, or find the associated transport,
5721 or an unset transport when one is required. Leave this test till now so
5722 that the forbid errors are given in preference. */
5724 if (addr->basic_errno == ERRNO_BADTRANSPORT)
5726 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5730 /* Treat /dev/null as a special case and abandon the delivery. This
5731 avoids having to specify a uid on the transport just for this case.
5732 Arrange for the transport name to be logged as "**bypassed**". */
5734 if (Ustrcmp(addr->address, "/dev/null") == 0)
5736 uschar *save = addr->transport->name;
5737 addr->transport->name = US"**bypassed**";
5738 (void)post_process_one(addr, OK, LOG_MAIN, DTYPE_TRANSPORT, '=');
5739 addr->transport->name = save;
5740 continue; /* with the next new address */
5743 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
5746 DEBUG(D_deliver|D_route)
5747 debug_printf("queued for %s transport\n", addr->transport->name);
5748 addr->next = addr_local;
5750 continue; /* with the next new address */
5753 /* Handle normal addresses. First, split up into local part and domain,
5754 handling the %-hack if necessary. There is the possibility of a defer from
5755 a lookup in percent_hack_domains. */
5757 if ((rc = deliver_split_address(addr)) == DEFER)
5759 addr->message = US"cannot check percent_hack_domains";
5760 addr->basic_errno = ERRNO_LISTDEFER;
5761 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5765 /* Check to see if the domain is held. If so, proceed only if the
5766 delivery was forced by hand. */
5768 deliver_domain = addr->domain; /* set $domain */
5769 if (!forced && hold_domains != NULL &&
5770 (rc = match_isinlist(addr->domain, &hold_domains, 0,
5771 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
5776 addr->message = US"hold_domains lookup deferred";
5777 addr->basic_errno = ERRNO_LISTDEFER;
5781 addr->message = US"domain is held";
5782 addr->basic_errno = ERRNO_HELD;
5784 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_NONE, 0);
5788 /* Now we can check for duplicates and previously delivered addresses. In
5789 order to do this, we have to generate a "unique" value for each address,
5790 because there may be identical actual addresses in a line of descendents.
5791 The "unique" field is initialized to the same value as the "address" field,
5792 but gets changed here to cope with identically-named descendents. */
5794 for (parent = addr->parent; parent != NULL; parent = parent->parent)
5795 if (strcmpic(addr->address, parent->address) == 0) break;
5797 /* If there's an ancestor with the same name, set the homonym flag. This
5798 influences how deliveries are recorded. Then add a prefix on the front of
5799 the unique address. We use \n\ where n starts at 0 and increases each time.
5800 It is unlikely to pass 9, but if it does, it may look odd but will still
5801 work. This means that siblings or cousins with the same names are treated
5802 as duplicates, which is what we want. */
5806 setflag(addr, af_homonym);
5807 if (parent->unique[0] != '\\')
5808 addr->unique = string_sprintf("\\0\\%s", addr->address);
5810 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
5814 /* Ensure that the domain in the unique field is lower cased, because
5815 domains are always handled caselessly. */
5817 p = Ustrrchr(addr->unique, '@');
5818 while (*p != 0) { *p = tolower(*p); p++; }
5820 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
5822 if (tree_search(tree_nonrecipients, addr->unique) != NULL)
5824 DEBUG(D_deliver|D_route)
5825 debug_printf("%s was previously delivered: discarded\n", addr->unique);
5826 child_done(addr, tod_stamp(tod_log));
5830 /* Get the routing retry status, saving the two retry keys (with and
5831 without the local part) for subsequent use. If there is no retry record for
5832 the standard address routing retry key, we look for the same key with the
5833 sender attached, because this form is used by the smtp transport after a
5834 4xx response to RCPT when address_retry_include_sender is true. */
5836 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
5837 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
5840 if (dbm_file == NULL)
5841 domain_retry_record = address_retry_record = NULL;
5844 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
5845 if (domain_retry_record != NULL &&
5846 now - domain_retry_record->time_stamp > retry_data_expire)
5847 domain_retry_record = NULL; /* Ignore if too old */
5849 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
5850 if (address_retry_record != NULL &&
5851 now - address_retry_record->time_stamp > retry_data_expire)
5852 address_retry_record = NULL; /* Ignore if too old */
5854 if (address_retry_record == NULL)
5856 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
5858 address_retry_record = dbfn_read(dbm_file, altkey);
5859 if (address_retry_record != NULL &&
5860 now - address_retry_record->time_stamp > retry_data_expire)
5861 address_retry_record = NULL; /* Ignore if too old */
5865 DEBUG(D_deliver|D_retry)
5867 if (domain_retry_record == NULL)
5868 debug_printf("no domain retry record\n");
5869 if (address_retry_record == NULL)
5870 debug_printf("no address retry record\n");
5873 /* If we are sending a message down an existing SMTP connection, we must
5874 assume that the message which created the connection managed to route
5875 an address to that connection. We do not want to run the risk of taking
5876 a long time over routing here, because if we do, the server at the other
5877 end of the connection may time it out. This is especially true for messages
5878 with lots of addresses. For this kind of delivery, queue_running is not
5879 set, so we would normally route all addresses. We take a pragmatic approach
5880 and defer routing any addresses that have any kind of domain retry record.
5881 That is, we don't even look at their retry times. It doesn't matter if this
5882 doesn't work occasionally. This is all just an optimization, after all.
5884 The reason for not doing the same for address retries is that they normally
5885 arise from 4xx responses, not DNS timeouts. */
5887 if (continue_hostname != NULL && domain_retry_record != NULL)
5889 addr->message = US"reusing SMTP connection skips previous routing defer";
5890 addr->basic_errno = ERRNO_RRETRY;
5891 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5894 /* If we are in a queue run, defer routing unless there is no retry data or
5895 we've passed the next retry time, or this message is forced. In other
5896 words, ignore retry data when not in a queue run.
5898 However, if the domain retry time has expired, always allow the routing
5899 attempt. If it fails again, the address will be failed. This ensures that
5900 each address is routed at least once, even after long-term routing
5903 If there is an address retry, check that too; just wait for the next
5904 retry time. This helps with the case when the temporary error on the
5905 address was really message-specific rather than address specific, since
5906 it allows other messages through.
5908 We also wait for the next retry time if this is a message sent down an
5909 existing SMTP connection (even though that will be forced). Otherwise there
5910 will be far too many attempts for an address that gets a 4xx error. In
5911 fact, after such an error, we should not get here because, the host should
5912 not be remembered as one this message needs. However, there was a bug that
5913 used to cause this to happen, so it is best to be on the safe side.
5915 Even if we haven't reached the retry time in the hints, there is one more
5916 check to do, which is for the ultimate address timeout. We only do this
5917 check if there is an address retry record and there is not a domain retry
5918 record; this implies that previous attempts to handle the address had the
5919 retry_use_local_parts option turned on. We use this as an approximation
5920 for the destination being like a local delivery, for example delivery over
5921 LMTP to an IMAP message store. In this situation users are liable to bump
5922 into their quota and thereby have intermittently successful deliveries,
5923 which keep the retry record fresh, which can lead to us perpetually
5924 deferring messages. */
5926 else if (((queue_running && !deliver_force) || continue_hostname != NULL)
5928 ((domain_retry_record != NULL &&
5929 now < domain_retry_record->next_try &&
5930 !domain_retry_record->expired)
5932 (address_retry_record != NULL &&
5933 now < address_retry_record->next_try))
5935 (domain_retry_record != NULL ||
5936 address_retry_record == NULL ||
5937 !retry_ultimate_address_timeout(addr->address_retry_key,
5938 addr->domain, address_retry_record, now)))
5940 addr->message = US"retry time not reached";
5941 addr->basic_errno = ERRNO_RRETRY;
5942 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5945 /* The domain is OK for routing. Remember if retry data exists so it
5946 can be cleaned up after a successful delivery. */
5950 if (domain_retry_record != NULL || address_retry_record != NULL)
5951 setflag(addr, af_dr_retry_exists);
5952 addr->next = addr_route;
5954 DEBUG(D_deliver|D_route)
5955 debug_printf("%s: queued for routing\n", addr->address);
5959 /* The database is closed while routing is actually happening. Requests to
5960 update it are put on a chain and all processed together at the end. */
5962 if (dbm_file != NULL) dbfn_close(dbm_file);
5964 /* If queue_domains is set, we don't even want to try routing addresses in
5965 those domains. During queue runs, queue_domains is forced to be unset.
5966 Optimize by skipping this pass through the addresses if nothing is set. */
5968 if (!deliver_force && queue_domains != NULL)
5970 address_item *okaddr = NULL;
5971 while (addr_route != NULL)
5973 address_item *addr = addr_route;
5974 addr_route = addr->next;
5976 deliver_domain = addr->domain; /* set $domain */
5977 if ((rc = match_isinlist(addr->domain, &queue_domains, 0,
5978 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5983 addr->basic_errno = ERRNO_LISTDEFER;
5984 addr->message = US"queue_domains lookup deferred";
5985 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
5989 addr->next = okaddr;
5995 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
5996 addr->message = US"domain is in queue_domains";
5997 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_ROUTER, 0);
6001 addr_route = okaddr;
6004 /* Now route those addresses that are not deferred. */
6006 while (addr_route != NULL)
6009 address_item *addr = addr_route;
6010 uschar *old_domain = addr->domain;
6011 uschar *old_unique = addr->unique;
6012 addr_route = addr->next;
6015 /* Just in case some router parameter refers to it. */
6017 return_path = (addr->p.errors_address != NULL)?
6018 addr->p.errors_address : sender_address;
6020 /* If a router defers an address, add a retry item. Whether or not to
6021 use the local part in the key is a property of the router. */
6023 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6024 &addr_succeed, v_none)) == DEFER)
6025 retry_add_item(addr, (addr->router->retry_use_local_part)?
6026 string_sprintf("R:%s@%s", addr->local_part, addr->domain) :
6027 string_sprintf("R:%s", addr->domain), 0);
6029 /* Otherwise, if there is an existing retry record in the database, add
6030 retry items to delete both forms. We must also allow for the possibility
6031 of a routing retry that includes the sender address. Since the domain might
6032 have been rewritten (expanded to fully qualified) as a result of routing,
6033 ensure that the rewritten form is also deleted. */
6035 else if (testflag(addr, af_dr_retry_exists))
6037 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6039 retry_add_item(addr, altkey, rf_delete);
6040 retry_add_item(addr, addr->address_retry_key, rf_delete);
6041 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6042 if (Ustrcmp(addr->domain, old_domain) != 0)
6043 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6046 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6047 logged, but we need to ensure the address (and maybe parents) is marked
6052 address_done(addr, tod_stamp(tod_log));
6053 continue; /* route next address */
6056 /* The address is finished with (failed or deferred). */
6060 (void)post_process_one(addr, rc, LOG_MAIN, DTYPE_ROUTER, 0);
6061 continue; /* route next address */
6064 /* The address has been routed. If the router changed the domain, it will
6065 also have changed the unique address. We have to test whether this address
6066 has already been delivered, because it's the unique address that finally
6069 if (addr->unique != old_unique &&
6070 tree_search(tree_nonrecipients, addr->unique) != 0)
6072 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6073 "discarded\n", addr->address);
6074 if (addr_remote == addr) addr_remote = addr->next;
6075 else if (addr_local == addr) addr_local = addr->next;
6078 /* If the router has same_domain_copy_routing set, we are permitted to copy
6079 the routing for any other addresses with the same domain. This is an
6080 optimisation to save repeated DNS lookups for "standard" remote domain
6081 routing. The option is settable only on routers that generate host lists.
6082 We play it very safe, and do the optimization only if the address is routed
6083 to a remote transport, there are no header changes, and the domain was not
6084 modified by the router. */
6086 if (addr_remote == addr &&
6087 addr->router->same_domain_copy_routing &&
6088 addr->p.extra_headers == NULL &&
6089 addr->p.remove_headers == NULL &&
6090 old_domain == addr->domain)
6092 address_item **chain = &addr_route;
6093 while (*chain != NULL)
6095 address_item *addr2 = *chain;
6096 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6098 chain = &(addr2->next);
6102 /* Found a suitable address; take it off the routing list and add it to
6103 the remote delivery list. */
6105 *chain = addr2->next;
6106 addr2->next = addr_remote;
6107 addr_remote = addr2;
6109 /* Copy the routing data */
6111 addr2->domain = addr->domain;
6112 addr2->router = addr->router;
6113 addr2->transport = addr->transport;
6114 addr2->host_list = addr->host_list;
6115 addr2->fallback_hosts = addr->fallback_hosts;
6116 addr2->p.errors_address = addr->p.errors_address;
6117 copyflag(addr2, addr, af_hide_child | af_local_host_removed);
6119 DEBUG(D_deliver|D_route)
6121 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6123 "Routing for %s copied from %s\n",
6124 addr2->address, addr2->address, addr->address);
6128 } /* Continue with routing the next address. */
6129 } /* Loop to process any child addresses that the routers created, and
6130 any rerouted addresses that got put back on the new chain. */
6133 /* Debugging: show the results of the routing */
6135 DEBUG(D_deliver|D_retry|D_route)
6137 address_item *p = addr_local;
6138 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6139 debug_printf("After routing:\n Local deliveries:\n");
6142 debug_printf(" %s\n", p->address);
6147 debug_printf(" Remote deliveries:\n");
6150 debug_printf(" %s\n", p->address);
6155 debug_printf(" Failed addresses:\n");
6158 debug_printf(" %s\n", p->address);
6163 debug_printf(" Deferred addresses:\n");
6166 debug_printf(" %s\n", p->address);
6171 /* Free any resources that were cached during routing. */
6176 /* These two variables are set only during routing, after check_local_user.
6177 Ensure they are not set in transports. */
6179 local_user_gid = (gid_t)(-1);
6180 local_user_uid = (uid_t)(-1);
6182 /* Check for any duplicate addresses. This check is delayed until after
6183 routing, because the flexibility of the routing configuration means that
6184 identical addresses with different parentage may end up being redirected to
6185 different addresses. Checking for duplicates too early (as we previously used
6186 to) makes this kind of thing not work. */
6188 do_duplicate_check(&addr_local);
6189 do_duplicate_check(&addr_remote);
6191 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6192 remote transport. The check that they all end up in one transaction happens in
6193 the do_remote_deliveries() function. */
6195 if (mua_wrapper && (addr_local != NULL || addr_failed != NULL ||
6196 addr_defer != NULL))
6199 uschar *which, *colon, *msg;
6201 if (addr_local != NULL)
6206 else if (addr_defer != NULL)
6209 which = US"deferred";
6217 while (addr->parent != NULL) addr = addr->parent;
6219 if (addr->message != NULL)
6222 msg = addr->message;
6224 else colon = msg = US"";
6226 /* We don't need to log here for a forced failure as it will already
6227 have been logged. Defer will also have been logged, but as a defer, so we do
6228 need to do the failure logging. */
6230 if (addr != addr_failed)
6231 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6232 addr->address, which);
6234 /* Always write an error to the caller */
6236 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6239 final_yield = DELIVER_MUA_FAILED;
6240 addr_failed = addr_defer = NULL; /* So that we remove the message */
6241 goto DELIVERY_TIDYUP;
6245 /* If this is a run to continue deliveries to an external channel that is
6246 already set up, defer any local deliveries. */
6248 if (continue_transport != NULL)
6250 if (addr_defer == NULL) addr_defer = addr_local; else
6252 address_item *addr = addr_defer;
6253 while (addr->next != NULL) addr = addr->next;
6254 addr->next = addr_local;
6260 /* Because address rewriting can happen in the routers, we should not really do
6261 ANY deliveries until all addresses have been routed, so that all recipients of
6262 the message get the same headers. However, this is in practice not always
6263 possible, since sometimes remote addresses give DNS timeouts for days on end.
6264 The pragmatic approach is to deliver what we can now, saving any rewritten
6265 headers so that at least the next lot of recipients benefit from the rewriting
6266 that has already been done.
6268 If any headers have been rewritten during routing, update the spool file to
6269 remember them for all subsequent deliveries. This can be delayed till later if
6270 there is only address to be delivered - if it succeeds the spool write need not
6273 if (header_rewritten &&
6274 ((addr_local != NULL &&
6275 (addr_local->next != NULL || addr_remote != NULL)) ||
6276 (addr_remote != NULL && addr_remote->next != NULL)))
6278 /* Panic-dies on error */
6279 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6280 header_rewritten = FALSE;
6284 /* If there are any deliveries to be done, open the journal file. This is used
6285 to record successful deliveries as soon as possible after each delivery is
6286 known to be complete. A file opened with O_APPEND is used so that several
6287 processes can run simultaneously.
6289 The journal is just insurance against crashes. When the spool file is
6290 ultimately updated at the end of processing, the journal is deleted. If a
6291 journal is found to exist at the start of delivery, the addresses listed
6292 therein are added to the non-recipients. */
6294 if (addr_local != NULL || addr_remote != NULL)
6296 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
6297 journal_fd = Uopen(spoolname, O_WRONLY|O_APPEND|O_CREAT, SPOOL_MODE);
6301 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6302 spoolname, strerror(errno));
6303 return DELIVER_NOT_ATTEMPTED;
6306 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
6307 that the mode is correct - the group setting doesn't always seem to get
6308 set automatically. */
6310 if( fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
6311 || fchown(journal_fd, exim_uid, exim_gid)
6312 || fchmod(journal_fd, SPOOL_MODE)
6315 int ret = Uunlink(spoolname);
6316 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
6317 spoolname, strerror(errno));
6318 if(ret && errno != ENOENT)
6319 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
6320 spoolname, strerror(errno));
6321 return DELIVER_NOT_ATTEMPTED;
6327 /* Now we can get down to the business of actually doing deliveries. Local
6328 deliveries are done first, then remote ones. If ever the problems of how to
6329 handle fallback transports are figured out, this section can be put into a loop
6330 for handling fallbacks, though the uid switching will have to be revised. */
6332 /* Precompile a regex that is used to recognize a parameter in response
6333 to an LHLO command, if is isn't already compiled. This may be used on both
6334 local and remote LMTP deliveries. */
6336 if (regex_IGNOREQUOTA == NULL) regex_IGNOREQUOTA =
6337 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
6339 /* Handle local deliveries */
6341 if (addr_local != NULL)
6343 DEBUG(D_deliver|D_transport)
6344 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
6345 do_local_deliveries();
6346 disable_logging = FALSE;
6349 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
6350 so just queue them all. */
6352 if (queue_run_local)
6354 while (addr_remote != NULL)
6356 address_item *addr = addr_remote;
6357 addr_remote = addr->next;
6359 addr->basic_errno = ERRNO_LOCAL_ONLY;
6360 addr->message = US"remote deliveries suppressed";
6361 (void)post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
6365 /* Handle remote deliveries */
6367 if (addr_remote != NULL)
6369 DEBUG(D_deliver|D_transport)
6370 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
6372 /* Precompile some regex that are used to recognize parameters in response
6373 to an EHLO command, if they aren't already compiled. */
6375 if (regex_PIPELINING == NULL) regex_PIPELINING =
6376 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
6378 if (regex_SIZE == NULL) regex_SIZE =
6379 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
6381 if (regex_AUTH == NULL) regex_AUTH =
6382 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
6386 if (regex_STARTTLS == NULL) regex_STARTTLS =
6387 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
6390 #ifndef DISABLE_PRDR
6391 if (regex_PRDR == NULL) regex_PRDR =
6392 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
6395 #ifdef EXPERIMENTAL_DSN
6396 /* Set the regex to check for DSN support on remote MTA */
6397 if (regex_DSN == NULL) regex_DSN =
6398 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
6401 /* Now sort the addresses if required, and do the deliveries. The yield of
6402 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
6403 cannot be delivered in one transaction. */
6405 if (remote_sort_domains != NULL) sort_remote_deliveries();
6406 if (!do_remote_deliveries(FALSE))
6408 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
6409 "be delivered in one transaction");
6410 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
6412 final_yield = DELIVER_MUA_FAILED;
6413 addr_failed = addr_defer = NULL; /* So that we remove the message */
6414 goto DELIVERY_TIDYUP;
6417 /* See if any of the addresses that failed got put on the queue for delivery
6418 to their fallback hosts. We do it this way because often the same fallback
6419 host is used for many domains, so all can be sent in a single transaction
6420 (if appropriately configured). */
6422 if (addr_fallback != NULL && !mua_wrapper)
6424 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
6425 addr_remote = addr_fallback;
6426 addr_fallback = NULL;
6427 if (remote_sort_domains != NULL) sort_remote_deliveries();
6428 do_remote_deliveries(TRUE);
6430 disable_logging = FALSE;
6434 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
6435 phase, to minimize cases of half-done things. */
6438 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
6440 /* Root privilege is no longer needed */
6442 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
6444 set_process_info("tidying up after delivering %s", message_id);
6445 signal(SIGTERM, SIG_IGN);
6447 /* When we are acting as an MUA wrapper, the smtp transport will either have
6448 succeeded for all addresses, or failed them all in normal cases. However, there
6449 are some setup situations (e.g. when a named port does not exist) that cause an
6450 immediate exit with deferral of all addresses. Convert those into failures. We
6451 do not ever want to retry, nor do we want to send a bounce message. */
6455 if (addr_defer != NULL)
6457 address_item *addr, *nextaddr;
6458 for (addr = addr_defer; addr != NULL; addr = nextaddr)
6460 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
6461 "delivery", addr->address);
6462 nextaddr = addr->next;
6463 addr->next = addr_failed;
6469 /* Now all should either have succeeded or failed. */
6471 if (addr_failed == NULL) final_yield = DELIVER_MUA_SUCCEEDED; else
6473 uschar *s = (addr_failed->user_message != NULL)?
6474 addr_failed->user_message : addr_failed->message;
6476 fprintf(stderr, "Delivery failed: ");
6477 if (addr_failed->basic_errno > 0)
6479 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
6480 if (s != NULL) fprintf(stderr, ": ");
6484 if (addr_failed->basic_errno <= 0) fprintf(stderr, "unknown error");
6486 else fprintf(stderr, "%s", CS s);
6487 fprintf(stderr, "\n");
6489 final_yield = DELIVER_MUA_FAILED;
6494 /* In a normal configuration, we now update the retry database. This is done in
6495 one fell swoop at the end in order not to keep opening and closing (and
6496 locking) the database. The code for handling retries is hived off into a
6497 separate module for convenience. We pass it the addresses of the various
6498 chains, because deferred addresses can get moved onto the failed chain if the
6499 retry cutoff time has expired for all alternative destinations. Bypass the
6500 updating of the database if the -N flag is set, which is a debugging thing that
6501 prevents actual delivery. */
6503 else if (!dont_deliver) retry_update(&addr_defer, &addr_failed, &addr_succeed);
6505 #ifdef EXPERIMENTAL_DSN
6506 /* Send DSN for successful messages */
6507 addr_dsntmp = addr_succeed;
6508 addr_senddsn = NULL;
6510 while(addr_dsntmp != NULL)
6513 debug_printf("DSN: processing router : %s\n", addr_dsntmp->router->name);
6516 debug_printf("DSN: processing successful delivery address: %s\n", addr_dsntmp->address);
6518 /* af_ignore_error not honored here. it's not an error */
6520 DEBUG(D_deliver) debug_printf("DSN: Sender_address: %s\n", sender_address);
6521 DEBUG(D_deliver) debug_printf("DSN: orcpt: %s flags: %d\n", addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags);
6522 DEBUG(D_deliver) debug_printf("DSN: envid: %s ret: %d\n", dsn_envid, dsn_ret);
6523 DEBUG(D_deliver) debug_printf("DSN: Final recipient: %s\n", addr_dsntmp->address);
6524 DEBUG(D_deliver) debug_printf("DSN: Remote SMTP server supports DSN: %d\n", addr_dsntmp->dsn_aware);
6526 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6527 and a report was requested */
6528 if (((addr_dsntmp->dsn_aware != dsn_support_yes) ||
6529 ((addr_dsntmp->dsn_flags & rf_dsnlasthop) != 0))
6531 (((addr_dsntmp->dsn_flags & rf_dsnflags) != 0) &&
6532 ((addr_dsntmp->dsn_flags & rf_notify_success) != 0)))
6534 /* copy and relink address_item and send report with all of them at once later */
6535 address_item *addr_next;
6536 addr_next = addr_senddsn;
6537 addr_senddsn = store_get(sizeof(address_item));
6538 memcpy(addr_senddsn, addr_dsntmp, sizeof(address_item));
6539 addr_senddsn->next = addr_next;
6543 DEBUG(D_deliver) debug_printf("DSN: *** NOT SENDING DSN SUCCESS Message ***\n");
6546 addr_dsntmp = addr_dsntmp->next;
6549 if (addr_senddsn != NULL)
6554 /* create exim process to send message */
6555 pid = child_open_exim(&fd);
6557 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6559 if (pid < 0) /* Creation of child failed */
6561 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6562 "create child process to send failure message: %s", getpid(),
6563 getppid(), strerror(errno));
6565 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6568 else /* Creation of child succeeded */
6570 FILE *f = fdopen(fd, "wb");
6571 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6572 int topt = topt_add_return_path | topt_no_body;
6573 uschar boundaryStr[64];
6575 DEBUG(D_deliver) debug_printf("sending error message to: %s\n", sender_address);
6577 /* build unique id for MIME boundary */
6578 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6579 time(NULL), rand());
6580 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", boundaryStr);
6582 if (errors_reply_to)
6583 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6585 fprintf(f, "Auto-Submitted: auto-generated\n"
6586 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
6588 "Subject: Delivery Status Notification\n"
6589 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
6590 "MIME-Version: 1.0\n\n"
6593 "Content-type: text/plain; charset=us-ascii\n\n"
6595 "This message was created automatically by mail delivery software.\n"
6596 " ----- The following addresses had successful delivery notifications -----\n",
6597 qualify_domain_sender, sender_address, boundaryStr, boundaryStr);
6599 addr_dsntmp = addr_senddsn;
6602 fprintf(f, "<%s> (relayed %s)\n\n",
6603 addr_dsntmp->address,
6604 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
6605 ? "via non DSN router"
6606 : addr_dsntmp->dsn_aware == dsn_support_no
6607 ? "to non-DSN-aware mailer"
6608 : "via non \"Remote SMTP\" router"
6610 addr_dsntmp = addr_dsntmp->next;
6613 "Content-type: message/delivery-status\n\n"
6614 "Reporting-MTA: dns; %s\n",
6615 boundaryStr, smtp_active_hostname);
6617 if (dsn_envid != NULL) {
6618 /* must be decoded from xtext: see RFC 3461:6.3a */
6620 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6621 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6623 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
6627 for (addr_dsntmp = addr_senddsn;
6629 addr_dsntmp = addr_dsntmp->next)
6631 if (addr_dsntmp->dsn_orcpt)
6632 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
6634 fprintf(f, "Action: delivered\n"
6635 "Final-Recipient: rfc822;%s\n"
6637 addr_dsntmp->address);
6639 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
6640 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n",
6641 addr_dsntmp->host_used->name);
6643 fprintf(f,"Diagnostic-Code: X-Exim; relayed via non %s router\n",
6644 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
6648 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", boundaryStr);
6651 transport_filter_argv = NULL; /* Just in case */
6652 return_path = sender_address; /* In case not previously set */
6654 /* Write the original email out */
6655 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
6659 fprintf(f,"--%s--\n", boundaryStr);
6663 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6666 #endif /*EXPERIMENTAL_DSN*/
6668 /* If any addresses failed, we must send a message to somebody, unless
6669 af_ignore_error is set, in which case no action is taken. It is possible for
6670 several messages to get sent if there are addresses with different
6673 while (addr_failed != NULL)
6677 uschar *logtod = tod_stamp(tod_log);
6679 address_item *handled_addr = NULL;
6680 address_item **paddr;
6681 address_item *msgchain = NULL;
6682 address_item **pmsgchain = &msgchain;
6684 /* There are weird cases when logging is disabled in the transport. However,
6685 there may not be a transport (address failed by a router). */
6687 disable_logging = FALSE;
6688 if (addr_failed->transport != NULL)
6689 disable_logging = addr_failed->transport->disable_logging;
6692 debug_printf("processing failed address %s\n", addr_failed->address);
6694 /* There are only two ways an address in a bounce message can get here:
6696 (1) When delivery was initially deferred, but has now timed out (in the call
6697 to retry_update() above). We can detect this by testing for
6698 af_retry_timedout. If the address does not have its own errors address,
6699 we arrange to ignore the error.
6701 (2) If delivery failures for bounce messages are being ignored. We can detect
6702 this by testing for af_ignore_error. This will also be set if a bounce
6703 message has been autothawed and the ignore_bounce_errors_after time has
6704 passed. It might also be set if a router was explicitly configured to
6705 ignore errors (errors_to = "").
6707 If neither of these cases obtains, something has gone wrong. Log the
6708 incident, but then ignore the error. */
6710 if (sender_address[0] == 0 && addr_failed->p.errors_address == NULL)
6712 if (!testflag(addr_failed, af_retry_timedout) &&
6713 !testflag(addr_failed, af_ignore_error))
6715 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
6716 "failure is neither frozen nor ignored (it's been ignored)");
6718 setflag(addr_failed, af_ignore_error);
6721 /* If the first address on the list has af_ignore_error set, just remove
6722 it from the list, throw away any saved message file, log it, and
6723 mark the recipient done. */
6725 if (testflag(addr_failed, af_ignore_error)
6726 #ifdef EXPERIMENTAL_DSN
6727 || (((addr_failed->dsn_flags & rf_dsnflags) != 0)
6728 && ((addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure))
6733 addr_failed = addr->next;
6734 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
6736 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
6738 (addr->parent == NULL)? US"" : US" <",
6739 (addr->parent == NULL)? US"" : addr->parent->address,
6740 (addr->parent == NULL)? US"" : US">");
6742 address_done(addr, logtod);
6743 child_done(addr, logtod);
6744 /* Panic-dies on error */
6745 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6748 /* Otherwise, handle the sending of a message. Find the error address for
6749 the first address, then send a message that includes all failed addresses
6750 that have the same error address. Note the bounce_recipient is a global so
6751 that it can be accesssed by $bounce_recipient while creating a customized
6756 bounce_recipient = (addr_failed->p.errors_address == NULL)?
6757 sender_address : addr_failed->p.errors_address;
6759 /* Make a subprocess to send a message */
6761 pid = child_open_exim(&fd);
6763 /* Creation of child failed */
6766 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6767 "create child process to send failure message: %s", getpid(),
6768 getppid(), strerror(errno));
6770 /* Creation of child succeeded */
6777 uschar *bcc, *emf_text;
6778 FILE *f = fdopen(fd, "wb");
6780 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
6781 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
6782 DELIVER_IN_BUFFER_SIZE;
6783 #ifdef EXPERIMENTAL_DSN
6784 uschar boundaryStr[64];
6785 uschar *dsnlimitmsg;
6786 uschar *dsnnotifyhdr;
6791 debug_printf("sending error message to: %s\n", bounce_recipient);
6793 /* Scan the addresses for all that have the same errors address, removing
6794 them from the addr_failed chain, and putting them on msgchain. */
6796 paddr = &addr_failed;
6797 for (addr = addr_failed; addr != NULL; addr = *paddr)
6799 if (Ustrcmp(bounce_recipient, (addr->p.errors_address == NULL)?
6800 sender_address : addr->p.errors_address) != 0)
6802 paddr = &(addr->next); /* Not the same; skip */
6804 else /* The same - dechain */
6806 *paddr = addr->next;
6809 pmsgchain = &(addr->next);
6813 /* Include X-Failed-Recipients: for automatic interpretation, but do
6814 not let any one header line get too long. We do this by starting a
6815 new header every 50 recipients. Omit any addresses for which the
6816 "hide_child" flag is set. */
6818 for (addr = msgchain; addr != NULL; addr = addr->next)
6820 if (testflag(addr, af_hide_child)) continue;
6827 (rcount++ == 0)? "X-Failed-Recipients: " : ",\n ",
6828 (testflag(addr, af_pfr) && addr->parent != NULL)?
6829 string_printing(addr->parent->address) :
6830 string_printing(addr->address));
6832 if (rcount > 0) fprintf(f, "\n");
6834 /* Output the standard headers */
6836 if (errors_reply_to != NULL)
6837 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6838 fprintf(f, "Auto-Submitted: auto-replied\n");
6840 fprintf(f, "To: %s\n", bounce_recipient);
6842 #ifdef EXPERIMENTAL_DSN
6843 /* generate boundary string and output MIME-Headers */
6844 snprintf(boundaryStr, sizeof(boundaryStr)-1, TIME_T_FMT "-eximdsn-%d",
6845 time(NULL), rand());
6847 fprintf(f, "Content-Type: multipart/report;"
6848 " report-type=delivery-status; boundary=%s\n"
6849 "MIME-Version: 1.0\n",
6853 /* Open a template file if one is provided. Log failure to open, but
6854 carry on - default texts will be used. */
6856 if (bounce_message_file)
6857 if (!(emf = Ufopen(bounce_message_file, "rb")))
6858 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
6859 "message texts: %s", bounce_message_file, strerror(errno));
6861 /* Quietly copy to configured additional addresses if required. */
6863 if ((bcc = moan_check_errorcopy(bounce_recipient)))
6864 fprintf(f, "Bcc: %s\n", bcc);
6866 /* The texts for the message can be read from a template file; if there
6867 isn't one, or if it is too short, built-in texts are used. The first
6868 emf text is a Subject: and any other headers. */
6870 if ((emf_text = next_emf(emf, US"header")))
6871 fprintf(f, "%s\n", emf_text);
6873 fprintf(f, "Subject: Mail delivery failed%s\n\n",
6874 to_sender? ": returning message to sender" : "");
6876 #ifdef EXPERIMENTAL_DSN
6877 /* output human readable part as text/plain section */
6879 "Content-type: text/plain; charset=us-ascii\n\n",
6883 if ((emf_text = next_emf(emf, US"intro")))
6884 fprintf(f, "%s", CS emf_text);
6888 /* This message has been reworded several times. It seems to be confusing to
6889 somebody, however it is worded. I have retreated to the original, simple
6891 "This message was created automatically by mail delivery software.\n");
6893 if (bounce_message_text)
6894 fprintf(f, "%s", CS bounce_message_text);
6897 "\nA message that you sent could not be delivered to one or more of its\n"
6898 "recipients. This is a permanent error. The following address(es) failed:\n");
6901 "\nA message sent by\n\n <%s>\n\n"
6902 "could not be delivered to one or more of its recipients. The following\n"
6903 "address(es) failed:\n", sender_address);
6907 /* Process the addresses, leaving them on the msgchain if they have a
6908 file name for a return message. (There has already been a check in
6909 post_process_one() for the existence of data in the message file.) A TRUE
6910 return from print_address_information() means that the address is not
6914 for (addr = msgchain; addr != NULL; addr = *paddr)
6916 if (print_address_information(addr, f, US" ", US"\n ", US""))
6917 print_address_error(addr, f, US"");
6919 /* End the final line for the address */
6923 /* Leave on msgchain if there's a return file. */
6925 if (addr->return_file >= 0)
6927 paddr = &(addr->next);
6931 /* Else save so that we can tick off the recipient when the
6936 *paddr = addr->next;
6937 addr->next = handled_addr;
6938 handled_addr = addr;
6944 /* Get the next text, whether we need it or not, so as to be
6945 positioned for the one after. */
6947 emf_text = next_emf(emf, US"generated text");
6949 /* If there were any file messages passed by the local transports,
6950 include them in the message. Then put the address on the handled chain.
6951 In the case of a batch of addresses that were all sent to the same
6952 transport, the return_file field in all of them will contain the same
6953 fd, and the return_filename field in the *last* one will be set (to the
6954 name of the file). */
6958 address_item *nextaddr;
6961 fprintf(f, "%s", CS emf_text);
6964 "The following text was generated during the delivery "
6965 "attempt%s:\n", (filecount > 1)? "s" : "");
6967 for (addr = msgchain; addr != NULL; addr = nextaddr)
6970 address_item *topaddr = addr;
6972 /* List all the addresses that relate to this file */
6975 while(addr) /* Insurance */
6977 print_address_information(addr, f, US"------ ", US"\n ",
6979 if (addr->return_filename) break;
6984 /* Now copy the file */
6986 fm = Ufopen(addr->return_filename, "rb");
6989 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
6993 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
6996 Uunlink(addr->return_filename);
6998 /* Can now add to handled chain, first fishing off the next
6999 address on the msgchain. */
7001 nextaddr = addr->next;
7002 addr->next = handled_addr;
7003 handled_addr = topaddr;
7008 #ifdef EXPERIMENTAL_DSN
7009 /* output machine readable part */
7011 "Content-type: message/delivery-status\n\n"
7012 "Reporting-MTA: dns; %s\n",
7013 boundaryStr, smtp_active_hostname);
7017 /* must be decoded from xtext: see RFC 3461:6.3a */
7019 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7020 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7022 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7026 for (addr = handled_addr; addr; addr = addr->next)
7028 fprintf(f, "Action: failed\n"
7029 "Final-Recipient: rfc822;%s\n"
7032 if (addr->host_used && addr->host_used->name)
7033 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
7034 addr->host_used->name, addr->basic_errno);
7038 /* Now copy the message, trying to give an intelligible comment if
7039 it is too long for it all to be copied. The limit isn't strictly
7040 applied because of the buffering. There is, however, an option
7041 to suppress copying altogether. */
7043 emf_text = next_emf(emf, US"copy");
7045 #ifndef EXPERIMENTAL_DSN
7046 if (bounce_return_message)
7048 int topt = topt_add_return_path;
7049 if (!bounce_return_body) topt |= topt_no_body;
7052 fprintf(f, "%s", CS emf_text);
7055 if (bounce_return_body) fprintf(f,
7056 "------ This is a copy of the message, including all the headers. ------\n");
7058 "------ This is a copy of the message's headers. ------\n");
7061 /* While reading the "truncated" message, set return_size_limit to
7062 the actual max testing value, rounded. We need to read the message
7063 whether we are going to use it or not. */
7066 int temp = bounce_return_size_limit;
7067 bounce_return_size_limit = (max/1000)*1000;
7068 emf_text = next_emf(emf, US"truncated");
7069 bounce_return_size_limit = temp;
7072 if (bounce_return_body && bounce_return_size_limit > 0)
7074 struct stat statbuf;
7075 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7078 fprintf(f, "%s", CS emf_text);
7081 "------ The body of the message is " OFF_T_FMT " characters long; only the first\n"
7082 "------ %d or so are included here.\n", statbuf.st_size, max);
7089 transport_filter_argv = NULL; /* Just in case */
7090 return_path = sender_address; /* In case not previously set */
7091 transport_write_message(NULL, fileno(f), topt,
7092 bounce_return_size_limit, NULL, NULL, NULL, NULL, NULL, 0);
7095 /* Write final text and close the template file if one is open */
7099 if ((emf_text = next_emf(emf, US"final")))
7100 fprintf(f, "%s", CS emf_text);
7105 we ignore the intro text from template and add
7106 the text for bounce_return_size_limit at the end.
7108 bounce_return_message is ignored
7109 in case RET= is defined we honor these values
7110 otherwise bounce_return_body is honored.
7112 bounce_return_size_limit is always honored.
7115 fprintf(f, "\n--%s\n", boundaryStr);
7117 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7118 dsnnotifyhdr = NULL;
7119 topt = topt_add_return_path;
7121 /* RET=HDRS? top priority */
7122 if (dsn_ret == dsn_ret_hdrs)
7123 topt |= topt_no_body;
7125 /* no full body return at all? */
7126 if (!bounce_return_body)
7128 topt |= topt_no_body;
7129 /* add header if we overrule RET=FULL */
7130 if (dsn_ret == dsn_ret_full)
7131 dsnnotifyhdr = dsnlimitmsg;
7133 /* size limited ... return headers only if limit reached */
7134 else if (bounce_return_size_limit > 0)
7136 struct stat statbuf;
7137 if (fstat(deliver_datafile, &statbuf) == 0 && statbuf.st_size > max)
7139 topt |= topt_no_body;
7140 dsnnotifyhdr = dsnlimitmsg;
7144 if (topt & topt_no_body)
7145 fprintf(f,"Content-type: text/rfc822-headers\n\n");
7147 fprintf(f,"Content-type: message/rfc822\n\n");
7150 transport_filter_argv = NULL; /* Just in case */
7151 return_path = sender_address; /* In case not previously set */
7152 transport_write_message(NULL, fileno(f), topt,
7153 0, dsnnotifyhdr, NULL, NULL, NULL, NULL, 0);
7156 /* we never add the final text. close the file */
7160 fprintf(f, "\n--%s--\n", boundaryStr);
7161 #endif /*EXPERIMENTAL_DSN*/
7163 /* Close the file, which should send an EOF to the child process
7164 that is receiving the message. Wait for it to finish. */
7167 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7169 /* In the test harness, let the child do it's thing first. */
7171 if (running_in_test_harness) millisleep(500);
7173 /* If the process failed, there was some disaster in setting up the
7174 error message. Unless the message is very old, ensure that addr_defer
7175 is non-null, which will have the effect of leaving the message on the
7176 spool. The failed addresses will get tried again next time. However, we
7177 don't really want this to happen too often, so freeze the message unless
7178 there are some genuine deferred addresses to try. To do this we have
7179 to call spool_write_header() here, because with no genuine deferred
7180 addresses the normal code below doesn't get run. */
7185 if (now - received_time < retry_maximum_timeout && addr_defer == NULL)
7187 addr_defer = (address_item *)(+1);
7188 deliver_freeze = TRUE;
7189 deliver_frozen_at = time(NULL);
7190 /* Panic-dies on error */
7191 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7194 deliver_msglog("Process failed (%d) when writing error message "
7195 "to %s%s", rc, bounce_recipient, s);
7196 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7197 "to %s%s", rc, bounce_recipient, s);
7200 /* The message succeeded. Ensure that the recipients that failed are
7201 now marked finished with on the spool and their parents updated. */
7205 for (addr = handled_addr; addr != NULL; addr = addr->next)
7207 address_done(addr, logtod);
7208 child_done(addr, logtod);
7210 /* Panic-dies on error */
7211 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7217 disable_logging = FALSE; /* In case left set */
7219 /* Come here from the mua_wrapper case if routing goes wrong */
7223 /* If there are now no deferred addresses, we are done. Preserve the
7224 message log if so configured, and we are using them. Otherwise, sling it.
7225 Then delete the message itself. */
7227 if (addr_defer == NULL)
7231 sprintf(CS spoolname, "%s/msglog/%s/%s", spool_directory, message_subdir,
7233 if (preserve_message_logs)
7236 sprintf(CS big_buffer, "%s/msglog.OLD/%s", spool_directory, id);
7237 if ((rc = Urename(spoolname, big_buffer)) < 0)
7239 (void)directory_make(spool_directory, US"msglog.OLD",
7240 MSGLOG_DIRECTORY_MODE, TRUE);
7241 rc = Urename(spoolname, big_buffer);
7244 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7245 "msglog.OLD directory", spoolname);
7249 if (Uunlink(spoolname) < 0)
7250 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7251 spoolname, strerror(errno));
7255 /* Remove the two message files. */
7257 sprintf(CS spoolname, "%s/input/%s/%s-D", spool_directory, message_subdir, id);
7258 if (Uunlink(spoolname) < 0)
7259 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7260 spoolname, strerror(errno));
7261 sprintf(CS spoolname, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
7262 if (Uunlink(spoolname) < 0)
7263 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7264 spoolname, strerror(errno));
7266 /* Log the end of this message, with queue time if requested. */
7268 if ((log_extra_selector & LX_queue_time_overall) != 0)
7269 log_write(0, LOG_MAIN, "Completed QT=%s",
7270 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
7272 log_write(0, LOG_MAIN, "Completed");
7274 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7275 deliver_freeze = FALSE;
7277 #ifdef EXPERIMENTAL_TPDA
7278 (void) tpda_raise_event(delivery_event_action, US"msg:complete", NULL);
7282 /* If there are deferred addresses, we are keeping this message because it is
7283 not yet completed. Lose any temporary files that were catching output from
7284 pipes for any of the deferred addresses, handle one-time aliases, and see if
7285 the message has been on the queue for so long that it is time to send a warning
7286 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7287 have the same domain, we can set deliver_domain for the expansion of
7288 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7289 the parent's domain.
7291 If all the deferred addresses have an error number that indicates "retry time
7292 not reached", skip sending the warning message, because it won't contain the
7293 reason for the delay. It will get sent at the next real delivery attempt.
7294 However, if at least one address has tried, we'd better include all of them in
7297 If we can't make a process to send the message, don't worry.
7299 For mailing list expansions we want to send the warning message to the
7300 mailing list manager. We can't do a perfect job here, as some addresses may
7301 have different errors addresses, but if we take the errors address from
7302 each deferred address it will probably be right in most cases.
7304 If addr_defer == +1, it means there was a problem sending an error message
7305 for failed addresses, and there were no "real" deferred addresses. The value
7306 was set just to keep the message on the spool, so there is nothing to do here.
7309 else if (addr_defer != (address_item *)(+1))
7312 uschar *recipients = US"";
7313 BOOL delivery_attempted = FALSE;
7315 deliver_domain = testflag(addr_defer, af_pfr)?
7316 addr_defer->parent->domain : addr_defer->domain;
7318 for (addr = addr_defer; addr != NULL; addr = addr->next)
7320 address_item *otaddr;
7322 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7324 if (deliver_domain != NULL)
7326 uschar *d = (testflag(addr, af_pfr))? addr->parent->domain : addr->domain;
7328 /* The domain may be unset for an address that has never been routed
7329 because the system filter froze the message. */
7331 if (d == NULL || Ustrcmp(d, deliver_domain) != 0) deliver_domain = NULL;
7334 if (addr->return_filename != NULL) Uunlink(addr->return_filename);
7336 /* Handle the case of one-time aliases. If any address in the ancestry
7337 of this one is flagged, ensure it is in the recipients list, suitably
7338 flagged, and that its parent is marked delivered. */
7340 for (otaddr = addr; otaddr != NULL; otaddr = otaddr->parent)
7341 if (otaddr->onetime_parent != NULL) break;
7346 int t = recipients_count;
7348 for (i = 0; i < recipients_count; i++)
7350 uschar *r = recipients_list[i].address;
7351 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
7352 if (Ustrcmp(otaddr->address, r) == 0) break;
7355 /* Didn't find the address already in the list, and did find the
7356 ultimate parent's address in the list. After adding the recipient,
7357 update the errors address in the recipients list. */
7359 if (i >= recipients_count && t < recipients_count)
7361 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
7362 otaddr->address, otaddr->parent->address);
7363 receive_add_recipient(otaddr->address, t);
7364 recipients_list[recipients_count-1].errors_to = otaddr->p.errors_address;
7365 tree_add_nonrecipient(otaddr->parent->address);
7366 update_spool = TRUE;
7370 /* Except for error messages, ensure that either the errors address for
7371 this deferred address or, if there is none, the sender address, is on the
7372 list of recipients for a warning message. */
7374 if (sender_address[0] != 0)
7376 if (addr->p.errors_address == NULL)
7378 if (Ustrstr(recipients, sender_address) == NULL)
7379 recipients = string_sprintf("%s%s%s", recipients,
7380 (recipients[0] == 0)? "" : ",", sender_address);
7384 if (Ustrstr(recipients, addr->p.errors_address) == NULL)
7385 recipients = string_sprintf("%s%s%s", recipients,
7386 (recipients[0] == 0)? "" : ",", addr->p.errors_address);
7391 /* Send a warning message if the conditions are right. If the condition check
7392 fails because of a lookup defer, there is nothing we can do. The warning
7393 is not sent. Another attempt will be made at the next delivery attempt (if
7396 if (!queue_2stage && delivery_attempted &&
7397 #ifdef EXPERIMENTAL_DSN
7398 (((addr_defer->dsn_flags & rf_dsnflags) == 0) ||
7399 (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay) &&
7401 delay_warning[1] > 0 && sender_address[0] != 0 &&
7402 (delay_warning_condition == NULL ||
7403 expand_check_condition(delay_warning_condition,
7404 US"delay_warning", US"option")))
7408 int queue_time = time(NULL) - received_time;
7410 /* When running in the test harness, there's an option that allows us to
7411 fudge this time so as to get repeatability of the tests. Take the first
7412 time off the list. In queue runs, the list pointer gets updated in the
7415 if (running_in_test_harness && fudged_queue_times[0] != 0)
7417 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
7420 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
7421 fudged_queue_times);
7426 /* See how many warnings we should have sent by now */
7428 for (count = 0; count < delay_warning[1]; count++)
7429 if (queue_time < delay_warning[count+2]) break;
7431 show_time = delay_warning[count+1];
7433 if (count >= delay_warning[1])
7436 int last_gap = show_time;
7437 if (count > 1) last_gap -= delay_warning[count];
7438 extra = (queue_time - delay_warning[count+1])/last_gap;
7439 show_time += last_gap * extra;
7445 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
7446 debug_printf("warning counts: required %d done %d\n", count,
7450 /* We have computed the number of warnings there should have been by now.
7451 If there haven't been enough, send one, and up the count to what it should
7454 if (warning_count < count)
7458 pid_t pid = child_open_exim(&fd);
7464 FILE *f = fdopen(fd, "wb");
7465 #ifdef EXPERIMENTAL_DSN
7466 uschar boundaryStr[64];
7469 if (warn_message_file)
7471 wmf = Ufopen(warn_message_file, "rb");
7473 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
7474 "message texts: %s", warn_message_file, strerror(errno));
7477 warnmsg_recipients = recipients;
7478 warnmsg_delay = (queue_time < 120*60)?
7479 string_sprintf("%d minutes", show_time/60):
7480 string_sprintf("%d hours", show_time/3600);
7482 if (errors_reply_to)
7483 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7484 fprintf(f, "Auto-Submitted: auto-replied\n");
7486 fprintf(f, "To: %s\n", recipients);
7488 #ifdef EXPERIMENTAL_DSN
7489 /* generated boundary string and output MIME-Headers */
7490 snprintf(boundaryStr, sizeof(boundaryStr)-1,
7491 TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7493 fprintf(f, "Content-Type: multipart/report;"
7494 " report-type=delivery-status; boundary=%s\n"
7495 "MIME-Version: 1.0\n",
7499 if ((wmf_text = next_emf(wmf, US"header")))
7500 fprintf(f, "%s\n", wmf_text);
7502 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
7503 message_id, warnmsg_delay);
7505 #ifdef EXPERIMENTAL_DSN
7506 /* output human readable part as text/plain section */
7508 "Content-type: text/plain; charset=us-ascii\n\n",
7512 if ((wmf_text = next_emf(wmf, US"intro")))
7513 fprintf(f, "%s", CS wmf_text);
7517 "This message was created automatically by mail delivery software.\n");
7519 if (Ustrcmp(recipients, sender_address) == 0)
7521 "A message that you sent has not yet been delivered to one or more of its\n"
7522 "recipients after more than ");
7526 "A message sent by\n\n <%s>\n\n"
7527 "has not yet been delivered to one or more of its recipients after more than \n",
7530 fprintf(f, "%s on the queue on %s.\n\n"
7531 "The message identifier is: %s\n",
7532 warnmsg_delay, primary_hostname, message_id);
7534 for (h = header_list; h != NULL; h = h->next)
7535 if (strncmpic(h->text, US"Subject:", 8) == 0)
7536 fprintf(f, "The subject of the message is: %s", h->text + 9);
7537 else if (strncmpic(h->text, US"Date:", 5) == 0)
7538 fprintf(f, "The date of the message is: %s", h->text + 6);
7541 fprintf(f, "The address%s to which the message has not yet been "
7543 !addr_defer->next ? "" : "es",
7544 !addr_defer->next ? "is": "are");
7547 /* List the addresses, with error information if allowed */
7549 #ifdef EXPERIMENTAL_DSN
7550 /* store addr_defer for machine readable part */
7551 address_item *addr_dsndefer = addr_defer;
7556 address_item *addr = addr_defer;
7557 addr_defer = addr->next;
7558 if (print_address_information(addr, f, US" ", US"\n ", US""))
7559 print_address_error(addr, f, US"Delay reason: ");
7568 if ((wmf_text = next_emf(wmf, US"final")))
7569 fprintf(f, "%s", CS wmf_text);
7575 "No action is required on your part. Delivery attempts will continue for\n"
7576 "some time, and this warning may be repeated at intervals if the message\n"
7577 "remains undelivered. Eventually the mail delivery software will give up,\n"
7578 "and when that happens, the message will be returned to you.\n");
7581 #ifdef EXPERIMENTAL_DSN
7582 /* output machine readable part */
7583 fprintf(f, "\n--%s\n"
7584 "Content-type: message/delivery-status\n\n"
7585 "Reporting-MTA: dns; %s\n",
7587 smtp_active_hostname);
7592 /* must be decoded from xtext: see RFC 3461:6.3a */
7594 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7595 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
7597 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formated ENVID\n");
7601 while (addr_dsndefer)
7603 if (addr_dsndefer->dsn_orcpt)
7604 fprintf(f,"Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
7606 fprintf(f,"Action: delayed\n");
7607 fprintf(f,"Final-Recipient: rfc822;%s\n", addr_dsndefer->address);
7608 fprintf(f,"Status: 4.0.0\n");
7609 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
7610 fprintf(f,"Remote-MTA: dns; %s\nDiagnostic-Code: smtp; %d\n",
7611 addr_dsndefer->host_used->name, addr_dsndefer->basic_errno);
7612 addr_dsndefer = addr_dsndefer->next;
7615 fprintf(f, "\n--%s\n"
7616 "Content-type: text/rfc822-headers\n\n",
7620 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7621 int topt = topt_add_return_path | topt_no_body;
7622 transport_filter_argv = NULL; /* Just in case */
7623 return_path = sender_address; /* In case not previously set */
7624 /* Write the original email out */
7625 transport_write_message(NULL, fileno(f), topt, 0, NULL, NULL, NULL, NULL, NULL, 0);
7628 fprintf(f,"\n--%s--\n", boundaryStr);
7631 #endif /*EXPERIMENTAL_DSN*/
7633 /* Close and wait for child process to complete, without a timeout.
7634 If there's an error, don't update the count. */
7637 if (child_close(pid, 0) == 0)
7639 warning_count = count;
7640 update_spool = TRUE; /* Ensure spool rewritten */
7646 /* Clear deliver_domain */
7648 deliver_domain = NULL;
7650 /* If this was a first delivery attempt, unset the first time flag, and
7651 ensure that the spool gets updated. */
7653 if (deliver_firsttime)
7655 deliver_firsttime = FALSE;
7656 update_spool = TRUE;
7659 /* If delivery was frozen and freeze_tell is set, generate an appropriate
7660 message, unless the message is a local error message (to avoid loops). Then
7661 log the freezing. If the text in "frozen_info" came from a system filter,
7662 it has been escaped into printing characters so as not to mess up log lines.
7663 For the "tell" message, we turn \n back into newline. Also, insert a newline
7664 near the start instead of the ": " string. */
7668 if (freeze_tell != NULL && freeze_tell[0] != 0 && !local_error_message)
7670 uschar *s = string_copy(frozen_info);
7671 uschar *ss = Ustrstr(s, " by the system filter: ");
7682 if (*ss == '\\' && ss[1] == 'n')
7689 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
7690 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
7694 /* Log freezing just before we update the -H file, to minimize the chance
7695 of a race problem. */
7697 deliver_msglog("*** Frozen%s\n", frozen_info);
7698 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
7701 /* If there have been any updates to the non-recipients list, or other things
7702 that get written to the spool, we must now update the spool header file so
7703 that it has the right information for the next delivery attempt. If there
7704 was more than one address being delivered, the header_change update is done
7705 earlier, in case one succeeds and then something crashes. */
7708 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
7709 update_spool, header_rewritten);
7711 if (update_spool || header_rewritten)
7712 /* Panic-dies on error */
7713 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7716 /* Finished with the message log. If the message is complete, it will have
7717 been unlinked or renamed above. */
7719 if (message_logs) (void)fclose(message_log);
7721 /* Now we can close and remove the journal file. Its only purpose is to record
7722 successfully completed deliveries asap so that this information doesn't get
7723 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
7724 not serious, as trying it again is not harmful. The journal might not be open
7725 if all addresses were deferred at routing or directing. Nevertheless, we must
7726 remove it if it exists (may have been lying around from a crash during the
7727 previous delivery attempt). We don't remove the journal if a delivery
7728 subprocess failed to pass back delivery information; this is controlled by
7729 the remove_journal flag. When the journal is left, we also don't move the
7730 message off the main spool if frozen and the option is set. It should get moved
7731 at the next attempt, after the journal has been inspected. */
7733 if (journal_fd >= 0) (void)close(journal_fd);
7737 sprintf(CS spoolname, "%s/input/%s/%s-J", spool_directory, message_subdir, id);
7738 if (Uunlink(spoolname) < 0 && errno != ENOENT)
7739 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", spoolname,
7742 /* Move the message off the spool if reqested */
7744 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
7745 if (deliver_freeze && move_frozen_messages)
7746 (void)spool_move_message(id, message_subdir, US"", US"F");
7750 /* Closing the data file frees the lock; if the file has been unlinked it
7751 will go away. Otherwise the message becomes available for another process
7754 (void)close(deliver_datafile);
7755 deliver_datafile = -1;
7756 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
7758 /* It is unlikely that there will be any cached resources, since they are
7759 released after routing, and in the delivery subprocesses. However, it's
7760 possible for an expansion for something afterwards (for example,
7761 expand_check_condition) to do a lookup. We must therefore be sure everything is
7765 acl_where = ACL_WHERE_UNKNOWN;
7771 /* End of deliver.c */