1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* The main code for delivering a message. */
13 #include "transports/smtp.h"
18 /* Data block for keeping track of subprocesses for parallel remote
21 typedef struct pardata {
22 address_item *addrlist; /* chain of addresses */
23 address_item *addr; /* next address data expected for */
24 pid_t pid; /* subprocess pid */
25 int fd; /* pipe fd for getting result from subprocess */
26 int transport_count; /* returned transport count value */
27 BOOL done; /* no more data needed */
28 uschar *msg; /* error message */
29 uschar *return_path; /* return_path for these addresses */
32 /* Values for the process_recipients variable */
34 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
38 /* Mutually recursive functions for marking addresses done. */
40 static void child_done(address_item *, uschar *);
41 static void address_done(address_item *, uschar *);
43 /* Table for turning base-62 numbers into binary */
45 static uschar tab62[] =
46 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
47 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
48 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
49 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
50 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
51 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
55 /*************************************************
56 * Local static variables *
57 *************************************************/
59 /* addr_duplicate is global because it needs to be seen from the Envelope-To
62 static address_item *addr_defer = NULL;
63 static address_item *addr_failed = NULL;
64 static address_item *addr_fallback = NULL;
65 static address_item *addr_local = NULL;
66 static address_item *addr_new = NULL;
67 static address_item *addr_remote = NULL;
68 static address_item *addr_route = NULL;
69 static address_item *addr_succeed = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static struct pollfd *parpoll;
78 static int return_count;
79 static uschar *frozen_info = US"";
80 static uschar *used_return_path = NULL;
84 /*************************************************
85 * read as much as requested *
86 *************************************************/
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
97 This function read(2)s until we got all the data we *requested*.
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
103 fd the file descriptor to read from
104 buffer pointer to a buffer of size len
105 len the requested(!) amount of bytes
107 Returns: the amount of bytes read
110 readn(int fd, void * buffer, size_t len)
112 uschar * next = buffer;
113 uschar * end = next + len;
117 ssize_t got = read(fd, next, end - next);
119 /* I'm not sure if there are signals that can interrupt us,
120 for now I assume the worst */
121 if (got == -1 && errno == EINTR) continue;
122 if (got <= 0) return next - US buffer;
130 /*************************************************
131 * Make a new address item *
132 *************************************************/
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
140 address the RFC822 address string
141 copy force a copy of the address
143 Returns: a pointer to an initialized address_item
147 deliver_make_addr(uschar *address, BOOL copy)
149 address_item *addr = store_get(sizeof(address_item), FALSE);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
160 /*************************************************
161 * Set expansion values for an address *
162 *************************************************/
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
169 addr the address in question, or NULL to clear values
174 deliver_set_expansions(address_item *addr)
178 const uschar ***p = address_expansions;
179 while (*p) **p++ = NULL;
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
187 if (!addr->host_list)
189 deliver_host = deliver_host_address = US"";
190 deliver_host_port = 0;
194 deliver_host = addr->host_list->name;
195 deliver_host_address = addr->host_list->address;
196 deliver_host_port = addr->host_list->port;
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
205 /* These may be unset for multiple addresses */
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1; /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
217 /* If there's only one address we can set everything. */
221 address_item *addr_orig;
223 deliver_localpart = addr->local_part;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
261 if (testflag(addr, af_pfr))
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
293 if (testflag(addr, af_pfr))
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
324 Called from deliver_message(), can be operating as root.
327 filename the file name
328 mode the mode required
329 error used for saying what failed
331 Returns: a file descriptor, or -1 (with errno set)
335 open_msglog_file(uschar *filename, int mode, uschar **error)
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
341 for (int i = 2; i > 0; i--)
343 int fd = Uopen(filename,
350 O_WRONLY|O_APPEND|O_CREAT, mode);
353 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
354 function is called as root). Double check the mode, because the group setting
355 doesn't always get set automatically. */
358 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
360 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
365 if (fchmod(fd, mode) < 0)
375 (void)directory_make(spool_directory,
376 spool_sname(US"msglog", message_subdir),
377 MSGLOG_DIRECTORY_MODE, TRUE);
380 *error = US"create or open";
387 /*************************************************
388 * Write to msglog if required *
389 *************************************************/
391 /* Write to the message log, if configured. This function may also be called
395 format a string format
401 deliver_msglog(const char *format, ...)
404 if (!message_logs) return;
405 va_start(ap, format);
406 vfprintf(message_log, format, ap);
414 /*************************************************
415 * Replicate status for batch *
416 *************************************************/
418 /* When a transport handles a batch of addresses, it may treat them
419 individually, or it may just put the status in the first one, and return FALSE,
420 requesting that the status be copied to all the others externally. This is the
421 replication function. As well as the status, it copies the transport pointer,
422 which may have changed if appendfile passed the addresses on to a different
425 Argument: pointer to the first address in a chain
430 replicate_status(address_item *addr)
432 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
434 addr2->transport = addr->transport;
435 addr2->transport_return = addr->transport_return;
436 addr2->basic_errno = addr->basic_errno;
437 addr2->more_errno = addr->more_errno;
438 addr2->delivery_time = addr->delivery_time;
439 addr2->special_action = addr->special_action;
440 addr2->message = addr->message;
441 addr2->user_message = addr->user_message;
447 /*************************************************
448 * Compare lists of hosts *
449 *************************************************/
451 /* This function is given two pointers to chains of host items, and it yields
452 TRUE if the lists refer to the same hosts in the same order, except that
454 (1) Multiple hosts with the same non-negative MX values are permitted to appear
455 in different orders. Round-robinning nameservers can cause this to happen.
457 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
458 permitted to appear in different orders. This is caused by randomizing
461 This enables Exim to use a single SMTP transaction for sending to two entirely
462 different domains that happen to end up pointing at the same hosts.
464 We do not try to batch up different A-record host names that refer to the
468 one points to the first host list
469 two points to the second host list
471 Returns: TRUE if the lists refer to the same host set
475 same_hosts(host_item *one, host_item *two)
479 if (Ustrcmp(one->name, two->name) != 0)
482 host_item *end_one = one;
483 host_item *end_two = two;
485 /* Batch up only if there was no MX and the list was not randomized */
487 if (mx == MX_NONE) return FALSE;
489 /* Find the ends of the shortest sequence of identical MX values */
491 while ( end_one->next && end_one->next->mx == mx
492 && end_two->next && end_two->next->mx == mx)
494 end_one = end_one->next;
495 end_two = end_two->next;
498 /* If there aren't any duplicates, there's no match. */
500 if (end_one == one) return FALSE;
502 /* For each host in the 'one' sequence, check that it appears in the 'two'
503 sequence, returning FALSE if not. */
508 for (hi = two; hi != end_two->next; hi = hi->next)
509 if (Ustrcmp(one->name, hi->name) == 0) break;
510 if (hi == end_two->next) return FALSE;
511 if (one == end_one) break;
515 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
516 Ensure both are pointing at the last host, and carry on as for equality. */
521 /* if the names matched but ports do not, mismatch */
522 else if (one->port != two->port)
526 /* DNSSEC equality */
527 if (one->dnssec != two->dnssec) return FALSE;
535 /* True if both are NULL */
542 /*************************************************
543 * Compare header lines *
544 *************************************************/
546 /* This function is given two pointers to chains of header items, and it yields
547 TRUE if they are the same header texts in the same order.
550 one points to the first header list
551 two points to the second header list
553 Returns: TRUE if the lists refer to the same header set
557 same_headers(header_line *one, header_line *two)
559 for (;; one = one->next, two = two->next)
561 if (one == two) return TRUE; /* Includes the case where both NULL */
562 if (!one || !two) return FALSE;
563 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
569 /*************************************************
570 * Compare string settings *
571 *************************************************/
573 /* This function is given two pointers to strings, and it returns
574 TRUE if they are the same pointer, or if the two strings are the same.
577 one points to the first string
578 two points to the second string
580 Returns: TRUE or FALSE
584 same_strings(uschar *one, uschar *two)
586 if (one == two) return TRUE; /* Includes the case where both NULL */
587 if (!one || !two) return FALSE;
588 return (Ustrcmp(one, two) == 0);
593 /*************************************************
594 * Compare uid/gid for addresses *
595 *************************************************/
597 /* This function is given a transport and two addresses. It yields TRUE if the
598 uid/gid/initgroups settings for the two addresses are going to be the same when
603 addr1 the first address
604 addr2 the second address
606 Returns: TRUE or FALSE
610 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
612 if ( !tp->uid_set && !tp->expand_uid
613 && !tp->deliver_as_creator
614 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
615 || ( testflag(addr1, af_uid_set)
616 && ( addr1->uid != addr2->uid
617 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
621 if ( !tp->gid_set && !tp->expand_gid
622 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
623 || ( testflag(addr1, af_gid_set)
624 && addr1->gid != addr2->gid
634 /*************************************************
635 * Record that an address is complete *
636 *************************************************/
638 /* This function records that an address is complete. This is straightforward
639 for most addresses, where the unique address is just the full address with the
640 domain lower cased. For homonyms (addresses that are the same as one of their
641 ancestors) their are complications. Their unique addresses have \x\ prepended
642 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
645 Exim used to record the unique addresses of homonyms as "complete". This,
646 however, fails when the pattern of redirection varies over time (e.g. if taking
647 unseen copies at only some times of day) because the prepended numbers may vary
648 from one delivery run to the next. This problem is solved by never recording
649 prepended unique addresses as complete. Instead, when a homonymic address has
650 actually been delivered via a transport, we record its basic unique address
651 followed by the name of the transport. This is checked in subsequent delivery
652 runs whenever an address is routed to a transport.
654 If the completed address is a top-level one (has no parent, which means it
655 cannot be homonymic) we also add the original address to the non-recipients
656 tree, so that it gets recorded in the spool file and therefore appears as
657 "done" in any spool listings. The original address may differ from the unique
658 address in the case of the domain.
660 Finally, this function scans the list of duplicates, marks as done any that
661 match this address, and calls child_done() for their ancestors.
664 addr address item that has been completed
665 now current time as a string
671 address_done(address_item *addr, uschar *now)
673 update_spool = TRUE; /* Ensure spool gets updated */
675 /* Top-level address */
679 tree_add_nonrecipient(addr->unique);
680 tree_add_nonrecipient(addr->address);
683 /* Homonymous child address */
685 else if (testflag(addr, af_homonym))
688 tree_add_nonrecipient(
689 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
692 /* Non-homonymous child address */
694 else tree_add_nonrecipient(addr->unique);
696 /* Check the list of duplicate addresses and ensure they are now marked
699 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
700 if (Ustrcmp(addr->unique, dup->unique) == 0)
702 tree_add_nonrecipient(dup->unique);
703 child_done(dup, now);
710 /*************************************************
711 * Decrease counts in parents and mark done *
712 *************************************************/
714 /* This function is called when an address is complete. If there is a parent
715 address, its count of children is decremented. If there are still other
716 children outstanding, the function exits. Otherwise, if the count has become
717 zero, address_done() is called to mark the parent and its duplicates complete.
718 Then loop for any earlier ancestors.
721 addr points to the completed address item
722 now the current time as a string, for writing to the message log
728 child_done(address_item *addr, uschar *now)
735 if (--addr->child_count > 0) return; /* Incomplete parent */
736 address_done(addr, now);
738 /* Log the completion of all descendents only when there is no ancestor with
739 the same original address. */
741 for (aa = addr->parent; aa; aa = aa->parent)
742 if (Ustrcmp(aa->address, addr->address) == 0) break;
745 deliver_msglog("%s %s: children all complete\n", now, addr->address);
746 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
752 /*************************************************
753 * Delivery logging support functions *
754 *************************************************/
756 /* The LOGGING() checks in d_log_interface() are complicated for backwards
757 compatibility. When outgoing interface logging was originally added, it was
758 conditional on just incoming_interface (which is off by default). The
759 outgoing_interface option is on by default to preserve this behaviour, but
760 you can enable incoming_interface and disable outgoing_interface to get I=
761 fields on incoming lines only.
765 addr The address to be logged
767 Returns: New value for s
771 d_log_interface(gstring * g)
773 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
774 && sending_ip_address)
776 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
777 if (LOGGING(outgoing_port))
778 g = string_fmt_append(g, ":%d", sending_port);
786 d_hostlog(gstring * g, address_item * addr)
788 host_item * h = addr->host_used;
790 g = string_append(g, 2, US" H=", h->name);
792 if (LOGGING(dnssec) && h->dnssec == DS_YES)
793 g = string_catn(g, US" DS", 3);
795 g = string_append(g, 3, US" [", h->address, US"]");
797 if (LOGGING(outgoing_port))
798 g = string_fmt_append(g, ":%d", h->port);
800 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
801 g = string_catn(g, US"*", 1);
804 if (LOGGING(proxy) && proxy_local_address)
806 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
807 if (LOGGING(outgoing_port))
808 g = string_fmt_append(g, ":%d", proxy_local_port);
812 g = d_log_interface(g);
814 if (testflag(addr, af_tcp_fastopen))
815 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
826 d_tlslog(gstring * g, address_item * addr)
828 if (LOGGING(tls_cipher) && addr->cipher)
830 g = string_append(g, 2, US" X=", addr->cipher);
831 #ifndef DISABLE_TLS_RESUME
832 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
833 g = string_catn(g, US"*", 1);
836 if (LOGGING(tls_certificate_verified) && addr->cipher)
837 g = string_append(g, 2, US" CV=",
838 testflag(addr, af_cert_verified)
841 testflag(addr, af_dane_verified)
847 if (LOGGING(tls_peerdn) && addr->peerdn)
848 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
856 #ifndef DISABLE_EVENT
858 event_raise(uschar * action, const uschar * event, uschar * ev_data)
864 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
866 action, deliver_host_address);
869 event_data = ev_data;
871 if (!(s = expand_string(action)) && *expand_string_message)
872 log_write(0, LOG_MAIN|LOG_PANIC,
873 "failed to expand event_action %s in %s: %s\n",
874 event, transport_name ? transport_name : US"main", expand_string_message);
876 event_name = event_data = NULL;
878 /* If the expansion returns anything but an empty string, flag for
879 the caller to modify his normal processing
884 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
893 msg_event_raise(const uschar * event, const address_item * addr)
895 const uschar * save_domain = deliver_domain;
896 uschar * save_local = deliver_localpart;
897 const uschar * save_host = deliver_host;
898 const uschar * save_address = deliver_host_address;
899 const int save_port = deliver_host_port;
901 router_name = addr->router ? addr->router->name : NULL;
902 deliver_domain = addr->domain;
903 deliver_localpart = addr->local_part;
904 deliver_host = addr->host_used ? addr->host_used->name : NULL;
906 if (!addr->transport)
908 if (Ustrcmp(event, "msg:fail:delivery") == 0)
910 /* An address failed with no transport involved. This happens when
911 a filter was used which triggered a fail command (in such a case
912 a transport isn't needed). Convert it to an internal fail event. */
914 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
919 transport_name = addr->transport->name;
921 (void) event_raise(addr->transport->event_action, event,
923 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
924 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
925 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
926 ? addr->message : NULL);
929 deliver_host_port = save_port;
930 deliver_host_address = save_address;
931 deliver_host = save_host;
932 deliver_localpart = save_local;
933 deliver_domain = save_domain;
934 router_name = transport_name = NULL;
936 #endif /*DISABLE_EVENT*/
940 /******************************************************************************/
943 /*************************************************
944 * Generate local prt for logging *
945 *************************************************/
947 /* This function is a subroutine for use in string_log_address() below.
950 addr the address being logged
951 yield the current dynamic buffer pointer
953 Returns: the new value of the buffer pointer
957 string_get_localpart(address_item * addr, gstring * yield)
962 if (testflag(addr, af_include_affixes) && s)
965 if (testflag(addr, af_utf8_downcvt))
966 s = string_localpart_utf8_to_alabel(s, NULL);
968 yield = string_cat(yield, s);
971 s = addr->local_part;
973 if (testflag(addr, af_utf8_downcvt))
974 s = string_localpart_utf8_to_alabel(s, NULL);
976 yield = string_cat(yield, s);
979 if (testflag(addr, af_include_affixes) && s)
982 if (testflag(addr, af_utf8_downcvt))
983 s = string_localpart_utf8_to_alabel(s, NULL);
985 yield = string_cat(yield, s);
992 /*************************************************
993 * Generate log address list *
994 *************************************************/
996 /* This function generates a list consisting of an address and its parents, for
997 use in logging lines. For saved onetime aliased addresses, the onetime parent
998 field is used. If the address was delivered by a transport with rcpt_include_
999 affixes set, the af_include_affixes bit will be set in the address. In that
1000 case, we include the affixes here too.
1003 g points to growing-string struct
1004 addr bottom (ultimate) address
1005 all_parents if TRUE, include all parents
1006 success TRUE for successful delivery
1008 Returns: a growable string in dynamic store
1012 string_log_address(gstring * g,
1013 address_item *addr, BOOL all_parents, BOOL success)
1015 BOOL add_topaddr = TRUE;
1016 address_item *topaddr;
1018 /* Find the ultimate parent */
1020 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1022 /* We start with just the local part for pipe, file, and reply deliveries, and
1023 for successful local deliveries from routers that have the log_as_local flag
1024 set. File deliveries from filters can be specified as non-absolute paths in
1025 cases where the transport is going to complete the path. If there is an error
1026 before this happens (expansion failure) the local part will not be updated, and
1027 so won't necessarily look like a path. Add extra text for this case. */
1029 if ( testflag(addr, af_pfr)
1031 && addr->router && addr->router->log_as_local
1032 && addr->transport && addr->transport->info->local
1035 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1036 g = string_catn(g, CUS"save ", 5);
1037 g = string_get_localpart(addr, g);
1040 /* Other deliveries start with the full address. It we have split it into local
1041 part and domain, use those fields. Some early failures can happen before the
1042 splitting is done; in those cases use the original field. */
1047 int off = g->ptr; /* start of the "full address" */
1049 if (addr->local_part)
1052 g = string_get_localpart(addr, g);
1053 g = string_catn(g, US"@", 1);
1056 if (testflag(addr, af_utf8_downcvt))
1057 s = string_localpart_utf8_to_alabel(s, NULL);
1059 g = string_cat(g, s);
1062 g = string_cat(g, addr->address);
1064 /* If the address we are going to print is the same as the top address,
1065 and all parents are not being included, don't add on the top address. First
1066 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1067 on the local parts. */
1069 cmp = g->s + off; /* only now, as rebuffer likely done */
1070 string_from_gstring(g); /* ensure nul-terminated */
1071 if ( strcmpic(cmp, topaddr->address) == 0
1072 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1073 && !addr->onetime_parent
1074 && (!all_parents || !addr->parent || addr->parent == topaddr)
1076 add_topaddr = FALSE;
1079 /* If all parents are requested, or this is a local pipe/file/reply, and
1080 there is at least one intermediate parent, show it in brackets, and continue
1081 with all of them if all are wanted. */
1083 if ( (all_parents || testflag(addr, af_pfr))
1085 && addr->parent != topaddr)
1088 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1090 g = string_catn(g, s, 2);
1091 g = string_cat (g, addr2->address);
1092 if (!all_parents) break;
1095 g = string_catn(g, US")", 1);
1098 /* Add the top address if it is required */
1101 g = string_append(g, 3,
1103 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1111 /******************************************************************************/
1115 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1116 this is a nonstandard call; no two-character delivery flag is written
1117 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1120 flags passed to log_write()
1123 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1125 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1128 /* Log the delivery on the main log. We use an extensible string to build up
1129 the log line, and reset the store afterwards. Remote deliveries should always
1130 have a pointer to the host item that succeeded; local deliveries can have a
1131 pointer to a single host item in their host list, for use by the transport. */
1133 #ifndef DISABLE_EVENT
1134 /* presume no successful remote delivery */
1135 lookup_dnssec_authenticated = NULL;
1138 reset_point = store_mark();
1139 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1142 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1145 g->s[0] = logchar; g->ptr = 1;
1146 g = string_catn(g, US"> ", 2);
1148 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1150 if (LOGGING(sender_on_delivery) || msg)
1151 g = string_append(g, 3, US" F=<",
1153 testflag(addr, af_utf8_downcvt)
1154 ? string_address_utf8_to_alabel(sender_address, NULL)
1161 g = string_append(g, 2, US" Q=", queue_name);
1163 #ifdef EXPERIMENTAL_SRS_ALT
1164 if(addr->prop.srs_sender)
1165 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1168 /* You might think that the return path must always be set for a successful
1169 delivery; indeed, I did for some time, until this statement crashed. The case
1170 when it is not set is for a delivery to /dev/null which is optimised by not
1171 being run at all. */
1173 if (used_return_path && LOGGING(return_path_on_delivery))
1174 g = string_append(g, 3, US" P=<", used_return_path, US">");
1177 g = string_append(g, 2, US" ", msg);
1179 /* For a delivery from a system filter, there may not be a router */
1181 g = string_append(g, 2, US" R=", addr->router->name);
1183 g = string_append(g, 2, US" T=", addr->transport->name);
1185 if (LOGGING(delivery_size))
1186 g = string_fmt_append(g, " S=%d", transport_count);
1188 /* Local delivery */
1190 if (addr->transport->info->local)
1192 if (addr->host_list)
1193 g = string_append(g, 2, US" H=", addr->host_list->name);
1194 g = d_log_interface(g);
1195 if (addr->shadow_message)
1196 g = string_cat(g, addr->shadow_message);
1199 /* Remote delivery */
1203 if (addr->host_used)
1205 g = d_hostlog(g, addr);
1207 #ifndef DISABLE_EVENT
1208 deliver_host_address = addr->host_used->address;
1209 deliver_host_port = addr->host_used->port;
1210 deliver_host = addr->host_used->name;
1212 /* DNS lookup status */
1213 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1214 : addr->host_used->dnssec==DS_NO ? US"no"
1220 g = d_tlslog(g, addr);
1223 if (addr->authenticator)
1225 g = string_append(g, 2, US" A=", addr->authenticator);
1228 g = string_append(g, 2, US":", addr->auth_id);
1229 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1230 g = string_append(g, 2, US":", addr->auth_sndr);
1234 if (LOGGING(pipelining))
1236 if (testflag(addr, af_pipelining))
1237 g = string_catn(g, US" L", 2);
1238 #ifndef DISABLE_PIPE_CONNECT
1239 if (testflag(addr, af_early_pipe))
1240 g = string_catn(g, US"*", 1);
1244 #ifndef DISABLE_PRDR
1245 if (testflag(addr, af_prdr_used))
1246 g = string_catn(g, US" PRDR", 5);
1249 if (testflag(addr, af_chunking_used))
1250 g = string_catn(g, US" K", 2);
1253 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1255 if ( LOGGING(smtp_confirmation)
1257 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1260 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1261 uschar *p = big_buffer;
1262 uschar *ss = addr->message;
1264 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1266 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1271 g = string_append(g, 2, US" C=", big_buffer);
1274 /* Time on queue and actual time taken to deliver */
1276 if (LOGGING(queue_time))
1277 g = string_append(g, 2, US" QT=", string_timesince(
1278 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1280 if (LOGGING(deliver_time))
1281 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1283 /* string_cat() always leaves room for the terminator. Release the
1284 store we used to build the line after writing it. */
1286 log_write(0, flags, "%s", string_from_gstring(g));
1288 #ifndef DISABLE_EVENT
1289 if (!msg) msg_event_raise(US"msg:delivery", addr);
1292 store_reset(reset_point);
1299 deferral_log(address_item * addr, uschar * now,
1300 int logflags, uschar * driver_name, uschar * driver_kind)
1302 rmark reset_point = store_mark();
1303 gstring * g = string_get(256);
1305 /* Build up the line that is used for both the message log and the main
1308 /* Create the address string for logging. Must not do this earlier, because
1309 an OK result may be changed to FAIL when a pipe returns text. */
1311 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1314 g = string_append(g, 2, US" Q=", queue_name);
1316 /* Either driver_name contains something and driver_kind contains
1317 " router" or " transport" (note the leading space), or driver_name is
1318 a null string and driver_kind contains "routing" without the leading
1319 space, if all routing has been deferred. When a domain has been held,
1320 so nothing has been done at all, both variables contain null strings. */
1324 if (driver_kind[1] == 't' && addr->router)
1325 g = string_append(g, 2, US" R=", addr->router->name);
1326 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1328 else if (driver_kind)
1329 g = string_append(g, 2, US" ", driver_kind);
1331 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1333 if (addr->basic_errno > 0)
1334 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1336 if (addr->host_used)
1337 g = d_hostlog(g, addr);
1339 if (LOGGING(deliver_time))
1340 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1343 g = string_append(g, 2, US": ", addr->message);
1345 (void) string_from_gstring(g);
1347 /* Log the deferment in the message log, but don't clutter it
1348 up with retry-time defers after the first delivery attempt. */
1350 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1351 deliver_msglog("%s %s\n", now, g->s);
1353 /* Write the main log and reset the store.
1354 For errors of the type "retry time not reached" (also remotes skipped
1355 on queue run), logging is controlled by L_retry_defer. Note that this kind
1356 of error number is negative, and all the retry ones are less than any
1360 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1363 store_reset(reset_point);
1370 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1372 rmark reset_point = store_mark();
1373 gstring * g = string_get(256);
1375 #ifndef DISABLE_EVENT
1376 /* Message failures for which we will send a DSN get their event raised
1377 later so avoid doing it here. */
1379 if ( !addr->prop.ignore_error
1380 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1382 msg_event_raise(US"msg:fail:delivery", addr);
1385 /* Build up the log line for the message and main logs */
1387 /* Create the address string for logging. Must not do this earlier, because
1388 an OK result may be changed to FAIL when a pipe returns text. */
1390 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1392 if (LOGGING(sender_on_delivery))
1393 g = string_append(g, 3, US" F=<", sender_address, US">");
1396 g = string_append(g, 2, US" Q=", queue_name);
1398 /* Return path may not be set if no delivery actually happened */
1400 if (used_return_path && LOGGING(return_path_on_delivery))
1401 g = string_append(g, 3, US" P=<", used_return_path, US">");
1404 g = string_append(g, 2, US" R=", addr->router->name);
1405 if (addr->transport)
1406 g = string_append(g, 2, US" T=", addr->transport->name);
1408 if (addr->host_used)
1409 g = d_hostlog(g, addr);
1412 g = d_tlslog(g, addr);
1415 if (addr->basic_errno > 0)
1416 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1419 g = string_append(g, 2, US": ", addr->message);
1421 if (LOGGING(deliver_time))
1422 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1424 (void) string_from_gstring(g);
1426 /* Do the logging. For the message log, "routing failed" for those cases,
1427 just to make it clearer. */
1430 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1432 deliver_msglog("%s %s\n", now, g->s);
1434 log_write(0, LOG_MAIN, "** %s", g->s);
1436 store_reset(reset_point);
1442 /*************************************************
1443 * Actions at the end of handling an address *
1444 *************************************************/
1446 /* This is a function for processing a single address when all that can be done
1447 with it has been done.
1450 addr points to the address block
1451 result the result of the delivery attempt
1452 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1453 driver_type indicates which type of driver (transport, or router) was last
1454 to process the address
1455 logchar '=' or '-' for use when logging deliveries with => or ->
1461 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1464 uschar *now = tod_stamp(tod_log);
1465 uschar *driver_kind = NULL;
1466 uschar *driver_name = NULL;
1468 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1470 /* Set up driver kind and name for logging. Disable logging if the router or
1471 transport has disabled it. */
1473 if (driver_type == EXIM_DTYPE_TRANSPORT)
1475 if (addr->transport)
1477 driver_name = addr->transport->name;
1478 driver_kind = US" transport";
1479 f.disable_logging = addr->transport->disable_logging;
1481 else driver_kind = US"transporting";
1483 else if (driver_type == EXIM_DTYPE_ROUTER)
1487 driver_name = addr->router->name;
1488 driver_kind = US" router";
1489 f.disable_logging = addr->router->disable_logging;
1491 else driver_kind = US"routing";
1494 /* If there's an error message set, ensure that it contains only printing
1495 characters - it should, but occasionally things slip in and this at least
1496 stops the log format from getting wrecked. We also scan the message for an LDAP
1497 expansion item that has a password setting, and flatten the password. This is a
1498 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1499 malformed, it won't ever have gone near LDAP.) */
1503 const uschar * s = string_printing(addr->message);
1505 /* deconst cast ok as string_printing known to have alloc'n'copied */
1506 addr->message = expand_hide_passwords(US s);
1509 /* If we used a transport that has one of the "return_output" options set, and
1510 if it did in fact generate some output, then for return_output we treat the
1511 message as failed if it was not already set that way, so that the output gets
1512 returned to the sender, provided there is a sender to send it to. For
1513 return_fail_output, do this only if the delivery failed. Otherwise we just
1514 unlink the file, and remove the name so that if the delivery failed, we don't
1515 try to send back an empty or unwanted file. The log_output options operate only
1516 on a non-empty file.
1518 In any case, we close the message file, because we cannot afford to leave a
1519 file-descriptor for one address while processing (maybe very many) others. */
1521 if (addr->return_file >= 0 && addr->return_filename)
1523 BOOL return_output = FALSE;
1524 struct stat statbuf;
1525 (void)EXIMfsync(addr->return_file);
1527 /* If there is no output, do nothing. */
1529 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1531 transport_instance *tb = addr->transport;
1533 /* Handle logging options */
1536 || result == FAIL && tb->log_fail_output
1537 || result == DEFER && tb->log_defer_output
1541 FILE *f = Ufopen(addr->return_filename, "rb");
1543 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1544 "from %s transport: %s", addr->return_filename, tb->name,
1547 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1549 uschar *p = big_buffer + Ustrlen(big_buffer);
1551 while (p > big_buffer && isspace(p[-1])) p--;
1553 sp = string_printing(big_buffer);
1554 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1555 addr->address, tb->name, sp);
1560 /* Handle returning options, but only if there is an address to return
1563 if (sender_address[0] != 0 || addr->prop.errors_address)
1564 if (tb->return_output)
1566 addr->transport_return = result = FAIL;
1567 if (addr->basic_errno == 0 && !addr->message)
1568 addr->message = US"return message generated";
1569 return_output = TRUE;
1572 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1575 /* Get rid of the file unless it might be returned, but close it in
1580 Uunlink(addr->return_filename);
1581 addr->return_filename = NULL;
1582 addr->return_file = -1;
1585 (void)close(addr->return_file);
1588 /* Check if the transport notifed continue-conn status explicitly, and
1589 update our knowlege. */
1591 if (testflag(addr, af_new_conn)) continue_sequence = 1;
1592 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1594 /* The success case happens only after delivery by a transport. */
1598 addr->next = addr_succeed;
1599 addr_succeed = addr;
1601 /* Call address_done() to ensure that we don't deliver to this address again,
1602 and write appropriate things to the message log. If it is a child address, we
1603 call child_done() to scan the ancestors and mark them complete if this is the
1604 last child to complete. */
1606 address_done(addr, now);
1607 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1610 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1611 driver_name, driver_kind);
1614 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1615 addr->parent->address, driver_name, driver_kind);
1616 child_done(addr, now);
1619 /* Certificates for logging (via events) */
1621 tls_out.ourcert = addr->ourcert;
1622 addr->ourcert = NULL;
1623 tls_out.peercert = addr->peercert;
1624 addr->peercert = NULL;
1626 tls_out.ver = addr->tlsver;
1627 tls_out.cipher = addr->cipher;
1628 tls_out.peerdn = addr->peerdn;
1629 tls_out.ocsp = addr->ocsp;
1630 # ifdef SUPPORT_DANE
1631 tls_out.dane_verified = testflag(addr, af_dane_verified);
1635 delivery_log(LOG_MAIN, addr, logchar, NULL);
1638 tls_free_cert(&tls_out.ourcert);
1639 tls_free_cert(&tls_out.peercert);
1641 tls_out.cipher = NULL;
1642 tls_out.peerdn = NULL;
1643 tls_out.ocsp = OCSP_NOT_REQ;
1644 # ifdef SUPPORT_DANE
1645 tls_out.dane_verified = FALSE;
1651 /* Soft failure, or local delivery process failed; freezing may be
1654 else if (result == DEFER || result == PANIC)
1656 if (result == PANIC) logflags |= LOG_PANIC;
1658 /* This puts them on the chain in reverse order. Do not change this, because
1659 the code for handling retries assumes that the one with the retry
1660 information is last. */
1662 addr->next = addr_defer;
1665 /* The only currently implemented special action is to freeze the
1666 message. Logging of this is done later, just before the -H file is
1669 if (addr->special_action == SPECIAL_FREEZE)
1671 f.deliver_freeze = TRUE;
1672 deliver_frozen_at = time(NULL);
1673 update_spool = TRUE;
1676 /* If doing a 2-stage queue run, we skip writing to either the message
1677 log or the main log for SMTP defers. */
1679 if (!f.queue_2stage || addr->basic_errno != 0)
1680 deferral_log(addr, now, logflags, driver_name, driver_kind);
1684 /* Hard failure. If there is an address to which an error message can be sent,
1685 put this address on the failed list. If not, put it on the deferred list and
1686 freeze the mail message for human attention. The latter action can also be
1687 explicitly requested by a router or transport. */
1691 /* If this is a delivery error, or a message for which no replies are
1692 wanted, and the message's age is greater than ignore_bounce_errors_after,
1693 force the af_ignore_error flag. This will cause the address to be discarded
1694 later (with a log entry). */
1696 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1697 addr->prop.ignore_error = TRUE;
1699 /* Freeze the message if requested, or if this is a bounce message (or other
1700 message with null sender) and this address does not have its own errors
1701 address. However, don't freeze if errors are being ignored. The actual code
1702 to ignore occurs later, instead of sending a message. Logging of freezing
1703 occurs later, just before writing the -H file. */
1705 if ( !addr->prop.ignore_error
1706 && ( addr->special_action == SPECIAL_FREEZE
1707 || (sender_address[0] == 0 && !addr->prop.errors_address)
1710 frozen_info = addr->special_action == SPECIAL_FREEZE
1712 : f.sender_local && !f.local_error_message
1713 ? US" (message created with -f <>)"
1714 : US" (delivery error message)";
1715 f.deliver_freeze = TRUE;
1716 deliver_frozen_at = time(NULL);
1717 update_spool = TRUE;
1719 /* The address is put on the defer rather than the failed queue, because
1720 the message is being retained. */
1722 addr->next = addr_defer;
1726 /* Don't put the address on the nonrecipients tree yet; wait until an
1727 error message has been successfully sent. */
1731 addr->next = addr_failed;
1735 failure_log(addr, driver_name ? NULL : driver_kind, now);
1738 /* Ensure logging is turned on again in all cases */
1740 f.disable_logging = FALSE;
1746 /*************************************************
1747 * Address-independent error *
1748 *************************************************/
1750 /* This function is called when there's an error that is not dependent on a
1751 particular address, such as an expansion string failure. It puts the error into
1752 all the addresses in a batch, logs the incident on the main and panic logs, and
1753 clears the expansions. It is mostly called from local_deliver(), but can be
1754 called for a remote delivery via findugid().
1757 logit TRUE if (MAIN+PANIC) logging required
1758 addr the first of the chain of addresses
1760 format format string for error message, or NULL if already set in addr
1761 ... arguments for the format
1767 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1769 addr->basic_errno = code;
1776 va_start(ap, format);
1777 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1779 addr->message = string_from_gstring(g);
1782 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1784 addr2->basic_errno = code;
1785 addr2->message = addr->message;
1788 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1789 deliver_set_expansions(NULL);
1795 /*************************************************
1796 * Check a "never users" list *
1797 *************************************************/
1799 /* This function is called to check whether a uid is on one of the two "never
1803 uid the uid to be checked
1804 nusers the list to be scanned; the first item in the list is the count
1806 Returns: TRUE if the uid is on the list
1810 check_never_users(uid_t uid, uid_t *nusers)
1812 if (!nusers) return FALSE;
1813 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1819 /*************************************************
1820 * Find uid and gid for a transport *
1821 *************************************************/
1823 /* This function is called for both local and remote deliveries, to find the
1824 uid/gid under which to run the delivery. The values are taken preferentially
1825 from the transport (either explicit or deliver_as_creator), then from the
1826 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1827 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1828 panic error is logged, and the function fails (which normally leads to delivery
1832 addr the address (possibly a chain)
1834 uidp pointer to uid field
1835 gidp pointer to gid field
1836 igfp pointer to the use_initgroups field
1838 Returns: FALSE if failed - error has been set in address(es)
1842 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1846 BOOL gid_set = FALSE;
1848 /* Default initgroups flag comes from the transport */
1850 *igfp = tp->initgroups;
1852 /* First see if there's a gid on the transport, either fixed or expandable.
1853 The expanding function always logs failure itself. */
1860 else if (tp->expand_gid)
1862 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1865 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1871 /* If the transport did not set a group, see if the router did. */
1873 if (!gid_set && testflag(addr, af_gid_set))
1879 /* Pick up a uid from the transport if one is set. */
1881 if (tp->uid_set) *uidp = tp->uid;
1883 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1884 it does not provide a passwd value from which a gid can be taken. */
1886 else if (tp->expand_uid)
1889 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1890 uidp, &(addr->message)))
1892 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1902 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1904 else if (tp->deliver_as_creator)
1906 *uidp = originator_uid;
1909 *gidp = originator_gid;
1914 /* Otherwise see if the address specifies the uid and if so, take it and its
1917 else if (testflag(addr, af_uid_set))
1920 *igfp = testflag(addr, af_initgroups);
1923 /* Nothing has specified the uid - default to the Exim user, and group if the
1936 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1937 defaulting to the Exim uid. In other words, if the configuration has specified
1938 a uid, it must also provide a gid. */
1942 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1943 "%s transport", tp->name);
1947 /* Check that the uid is not on the lists of banned uids that may not be used
1948 for delivery processes. */
1950 nuname = check_never_users(*uidp, never_users)
1952 : check_never_users(*uidp, fixed_never_users)
1953 ? US"fixed_never_users"
1957 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1958 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1970 /*************************************************
1971 * Check the size of a message for a transport *
1972 *************************************************/
1974 /* Checks that the message isn't too big for the selected transport.
1975 This is called only when it is known that the limit is set.
1979 addr the (first) address being delivered
1982 DEFER expansion failed or did not yield an integer
1983 FAIL message too big
1987 check_message_size(transport_instance *tp, address_item *addr)
1992 deliver_set_expansions(addr);
1993 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1994 deliver_set_expansions(NULL);
1996 if (expand_string_message)
1999 addr->message = size_limit == -1
2000 ? string_sprintf("failed to expand message_size_limit "
2001 "in %s transport: %s", tp->name, expand_string_message)
2002 : string_sprintf("invalid message_size_limit "
2003 "in %s transport: %s", tp->name, expand_string_message);
2005 else if (size_limit > 0 && message_size > size_limit)
2009 string_sprintf("message is too big (transport limit = %d)",
2018 /*************************************************
2019 * Transport-time check for a previous delivery *
2020 *************************************************/
2022 /* Check that this base address hasn't previously been delivered to its routed
2023 transport. If it has been delivered, mark it done. The check is necessary at
2024 delivery time in order to handle homonymic addresses correctly in cases where
2025 the pattern of redirection changes between delivery attempts (so the unique
2026 fields change). Non-homonymic previous delivery is detected earlier, at routing
2027 time (which saves unnecessary routing).
2030 addr the address item
2031 testing TRUE if testing wanted only, without side effects
2033 Returns: TRUE if previously delivered by the transport
2037 previously_transported(address_item *addr, BOOL testing)
2039 uschar * s = string_sprintf("%s/%s",
2040 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2042 if (tree_search(tree_nonrecipients, s) != 0)
2044 DEBUG(D_deliver|D_route|D_transport)
2045 debug_printf("%s was previously delivered (%s transport): discarded\n",
2046 addr->address, addr->transport->name);
2047 if (!testing) child_done(addr, tod_stamp(tod_log));
2056 /******************************************************
2057 * Check for a given header in a header string *
2058 ******************************************************/
2060 /* This function is used when generating quota warnings. The configuration may
2061 specify any header lines it likes in quota_warn_message. If certain of them are
2062 missing, defaults are inserted, so we need to be able to test for the presence
2066 hdr the required header name
2067 hstring the header string
2069 Returns: TRUE the header is in the string
2070 FALSE the header is not in the string
2074 contains_header(uschar *hdr, uschar *hstring)
2076 int len = Ustrlen(hdr);
2077 uschar *p = hstring;
2080 if (strncmpic(p, hdr, len) == 0)
2083 while (*p == ' ' || *p == '\t') p++;
2084 if (*p == ':') return TRUE;
2086 while (*p != 0 && *p != '\n') p++;
2087 if (*p == '\n') p++;
2095 /*************************************************
2096 * Perform a local delivery *
2097 *************************************************/
2099 /* Each local delivery is performed in a separate process which sets its
2100 uid and gid as specified. This is a safer way than simply changing and
2101 restoring using seteuid(); there is a body of opinion that seteuid()
2102 cannot be used safely. From release 4, Exim no longer makes any use of
2103 it for delivery. Besides, not all systems have seteuid().
2105 If the uid/gid are specified in the transport_instance, they are used; the
2106 transport initialization must ensure that either both or neither are set.
2107 Otherwise, the values associated with the address are used. If neither are set,
2108 it is a configuration error.
2110 The transport or the address may specify a home directory (transport over-
2111 rides), and if they do, this is set as $home. If neither have set a working
2112 directory, this value is used for that as well. Otherwise $home is left unset
2113 and the cwd is set to "/" - a directory that should be accessible to all users.
2115 Using a separate process makes it more complicated to get error information
2116 back. We use a pipe to pass the return code and also an error code and error
2117 text string back to the parent process.
2120 addr points to an address block for this delivery; for "normal" local
2121 deliveries this is the only address to be delivered, but for
2122 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2123 a number of addresses can be handled simultaneously, and in this
2124 case addr will point to a chain of addresses with the same
2127 shadowing TRUE if running a shadow transport; this causes output from pipes
2134 deliver_local(address_item *addr, BOOL shadowing)
2136 BOOL use_initgroups;
2139 int status, len, rc;
2142 uschar *working_directory;
2143 address_item *addr2;
2144 transport_instance *tp = addr->transport;
2146 /* Set up the return path from the errors or sender address. If the transport
2147 has its own return path setting, expand it and replace the existing value. */
2149 if(addr->prop.errors_address)
2150 return_path = addr->prop.errors_address;
2151 #ifdef EXPERIMENTAL_SRS_ALT
2152 else if (addr->prop.srs_sender)
2153 return_path = addr->prop.srs_sender;
2156 return_path = sender_address;
2158 if (tp->return_path)
2160 uschar * new_return_path = expand_string(tp->return_path);
2161 if (new_return_path)
2162 return_path = new_return_path;
2163 else if (!f.expand_string_forcedfail)
2165 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2166 US"Failed to expand return path \"%s\" in %s transport: %s",
2167 tp->return_path, tp->name, expand_string_message);
2172 /* For local deliveries, one at a time, the value used for logging can just be
2173 set directly, once and for all. */
2175 used_return_path = return_path;
2177 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2178 gets put into the address(es), and the expansions are unset, so we can just
2181 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2183 /* See if either the transport or the address specifies a home directory. A
2184 home directory set in the address may already be expanded; a flag is set to
2185 indicate that. In other cases we must expand it. */
2187 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2188 || ( (deliver_home = addr->home_dir) /* Set in address and */
2189 && !testflag(addr, af_home_expanded) /* not expanded */
2192 uschar *rawhome = deliver_home;
2193 deliver_home = NULL; /* in case it contains $home */
2194 if (!(deliver_home = expand_string(rawhome)))
2196 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2197 "to expand for %s transport: %s", rawhome, tp->name,
2198 expand_string_message);
2201 if (*deliver_home != '/')
2203 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2204 "is not absolute for %s transport", deliver_home, tp->name);
2209 /* See if either the transport or the address specifies a current directory,
2210 and if so, expand it. If nothing is set, use the home directory, unless it is
2211 also unset in which case use "/", which is assumed to be a directory to which
2212 all users have access. It is necessary to be in a visible directory for some
2213 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2214 2.5) require this. */
2216 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2217 if (working_directory)
2219 uschar *raw = working_directory;
2220 if (!(working_directory = expand_string(raw)))
2222 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2223 "failed to expand for %s transport: %s", raw, tp->name,
2224 expand_string_message);
2227 if (*working_directory != '/')
2229 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2230 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2234 else working_directory = deliver_home ? deliver_home : US"/";
2236 /* If one of the return_output flags is set on the transport, create and open a
2237 file in the message log directory for the transport to write its output onto.
2238 This is mainly used by pipe transports. The file needs to be unique to the
2239 address. This feature is not available for shadow transports. */
2242 && ( tp->return_output || tp->return_fail_output
2243 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2248 addr->return_filename =
2249 spool_fname(US"msglog", message_subdir, message_id,
2250 string_sprintf("-%d-%d", getpid(), return_count++));
2252 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2254 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2255 "to return message: %s", error, tp->name, strerror(errno));
2260 /* Create the pipe for inter-process communication. */
2264 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2269 /* Now fork the process to do the real work in the subprocess, but first
2270 ensure that all cached resources are freed so that the subprocess starts with
2271 a clean slate and doesn't interfere with the parent process. */
2275 if ((pid = exim_fork(US"delivery-local")) == 0)
2277 BOOL replicate = TRUE;
2279 /* Prevent core dumps, as we don't want them in users' home directories.
2280 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2281 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2282 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2283 complain if the error is "not supported".
2285 There are two scenarios where changing the max limit has an effect. In one,
2286 the user is using a .forward and invoking a command of their choice via pipe;
2287 for these, we do need the max limit to be 0 unless the admin chooses to
2288 permit an increased limit. In the other, the command is invoked directly by
2289 the transport and is under administrator control, thus being able to raise
2290 the limit aids in debugging. So there's no general always-right answer.
2292 Thus we inhibit core-dumps completely but let individual transports, while
2293 still root, re-raise the limits back up to aid debugging. We make the
2294 default be no core-dumps -- few enough people can use core dumps in
2295 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2302 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2304 # ifdef SETRLIMIT_NOT_SUPPORTED
2305 if (errno != ENOSYS && errno != ENOTSUP)
2307 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2312 /* Reset the random number generator, so different processes don't all
2313 have the same sequence. */
2317 /* If the transport has a setup entry, call this first, while still
2318 privileged. (Appendfile uses this to expand quota, for example, while
2319 able to read private files.) */
2321 if (addr->transport->setup)
2322 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2326 addr->transport_return = DEFER;
2330 addr->transport_return = PANIC;
2334 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2335 when the process becomes unprivileged, it won't be able to write to the
2336 process log. SIGHUP is ignored throughout exim, except when it is being
2339 signal(SIGINT, SIG_IGN);
2340 signal(SIGTERM, SIG_IGN);
2341 signal(SIGUSR1, SIG_IGN);
2343 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2344 half - for transports that exec things (e.g. pipe). Then set the required
2347 (void)close(pfd[pipe_read]);
2348 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2350 exim_setugid(uid, gid, use_initgroups,
2351 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2352 addr->address, addr->transport->name));
2356 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2357 for (address_item * batched = addr->next; batched; batched = batched->next)
2358 debug_printf("additional batched address: %s\n", batched->address);
2361 /* Set an appropriate working directory. */
2363 if (Uchdir(working_directory) < 0)
2365 addr->transport_return = DEFER;
2366 addr->basic_errno = errno;
2367 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2370 /* If successful, call the transport */
2375 set_process_info("delivering %s to %s using %s", message_id,
2376 addr->local_part, addr->transport->name);
2378 /* Setting this global in the subprocess means we need never clear it */
2379 transport_name = addr->transport->name;
2381 /* If a transport filter has been specified, set up its argument list.
2382 Any errors will get put into the address, and FALSE yielded. */
2384 if (addr->transport->filter_command)
2386 ok = transport_set_up_command(&transport_filter_argv,
2387 addr->transport->filter_command,
2388 TRUE, PANIC, addr, US"transport filter", NULL);
2389 transport_filter_timeout = addr->transport->filter_timeout;
2391 else transport_filter_argv = NULL;
2395 debug_print_string(addr->transport->debug_string);
2396 replicate = !(addr->transport->info->code)(addr->transport, addr);
2400 /* Pass the results back down the pipe. If necessary, first replicate the
2401 status in the top address to the others in the batch. The label is the
2402 subject of a goto when a call to the transport's setup function fails. We
2403 pass the pointer to the transport back in case it got changed as a result of
2404 file_format in appendfile. */
2408 if (replicate) replicate_status(addr);
2409 for (addr2 = addr; addr2; addr2 = addr2->next)
2412 int local_part_length = Ustrlen(addr2->local_part);
2416 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2417 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2418 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2419 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2420 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2421 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2422 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2423 || (ret = write(pfd[pipe_write], &addr2->transport,
2424 sizeof(transport_instance *))) != sizeof(transport_instance *)
2426 /* For a file delivery, pass back the local part, in case the original
2427 was only part of the final delivery path. This gives more complete
2430 || (testflag(addr2, af_file)
2431 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2432 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2436 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2437 ret == -1 ? strerror(errno) : "short write");
2439 /* Now any messages */
2441 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2443 int message_length = s ? Ustrlen(s) + 1 : 0;
2444 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2445 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2447 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2448 ret == -1 ? strerror(errno) : "short write");
2452 /* OK, this process is now done. Free any cached resources that it opened,
2453 and close the pipe we were writing down before exiting. */
2455 (void)close(pfd[pipe_write]);
2460 /* Back in the main process: panic if the fork did not succeed. This seems
2461 better than returning an error - if forking is failing it is probably best
2462 not to try other deliveries for this message. */
2465 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2468 /* Read the pipe to get the delivery status codes and error messages. Our copy
2469 of the writing end must be closed first, as otherwise read() won't return zero
2470 on an empty pipe. We check that a status exists for each address before
2471 overwriting the address structure. If data is missing, the default DEFER status
2472 will remain. Afterwards, close the reading end. */
2474 (void)close(pfd[pipe_write]);
2476 for (addr2 = addr; addr2; addr2 = addr2->next)
2478 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2483 addr2->transport_return = status;
2484 len = read(pfd[pipe_read], &transport_count,
2485 sizeof(transport_count));
2486 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2487 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2488 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2489 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2490 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2491 len = read(pfd[pipe_read], &addr2->transport,
2492 sizeof(transport_instance *));
2494 if (testflag(addr2, af_file))
2497 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2498 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2501 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2502 " from delivery subprocess");
2505 /* sanity-checked llen so disable the Coverity error */
2506 /* coverity[tainted_data] */
2507 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2509 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2510 " from delivery subprocess");
2513 big_buffer[llen] = 0;
2514 addr2->local_part = string_copy(big_buffer);
2517 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2520 len = read(pfd[pipe_read], &message_length, sizeof(int));
2521 if (message_length > 0)
2523 len = read(pfd[pipe_read], big_buffer, message_length);
2524 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2525 if (len > 0) *sptr = string_copy(big_buffer);
2532 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2533 "from delivery subprocess", addr2->unique);
2538 (void)close(pfd[pipe_read]);
2540 /* Unless shadowing, write all successful addresses immediately to the journal
2541 file, to ensure they are recorded asap. For homonymic addresses, use the base
2542 address plus the transport name. Failure to write the journal is panic-worthy,
2543 but don't stop, as it may prove possible subsequently to update the spool file
2544 in order to record the delivery. */
2548 for (addr2 = addr; addr2; addr2 = addr2->next)
2549 if (addr2->transport_return == OK)
2551 if (testflag(addr2, af_homonym))
2552 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2554 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2556 /* In the test harness, wait just a bit to let the subprocess finish off
2557 any debug output etc first. */
2559 testharness_pause_ms(300);
2561 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2562 len = Ustrlen(big_buffer);
2563 if (write(journal_fd, big_buffer, len) != len)
2564 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2565 big_buffer, strerror(errno));
2568 /* Ensure the journal file is pushed out to disk. */
2570 if (EXIMfsync(journal_fd) < 0)
2571 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2575 /* Wait for the process to finish. If it terminates with a non-zero code,
2576 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2577 status values of all the addresses as they are. Take care to handle the case
2578 when the subprocess doesn't seem to exist. This has been seen on one system
2579 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2580 happens, wait() doesn't recognize the termination of child processes. Exim now
2581 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2583 while ((rc = wait(&status)) != pid)
2584 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2586 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2587 addr->transport->driver_name);
2592 if ((status & 0xffff) != 0)
2594 int msb = (status >> 8) & 255;
2595 int lsb = status & 255;
2596 int code = (msb == 0)? (lsb & 0x7f) : msb;
2597 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2598 addr->special_action = SPECIAL_FREEZE;
2599 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2600 "status 0x%04x: %s %d",
2601 addr->transport->driver_name,
2603 msb == 0 ? "terminated by signal" : "exit code",
2607 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2609 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2612 uschar *warn_message;
2615 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2617 if (!(warn_message = expand_string(addr->transport->warn_message)))
2618 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2619 "message for %s transport): %s", addr->transport->warn_message,
2620 addr->transport->name, expand_string_message);
2622 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2624 FILE *f = fdopen(fd, "wb");
2625 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2626 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2627 fprintf(f, "Auto-Submitted: auto-replied\n");
2628 if (!contains_header(US"From", warn_message))
2630 fprintf(f, "%s", CS warn_message);
2632 /* Close and wait for child process to complete, without a timeout. */
2635 (void)child_close(pid, 0);
2638 addr->special_action = SPECIAL_NONE;
2645 /* Check transport for the given concurrency limit. Return TRUE if over
2646 the limit (or an expansion failure), else FALSE and if there was a limit,
2647 the key for the hints database used for the concurrency count. */
2650 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2652 unsigned max_parallel;
2654 if (!tp->max_parallel) return FALSE;
2656 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2657 if (expand_string_message)
2659 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2660 "in %s transport (%s): %s", tp->name, addr->address,
2661 expand_string_message);
2665 if (max_parallel > 0)
2667 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2668 if (!enq_start(serialize_key, max_parallel))
2670 address_item * next;
2672 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2673 tp->name, max_parallel);
2677 addr->message = US"concurrency limit reached for transport";
2678 addr->basic_errno = ERRNO_TRETRY;
2679 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2680 } while ((addr = next));
2683 *key = serialize_key;
2690 /*************************************************
2691 * Do local deliveries *
2692 *************************************************/
2694 /* This function processes the list of addresses in addr_local. True local
2695 deliveries are always done one address at a time. However, local deliveries can
2696 be batched up in some cases. Typically this is when writing batched SMTP output
2697 files for use by some external transport mechanism, or when running local
2698 deliveries over LMTP.
2705 do_local_deliveries(void)
2708 open_db *dbm_file = NULL;
2709 time_t now = time(NULL);
2711 /* Loop until we have exhausted the supply of local deliveries */
2715 struct timeval delivery_start;
2716 struct timeval deliver_time;
2717 address_item *addr2, *addr3, *nextaddr;
2718 int logflags = LOG_MAIN;
2719 int logchar = f.dont_deliver? '*' : '=';
2720 transport_instance *tp;
2721 uschar * serialize_key = NULL;
2723 /* Pick the first undelivered address off the chain */
2725 address_item *addr = addr_local;
2726 addr_local = addr->next;
2729 DEBUG(D_deliver|D_transport)
2730 debug_printf("--------> %s <--------\n", addr->address);
2732 /* An internal disaster if there is no transport. Should not occur! */
2734 if (!(tp = addr->transport))
2736 logflags |= LOG_PANIC;
2737 f.disable_logging = FALSE; /* Jic */
2738 addr->message = addr->router
2739 ? string_sprintf("No transport set by %s router", addr->router->name)
2740 : US"No transport set by system filter";
2741 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2745 /* Check that this base address hasn't previously been delivered to this
2746 transport. The check is necessary at this point to handle homonymic addresses
2747 correctly in cases where the pattern of redirection changes between delivery
2748 attempts. Non-homonymic previous delivery is detected earlier, at routing
2751 if (previously_transported(addr, FALSE)) continue;
2753 /* There are weird cases where logging is disabled */
2755 f.disable_logging = tp->disable_logging;
2757 /* Check for batched addresses and possible amalgamation. Skip all the work
2758 if either batch_max <= 1 or there aren't any other addresses for local
2761 if (tp->batch_max > 1 && addr_local)
2763 int batch_count = 1;
2764 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2765 BOOL uses_lp = ( testflag(addr, af_pfr)
2766 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2768 || readconf_depends((driver_instance *)tp, US"local_part");
2769 uschar *batch_id = NULL;
2770 address_item **anchor = &addr_local;
2771 address_item *last = addr;
2774 /* Expand the batch_id string for comparison with other addresses.
2775 Expansion failure suppresses batching. */
2779 deliver_set_expansions(addr);
2780 batch_id = expand_string(tp->batch_id);
2781 deliver_set_expansions(NULL);
2784 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2785 "in %s transport (%s): %s", tp->name, addr->address,
2786 expand_string_message);
2787 batch_count = tp->batch_max;
2791 /* Until we reach the batch_max limit, pick off addresses which have the
2792 same characteristics. These are:
2795 not previously delivered (see comment about 50 lines above)
2796 same local part if the transport's configuration contains $local_part
2797 or if this is a file or pipe delivery from a redirection
2798 same domain if the transport's configuration contains $domain
2800 same additional headers
2801 same headers to be removed
2802 same uid/gid for running the transport
2803 same first host if a host list is set
2806 while ((next = *anchor) && batch_count < tp->batch_max)
2809 tp == next->transport
2810 && !previously_transported(next, TRUE)
2811 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2812 && testflag(addr, af_file) == testflag(next, af_file)
2813 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2814 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2815 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2816 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2817 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2818 && same_ugid(tp, addr, next)
2819 && ( !addr->host_list && !next->host_list
2822 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2825 /* If the transport has a batch_id setting, batch_id will be non-NULL
2826 from the expansion outside the loop. Expand for this address and compare.
2827 Expansion failure makes this address ineligible for batching. */
2832 address_item *save_nextnext = next->next;
2833 next->next = NULL; /* Expansion for a single address */
2834 deliver_set_expansions(next);
2835 next->next = save_nextnext;
2836 bid = expand_string(tp->batch_id);
2837 deliver_set_expansions(NULL);
2840 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2841 "in %s transport (%s): %s", tp->name, next->address,
2842 expand_string_message);
2845 else ok = (Ustrcmp(batch_id, bid) == 0);
2848 /* Take address into batch if OK. */
2852 *anchor = next->next; /* Include the address */
2858 else anchor = &next->next; /* Skip the address */
2862 /* We now have one or more addresses that can be delivered in a batch. Check
2863 whether the transport is prepared to accept a message of this size. If not,
2864 fail them all forthwith. If the expansion fails, or does not yield an
2865 integer, defer delivery. */
2867 if (tp->message_size_limit)
2869 int rc = check_message_size(tp, addr);
2872 replicate_status(addr);
2876 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2879 continue; /* With next batch of addresses */
2883 /* If we are not running the queue, or if forcing, all deliveries will be
2884 attempted. Otherwise, we must respect the retry times for each address. Even
2885 when not doing this, we need to set up the retry key string, and determine
2886 whether a retry record exists, because after a successful delivery, a delete
2887 retry item must be set up. Keep the retry database open only for the duration
2888 of these checks, rather than for all local deliveries, because some local
2889 deliveries (e.g. to pipes) can take a substantial time. */
2891 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2892 DEBUG(D_deliver|D_retry|D_hints_lookup)
2893 debug_printf("no retry data available\n");
2899 BOOL ok = TRUE; /* to deliver this address */
2902 /* Set up the retry key to include the domain or not, and change its
2903 leading character from "R" to "T". Must make a copy before doing this,
2904 because the old key may be pointed to from a "delete" retry item after
2907 retry_key = string_copy(
2908 tp->retry_use_local_part ? addr2->address_retry_key :
2909 addr2->domain_retry_key);
2912 /* Inspect the retry data. If there is no hints file, delivery happens. */
2916 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2918 /* If there is no retry record, delivery happens. If there is,
2919 remember it exists so it can be deleted after a successful delivery. */
2923 setflag(addr2, af_lt_retry_exists);
2925 /* A retry record exists for this address. If queue running and not
2926 forcing, inspect its contents. If the record is too old, or if its
2927 retry time has come, or if it has passed its cutoff time, delivery
2932 debug_printf("retry record exists: age=%s ",
2933 readconf_printtime(now - retry_record->time_stamp));
2934 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2935 debug_printf(" time to retry = %s expired = %d\n",
2936 readconf_printtime(retry_record->next_try - now),
2937 retry_record->expired);
2940 if (f.queue_running && !f.deliver_force)
2942 ok = (now - retry_record->time_stamp > retry_data_expire)
2943 || (now >= retry_record->next_try)
2944 || retry_record->expired;
2946 /* If we haven't reached the retry time, there is one more check
2947 to do, which is for the ultimate address timeout. */
2950 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2954 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2957 /* This address is to be delivered. Leave it on the chain. */
2962 addr2 = addr2->next;
2965 /* This address is to be deferred. Take it out of the chain, and
2966 post-process it as complete. Must take it out of the chain first,
2967 because post processing puts it on another chain. */
2971 address_item *this = addr2;
2972 this->message = US"Retry time not yet reached";
2973 this->basic_errno = ERRNO_LRETRY;
2974 addr2 = addr3 ? (addr3->next = addr2->next)
2975 : (addr = addr2->next);
2976 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2980 if (dbm_file) dbfn_close(dbm_file);
2982 /* If there are no addresses left on the chain, they all deferred. Loop
2983 for the next set of addresses. */
2985 if (!addr) continue;
2987 /* If the transport is limited for parallellism, enforce that here.
2988 We use a hints DB entry, incremented here and decremented after
2989 the transport (and any shadow transport) completes. */
2991 if (tpt_parallel_check(tp, addr, &serialize_key))
2993 if (expand_string_message)
2995 logflags |= LOG_PANIC;
2999 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3000 } while ((addr = addr2));
3002 continue; /* Loop for the next set of addresses. */
3006 /* So, finally, we do have some addresses that can be passed to the
3007 transport. Before doing so, set up variables that are relevant to a
3010 deliver_set_expansions(addr);
3012 gettimeofday(&delivery_start, NULL);
3013 deliver_local(addr, FALSE);
3014 timesince(&deliver_time, &delivery_start);
3016 /* If a shadow transport (which must perforce be another local transport), is
3017 defined, and its condition is met, we must pass the message to the shadow
3018 too, but only those addresses that succeeded. We do this by making a new
3019 chain of addresses - also to keep the original chain uncontaminated. We must
3020 use a chain rather than doing it one by one, because the shadow transport may
3023 NOTE: if the condition fails because of a lookup defer, there is nothing we
3027 && ( !tp->shadow_condition
3028 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3031 transport_instance *stp;
3032 address_item *shadow_addr = NULL;
3033 address_item **last = &shadow_addr;
3035 for (stp = transports; stp; stp = stp->next)
3036 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3039 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3042 /* Pick off the addresses that have succeeded, and make clones. Put into
3043 the shadow_message field a pointer to the shadow_message field of the real
3046 else for (addr2 = addr; addr2; addr2 = addr2->next)
3047 if (addr2->transport_return == OK)
3049 addr3 = store_get(sizeof(address_item), FALSE);
3052 addr3->shadow_message = US &addr2->shadow_message;
3053 addr3->transport = stp;
3054 addr3->transport_return = DEFER;
3055 addr3->return_filename = NULL;
3056 addr3->return_file = -1;
3058 last = &addr3->next;
3061 /* If we found any addresses to shadow, run the delivery, and stick any
3062 message back into the shadow_message field in the original. */
3066 int save_count = transport_count;
3068 DEBUG(D_deliver|D_transport)
3069 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3070 deliver_local(shadow_addr, TRUE);
3072 for(; shadow_addr; shadow_addr = shadow_addr->next)
3074 int sresult = shadow_addr->transport_return;
3075 *(uschar **)shadow_addr->shadow_message =
3077 ? string_sprintf(" ST=%s", stp->name)
3078 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3079 shadow_addr->basic_errno <= 0
3081 : US strerror(shadow_addr->basic_errno),
3082 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3085 shadow_addr->message
3086 ? shadow_addr->message
3087 : shadow_addr->basic_errno <= 0
3091 DEBUG(D_deliver|D_transport)
3092 debug_printf("%s shadow transport returned %s for %s\n",
3093 stp->name, rc_to_string(sresult), shadow_addr->address);
3096 DEBUG(D_deliver|D_transport)
3097 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3099 transport_count = save_count; /* Restore original transport count */
3103 /* Cancel the expansions that were set up for the delivery. */
3105 deliver_set_expansions(NULL);
3107 /* If the transport was parallelism-limited, decrement the hints DB record. */
3109 if (serialize_key) enq_end(serialize_key);
3111 /* Now we can process the results of the real transport. We must take each
3112 address off the chain first, because post_process_one() puts it on another
3115 for (addr2 = addr; addr2; addr2 = nextaddr)
3117 int result = addr2->transport_return;
3118 nextaddr = addr2->next;
3120 DEBUG(D_deliver|D_transport)
3121 debug_printf("%s transport returned %s for %s\n",
3122 tp->name, rc_to_string(result), addr2->address);
3124 /* If there is a retry_record, or if delivery is deferred, build a retry
3125 item for setting a new retry time or deleting the old retry record from
3126 the database. These items are handled all together after all addresses
3127 have been handled (so the database is open just for a short time for
3130 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3132 int flags = result == DEFER ? 0 : rf_delete;
3133 uschar *retry_key = string_copy(tp->retry_use_local_part
3134 ? addr2->address_retry_key : addr2->domain_retry_key);
3136 retry_add_item(addr2, retry_key, flags);
3139 /* Done with this address */
3141 addr2->delivery_time = deliver_time;
3142 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3144 /* If a pipe delivery generated text to be sent back, the result may be
3145 changed to FAIL, and we must copy this for subsequent addresses in the
3148 if (addr2->transport_return != result)
3150 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3152 addr3->transport_return = addr2->transport_return;
3153 addr3->basic_errno = addr2->basic_errno;
3154 addr3->message = addr2->message;
3156 result = addr2->transport_return;
3159 /* Whether or not the result was changed to FAIL, we need to copy the
3160 return_file value from the first address into all the addresses of the
3161 batch, so they are all listed in the error message. */
3163 addr2->return_file = addr->return_file;
3165 /* Change log character for recording successful deliveries. */
3167 if (result == OK) logchar = '-';
3169 } /* Loop back for next batch of addresses */
3175 /*************************************************
3176 * Sort remote deliveries *
3177 *************************************************/
3179 /* This function is called if remote_sort_domains is set. It arranges that the
3180 chain of addresses for remote deliveries is ordered according to the strings
3181 specified. Try to make this shuffling reasonably efficient by handling
3182 sequences of addresses rather than just single ones.
3189 sort_remote_deliveries(void)
3192 address_item **aptr = &addr_remote;
3193 const uschar *listptr = remote_sort_domains;
3197 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3199 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3202 address_item *moved = NULL;
3203 address_item **bptr = &moved;
3207 address_item **next;
3208 deliver_domain = (*aptr)->domain; /* set $domain */
3209 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3210 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3212 aptr = &(*aptr)->next;
3216 next = &(*aptr)->next;
3218 && (deliver_domain = (*next)->domain, /* Set $domain */
3219 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3220 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3222 next = &(*next)->next;
3224 /* If the batch of non-matchers is at the end, add on any that were
3225 extracted further up the chain, and end this iteration. Otherwise,
3226 extract them from the chain and hang on the moved chain. */
3238 aptr = &(*aptr)->next;
3241 /* If the loop ended because the final address matched, *aptr will
3242 be NULL. Add on to the end any extracted non-matching addresses. If
3243 *aptr is not NULL, the loop ended via "break" when *next is null, that
3244 is, there was a string of non-matching addresses at the end. In this
3245 case the extracted addresses have already been added on the end. */
3247 if (!*aptr) *aptr = moved;
3252 debug_printf("remote addresses after sorting:\n");
3253 for (address_item * addr = addr_remote; addr; addr = addr->next)
3254 debug_printf(" %s\n", addr->address);
3260 /*************************************************
3261 * Read from pipe for remote delivery subprocess *
3262 *************************************************/
3264 /* This function is called when the subprocess is complete, but can also be
3265 called before it is complete, in order to empty a pipe that is full (to prevent
3266 deadlock). It must therefore keep track of its progress in the parlist data
3269 We read the pipe to get the delivery status codes and a possible error message
3270 for each address, optionally preceded by unusability data for the hosts and
3271 also by optional retry data.
3273 Read in large chunks into the big buffer and then scan through, interpreting
3274 the data therein. In most cases, only a single read will be necessary. No
3275 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3276 that we read the next chunk when there is less than 2500 bytes left in the
3277 non-final chunk, we can assume each item is complete in the buffer before
3278 handling it. Each item is written using a single write(), which is atomic for
3279 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3280 often bigger) so even if we are reading while the subprocess is still going, we
3281 should never have only a partial item in the buffer.
3283 hs12: This assumption is not true anymore, since we get quite large items (certificate
3284 information and such).
3287 poffset the offset of the parlist item
3288 eop TRUE if the process has completed
3290 Returns: TRUE if the terminating 'Z' item has been read,
3291 or there has been a disaster (i.e. no more data needed);
3296 par_read_pipe(int poffset, BOOL eop)
3299 pardata *p = parlist + poffset;
3300 address_item *addrlist = p->addrlist;
3301 address_item *addr = p->addr;
3305 uschar *msg = p->msg;
3306 BOOL done = p->done;
3308 /* Loop through all items, reading from the pipe when necessary. The pipe
3309 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3310 here, as the preceding poll() tells us, if data is available for reading.
3312 A read() on a "selected" handle should never block, but(!) it may return
3313 less data then we expected. (The buffer size we pass to read() shouldn't be
3314 understood as a "request", but as a "limit".)
3316 Each separate item is written to the pipe in a timely manner. But, especially for
3317 larger items, the read(2) may already return partial data from the write(2).
3319 The write is atomic mostly (depending on the amount written), but atomic does
3320 not imply "all or noting", it just is "not intermixed" with other writes on the
3321 same channel (pipe).
3325 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3326 (int)p->pid, eop? "ended" : "not ended yet");
3330 retry_item *r, **rp;
3331 uschar pipeheader[PIPE_HEADER_SIZE+1];
3332 uschar *id = &pipeheader[0];
3333 uschar *subid = &pipeheader[1];
3334 uschar *ptr = big_buffer;
3335 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3338 DEBUG(D_deliver) debug_printf(
3339 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3341 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3342 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3343 If we get less, we can assume the subprocess do be done and do not expect any further
3344 information from it. */
3346 if ((got = readn(fd, pipeheader, required)) != required)
3348 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3349 "from transport process %d for transport %s",
3350 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3355 pipeheader[PIPE_HEADER_SIZE] = '\0';
3357 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3361 /* If we can't decode the pipeheader, the subprocess seems to have a
3362 problem, we do not expect any furher information from it. */
3364 required = Ustrtol(pipeheader+2, &endc, 10);
3367 msg = string_sprintf("failed to read pipe "
3368 "from transport process %d for transport %s: error decoding size from header",
3369 pid, addr->transport->driver_name);
3376 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3377 (u_long)required, pid);
3379 /* Same as above, the transport process will write the bytes announced
3380 in a timely manner, so we can just wait for the bytes, getting less than expected
3381 is considered a problem of the subprocess, we do not expect anything else from it. */
3382 if ((got = readn(fd, big_buffer, required)) != required)
3384 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3385 " bytes (pipedata) from transport process %d for transport %s",
3386 got, required, pid, addr->transport->driver_name);
3391 /* Handle each possible type of item, assuming the complete item is
3392 available in store. */
3396 /* Host items exist only if any hosts were marked unusable. Match
3397 up by checking the IP address. */
3400 for (h = addrlist->host_list; h; h = h->next)
3402 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3410 /* Retry items are sent in a preceding R item for each address. This is
3411 kept separate to keep each message short enough to guarantee it won't
3412 be split in the pipe. Hopefully, in the majority of cases, there won't in
3413 fact be any retry items at all.
3415 The complete set of retry items might include an item to delete a
3416 routing retry if there was a previous routing delay. However, routing
3417 retries are also used when a remote transport identifies an address error.
3418 In that case, there may also be an "add" item for the same key. Arrange
3419 that a "delete" item is dropped in favour of an "add" item. */
3422 if (!addr) goto ADDR_MISMATCH;
3424 DEBUG(D_deliver|D_retry)
3425 debug_printf("reading retry information for %s from subprocess\n",
3428 /* Cut out any "delete" items on the list. */
3430 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3431 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3433 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3434 *rp = r->next; /* Excise a delete item */
3435 DEBUG(D_deliver|D_retry)
3436 debug_printf(" existing delete item dropped\n");
3439 /* We want to add a delete item only if there is no non-delete item;
3440 however we still have to step ptr through the data. */
3442 if (!r || !(*ptr & rf_delete))
3444 r = store_get(sizeof(retry_item), FALSE);
3445 r->next = addr->retries;
3448 r->key = string_copy(ptr);
3450 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3451 ptr += sizeof(r->basic_errno);
3452 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3453 ptr += sizeof(r->more_errno);
3454 r->message = *ptr ? string_copy(ptr) : NULL;
3455 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3456 r->flags & rf_delete ? "delete" : "retry");
3461 DEBUG(D_deliver|D_retry)
3462 debug_printf(" delete item not added: non-delete item exists\n");
3465 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3471 /* Put the amount of data written into the parlist block */
3474 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3475 ptr += sizeof(transport_count);
3478 /* Address items are in the order of items on the address chain. We
3479 remember the current address value in case this function is called
3480 several times to empty the pipe in stages. Information about delivery
3481 over TLS is sent in a preceding X item for each address. We don't put
3482 it in with the other info, in order to keep each message short enough to
3483 guarantee it won't be split in the pipe. */
3487 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3491 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3495 addr->cipher = string_copy(ptr);
3496 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3500 addr->peerdn = string_copy(ptr);
3505 (void) tls_import_cert(ptr, &addr->peercert);
3507 addr->peercert = NULL;
3512 (void) tls_import_cert(ptr, &addr->ourcert);
3514 addr->ourcert = NULL;
3517 # ifndef DISABLE_OCSP
3519 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3525 #endif /*DISABLE_TLS*/
3527 case 'C': /* client authenticator information */
3530 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3531 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3532 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3537 #ifndef DISABLE_PRDR
3539 setflag(addr, af_prdr_used);
3546 #ifndef DISABLE_PIPE_CONNECT
3547 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3549 case 1: setflag(addr, af_pipelining); break;
3554 setflag(addr, af_chunking_used);
3558 setflag(addr, af_tcp_fastopen_conn);
3559 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3560 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3564 if (!addr) goto ADDR_MISMATCH;
3565 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3566 ptr += sizeof(addr->dsn_aware);
3567 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3574 msg = string_sprintf("address count mismatch for data read from pipe "
3575 "for transport process %d for transport %s", pid,
3576 addrlist->transport->driver_name);
3583 case 3: /* explicit notification of continued-connection (non)use;
3584 overrides caller's knowlege. */
3585 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3586 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3589 #ifdef SUPPORT_SOCKS
3590 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3591 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3596 proxy_local_address = string_copy(ptr);
3598 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3599 ptr += sizeof(proxy_local_port);
3604 #ifdef EXPERIMENTAL_DSN_INFO
3605 case '1': /* must arrive before A0, and applies to that addr */
3606 /* Two strings: smtp_greeting and helo_response */
3607 addr->smtp_greeting = string_copy(ptr);
3609 addr->helo_response = string_copy(ptr);
3615 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3616 addr->transport_return = *ptr++;
3617 addr->special_action = *ptr++;
3618 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3619 ptr += sizeof(addr->basic_errno);
3620 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3621 ptr += sizeof(addr->more_errno);
3622 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3623 ptr += sizeof(addr->delivery_time);
3624 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3625 ptr += sizeof(addr->flags);
3626 addr->message = *ptr ? string_copy(ptr) : NULL;
3628 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3631 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3635 h = store_get(sizeof(host_item), FALSE);
3636 h->name = string_copy(ptr);
3638 h->address = string_copy(ptr);
3640 memcpy(&h->port, ptr, sizeof(h->port));
3641 ptr += sizeof(h->port);
3642 h->dnssec = *ptr == '2' ? DS_YES
3643 : *ptr == '1' ? DS_NO
3646 addr->host_used = h;
3650 /* Finished with this address */
3657 /* Local interface address/port */
3659 if (*ptr) sending_ip_address = string_copy(ptr);
3661 if (*ptr) sending_port = atoi(CS ptr);
3665 /* Z marks the logical end of the data. It is followed by '0' if
3666 continue_transport was NULL at the end of transporting, otherwise '1'.
3667 We need to know when it becomes NULL during a delivery down a passed SMTP
3668 channel so that we don't try to pass anything more down it. Of course, for
3669 most normal messages it will remain NULL all the time. */
3674 continue_transport = NULL;
3675 continue_hostname = NULL;
3678 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3681 /* Anything else is a disaster. */
3684 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3685 "process %d for transport %s", ptr[-1], pid,
3686 addr->transport->driver_name);
3692 /* The done flag is inspected externally, to determine whether or not to
3693 call the function again when the process finishes. */
3697 /* If the process hadn't finished, and we haven't seen the end of the data
3698 or if we suffered a disaster, update the rest of the state, and return FALSE to
3699 indicate "not finished". */
3708 /* Close our end of the pipe, to prevent deadlock if the far end is still
3709 pushing stuff into it. */
3714 /* If we have finished without error, but haven't had data for every address,
3715 something is wrong. */
3718 msg = string_sprintf("insufficient address data read from pipe "
3719 "for transport process %d for transport %s", pid,
3720 addr->transport->driver_name);
3722 /* If an error message is set, something has gone wrong in getting back
3723 the delivery data. Put the message into each address and freeze it. */
3726 for (addr = addrlist; addr; addr = addr->next)
3728 addr->transport_return = DEFER;
3729 addr->special_action = SPECIAL_FREEZE;
3730 addr->message = msg;
3731 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3734 /* Return TRUE to indicate we have got all we need from this process, even
3735 if it hasn't actually finished yet. */
3742 /*************************************************
3743 * Post-process a set of remote addresses *
3744 *************************************************/
3746 /* Do what has to be done immediately after a remote delivery for each set of
3747 addresses, then re-write the spool if necessary. Note that post_process_one
3748 puts the address on an appropriate queue; hence we must fish off the next
3749 one first. This function is also called if there is a problem with setting
3750 up a subprocess to do a remote delivery in parallel. In this case, the final
3751 argument contains a message, and the action must be forced to DEFER.
3754 addr pointer to chain of address items
3755 logflags flags for logging
3756 msg NULL for normal cases; -> error message for unexpected problems
3757 fallback TRUE if processing fallback hosts
3763 remote_post_process(address_item *addr, int logflags, uschar *msg,
3766 /* If any host addresses were found to be unusable, add them to the unusable
3767 tree so that subsequent deliveries don't try them. */
3769 for (host_item * h = addr->host_list; h; h = h->next)
3771 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3773 /* Now handle each address on the chain. The transport has placed '=' or '-'
3774 into the special_action field for each successful delivery. */
3778 address_item *next = addr->next;
3780 /* If msg == NULL (normal processing) and the result is DEFER and we are
3781 processing the main hosts and there are fallback hosts available, put the
3782 address on the list for fallback delivery. */
3784 if ( addr->transport_return == DEFER
3785 && addr->fallback_hosts
3790 addr->host_list = addr->fallback_hosts;
3791 addr->next = addr_fallback;
3792 addr_fallback = addr;
3793 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3796 /* If msg is set (=> unexpected problem), set it in the address before
3797 doing the ordinary post processing. */
3803 addr->message = msg;
3804 addr->transport_return = DEFER;
3806 (void)post_process_one(addr, addr->transport_return, logflags,
3807 EXIM_DTYPE_TRANSPORT, addr->special_action);
3815 /* If we have just delivered down a passed SMTP channel, and that was
3816 the last address, the channel will have been closed down. Now that
3817 we have logged that delivery, set continue_sequence to 1 so that
3818 any subsequent deliveries don't get "*" incorrectly logged. */
3820 if (!continue_transport) continue_sequence = 1;
3825 /*************************************************
3826 * Wait for one remote delivery subprocess *
3827 *************************************************/
3829 /* This function is called while doing remote deliveries when either the
3830 maximum number of processes exist and we need one to complete so that another
3831 can be created, or when waiting for the last ones to complete. It must wait for
3832 the completion of one subprocess, empty the control block slot, and return a
3833 pointer to the address chain.
3836 Returns: pointer to the chain of addresses handled by the process;
3837 NULL if no subprocess found - this is an unexpected error
3840 static address_item *
3843 int poffset, status;
3844 address_item * addr, * addrlist;
3847 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3848 "to finish", message_id);
3850 /* Loop until either a subprocess completes, or there are no subprocesses in
3851 existence - in which case give an error return. We cannot proceed just by
3852 waiting for a completion, because a subprocess may have filled up its pipe, and
3853 be waiting for it to be emptied. Therefore, if no processes have finished, we
3854 wait for one of the pipes to acquire some data by calling poll(), with a
3855 timeout just in case.
3857 The simple approach is just to iterate after reading data from a ready pipe.
3858 This leads to non-ideal behaviour when the subprocess has written its final Z
3859 item, closed the pipe, and is in the process of exiting (the common case). A
3860 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3861 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3864 To avoid this, if all the data that is needed has been read from a subprocess
3865 after poll(), an explicit wait() for it is done. We know that all it is doing
3866 is writing to the pipe and then exiting, so the wait should not be long.
3868 The non-blocking waitpid() is to some extent just insurance; if we could
3869 reliably detect end-of-file on the pipe, we could always know when to do a
3870 blocking wait() for a completed process. However, because some systems use
3871 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3872 use code that functions without the need to recognize EOF.
3874 There's a double loop here just in case we end up with a process that is not in
3875 the list of remote delivery processes. Something has obviously gone wrong if
3876 this is the case. (For example, a process that is incorrectly left over from
3877 routing or local deliveries might be found.) The damage can be minimized by
3878 looping back and looking for another process. If there aren't any, the error
3879 return will happen. */
3881 for (;;) /* Normally we do not repeat this loop */
3883 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3887 /* A return value of -1 can mean several things. If errno != ECHILD, it
3888 either means invalid options (which we discount), or that this process was
3889 interrupted by a signal. Just loop to try the waitpid() again.
3891 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3892 in existence. This should never happen, and is an unexpected error.
3893 However, there is a nasty complication when running under Linux. If "strace
3894 -f" is being used under Linux to trace this process and its children,
3895 subprocesses are "stolen" from their parents and become the children of the
3896 tracing process. A general wait such as the one we've just obeyed returns
3897 as if there are no children while subprocesses are running. Once a
3898 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3899 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3902 This does not happen using "truss" on Solaris, nor (I think) with other
3903 tracing facilities on other OS. It seems to be specific to Linux.
3905 What we do to get round this is to use kill() to see if any of our
3906 subprocesses are still in existence. If kill() gives an OK return, we know
3907 it must be for one of our processes - it can't be for a re-use of the pid,
3908 because if our process had finished, waitpid() would have found it. If any
3909 of our subprocesses are in existence, we proceed to use poll() as if
3910 waitpid() had returned zero. I think this is safe. */
3914 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3917 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3918 "for process existence\n");
3920 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3922 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3924 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3925 "stolen by strace\n", (int)pid);
3926 break; /* With poffset set */
3930 if (poffset >= remote_max_parallel)
3932 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3933 return NULL; /* This is the error return */
3937 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3938 been handled above. A return value of zero means that there is at least one
3939 subprocess, but there are no completed subprocesses. See if any pipes are
3940 ready with any data for reading. */
3942 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3944 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3945 if (parlist[poffset].pid != 0)
3947 parpoll[poffset].fd = parlist[poffset].fd;
3948 parpoll[poffset].events = POLLIN;
3951 parpoll[poffset].fd = -1;
3953 /* Stick in a 60-second timeout, just in case. */
3955 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3957 /* Scan through the pipes and read any that are ready; use the count
3958 returned by poll() to stop when there are no more. Select() can return
3959 with no processes (e.g. if interrupted). This shouldn't matter.
3961 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3962 read, or there was a disaster. In either case, we are finished with this
3963 process. Do an explicit wait() for the process and break the main loop if
3966 It turns out that we have to deal with the case of an interrupted system
3967 call, which can happen on some operating systems if the signal handling is
3968 set up to do that by default. */
3971 readycount > 0 && poffset < remote_max_parallel;
3974 if ( (pid = parlist[poffset].pid) != 0
3975 && parpoll[poffset].revents
3979 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3980 for (;;) /* Loop for signals */
3982 pid_t endedpid = waitpid(pid, &status, 0);
3983 if (endedpid == pid) goto PROCESS_DONE;
3984 if (endedpid != (pid_t)(-1) || errno != EINTR)
3985 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3986 "%d (errno = %d) from waitpid() for process %d",
3987 (int)endedpid, errno, (int)pid);
3992 /* Now go back and look for a completed subprocess again. */
3995 /* A completed process was detected by the non-blocking waitpid(). Find the
3996 data block that corresponds to this subprocess. */
3998 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3999 if (pid == parlist[poffset].pid) break;
4001 /* Found the data block; this is a known remote delivery process. We don't
4002 need to repeat the outer loop. This should be what normally happens. */
4004 if (poffset < remote_max_parallel) break;
4006 /* This situation is an error, but it's probably better to carry on looking
4007 for another process than to give up (as we used to do). */
4009 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4010 "transport process list", pid);
4011 } /* End of the "for" loop */
4013 /* Come here when all the data was completely read after a poll(), and
4014 the process in pid has been wait()ed for. */
4021 debug_printf("remote delivery process %d ended\n", (int)pid);
4023 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4027 set_process_info("delivering %s", message_id);
4029 /* Get the chain of processed addresses */
4031 addrlist = parlist[poffset].addrlist;
4033 /* If the process did not finish cleanly, record an error and freeze (except
4034 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4035 in case the delivery did actually happen. */
4037 if ((status & 0xffff) != 0)
4040 int msb = (status >> 8) & 255;
4041 int lsb = status & 255;
4042 int code = (msb == 0)? (lsb & 0x7f) : msb;
4044 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4046 addrlist->transport->driver_name,
4048 msb == 0 ? "terminated by signal" : "exit code",
4051 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4052 addrlist->special_action = SPECIAL_FREEZE;
4054 for (addr = addrlist; addr; addr = addr->next)
4056 addr->transport_return = DEFER;
4057 addr->message = msg;
4060 remove_journal = FALSE;
4063 /* Else complete reading the pipe to get the result of the delivery, if all
4064 the data has not yet been obtained. */
4066 else if (!parlist[poffset].done)
4067 (void) par_read_pipe(poffset, TRUE);
4069 /* Put the data count and return path into globals, mark the data slot unused,
4070 decrement the count of subprocesses, and return the address chain. */
4072 transport_count = parlist[poffset].transport_count;
4073 used_return_path = parlist[poffset].return_path;
4074 parlist[poffset].pid = 0;
4081 /*************************************************
4082 * Wait for subprocesses and post-process *
4083 *************************************************/
4085 /* This function waits for subprocesses until the number that are still running
4086 is below a given threshold. For each complete subprocess, the addresses are
4087 post-processed. If we can't find a running process, there is some shambles.
4088 Better not bomb out, as that might lead to multiple copies of the message. Just
4089 log and proceed as if all done.
4092 max maximum number of subprocesses to leave running
4093 fallback TRUE if processing fallback hosts
4099 par_reduce(int max, BOOL fallback)
4101 while (parcount > max)
4103 address_item *doneaddr = par_wait();
4106 log_write(0, LOG_MAIN|LOG_PANIC,
4107 "remote delivery process count got out of step");
4112 transport_instance * tp = doneaddr->transport;
4113 if (tp->max_parallel)
4114 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4116 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4122 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4124 uschar pipe_header[PIPE_HEADER_SIZE+1];
4125 size_t total_len = PIPE_HEADER_SIZE + size;
4127 struct iovec iov[2] = {
4128 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4129 { buf, size } /* *the* data */
4134 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4135 /* complain to log if someone tries with buffer sizes we can't handle*/
4137 if (size > BIG_BUFFER_SIZE-1)
4139 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4140 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4142 size = BIG_BUFFER_SIZE;
4145 /* Should we check that we do not write more than PIPE_BUF? What would
4148 /* convert size to human readable string prepended by id and subid */
4149 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4150 id, subid, (long)size))
4151 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4153 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4154 id, subid, (long)size, pipe_header);
4156 if ((ret = writev(fd, iov, 2)) != total_len)
4157 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4158 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4159 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4162 /*************************************************
4163 * Do remote deliveries *
4164 *************************************************/
4166 /* This function is called to process the addresses in addr_remote. We must
4167 pick off the queue all addresses that have the same transport, remote
4168 destination, and errors address, and hand them to the transport in one go,
4169 subject to some configured limitations. If this is a run to continue delivering
4170 to an existing delivery channel, skip all but those addresses that can go to
4171 that channel. The skipped addresses just get deferred.
4173 If mua_wrapper is set, all addresses must be able to be sent in a single
4174 transaction. If not, this function yields FALSE.
4176 In Exim 4, remote deliveries are always done in separate processes, even
4177 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4178 is so that the base process can retain privilege. This makes the
4179 implementation of fallback transports feasible (though not initially done.)
4181 We create up to the configured number of subprocesses, each of which passes
4182 back the delivery state via a pipe. (However, when sending down an existing
4183 connection, remote_max_parallel is forced to 1.)
4186 fallback TRUE if processing fallback hosts
4188 Returns: TRUE normally
4189 FALSE if mua_wrapper is set and the addresses cannot all be sent
4194 do_remote_deliveries(BOOL fallback)
4199 parcount = 0; /* Number of executing subprocesses */
4201 /* When sending down an existing channel, only do one delivery at a time.
4202 We use a local variable (parmax) to hold the maximum number of processes;
4203 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4205 if (continue_transport) remote_max_parallel = 1;
4206 parmax = remote_max_parallel;
4208 /* If the data for keeping a list of processes hasn't yet been
4213 parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4214 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4215 parlist[poffset].pid = 0;
4216 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), FALSE);
4219 /* Now loop for each remote delivery */
4221 for (int delivery_count = 0; addr_remote; delivery_count++)
4227 int address_count = 1;
4228 int address_count_max;
4230 BOOL use_initgroups;
4231 BOOL pipe_done = FALSE;
4232 transport_instance *tp;
4233 address_item **anchor = &addr_remote;
4234 address_item *addr = addr_remote;
4235 address_item *last = addr;
4238 uschar * serialize_key = NULL;
4240 /* Pull the first address right off the list. */
4242 addr_remote = addr->next;
4245 DEBUG(D_deliver|D_transport)
4246 debug_printf("--------> %s <--------\n", addr->address);
4248 /* If no transport has been set, there has been a big screw-up somewhere. */
4250 if (!(tp = addr->transport))
4252 f.disable_logging = FALSE; /* Jic */
4253 panicmsg = US"No transport set by router";
4254 goto panic_continue;
4257 /* Check that this base address hasn't previously been delivered to this
4258 transport. The check is necessary at this point to handle homonymic addresses
4259 correctly in cases where the pattern of redirection changes between delivery
4260 attempts. Non-homonymic previous delivery is detected earlier, at routing
4263 if (previously_transported(addr, FALSE)) continue;
4265 /* Force failure if the message is too big. */
4267 if (tp->message_size_limit)
4269 int rc = check_message_size(tp, addr);
4272 addr->transport_return = rc;
4273 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4278 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4279 So look out for the place it gets used.
4282 /* Get the flag which specifies whether the transport can handle different
4283 domains that nevertheless resolve to the same set of hosts. If it needs
4284 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4285 $host, $host_address, $host_port. */
4286 if (tp->expand_multi_domain)
4287 deliver_set_expansions(addr);
4289 if (exp_bool(addr, US"transport", tp->name, D_transport,
4290 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4291 &multi_domain) != OK)
4293 deliver_set_expansions(NULL);
4294 panicmsg = addr->message;
4295 goto panic_continue;
4298 /* Get the maximum it can handle in one envelope, with zero meaning
4299 unlimited, which is forced for the MUA wrapper case. */
4301 address_count_max = tp->max_addresses;
4302 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4305 /************************************************************************/
4306 /***** This is slightly experimental code, but should be safe. *****/
4308 /* The address_count_max value is the maximum number of addresses that the
4309 transport can send in one envelope. However, the transport must be capable of
4310 dealing with any number of addresses. If the number it gets exceeds its
4311 envelope limitation, it must send multiple copies of the message. This can be
4312 done over a single connection for SMTP, so uses less resources than making
4313 multiple connections. On the other hand, if remote_max_parallel is greater
4314 than one, it is perhaps a good idea to use parallel processing to move the
4315 message faster, even if that results in multiple simultaneous connections to
4318 How can we come to some compromise between these two ideals? What we do is to
4319 limit the number of addresses passed to a single instance of a transport to
4320 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4321 number of addresses routed to remote transports divided by
4322 remote_max_parallel. For example, if the message has 100 remote recipients,
4323 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4324 once. But if rcpt_max is 100, we could send up to 100.
4326 Of course, not all the remotely addresses in a message are going to go to the
4327 same set of hosts (except in smarthost configurations), so this is just a
4328 heuristic way of dividing up the work.
4330 Furthermore (1), because this may not be wanted in some cases, and also to
4331 cope with really pathological cases, there is also a limit to the number of
4332 messages that are sent over one connection. This is the same limit that is
4333 used when sending several different messages over the same connection.
4334 Continue_sequence is set when in this situation, to the number sent so
4335 far, including this message.
4337 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4338 is probably because they are using VERP, in which case they want to pass only
4339 one address at a time to the transport, in order to be able to use
4340 $local_part and $domain in constructing a new return path. We could test for
4341 the use of these variables, but as it is so likely they will be used when the
4342 maximum is 1, we don't bother. Just leave the value alone. */
4344 if ( address_count_max != 1
4345 && address_count_max < remote_delivery_count/remote_max_parallel
4348 int new_max = remote_delivery_count/remote_max_parallel;
4349 int message_max = tp->connection_max_messages;
4350 if (connection_max_messages >= 0) message_max = connection_max_messages;
4351 message_max -= continue_sequence - 1;
4352 if (message_max > 0 && new_max > address_count_max * message_max)
4353 new_max = address_count_max * message_max;
4354 address_count_max = new_max;
4357 /************************************************************************/
4360 /*XXX don't know yet if DANE will be used. So tpt will have to
4361 check at the point if gets next addr from list, and skip/defer any
4365 /* Pick off all addresses which have the same transport, errors address,
4366 destination, and extra headers. In some cases they point to the same host
4367 list, but we also need to check for identical host lists generated from
4368 entirely different domains. The host list pointers can be NULL in the case
4369 where the hosts are defined in the transport. There is also a configured
4370 maximum limit of addresses that can be handled at once (see comments above
4371 for how it is computed).
4372 If the transport does not handle multiple domains, enforce that also,
4373 and if it might need a per-address check for this, re-evaluate it.
4376 while ((next = *anchor) && address_count < address_count_max)
4379 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4380 && tp == next->transport
4381 && same_hosts(next->host_list, addr->host_list)
4382 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4383 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4384 && same_ugid(tp, next, addr)
4385 && ( next->prop.remove_headers == addr->prop.remove_headers
4386 || ( next->prop.remove_headers
4387 && addr->prop.remove_headers
4388 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4392 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4394 US"transport", next->transport->name, D_transport,
4395 US"multi_domain", next->transport->multi_domain,
4396 next->transport->expand_multi_domain, &md) == OK
4401 *anchor = next->next;
4403 next->first = addr; /* remember top one (for retry processing) */
4408 else anchor = &(next->next);
4409 deliver_set_expansions(NULL);
4412 /* If we are acting as an MUA wrapper, all addresses must go in a single
4413 transaction. If not, put them back on the chain and yield FALSE. */
4415 if (mua_wrapper && addr_remote)
4417 last->next = addr_remote;
4422 /* If the transport is limited for parallellism, enforce that here.
4423 The hints DB entry is decremented in par_reduce(), when we reap the
4424 transport process. */
4426 if (tpt_parallel_check(tp, addr, &serialize_key))
4427 if ((panicmsg = expand_string_message))
4428 goto panic_continue;
4430 continue; /* Loop for the next set of addresses. */
4432 /* Set up the expansion variables for this set of addresses */
4434 deliver_set_expansions(addr);
4436 /* Ensure any transport-set auth info is fresh */
4437 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4439 /* Compute the return path, expanding a new one if required. The old one
4440 must be set first, as it might be referred to in the expansion. */
4442 if(addr->prop.errors_address)
4443 return_path = addr->prop.errors_address;
4444 #ifdef EXPERIMENTAL_SRS_ALT
4445 else if(addr->prop.srs_sender)
4446 return_path = addr->prop.srs_sender;
4449 return_path = sender_address;
4451 if (tp->return_path)
4453 uschar *new_return_path = expand_string(tp->return_path);
4454 if (new_return_path)
4455 return_path = new_return_path;
4456 else if (!f.expand_string_forcedfail)
4458 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4459 tp->return_path, expand_string_message);
4464 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4465 logs and sets up error messages, so we just post-process and continue with
4466 the next address. */
4468 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4474 /* If this transport has a setup function, call it now so that it gets
4475 run in this process and not in any subprocess. That way, the results of
4476 any setup that are retained by the transport can be reusable. One of the
4477 things the setup does is to set the fallback host lists in the addresses.
4478 That is why it is called at this point, before the continue delivery
4479 processing, because that might use the fallback hosts. */
4482 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4484 /* If we have a connection still open from a verify stage (lazy-close)
4485 treat it as if it is a continued connection (apart from the counter used
4486 for the log line mark). */
4488 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4491 debug_printf("lazy-callout-close: have conn still open from verification\n");
4492 continue_transport = cutthrough.transport;
4493 continue_hostname = string_copy(cutthrough.host.name);
4494 continue_host_address = string_copy(cutthrough.host.address);
4495 continue_sequence = 1;
4496 sending_ip_address = cutthrough.snd_ip;
4497 sending_port = cutthrough.snd_port;
4498 smtp_peer_options = cutthrough.peer_options;
4501 /* If this is a run to continue delivery down an already-established
4502 channel, check that this set of addresses matches the transport and
4503 the channel. If it does not, defer the addresses. If a host list exists,
4504 we must check that the continue host is on the list. Otherwise, the
4505 host is set in the transport. */
4507 f.continue_more = FALSE; /* In case got set for the last lot */
4508 if (continue_transport)
4510 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4511 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4513 /* If the transport is about to override the host list do not check
4514 it here but take the cost of running the transport process to discover
4515 if the continued_hostname connection is suitable. This is a layering
4516 violation which is unfortunate as it requires we haul in the smtp
4521 smtp_transport_options_block * ob;
4523 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4524 && (ob = (smtp_transport_options_block *)tp->options_block)
4525 && ob->hosts_override && ob->hosts
4531 for (host_item * h = addr->host_list; h; h = h->next)
4532 if (Ustrcmp(h->name, continue_hostname) == 0)
4533 /*XXX should also check port here */
4534 { ok = TRUE; break; }
4538 /* Addresses not suitable; defer or queue for fallback hosts (which
4539 might be the continue host) and skip to next address. */
4543 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4544 Ustrcmp(continue_transport, tp->name) != 0
4545 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4546 : string_sprintf("no host matching %s", continue_hostname));
4547 if (serialize_key) enq_end(serialize_key);
4549 if (addr->fallback_hosts && !fallback)
4551 for (next = addr; ; next = next->next)
4553 next->host_list = next->fallback_hosts;
4554 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4555 if (!next->next) break;
4557 next->next = addr_fallback;
4558 addr_fallback = addr;
4563 for (next = addr; ; next = next->next)
4565 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4566 if (!next->next) break;
4568 next->next = addr_defer;
4575 /* Set a flag indicating whether there are further addresses that list
4576 the continued host. This tells the transport to leave the channel open,
4577 but not to pass it to another delivery process. We'd like to do that
4578 for non-continue_transport cases too but the knowlege of which host is
4579 connected to is too hard to manage. Perhaps we need a finer-grain
4580 interface to the transport. */
4582 for (next = addr_remote; next && !f.continue_more; next = next->next)
4583 for (host_item * h = next->host_list; h; h = h->next)
4584 if (Ustrcmp(h->name, continue_hostname) == 0)
4585 { f.continue_more = TRUE; break; }
4588 /* The transports set up the process info themselves as they may connect
4589 to more than one remote machine. They also have to set up the filter
4590 arguments, if required, so that the host name and address are available
4593 transport_filter_argv = NULL;
4595 /* Create the pipe for inter-process communication. If pipe creation
4596 fails, it is probably because the value of remote_max_parallel is so
4597 large that too many file descriptors for pipes have been created. Arrange
4598 to wait for a process to finish, and then try again. If we still can't
4599 create a pipe when all processes have finished, break the retry loop. */
4603 if (pipe(pfd) == 0) pipe_done = TRUE;
4604 else if (parcount > 0) parmax = parcount;
4607 /* We need to make the reading end of the pipe non-blocking. There are
4608 two different options for this. Exim is cunningly (I hope!) coded so
4609 that it can use either of them, though it prefers O_NONBLOCK, which
4610 distinguishes between EOF and no-more-data. */
4612 /* The data appears in a timely manner and we already did a poll on
4613 all pipes, so I do not see a reason to use non-blocking IO here
4616 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4618 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4622 /* If the maximum number of subprocesses already exist, wait for a process
4623 to finish. If we ran out of file descriptors, parmax will have been reduced
4624 from its initial value of remote_max_parallel. */
4626 par_reduce(parmax - 1, fallback);
4629 /* If we failed to create a pipe and there were no processes to wait
4630 for, we have to give up on this one. Do this outside the above loop
4631 so that we can continue the main loop. */
4635 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4639 /* Find a free slot in the pardata list. Must do this after the possible
4640 waiting for processes to finish, because a terminating process will free
4643 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4644 if (parlist[poffset].pid == 0)
4647 /* If there isn't one, there has been a horrible disaster. */
4649 if (poffset >= remote_max_parallel)
4651 (void)close(pfd[pipe_write]);
4652 (void)close(pfd[pipe_read]);
4653 panicmsg = US"Unexpectedly no free subprocess slot";
4657 /* Now fork a subprocess to do the remote delivery, but before doing so,
4658 ensure that any cached resources are released so as not to interfere with
4659 what happens in the subprocess. */
4663 if ((pid = exim_fork(US"transport")) == 0)
4665 int fd = pfd[pipe_write];
4668 /* Setting this global in the subprocess means we need never clear it */
4669 transport_name = tp->name;
4671 /* There are weird circumstances in which logging is disabled */
4672 f.disable_logging = tp->disable_logging;
4674 /* Show pids on debug output if parallelism possible */
4676 if (parmax > 1 && (parcount > 0 || addr_remote))
4677 DEBUG(D_any|D_v) debug_selector |= D_pid;
4679 /* Reset the random number generator, so different processes don't all
4680 have the same sequence. In the test harness we want different, but
4681 predictable settings for each delivery process, so do something explicit
4682 here rather they rely on the fixed reset in the random number function. */
4684 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4686 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4687 a new process that may be forked to do another delivery down the same
4690 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4692 /* Close open file descriptors for the pipes of other processes
4693 that are running in parallel. */
4695 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4696 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4698 /* This process has inherited a copy of the file descriptor
4699 for the data file, but its file pointer is shared with all the
4700 other processes running in parallel. Therefore, we have to re-open
4701 the file in order to get a new file descriptor with its own
4702 file pointer. We don't need to lock it, as the lock is held by
4703 the parent process. There doesn't seem to be any way of doing
4704 a dup-with-new-file-pointer. */
4706 (void)close(deliver_datafile);
4708 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4710 if ((deliver_datafile = Uopen(fname,
4714 O_RDWR | O_APPEND, 0)) < 0)
4715 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4716 "parallel delivery: %s", fname, strerror(errno));
4719 /* Set the close-on-exec flag */
4721 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4725 /* Set the uid/gid of this process; bombs out on failure. */
4727 exim_setugid(uid, gid, use_initgroups,
4728 string_sprintf("remote delivery to %s with transport=%s",
4729 addr->address, tp->name));
4731 /* Close the unwanted half of this process' pipe, set the process state,
4732 and run the transport. Afterwards, transport_count will contain the number
4733 of bytes written. */
4735 (void)close(pfd[pipe_read]);
4736 set_process_info("delivering %s using %s", message_id, tp->name);
4737 debug_print_string(tp->debug_string);
4738 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4740 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4741 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4743 /* Ensure any cached resources that we used are now released */
4747 /* Pass the result back down the pipe. This is a lot more information
4748 than is needed for a local delivery. We have to send back the error
4749 status for each address, the usability status for each host that is
4750 flagged as unusable, and all the retry items. When TLS is in use, we
4751 send also the cipher and peerdn information. Each type of information
4752 is flagged by an identifying byte, and is then in a fixed format (with
4753 strings terminated by zeros), and there is a final terminator at the
4754 end. The host information and retry information is all attached to
4755 the first address, so that gets sent at the start. */
4757 /* Host unusability information: for most success cases this will
4760 for (h = addr->host_list; h; h = h->next)
4762 if (!h->address || h->status < hstatus_unusable) continue;
4763 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4764 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4767 /* The number of bytes written. This is the same for each address. Even
4768 if we sent several copies of the message down the same connection, the
4769 size of each one is the same, and it's that value we have got because
4770 transport_count gets reset before calling transport_write_message(). */
4772 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4773 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4775 /* Information about what happened to each address. Four item types are
4776 used: an optional 'X' item first, for TLS information, then an optional "C"
4777 item for any client-auth info followed by 'R' items for any retry settings,
4778 and finally an 'A' item for the remaining data. */
4780 for(; addr; addr = addr->next)
4784 /* The certificate verification status goes into the flags */
4785 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4787 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4789 # ifndef DISABLE_TLS_RESUME
4790 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4793 /* Use an X item only if there's something to send */
4797 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4801 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4803 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4805 else if (continue_proxy_cipher)
4807 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4809 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4815 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4819 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4824 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4828 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4830 # ifndef DISABLE_OCSP
4831 if (addr->ocsp > OCSP_NOT_REQ)
4833 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4834 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4837 #endif /*DISABLE_TLS*/
4839 if (client_authenticator)
4841 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4842 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4844 if (client_authenticated_id)
4846 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4847 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4849 if (client_authenticated_sender)
4851 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4852 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4855 #ifndef DISABLE_PRDR
4856 if (testflag(addr, af_prdr_used))
4857 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4860 if (testflag(addr, af_pipelining))
4861 #ifndef DISABLE_PIPE_CONNECT
4862 if (testflag(addr, af_early_pipe))
4863 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4866 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4868 if (testflag(addr, af_chunking_used))
4869 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4871 if (testflag(addr, af_tcp_fastopen_conn))
4872 rmt_dlv_checked_write(fd, 'T',
4873 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4877 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4878 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4880 /* Retry information: for most success cases this will be null. */
4882 for (retry_item * r = addr->retries; r; r = r->next)
4884 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4885 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4886 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4887 ptr += sizeof(r->basic_errno);
4888 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4889 ptr += sizeof(r->more_errno);
4890 if (!r->message) *ptr++ = 0; else
4892 sprintf(CS ptr, "%.512s", r->message);
4895 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4898 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4900 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4901 testflag(addr, af_new_conn) ? "non-" : "");
4902 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4903 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4906 #ifdef SUPPORT_SOCKS
4907 if (LOGGING(proxy) && proxy_session)
4910 if (proxy_local_address)
4912 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4913 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4914 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4915 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4916 ptr += sizeof(proxy_local_port);
4920 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4924 #ifdef EXPERIMENTAL_DSN_INFO
4925 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4926 if (addr->smtp_greeting)
4928 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4929 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4930 if (addr->helo_response)
4932 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4933 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4937 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4941 /* The rest of the information goes in an 'A0' item. */
4943 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4944 ptr = big_buffer + 2;
4945 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4946 ptr += sizeof(addr->basic_errno);
4947 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4948 ptr += sizeof(addr->more_errno);
4949 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4950 ptr += sizeof(addr->delivery_time);
4951 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4952 ptr += sizeof(addr->flags);
4954 if (!addr->message) *ptr++ = 0; else
4955 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4957 if (!addr->user_message) *ptr++ = 0; else
4958 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4960 if (!addr->host_used) *ptr++ = 0; else
4962 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4963 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4964 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4965 ptr += sizeof(addr->host_used->port);
4967 /* DNS lookup status */
4968 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4969 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4972 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4975 /* Local interface address/port */
4976 #ifdef EXPERIMENTAL_DSN_INFO
4977 if (sending_ip_address)
4979 if (LOGGING(incoming_interface) && sending_ip_address)
4983 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4984 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4985 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4988 /* Add termination flag, close the pipe, and that's it. The character
4989 after 'Z' indicates whether continue_transport is now NULL or not.
4990 A change from non-NULL to NULL indicates a problem with a continuing
4993 big_buffer[0] = continue_transport ? '1' : '0';
4994 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4999 /* Back in the mainline: close the unwanted half of the pipe. */
5001 (void)close(pfd[pipe_write]);
5003 /* If we have a connection still open from a verify stage (lazy-close)
5004 release its TLS library context (if any) as responsibility was passed to
5005 the delivery child process. */
5007 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5010 if (cutthrough.is_tls)
5011 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5013 (void) close(cutthrough.cctx.sock);
5014 release_cutthrough_connection(US"passed to transport proc");
5017 /* Fork failed; defer with error message */
5021 (void)close(pfd[pipe_read]);
5022 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5023 addr->domain, strerror(errno));
5027 /* Fork succeeded; increment the count, and remember relevant data for
5028 when the process finishes. */
5031 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5032 parlist[poffset].pid = pid;
5033 parlist[poffset].fd = pfd[pipe_read];
5034 parlist[poffset].done = FALSE;
5035 parlist[poffset].msg = NULL;
5036 parlist[poffset].return_path = return_path;
5038 /* If the process we've just started is sending a message down an existing
5039 channel, wait for it now. This ensures that only one such process runs at
5040 once, whatever the value of remote_max parallel. Otherwise, we might try to
5041 send two or more messages simultaneously down the same channel. This could
5042 happen if there are different domains that include the same host in otherwise
5043 different host lists.
5045 Also, if the transport closes down the channel, this information gets back
5046 (continue_transport gets set to NULL) before we consider any other addresses
5049 if (continue_transport) par_reduce(0, fallback);
5051 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5052 newly created process get going before we create another process. This should
5053 ensure repeatability in the tests. Wait long enough for most cases to complete
5056 else testharness_pause_ms(600);
5061 if (serialize_key) enq_end(serialize_key);
5063 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5067 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5068 are still running and post-process their addresses. */
5070 par_reduce(0, fallback);
5077 /*************************************************
5078 * Split an address into local part and domain *
5079 *************************************************/
5081 /* This function initializes an address for routing by splitting it up into a
5082 local part and a domain. The local part is set up twice - once in its original
5083 casing, and once in lower case, and it is dequoted. We also do the "percent
5084 hack" for configured domains. This may lead to a DEFER result if a lookup
5085 defers. When a percent-hacking takes place, we insert a copy of the original
5086 address as a new parent of this address, as if we have had a redirection.
5089 addr points to an addr_item block containing the address
5092 DEFER - could not determine if domain is %-hackable
5096 deliver_split_address(address_item * addr)
5098 uschar * address = addr->address;
5103 if (!(domain = Ustrrchr(address, '@')))
5104 return DEFER; /* should always have a domain, but just in case... */
5106 len = domain - address;
5107 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5109 /* The implication in the RFCs (though I can't say I've seen it spelled out
5110 explicitly) is that quoting should be removed from local parts at the point
5111 where they are locally interpreted. [The new draft "821" is more explicit on
5112 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5113 removing quoting backslashes and any unquoted doublequotes. */
5115 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5119 if (c == '\"') continue;
5129 /* We do the percent hack only for those domains that are listed in
5130 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5132 if (percent_hack_domains)
5135 uschar *new_address = NULL;
5136 uschar *local_part = addr->cc_local_part;
5138 deliver_domain = addr->domain; /* set $domain */
5140 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5141 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5143 && (t = Ustrrchr(local_part, '%')) != NULL
5146 new_address = string_copy(local_part);
5147 new_address[t - local_part] = '@';
5148 deliver_domain = string_copylc(t+1);
5149 local_part = string_copyn(local_part, t - local_part);
5152 if (rc == DEFER) return DEFER; /* lookup deferred */
5154 /* If hackery happened, set up new parent and alter the current address. */
5158 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5159 *new_parent = *addr;
5160 addr->parent = new_parent;
5161 new_parent->child_count = 1;
5162 addr->address = new_address;
5163 addr->unique = string_copy(new_address);
5164 addr->domain = deliver_domain;
5165 addr->cc_local_part = local_part;
5166 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5171 /* Create the lowercased version of the final local part, and make that the
5172 default one to be used. */
5174 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5181 /*************************************************
5182 * Get next error message text *
5183 *************************************************/
5185 /* If f is not NULL, read the next "paragraph", from a customized error message
5186 text file, terminated by a line containing ****, and expand it.
5189 f NULL or a file to read from
5190 which string indicating which string (for errors)
5192 Returns: NULL or an expanded string
5196 next_emf(FILE *f, uschar *which)
5202 if (!f) return NULL;
5204 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5207 para = string_get(256);
5210 para = string_cat(para, buffer);
5211 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5214 if ((yield = expand_string(string_from_gstring(para))))
5217 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5218 "bounce_message_file or warn_message_file (%s): %s", which,
5219 expand_string_message);
5226 /*************************************************
5227 * Close down a passed transport channel *
5228 *************************************************/
5230 /* This function is called when a passed transport channel cannot be used.
5231 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5232 so that the function call can be the argument of a "return" statement.
5235 Returns: DELIVER_NOT_ATTEMPTED
5239 continue_closedown(void)
5241 if (continue_transport)
5242 for (transport_instance * t = transports; t; t = t->next)
5243 if (Ustrcmp(t->name, continue_transport) == 0)
5245 if (t->info->closedown) (t->info->closedown)(t);
5248 return DELIVER_NOT_ATTEMPTED;
5254 /*************************************************
5255 * Print address information *
5256 *************************************************/
5258 /* This function is called to output an address, or information about an
5259 address, for bounce or defer messages. If the hide_child flag is set, all we
5260 output is the original ancestor address.
5263 addr points to the address
5264 f the FILE to print to
5265 si an initial string
5266 sc a continuation string for before "generated"
5269 Returns: TRUE if the address is not hidden
5273 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5277 uschar *printed = US"";
5278 address_item *ancestor = addr;
5279 while (ancestor->parent) ancestor = ancestor->parent;
5281 fprintf(f, "%s", CS si);
5283 if (addr->parent && testflag(addr, af_hide_child))
5285 printed = US"an undisclosed address";
5288 else if (!testflag(addr, af_pfr) || !addr->parent)
5289 printed = addr->address;
5293 uschar *s = addr->address;
5296 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5297 else if (addr->address[0] == '|') ss = US"pipe";
5300 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5301 printed = addr->parent->address;
5304 fprintf(f, "%s", CS string_printing(printed));
5306 if (ancestor != addr)
5308 uschar *original = ancestor->onetime_parent;
5309 if (!original) original= ancestor->address;
5310 if (strcmpic(original, printed) != 0)
5311 fprintf(f, "%s(%sgenerated from %s)", sc,
5312 ancestor != addr->parent ? "ultimately " : "",
5313 string_printing(original));
5316 if (addr->host_used)
5317 fprintf(f, "\n host %s [%s]",
5318 addr->host_used->name, addr->host_used->address);
5320 fprintf(f, "%s", CS se);
5328 /*************************************************
5329 * Print error for an address *
5330 *************************************************/
5332 /* This function is called to print the error information out of an address for
5333 a bounce or a warning message. It tries to format the message reasonably by
5334 introducing newlines. All lines are indented by 4; the initial printing
5335 position must be set before calling.
5337 This function used always to print the error. Nowadays we want to restrict it
5338 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5339 and filter "fail". We no longer pass other information willy-nilly in bounce
5340 and warning messages. Text in user_message is always output; text in message
5341 only if the af_pass_message flag is set.
5345 f the FILE to print on
5352 print_address_error(address_item *addr, FILE *f, uschar *t)
5354 int count = Ustrlen(t);
5355 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5357 if (!s && !(s = addr->user_message))
5360 fprintf(f, "\n %s", t);
5363 if (*s == '\\' && s[1] == 'n')
5373 if (*s++ == ':' && isspace(*s) && count > 45)
5375 fprintf(f, "\n "); /* sic (because space follows) */
5382 /***********************************************************
5383 * Print Diagnostic-Code for an address *
5384 ************************************************************/
5386 /* This function is called to print the error information out of an address for
5387 a bounce or a warning message. It tries to format the message reasonably as
5388 required by RFC 3461 by adding a space after each newline
5390 it uses the same logic as print_address_error() above. if af_pass_message is true
5391 and addr->message is set it uses the remote host answer. if not addr->user_message
5392 is used instead if available.
5396 f the FILE to print on
5402 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5404 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5407 /* af_pass_message and addr->message set ? print remote host answer */
5411 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5413 /* search first ": ". we assume to find the remote-MTA answer there */
5414 if (!(s = Ustrstr(addr->message, ": ")))
5415 return; /* not found, bail out */
5416 s += 2; /* skip ": " */
5417 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5419 /* no message available. do nothing */
5424 if (cnt > 950) /* RFC line length limit: 998 */
5426 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5427 fputs("[truncated]", f);
5431 if (*s == '\\' && s[1] == 'n')
5433 fputs("\n ", f); /* as defined in RFC 3461 */
5448 /*************************************************
5449 * Check list of addresses for duplication *
5450 *************************************************/
5452 /* This function was introduced when the test for duplicate addresses that are
5453 not pipes, files, or autoreplies was moved from the middle of routing to when
5454 routing was complete. That was to fix obscure cases when the routing history
5455 affects the subsequent routing of identical addresses. This function is called
5456 after routing, to check that the final routed addresses are not duplicates.
5458 If we detect a duplicate, we remember what it is a duplicate of. Note that
5459 pipe, file, and autoreply de-duplication is handled during routing, so we must
5460 leave such "addresses" alone here, as otherwise they will incorrectly be
5463 Argument: address of list anchor
5468 do_duplicate_check(address_item **anchor)
5471 while ((addr = *anchor))
5474 if (testflag(addr, af_pfr))
5476 anchor = &(addr->next);
5478 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5480 DEBUG(D_deliver|D_route)
5481 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5482 *anchor = addr->next;
5483 addr->dupof = tnode->data.ptr;
5484 addr->next = addr_duplicate;
5485 addr_duplicate = addr;
5489 tree_add_duplicate(addr->unique, addr);
5490 anchor = &(addr->next);
5498 /************************************************/
5501 print_dsn_addr_action(FILE * f, address_item * addr,
5502 uschar * action, uschar * status)
5506 if (addr->dsn_orcpt)
5507 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5509 for (pa = addr; pa->parent; ) pa = pa->parent;
5510 fprintf(f, "Action: %s\n"
5511 "Final-Recipient: rfc822;%s\n"
5513 action, pa->address, status);
5518 /* When running in the test harness, there's an option that allows us to
5519 fudge this time so as to get repeatability of the tests. Take the first
5520 time off the list. In queue runs, the list pointer gets updated in the
5524 test_harness_fudged_queue_time(int actual_time)
5527 if ( f.running_in_test_harness && *fudged_queue_times
5528 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5530 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5531 fudged_queue_times);
5537 /************************************************/
5540 expand_open(const uschar * filename,
5541 const uschar * varname, const uschar * reason)
5543 const uschar * s = expand_cstring(filename);
5547 log_write(0, LOG_MAIN|LOG_PANIC,
5548 "Failed to expand %s: '%s'\n", varname, filename);
5550 log_write(0, LOG_MAIN|LOG_PANIC, "%s is not absolute after expansion: '%s'\n",
5552 else if (is_tainted2(s, LOG_MAIN|LOG_PANIC, "Tainted %s after expansion: '%s'\n", varname, s))
5554 else if (!(fp = Ufopen(s, "rb")))
5555 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5556 "message texts: %s", s, reason, strerror(errno));
5560 /*************************************************
5561 * Deliver one message *
5562 *************************************************/
5564 /* This is the function which is called when a message is to be delivered. It
5565 is passed the id of the message. It is possible that the message no longer
5566 exists, if some other process has delivered it, and it is also possible that
5567 the message is being worked on by another process, in which case the data file
5570 If no delivery is attempted for any of the above reasons, the function returns
5571 DELIVER_NOT_ATTEMPTED.
5573 If the give_up flag is set true, do not attempt any deliveries, but instead
5574 fail all outstanding addresses and return the message to the sender (or
5577 A delivery operation has a process all to itself; we never deliver more than
5578 one message in the same process. Therefore we needn't worry too much about
5581 Liable to be called as root.
5584 id the id of the message to be delivered
5585 forced TRUE if delivery was forced by an administrator; this overrides
5586 retry delays and causes a delivery to be tried regardless
5587 give_up TRUE if an administrator has requested that delivery attempts
5590 Returns: When the global variable mua_wrapper is FALSE:
5591 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5592 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5593 When the global variable mua_wrapper is TRUE:
5594 DELIVER_MUA_SUCCEEDED if delivery succeeded
5595 DELIVER_MUA_FAILED if delivery failed
5596 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5600 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5603 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5604 time_t now = time(NULL);
5605 address_item *addr_last = NULL;
5606 uschar *filter_message = NULL;
5607 int process_recipients = RECIP_ACCEPT;
5610 extern int acl_where;
5613 #ifdef MEASURE_TIMING
5614 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5617 info = queue_run_pid == (pid_t)0
5618 ? string_sprintf("delivering %s", id)
5619 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5621 /* If the D_process_info bit is on, set_process_info() will output debugging
5622 information. If not, we want to show this initial information if D_deliver or
5623 D_queue_run is set or in verbose mode. */
5625 set_process_info("%s", info);
5627 if ( !(debug_selector & D_process_info)
5628 && (debug_selector & (D_deliver|D_queue_run|D_v))
5630 debug_printf("%s\n", info);
5632 /* Ensure that we catch any subprocesses that are created. Although Exim
5633 sets SIG_DFL as its initial default, some routes through the code end up
5634 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5635 has been forked, but no re-exec has been done. We use sigaction rather than
5636 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5637 sure it is turned off. (There was a problem on AIX with this.) */
5641 struct sigaction act;
5642 act.sa_handler = SIG_DFL;
5643 sigemptyset(&(act.sa_mask));
5645 sigaction(SIGCHLD, &act, NULL);
5648 signal(SIGCHLD, SIG_DFL);
5651 /* Make the forcing flag available for routers and transports, set up the
5652 global message id field, and initialize the count for returned files and the
5653 message size. This use of strcpy() is OK because the length id is checked when
5654 it is obtained from a command line (the -M or -q options), and otherwise it is
5655 known to be a valid message id. */
5657 if (id != message_id)
5658 Ustrcpy(message_id, id);
5659 f.deliver_force = forced;
5663 /* Initialize some flags */
5665 update_spool = FALSE;
5666 remove_journal = TRUE;
5668 /* Set a known context for any ACLs we call via expansions */
5669 acl_where = ACL_WHERE_DELIVERY;
5671 /* Reset the random number generator, so that if several delivery processes are
5672 started from a queue runner that has already used random numbers (for sorting),
5673 they don't all get the same sequence. */
5677 /* Open and lock the message's data file. Exim locks on this one because the
5678 header file may get replaced as it is re-written during the delivery process.
5679 Any failures cause messages to be written to the log, except for missing files
5680 while queue running - another process probably completed delivery. As part of
5681 opening the data file, message_subdir gets set. */
5683 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5684 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5686 /* The value of message_size at this point has been set to the data length,
5687 plus one for the blank line that notionally precedes the data. */
5689 /* Now read the contents of the header file, which will set up the headers in
5690 store, and also the list of recipients and the tree of non-recipients and
5691 assorted flags. It updates message_size. If there is a reading or format error,
5692 give up; if the message has been around for sufficiently long, remove it. */
5695 uschar * spoolname = string_sprintf("%s-H", id);
5696 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5698 if (errno == ERRNO_SPOOLFORMAT)
5700 struct stat statbuf;
5701 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5703 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5704 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5706 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5709 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5712 /* If we managed to read the envelope data, received_time contains the
5713 time the message was received. Otherwise, we can calculate it from the
5716 if (rc != spool_read_hdrerror)
5718 received_time.tv_sec = received_time.tv_usec = 0;
5719 /*XXX subsec precision?*/
5720 for (i = 0; i < 6; i++)
5721 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5724 /* If we've had this malformed message too long, sling it. */
5726 if (now - received_time.tv_sec > keep_malformed)
5728 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5729 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5730 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5731 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5732 log_write(0, LOG_MAIN, "Message removed because older than %s",
5733 readconf_printtime(keep_malformed));
5736 (void)close(deliver_datafile);
5737 deliver_datafile = -1;
5738 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5742 /* The spool header file has been read. Look to see if there is an existing
5743 journal file for this message. If there is, it means that a previous delivery
5744 attempt crashed (program or host) before it could update the spool header file.
5745 Read the list of delivered addresses from the journal and add them to the
5746 nonrecipients tree. Then update the spool file. We can leave the journal in
5747 existence, as it will get further successful deliveries added to it in this
5748 run, and it will be deleted if this function gets to its end successfully.
5749 Otherwise it might be needed again. */
5752 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5755 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5763 && lseek(journal_fd, 0, SEEK_SET) == 0
5764 && (jread = fdopen(journal_fd, "rb"))
5767 while (Ufgets(big_buffer, big_buffer_size, jread))
5769 int n = Ustrlen(big_buffer);
5770 big_buffer[n-1] = 0;
5771 tree_add_nonrecipient(big_buffer);
5772 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5773 "journal file\n", big_buffer);
5776 if ((journal_fd = dup(fileno(jread))) < 0)
5777 journal_fd = fileno(jread);
5779 (void) fclose(jread); /* Try to not leak the FILE resource */
5781 /* Panic-dies on error */
5782 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5784 else if (errno != ENOENT)
5786 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5787 "%s", strerror(errno));
5788 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5791 /* A null recipients list indicates some kind of disaster. */
5793 if (!recipients_list)
5795 (void)close(deliver_datafile);
5796 deliver_datafile = -1;
5797 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5798 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5803 /* Handle a message that is frozen. There are a number of different things that
5804 can happen, but in the default situation, unless forced, no delivery is
5807 if (f.deliver_freeze)
5809 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5810 /* Moving to another directory removes the message from Exim's view. Other
5811 tools must be used to deal with it. Logging of this action happens in
5812 spool_move_message() and its subfunctions. */
5814 if ( move_frozen_messages
5815 && spool_move_message(id, message_subdir, US"", US"F")
5817 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5820 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5821 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5822 flag causing all recipients to be failed. The time is the age of the
5823 message, not the time since freezing. */
5825 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5827 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5828 process_recipients = RECIP_FAIL_TIMEOUT;
5831 /* For bounce messages (and others with no sender), thaw if the error message
5832 ignore timer is exceeded. The message will be discarded if this delivery
5835 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5836 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5838 /* If this is a bounce message, or there's no auto thaw, or we haven't
5839 reached the auto thaw time yet, and this delivery is not forced by an admin
5840 user, do not attempt delivery of this message. Note that forced is set for
5841 continuing messages down the same channel, in order to skip load checking and
5842 ignore hold domains, but we don't want unfreezing in that case. */
5846 if ( ( sender_address[0] == 0
5848 || now <= deliver_frozen_at + auto_thaw
5850 && ( !forced || !f.deliver_force_thaw
5851 || !f.admin_user || continue_hostname
5854 (void)close(deliver_datafile);
5855 deliver_datafile = -1;
5856 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5857 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5860 /* If delivery was forced (by an admin user), assume a manual thaw.
5861 Otherwise it's an auto thaw. */
5865 f.deliver_manual_thaw = TRUE;
5866 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5868 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5871 /* We get here if any of the rules for unfreezing have triggered. */
5873 f.deliver_freeze = FALSE;
5874 update_spool = TRUE;
5878 /* Open the message log file if we are using them. This records details of
5879 deliveries, deferments, and failures for the benefit of the mail administrator.
5880 The log is not used by exim itself to track the progress of a message; that is
5881 done by rewriting the header spool file. */
5885 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5889 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5891 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5892 fname, strerror(errno));
5893 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5896 /* Make a C stream out of it. */
5898 if (!(message_log = fdopen(fd, "a")))
5900 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5901 fname, strerror(errno));
5902 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5907 /* If asked to give up on a message, log who did it, and set the action for all
5912 struct passwd *pw = getpwuid(real_uid);
5913 log_write(0, LOG_MAIN, "cancelled by %s",
5914 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5915 process_recipients = RECIP_FAIL;
5918 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5920 else if (received_count > received_headers_max)
5921 process_recipients = RECIP_FAIL_LOOP;
5923 /* Otherwise, if a system-wide, address-independent message filter is
5924 specified, run it now, except in the case when we are failing all recipients as
5925 a result of timeout_frozen_after. If the system filter yields "delivered", then
5926 ignore the true recipients of the message. Failure of the filter file is
5927 logged, and the delivery attempt fails. */
5929 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5934 redirect_block redirect;
5936 if (system_filter_uid_set)
5938 ugid.uid = system_filter_uid;
5939 ugid.gid = system_filter_gid;
5940 ugid.uid_set = ugid.gid_set = TRUE;
5943 ugid.uid_set = ugid.gid_set = FALSE;
5945 return_path = sender_address;
5946 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5947 f.system_filtering = TRUE;
5949 /* Any error in the filter file causes a delivery to be abandoned. */
5951 redirect.string = system_filter;
5952 redirect.isfile = TRUE;
5953 redirect.check_owner = redirect.check_group = FALSE;
5954 redirect.owners = NULL;
5955 redirect.owngroups = NULL;
5957 redirect.modemask = 0;
5959 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5962 &redirect, /* Where the data is */
5963 RDO_DEFER | /* Turn on all the enabling options */
5964 RDO_FAIL | /* Leave off all the disabling options */
5969 NULL, /* No :include: restriction (not used in filter) */
5970 NULL, /* No sieve vacation directory (not sieve!) */
5971 NULL, /* No sieve enotify mailto owner (not sieve!) */
5972 NULL, /* No sieve user address (not sieve!) */
5973 NULL, /* No sieve subaddress (not sieve!) */
5974 &ugid, /* uid/gid data */
5975 &addr_new, /* Where to hang generated addresses */
5976 &filter_message, /* Where to put error message */
5977 NULL, /* Don't skip syntax errors */
5978 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5979 US"system filter"); /* For error messages */
5981 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5983 if (rc == FF_ERROR || rc == FF_NONEXIST)
5985 (void)close(deliver_datafile);
5986 deliver_datafile = -1;
5987 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5988 string_printing(filter_message));
5989 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5992 /* Reset things. If the filter message is an empty string, which can happen
5993 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5995 f.system_filtering = FALSE;
5996 f.enable_dollar_recipients = FALSE;
5997 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5999 /* Save the values of the system filter variables so that user filters
6002 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6004 /* The filter can request that delivery of the original addresses be
6009 process_recipients = RECIP_DEFER;
6010 deliver_msglog("Delivery deferred by system filter\n");
6011 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6014 /* The filter can request that a message be frozen, but this does not
6015 take place if the message has been manually thawed. In that case, we must
6016 unset "delivered", which is forced by the "freeze" command to make -bF
6019 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6021 f.deliver_freeze = TRUE;
6022 deliver_frozen_at = time(NULL);
6023 process_recipients = RECIP_DEFER;
6024 frozen_info = string_sprintf(" by the system filter%s%s",
6025 filter_message ? US": " : US"",
6026 filter_message ? filter_message : US"");
6029 /* The filter can request that a message be failed. The error message may be
6030 quite long - it is sent back to the sender in the bounce - but we don't want
6031 to fill up the log with repetitions of it. If it starts with << then the text
6032 between << and >> is written to the log, with the rest left for the bounce
6035 else if (rc == FF_FAIL)
6037 uschar *colon = US"";
6038 uschar *logmsg = US"";
6041 process_recipients = RECIP_FAIL_FILTER;
6047 if ( filter_message[0] == '<'
6048 && filter_message[1] == '<'
6049 && (logend = Ustrstr(filter_message, ">>"))
6052 logmsg = filter_message + 2;
6053 loglen = logend - logmsg;
6054 filter_message = logend + 2;
6055 if (filter_message[0] == 0) filter_message = NULL;
6059 logmsg = filter_message;
6060 loglen = Ustrlen(filter_message);
6064 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6068 /* Delivery can be restricted only to those recipients (if any) that the
6069 filter specified. */
6071 else if (rc == FF_DELIVERED)
6073 process_recipients = RECIP_IGNORE;
6075 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6077 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6080 /* If any new addresses were created by the filter, fake up a "parent"
6081 for them. This is necessary for pipes, etc., which are expected to have
6082 parents, and it also gives some sensible logging for others. Allow
6083 pipes, files, and autoreplies, and run them as the filter uid if set,
6084 otherwise as the current uid. */
6088 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6089 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6091 /* The text "system-filter" is tested in transport_set_up_command() and in
6092 set_up_shell_command() in the pipe transport, to enable them to permit
6093 $recipients, so don't change it here without also changing it there. */
6095 address_item *p = addr_new;
6096 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6098 parent->domain = string_copylc(qualify_domain_recipient);
6099 parent->local_part = US"system-filter";
6101 /* As part of this loop, we arrange for addr_last to end up pointing
6102 at the final address. This is used if we go on to add addresses for the
6103 original recipients. */
6107 if (parent->child_count == USHRT_MAX)
6108 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6109 "than %d delivery addresses", USHRT_MAX);
6110 parent->child_count++;
6113 if (testflag(p, af_pfr))
6119 setflag(p, af_uid_set);
6120 setflag(p, af_gid_set);
6121 setflag(p, af_allow_file);
6122 setflag(p, af_allow_pipe);
6123 setflag(p, af_allow_reply);
6125 /* Find the name of the system filter's appropriate pfr transport */
6127 if (p->address[0] == '|')
6130 tpname = system_filter_pipe_transport;
6131 address_pipe = p->address;
6133 else if (p->address[0] == '>')
6136 tpname = system_filter_reply_transport;
6140 if (p->address[Ustrlen(p->address)-1] == '/')
6142 type = US"directory";
6143 tpname = system_filter_directory_transport;
6148 tpname = system_filter_file_transport;
6150 address_file = p->address;
6153 /* Now find the actual transport, first expanding the name. We have
6154 set address_file or address_pipe above. */
6158 uschar *tmp = expand_string(tpname);
6159 address_file = address_pipe = NULL;
6161 p->message = string_sprintf("failed to expand \"%s\" as a "
6162 "system filter transport name", tpname);
6164 if ((m = is_tainted2(tmp, 0, "Tainted values '%s' " "for transport '%s' as a system filter", tmp, tpname)))
6170 p->message = string_sprintf("system_filter_%s_transport is unset",
6175 transport_instance *tp;
6176 for (tp = transports; tp; tp = tp->next)
6177 if (Ustrcmp(tp->name, tpname) == 0)
6183 p->message = string_sprintf("failed to find \"%s\" transport "
6184 "for system filter delivery", tpname);
6187 /* If we couldn't set up a transport, defer the delivery, putting the
6188 error on the panic log as well as the main log. */
6192 address_item *badp = p;
6194 if (!addr_last) addr_new = p; else addr_last->next = p;
6195 badp->local_part = badp->address; /* Needed for log line */
6196 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6199 } /* End of pfr handling */
6201 /* Either a non-pfr delivery, or we found a transport */
6203 DEBUG(D_deliver|D_filter)
6204 debug_printf("system filter added %s\n", p->address);
6208 } /* Loop through all addr_new addresses */
6213 /* Scan the recipients list, and for every one that is not in the non-
6214 recipients tree, add an addr item to the chain of new addresses. If the pno
6215 value is non-negative, we must set the onetime parent from it. This which
6216 points to the relevant entry in the recipients list.
6218 This processing can be altered by the setting of the process_recipients
6219 variable, which is changed if recipients are to be ignored, failed, or
6220 deferred. This can happen as a result of system filter activity, or if the -Mg
6221 option is used to fail all of them.
6223 Duplicate addresses are handled later by a different tree structure; we can't
6224 just extend the non-recipients tree, because that will be re-written to the
6225 spool if the message is deferred, and in any case there are casing
6226 complications for local addresses. */
6228 if (process_recipients != RECIP_IGNORE)
6229 for (i = 0; i < recipients_count; i++)
6230 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6232 recipient_item *r = recipients_list + i;
6233 address_item *new = deliver_make_addr(r->address, FALSE);
6234 new->prop.errors_address = r->errors_to;
6236 if ((new->prop.utf8_msg = message_smtputf8))
6238 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6239 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6240 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6241 new->prop.utf8_downcvt ? "yes"
6242 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6248 new->onetime_parent = recipients_list[r->pno].address;
6250 /* If DSN support is enabled, set the dsn flags and the original receipt
6251 to be passed on to other DSN enabled MTAs */
6253 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6254 new->dsn_orcpt = r->orcpt;
6255 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6256 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6258 switch (process_recipients)
6260 /* RECIP_DEFER is set when a system filter freezes a message. */
6263 new->next = addr_defer;
6268 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6271 case RECIP_FAIL_FILTER:
6273 filter_message ? filter_message : US"delivery cancelled";
6274 setflag(new, af_pass_message);
6275 goto RECIP_QUEUE_FAILED; /* below */
6278 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6279 than the value in timeout_frozen_after. Treat non-bounce messages
6280 similarly to -Mg; for bounce messages we just want to discard, so
6281 don't put the address on the failed list. The timeout has already
6284 case RECIP_FAIL_TIMEOUT:
6285 new->message = US"delivery cancelled; message timed out";
6286 goto RECIP_QUEUE_FAILED; /* below */
6289 /* RECIP_FAIL is set when -Mg has been used. */
6292 new->message = US"delivery cancelled by administrator";
6295 /* Common code for the failure cases above. If this is not a bounce
6296 message, put the address on the failed list so that it is used to
6297 create a bounce. Otherwise do nothing - this just discards the address.
6298 The incident has already been logged. */
6301 if (sender_address[0])
6303 new->next = addr_failed;
6309 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6310 in the message. Process each address as a routing failure; if this
6311 is a bounce message, it will get frozen. */
6313 case RECIP_FAIL_LOOP:
6314 new->message = US"Too many \"Received\" headers - suspected mail loop";
6315 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6319 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6322 if (!addr_new) addr_new = new; else addr_last->next = new;
6327 #ifndef DISABLE_EVENT
6328 if (process_recipients != RECIP_ACCEPT && event_action)
6330 uschar * save_local = deliver_localpart;
6331 const uschar * save_domain = deliver_domain;
6332 uschar * addr = new->address, * errmsg = NULL;
6333 int start, end, dom;
6335 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6336 log_write(0, LOG_MAIN|LOG_PANIC,
6337 "failed to parse address '%.100s': %s\n", addr, errmsg);
6341 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6342 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6344 event_raise(event_action, US"msg:fail:internal", new->message);
6346 deliver_localpart = save_local;
6347 deliver_domain = save_domain;
6355 debug_printf("Delivery address list:\n");
6356 for (address_item * p = addr_new; p; p = p->next)
6357 debug_printf(" %s %s\n", p->address,
6358 p->onetime_parent ? p->onetime_parent : US"");
6361 /* Set up the buffers used for copying over the file when delivering. */
6363 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6364 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6368 /* Until there are no more new addresses, handle each one as follows:
6370 . If this is a generated address (indicated by the presence of a parent
6371 pointer) then check to see whether it is a pipe, file, or autoreply, and
6372 if so, handle it directly here. The router that produced the address will
6373 have set the allow flags into the address, and also set the uid/gid required.
6374 Having the routers generate new addresses and then checking them here at
6375 the outer level is tidier than making each router do the checking, and
6376 means that routers don't need access to the failed address queue.
6378 . Break up the address into local part and domain, and make lowercased
6379 versions of these strings. We also make unquoted versions of the local part.
6381 . Handle the percent hack for those domains for which it is valid.
6383 . For child addresses, determine if any of the parents have the same address.
6384 If so, generate a different string for previous delivery checking. Without
6385 this code, if the address spqr generates spqr via a forward or alias file,
6386 delivery of the generated spqr stops further attempts at the top level spqr,
6387 which is not what is wanted - it may have generated other addresses.
6389 . Check on the retry database to see if routing was previously deferred, but
6390 only if in a queue run. Addresses that are to be routed are put on the
6391 addr_route chain. Addresses that are to be deferred are put on the
6392 addr_defer chain. We do all the checking first, so as not to keep the
6393 retry database open any longer than necessary.
6395 . Now we run the addresses through the routers. A router may put the address
6396 on either the addr_local or the addr_remote chain for local or remote
6397 delivery, respectively, or put it on the addr_failed chain if it is
6398 undeliveable, or it may generate child addresses and put them on the
6399 addr_new chain, or it may defer an address. All the chain anchors are
6400 passed as arguments so that the routers can be called for verification
6403 . If new addresses have been generated by the routers, da capo.
6406 f.header_rewritten = FALSE; /* No headers rewritten yet */
6407 while (addr_new) /* Loop until all addresses dealt with */
6409 address_item *addr, *parent;
6411 /* Failure to open the retry database is treated the same as if it does
6412 not exist. In both cases, dbm_file is NULL. */
6414 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6415 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6416 debug_printf("no retry data available\n");
6418 /* Scan the current batch of new addresses, to handle pipes, files and
6419 autoreplies, and determine which others are ready for routing. */
6426 dbdata_retry *domain_retry_record;
6427 dbdata_retry *address_retry_record;
6430 addr_new = addr->next;
6432 DEBUG(D_deliver|D_retry|D_route)
6434 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6435 debug_printf("Considering: %s\n", addr->address);
6438 /* Handle generated address that is a pipe or a file or an autoreply. */
6440 if (testflag(addr, af_pfr))
6442 /* If an autoreply in a filter could not generate a syntactically valid
6443 address, give up forthwith. Set af_ignore_error so that we don't try to
6444 generate a bounce. */
6446 if (testflag(addr, af_bad_reply))
6448 addr->basic_errno = ERRNO_BADADDRESS2;
6449 addr->local_part = addr->address;
6451 US"filter autoreply generated syntactically invalid recipient";
6452 addr->prop.ignore_error = TRUE;
6453 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6454 continue; /* with the next new address */
6457 /* If two different users specify delivery to the same pipe or file or
6458 autoreply, there should be two different deliveries, so build a unique
6459 string that incorporates the original address, and use this for
6460 duplicate testing and recording delivery, and also for retrying. */
6463 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6464 (testflag(addr->parent, af_homonym)? 3:0));
6466 addr->address_retry_key = addr->domain_retry_key =
6467 string_sprintf("T:%s", addr->unique);
6469 /* If a filter file specifies two deliveries to the same pipe or file,
6470 we want to de-duplicate, but this is probably not wanted for two mail
6471 commands to the same address, where probably both should be delivered.
6472 So, we have to invent a different unique string in that case. Just
6473 keep piling '>' characters on the front. */
6475 if (addr->address[0] == '>')
6476 while (tree_search(tree_duplicates, addr->unique))
6477 addr->unique = string_sprintf(">%s", addr->unique);
6479 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6481 DEBUG(D_deliver|D_route)
6482 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6483 addr->dupof = tnode->data.ptr;
6484 addr->next = addr_duplicate;
6485 addr_duplicate = addr;
6489 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6491 /* Check for previous delivery */
6493 if (tree_search(tree_nonrecipients, addr->unique))
6495 DEBUG(D_deliver|D_route)
6496 debug_printf("%s was previously delivered: discarded\n", addr->address);
6497 child_done(addr, tod_stamp(tod_log));
6501 /* Save for checking future duplicates */
6503 tree_add_duplicate(addr->unique, addr);
6505 /* Set local part and domain */
6507 addr->local_part = addr->address;
6508 addr->domain = addr->parent->domain;
6510 /* Ensure that the delivery is permitted. */
6512 if (testflag(addr, af_file))
6514 if (!testflag(addr, af_allow_file))
6516 addr->basic_errno = ERRNO_FORBIDFILE;
6517 addr->message = US"delivery to file forbidden";
6518 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6519 continue; /* with the next new address */
6522 else if (addr->address[0] == '|')
6524 if (!testflag(addr, af_allow_pipe))
6526 addr->basic_errno = ERRNO_FORBIDPIPE;
6527 addr->message = US"delivery to pipe forbidden";
6528 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6529 continue; /* with the next new address */
6532 else if (!testflag(addr, af_allow_reply))
6534 addr->basic_errno = ERRNO_FORBIDREPLY;
6535 addr->message = US"autoreply forbidden";
6536 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6537 continue; /* with the next new address */
6540 /* If the errno field is already set to BADTRANSPORT, it indicates
6541 failure to expand a transport string, or find the associated transport,
6542 or an unset transport when one is required. Leave this test till now so
6543 that the forbid errors are given in preference. */
6545 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6547 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6551 /* Treat /dev/null as a special case and abandon the delivery. This
6552 avoids having to specify a uid on the transport just for this case.
6553 Arrange for the transport name to be logged as "**bypassed**".
6554 Copy the transport for this fairly unusual case rather than having
6555 to make all transports mutable. */
6557 if (Ustrcmp(addr->address, "/dev/null") == 0)
6559 transport_instance * save_t = addr->transport;
6560 transport_instance * t = store_get(sizeof(*t), is_tainted(save_t));
6562 t->name = US"**bypassed**";
6563 addr->transport = t;
6564 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6565 addr->transport= save_t;
6566 continue; /* with the next new address */
6569 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6572 DEBUG(D_deliver|D_route)
6573 debug_printf("queued for %s transport\n", addr->transport->name);
6574 addr->next = addr_local;
6576 continue; /* with the next new address */
6579 /* Handle normal addresses. First, split up into local part and domain,
6580 handling the %-hack if necessary. There is the possibility of a defer from
6581 a lookup in percent_hack_domains. */
6583 if ((rc = deliver_split_address(addr)) == DEFER)
6585 addr->message = US"cannot check percent_hack_domains";
6586 addr->basic_errno = ERRNO_LISTDEFER;
6587 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6591 /* Check to see if the domain is held. If so, proceed only if the
6592 delivery was forced by hand. */
6594 deliver_domain = addr->domain; /* set $domain */
6595 if ( !forced && hold_domains
6596 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6597 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6603 addr->message = US"hold_domains lookup deferred";
6604 addr->basic_errno = ERRNO_LISTDEFER;
6608 addr->message = US"domain is held";
6609 addr->basic_errno = ERRNO_HELD;
6611 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6615 /* Now we can check for duplicates and previously delivered addresses. In
6616 order to do this, we have to generate a "unique" value for each address,
6617 because there may be identical actual addresses in a line of descendents.
6618 The "unique" field is initialized to the same value as the "address" field,
6619 but gets changed here to cope with identically-named descendents. */
6621 for (parent = addr->parent; parent; parent = parent->parent)
6622 if (strcmpic(addr->address, parent->address) == 0) break;
6624 /* If there's an ancestor with the same name, set the homonym flag. This
6625 influences how deliveries are recorded. Then add a prefix on the front of
6626 the unique address. We use \n\ where n starts at 0 and increases each time.
6627 It is unlikely to pass 9, but if it does, it may look odd but will still
6628 work. This means that siblings or cousins with the same names are treated
6629 as duplicates, which is what we want. */
6633 setflag(addr, af_homonym);
6634 if (parent->unique[0] != '\\')
6635 addr->unique = string_sprintf("\\0\\%s", addr->address);
6637 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6641 /* Ensure that the domain in the unique field is lower cased, because
6642 domains are always handled caselessly. */
6644 p = Ustrrchr(addr->unique, '@');
6645 while (*p != 0) { *p = tolower(*p); p++; }
6647 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6649 if (tree_search(tree_nonrecipients, addr->unique))
6651 DEBUG(D_deliver|D_route)
6652 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6653 child_done(addr, tod_stamp(tod_log));
6657 /* Get the routing retry status, saving the two retry keys (with and
6658 without the local part) for subsequent use. If there is no retry record for
6659 the standard address routing retry key, we look for the same key with the
6660 sender attached, because this form is used by the smtp transport after a
6661 4xx response to RCPT when address_retry_include_sender is true. */
6663 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6664 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6669 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6670 if ( domain_retry_record
6671 && now - domain_retry_record->time_stamp > retry_data_expire
6674 DEBUG(D_deliver|D_retry)
6675 debug_printf("domain retry record present but expired\n");
6676 domain_retry_record = NULL; /* Ignore if too old */
6679 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6680 if ( address_retry_record
6681 && now - address_retry_record->time_stamp > retry_data_expire
6684 DEBUG(D_deliver|D_retry)
6685 debug_printf("address retry record present but expired\n");
6686 address_retry_record = NULL; /* Ignore if too old */
6689 if (!address_retry_record)
6691 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6693 address_retry_record = dbfn_read(dbm_file, altkey);
6694 if ( address_retry_record
6695 && now - address_retry_record->time_stamp > retry_data_expire)
6697 DEBUG(D_deliver|D_retry)
6698 debug_printf("address<sender> retry record present but expired\n");
6699 address_retry_record = NULL; /* Ignore if too old */
6704 domain_retry_record = address_retry_record = NULL;
6706 DEBUG(D_deliver|D_retry)
6708 if (!domain_retry_record)
6709 debug_printf("no domain retry record\n");
6711 debug_printf("have domain retry record; next_try = now%+d\n",
6712 f.running_in_test_harness ? 0 :
6713 (int)(domain_retry_record->next_try - now));
6715 if (!address_retry_record)
6716 debug_printf("no address retry record\n");
6718 debug_printf("have address retry record; next_try = now%+d\n",
6719 f.running_in_test_harness ? 0 :
6720 (int)(address_retry_record->next_try - now));
6723 /* If we are sending a message down an existing SMTP connection, we must
6724 assume that the message which created the connection managed to route
6725 an address to that connection. We do not want to run the risk of taking
6726 a long time over routing here, because if we do, the server at the other
6727 end of the connection may time it out. This is especially true for messages
6728 with lots of addresses. For this kind of delivery, queue_running is not
6729 set, so we would normally route all addresses. We take a pragmatic approach
6730 and defer routing any addresses that have any kind of domain retry record.
6731 That is, we don't even look at their retry times. It doesn't matter if this
6732 doesn't work occasionally. This is all just an optimization, after all.
6734 The reason for not doing the same for address retries is that they normally
6735 arise from 4xx responses, not DNS timeouts. */
6737 if (continue_hostname && domain_retry_record)
6739 addr->message = US"reusing SMTP connection skips previous routing defer";
6740 addr->basic_errno = ERRNO_RRETRY;
6741 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6743 addr->message = domain_retry_record->text;
6744 setflag(addr, af_pass_message);
6747 /* If we are in a queue run, defer routing unless there is no retry data or
6748 we've passed the next retry time, or this message is forced. In other
6749 words, ignore retry data when not in a queue run.
6751 However, if the domain retry time has expired, always allow the routing
6752 attempt. If it fails again, the address will be failed. This ensures that
6753 each address is routed at least once, even after long-term routing
6756 If there is an address retry, check that too; just wait for the next
6757 retry time. This helps with the case when the temporary error on the
6758 address was really message-specific rather than address specific, since
6759 it allows other messages through.
6761 We also wait for the next retry time if this is a message sent down an
6762 existing SMTP connection (even though that will be forced). Otherwise there
6763 will be far too many attempts for an address that gets a 4xx error. In
6764 fact, after such an error, we should not get here because, the host should
6765 not be remembered as one this message needs. However, there was a bug that
6766 used to cause this to happen, so it is best to be on the safe side.
6768 Even if we haven't reached the retry time in the hints, there is one more
6769 check to do, which is for the ultimate address timeout. We only do this
6770 check if there is an address retry record and there is not a domain retry
6771 record; this implies that previous attempts to handle the address had the
6772 retry_use_local_parts option turned on. We use this as an approximation
6773 for the destination being like a local delivery, for example delivery over
6774 LMTP to an IMAP message store. In this situation users are liable to bump
6775 into their quota and thereby have intermittently successful deliveries,
6776 which keep the retry record fresh, which can lead to us perpetually
6777 deferring messages. */
6779 else if ( ( f.queue_running && !f.deliver_force
6780 || continue_hostname
6782 && ( ( domain_retry_record
6783 && now < domain_retry_record->next_try
6784 && !domain_retry_record->expired
6786 || ( address_retry_record
6787 && now < address_retry_record->next_try
6789 && ( domain_retry_record
6790 || !address_retry_record
6791 || !retry_ultimate_address_timeout(addr->address_retry_key,
6792 addr->domain, address_retry_record, now)
6795 addr->message = US"retry time not reached";
6796 addr->basic_errno = ERRNO_RRETRY;
6797 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6799 /* For remote-retry errors (here and just above) that we've not yet
6800 hit the retry time, use the error recorded in the retry database
6801 as info in the warning message. This lets us send a message even
6802 when we're not failing on a fresh attempt. We assume that this
6803 info is not sensitive. */
6805 addr->message = domain_retry_record
6806 ? domain_retry_record->text : address_retry_record->text;
6807 setflag(addr, af_pass_message);
6810 /* The domain is OK for routing. Remember if retry data exists so it
6811 can be cleaned up after a successful delivery. */
6815 if (domain_retry_record || address_retry_record)
6816 setflag(addr, af_dr_retry_exists);
6817 addr->next = addr_route;
6819 DEBUG(D_deliver|D_route)
6820 debug_printf("%s: queued for routing\n", addr->address);
6824 /* The database is closed while routing is actually happening. Requests to
6825 update it are put on a chain and all processed together at the end. */
6827 if (dbm_file) dbfn_close(dbm_file);
6829 /* If queue_domains is set, we don't even want to try routing addresses in
6830 those domains. During queue runs, queue_domains is forced to be unset.
6831 Optimize by skipping this pass through the addresses if nothing is set. */
6833 if (!f.deliver_force && queue_domains)
6835 address_item *okaddr = NULL;
6838 address_item *addr = addr_route;
6839 addr_route = addr->next;
6841 deliver_domain = addr->domain; /* set $domain */
6842 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
6843 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6847 addr->basic_errno = ERRNO_LISTDEFER;
6848 addr->message = US"queue_domains lookup deferred";
6849 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6853 addr->next = okaddr;
6858 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6859 addr->message = US"domain is in queue_domains";
6860 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6864 addr_route = okaddr;
6867 /* Now route those addresses that are not deferred. */
6872 address_item *addr = addr_route;
6873 const uschar *old_domain = addr->domain;
6874 uschar *old_unique = addr->unique;
6875 addr_route = addr->next;
6878 /* Just in case some router parameter refers to it. */
6880 if (!(return_path = addr->prop.errors_address))
6881 return_path = sender_address;
6883 /* If a router defers an address, add a retry item. Whether or not to
6884 use the local part in the key is a property of the router. */
6886 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6887 &addr_succeed, v_none)) == DEFER)
6888 retry_add_item(addr,
6889 addr->router->retry_use_local_part
6890 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6891 : string_sprintf("R:%s", addr->domain),
6894 /* Otherwise, if there is an existing retry record in the database, add
6895 retry items to delete both forms. We must also allow for the possibility
6896 of a routing retry that includes the sender address. Since the domain might
6897 have been rewritten (expanded to fully qualified) as a result of routing,
6898 ensure that the rewritten form is also deleted. */
6900 else if (testflag(addr, af_dr_retry_exists))
6902 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6904 retry_add_item(addr, altkey, rf_delete);
6905 retry_add_item(addr, addr->address_retry_key, rf_delete);
6906 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6907 if (Ustrcmp(addr->domain, old_domain) != 0)
6908 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6911 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6912 logged, but we need to ensure the address (and maybe parents) is marked
6917 address_done(addr, tod_stamp(tod_log));
6918 continue; /* route next address */
6921 /* The address is finished with (failed or deferred). */
6925 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6926 continue; /* route next address */
6929 /* The address has been routed. If the router changed the domain, it will
6930 also have changed the unique address. We have to test whether this address
6931 has already been delivered, because it's the unique address that finally
6934 if ( addr->unique != old_unique
6935 && tree_search(tree_nonrecipients, addr->unique) != 0
6938 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6939 "discarded\n", addr->address);
6940 if (addr_remote == addr) addr_remote = addr->next;
6941 else if (addr_local == addr) addr_local = addr->next;
6944 /* If the router has same_domain_copy_routing set, we are permitted to copy
6945 the routing for any other addresses with the same domain. This is an
6946 optimisation to save repeated DNS lookups for "standard" remote domain
6947 routing. The option is settable only on routers that generate host lists.
6948 We play it very safe, and do the optimization only if the address is routed
6949 to a remote transport, there are no header changes, and the domain was not
6950 modified by the router. */
6952 if ( addr_remote == addr
6953 && addr->router->same_domain_copy_routing
6954 && !addr->prop.extra_headers
6955 && !addr->prop.remove_headers
6956 && old_domain == addr->domain
6959 address_item **chain = &addr_route;
6962 address_item *addr2 = *chain;
6963 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6965 chain = &(addr2->next);
6969 /* Found a suitable address; take it off the routing list and add it to
6970 the remote delivery list. */
6972 *chain = addr2->next;
6973 addr2->next = addr_remote;
6974 addr_remote = addr2;
6976 /* Copy the routing data */
6978 addr2->domain = addr->domain;
6979 addr2->router = addr->router;
6980 addr2->transport = addr->transport;
6981 addr2->host_list = addr->host_list;
6982 addr2->fallback_hosts = addr->fallback_hosts;
6983 addr2->prop.errors_address = addr->prop.errors_address;
6984 copyflag(addr2, addr, af_hide_child);
6985 copyflag(addr2, addr, af_local_host_removed);
6987 DEBUG(D_deliver|D_route)
6988 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6990 "Routing for %s copied from %s\n",
6991 addr2->address, addr2->address, addr->address);
6994 } /* Continue with routing the next address. */
6995 } /* Loop to process any child addresses that the routers created, and
6996 any rerouted addresses that got put back on the new chain. */
6999 /* Debugging: show the results of the routing */
7001 DEBUG(D_deliver|D_retry|D_route)
7003 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7004 debug_printf("After routing:\n Local deliveries:\n");
7005 for (address_item * p = addr_local; p; p = p->next)
7006 debug_printf(" %s\n", p->address);
7008 debug_printf(" Remote deliveries:\n");
7009 for (address_item * p = addr_remote; p; p = p->next)
7010 debug_printf(" %s\n", p->address);
7012 debug_printf(" Failed addresses:\n");
7013 for (address_item * p = addr_failed; p; p = p->next)
7014 debug_printf(" %s\n", p->address);
7016 debug_printf(" Deferred addresses:\n");
7017 for (address_item * p = addr_defer; p; p = p->next)
7018 debug_printf(" %s\n", p->address);
7021 /* Free any resources that were cached during routing. */
7026 /* These two variables are set only during routing, after check_local_user.
7027 Ensure they are not set in transports. */
7029 local_user_gid = (gid_t)(-1);
7030 local_user_uid = (uid_t)(-1);
7032 /* Check for any duplicate addresses. This check is delayed until after
7033 routing, because the flexibility of the routing configuration means that
7034 identical addresses with different parentage may end up being redirected to
7035 different addresses. Checking for duplicates too early (as we previously used
7036 to) makes this kind of thing not work. */
7038 do_duplicate_check(&addr_local);
7039 do_duplicate_check(&addr_remote);
7041 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7042 remote transport. The check that they all end up in one transaction happens in
7043 the do_remote_deliveries() function. */
7046 && (addr_local || addr_failed || addr_defer)
7050 uschar *which, *colon, *msg;
7057 else if (addr_defer)
7060 which = US"deferred";
7068 while (addr->parent) addr = addr->parent;
7073 msg = addr->message;
7075 else colon = msg = US"";
7077 /* We don't need to log here for a forced failure as it will already
7078 have been logged. Defer will also have been logged, but as a defer, so we do
7079 need to do the failure logging. */
7081 if (addr != addr_failed)
7082 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7083 addr->address, which);
7085 /* Always write an error to the caller */
7087 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7090 final_yield = DELIVER_MUA_FAILED;
7091 addr_failed = addr_defer = NULL; /* So that we remove the message */
7092 goto DELIVERY_TIDYUP;
7096 /* If this is a run to continue deliveries to an external channel that is
7097 already set up, defer any local deliveries.
7099 jgh 2020/12/20: I don't see why; locals should be quick.
7100 The defer goes back to version 1.62 in 1997. A local being still deliverable
7101 during a continued run might result from something like a defer during the
7102 original delivery, eg. in a DB lookup. Unlikely but possible.
7104 To avoid delaying a local when combined with a callout-hold for a remote
7105 delivery, test continue_sequence rather than continue_transport. */
7107 if (continue_sequence > 1 && addr_local)
7109 DEBUG(D_deliver|D_retry|D_route)
7110 debug_printf("deferring local deliveries due to continued-transport\n");
7113 address_item * addr = addr_defer;
7114 while (addr->next) addr = addr->next;
7115 addr->next = addr_local;
7118 addr_defer = addr_local;
7123 /* Because address rewriting can happen in the routers, we should not really do
7124 ANY deliveries until all addresses have been routed, so that all recipients of
7125 the message get the same headers. However, this is in practice not always
7126 possible, since sometimes remote addresses give DNS timeouts for days on end.
7127 The pragmatic approach is to deliver what we can now, saving any rewritten
7128 headers so that at least the next lot of recipients benefit from the rewriting
7129 that has already been done.
7131 If any headers have been rewritten during routing, update the spool file to
7132 remember them for all subsequent deliveries. This can be delayed till later if
7133 there is only address to be delivered - if it succeeds the spool write need not
7136 if ( f.header_rewritten
7137 && ( addr_local && (addr_local->next || addr_remote)
7138 || addr_remote && addr_remote->next
7141 /* Panic-dies on error */
7142 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7143 f.header_rewritten = FALSE;
7147 /* If there are any deliveries to do and we do not already have the journal
7148 file, create it. This is used to record successful deliveries as soon as
7149 possible after each delivery is known to be complete. A file opened with
7150 O_APPEND is used so that several processes can run simultaneously.
7152 The journal is just insurance against crashes. When the spool file is
7153 ultimately updated at the end of processing, the journal is deleted. If a
7154 journal is found to exist at the start of delivery, the addresses listed
7155 therein are added to the non-recipients. */
7157 if (addr_local || addr_remote)
7161 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7163 if ((journal_fd = Uopen(fname,
7167 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7169 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7170 fname, strerror(errno));
7171 return DELIVER_NOT_ATTEMPTED;
7174 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7175 that the mode is correct - the group setting doesn't always seem to get
7176 set automatically. */
7178 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7179 || fchmod(journal_fd, SPOOL_MODE)
7181 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7185 int ret = Uunlink(fname);
7186 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7187 fname, strerror(errno));
7188 if(ret && errno != ENOENT)
7189 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7190 fname, strerror(errno));
7191 return DELIVER_NOT_ATTEMPTED;
7195 else if (journal_fd >= 0)
7203 /* Now we can get down to the business of actually doing deliveries. Local
7204 deliveries are done first, then remote ones. If ever the problems of how to
7205 handle fallback transports are figured out, this section can be put into a loop
7206 for handling fallbacks, though the uid switching will have to be revised. */
7208 /* Precompile a regex that is used to recognize a parameter in response
7209 to an LHLO command, if is isn't already compiled. This may be used on both
7210 local and remote LMTP deliveries. */
7212 if (!regex_IGNOREQUOTA)
7214 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7216 /* Handle local deliveries */
7220 DEBUG(D_deliver|D_transport)
7221 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7222 do_local_deliveries();
7223 f.disable_logging = FALSE;
7226 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7227 so just queue them all. */
7229 if (f.queue_run_local)
7232 address_item *addr = addr_remote;
7233 addr_remote = addr->next;
7235 addr->basic_errno = ERRNO_LOCAL_ONLY;
7236 addr->message = US"remote deliveries suppressed";
7237 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7240 /* Handle remote deliveries */
7244 DEBUG(D_deliver|D_transport)
7245 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7247 /* Precompile some regex that are used to recognize parameters in response
7248 to an EHLO command, if they aren't already compiled. */
7250 smtp_deliver_init();
7252 /* Now sort the addresses if required, and do the deliveries. The yield of
7253 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7254 cannot be delivered in one transaction. */
7256 if (remote_sort_domains) sort_remote_deliveries();
7257 if (!do_remote_deliveries(FALSE))
7259 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7260 "be delivered in one transaction");
7261 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7263 final_yield = DELIVER_MUA_FAILED;
7264 addr_failed = addr_defer = NULL; /* So that we remove the message */
7265 goto DELIVERY_TIDYUP;
7268 /* See if any of the addresses that failed got put on the queue for delivery
7269 to their fallback hosts. We do it this way because often the same fallback
7270 host is used for many domains, so all can be sent in a single transaction
7271 (if appropriately configured). */
7273 if (addr_fallback && !mua_wrapper)
7275 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7276 addr_remote = addr_fallback;
7277 addr_fallback = NULL;
7278 if (remote_sort_domains) sort_remote_deliveries();
7279 do_remote_deliveries(TRUE);
7281 f.disable_logging = FALSE;
7285 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7286 phase, to minimize cases of half-done things. */
7289 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7290 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7292 /* Root privilege is no longer needed */
7294 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7296 set_process_info("tidying up after delivering %s", message_id);
7297 signal(SIGTERM, SIG_IGN);
7299 /* When we are acting as an MUA wrapper, the smtp transport will either have
7300 succeeded for all addresses, or failed them all in normal cases. However, there
7301 are some setup situations (e.g. when a named port does not exist) that cause an
7302 immediate exit with deferral of all addresses. Convert those into failures. We
7303 do not ever want to retry, nor do we want to send a bounce message. */
7309 address_item * nextaddr;
7310 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7312 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7313 "delivery", addr->address);
7314 nextaddr = addr->next;
7315 addr->next = addr_failed;
7321 /* Now all should either have succeeded or failed. */
7324 final_yield = DELIVER_MUA_SUCCEEDED;
7328 uschar *s = addr_failed->user_message;
7330 if (!s) s = addr_failed->message;
7332 fprintf(stderr, "Delivery failed: ");
7333 if (addr_failed->basic_errno > 0)
7335 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7336 if (s) fprintf(stderr, ": ");
7338 if ((host = addr_failed->host_used))
7339 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7341 fprintf(stderr, "%s", CS s);
7342 else if (addr_failed->basic_errno <= 0)
7343 fprintf(stderr, "unknown error");
7344 fprintf(stderr, "\n");
7346 final_yield = DELIVER_MUA_FAILED;
7351 /* In a normal configuration, we now update the retry database. This is done in
7352 one fell swoop at the end in order not to keep opening and closing (and
7353 locking) the database. The code for handling retries is hived off into a
7354 separate module for convenience. We pass it the addresses of the various
7355 chains, because deferred addresses can get moved onto the failed chain if the
7356 retry cutoff time has expired for all alternative destinations. Bypass the
7357 updating of the database if the -N flag is set, which is a debugging thing that
7358 prevents actual delivery. */
7360 else if (!f.dont_deliver)
7361 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7363 /* Send DSN for successful messages if requested */
7364 addr_senddsn = NULL;
7366 for (address_item * a = addr_succeed; a; a = a->next)
7368 /* af_ignore_error not honored here. it's not an error */
7369 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7370 "DSN: processing successful delivery address: %s\n"
7371 "DSN: Sender_address: %s\n"
7372 "DSN: orcpt: %s flags: 0x%x\n"
7373 "DSN: envid: %s ret: %d\n"
7374 "DSN: Final recipient: %s\n"
7375 "DSN: Remote SMTP server supports DSN: %d\n",
7376 a->router ? a->router->name : US"(unknown)",
7379 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7381 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7386 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7387 and a report was requested */
7389 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7390 && a->dsn_flags & rf_notify_success
7393 /* copy and relink address_item and send report with all of them at once later */
7394 address_item * addr_next = addr_senddsn;
7395 addr_senddsn = store_get(sizeof(address_item), FALSE);
7397 addr_senddsn->next = addr_next;
7400 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7408 /* create exim process to send message */
7409 pid = child_open_exim(&fd, US"DSN");
7411 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7413 if (pid < 0) /* Creation of child failed */
7415 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7416 "create child process to send success-dsn message: %s", getpid(),
7417 getppid(), strerror(errno));
7419 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7421 else /* Creation of child succeeded */
7423 FILE * f = fdopen(fd, "wb");
7424 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7426 transport_ctx tctx = {{0}};
7429 debug_printf("sending success-dsn to: %s\n", sender_address);
7431 /* build unique id for MIME boundary */
7432 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7433 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7435 if (errors_reply_to)
7436 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7439 fprintf(f, "Auto-Submitted: auto-generated\n"
7441 "Subject: Delivery Status Notification\n",
7443 moan_write_references(f, NULL);
7444 fprintf(f, "Content-Type: multipart/report;"
7445 " report-type=delivery-status; boundary=%s\n"
7446 "MIME-Version: 1.0\n\n"
7449 "Content-type: text/plain; charset=us-ascii\n\n"
7451 "This message was created automatically by mail delivery software.\n"
7452 " ----- The following addresses had successful delivery notifications -----\n",
7455 for (address_item * a = addr_senddsn; a; a = a->next)
7456 fprintf(f, "<%s> (relayed %s)\n\n",
7458 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7459 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7460 : "via non \"Remote SMTP\" router"
7464 "Content-type: message/delivery-status\n\n"
7465 "Reporting-MTA: dns; %s\n",
7466 bound, smtp_active_hostname);
7469 { /* must be decoded from xtext: see RFC 3461:6.3a */
7471 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7472 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7474 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7478 for (address_item * a = addr_senddsn; a; a = a->next)
7482 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7484 if ((hu = a->host_used) && hu->name)
7485 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7488 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7489 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7492 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7495 transport_filter_argv = NULL; /* Just in case */
7496 return_path = sender_address; /* In case not previously set */
7498 /* Write the original email out */
7501 tctx.options = topt_add_return_path | topt_no_body;
7502 /*XXX hmm, FALSE(fail) retval ignored.
7503 Could error for any number of reasons, and they are not handled. */
7504 transport_write_message(&tctx, 0);
7507 fprintf(f,"\n--%s--\n", bound);
7511 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7515 /* If any addresses failed, we must send a message to somebody, unless
7516 af_ignore_error is set, in which case no action is taken. It is possible for
7517 several messages to get sent if there are addresses with different
7524 uschar *logtod = tod_stamp(tod_log);
7526 address_item *handled_addr = NULL;
7527 address_item **paddr;
7528 address_item *msgchain = NULL;
7529 address_item **pmsgchain = &msgchain;
7531 /* There are weird cases when logging is disabled in the transport. However,
7532 there may not be a transport (address failed by a router). */
7534 f.disable_logging = FALSE;
7535 if (addr_failed->transport)
7536 f.disable_logging = addr_failed->transport->disable_logging;
7539 debug_printf("processing failed address %s\n", addr_failed->address);
7541 /* There are only two ways an address in a bounce message can get here:
7543 (1) When delivery was initially deferred, but has now timed out (in the call
7544 to retry_update() above). We can detect this by testing for
7545 af_retry_timedout. If the address does not have its own errors address,
7546 we arrange to ignore the error.
7548 (2) If delivery failures for bounce messages are being ignored. We can detect
7549 this by testing for af_ignore_error. This will also be set if a bounce
7550 message has been autothawed and the ignore_bounce_errors_after time has
7551 passed. It might also be set if a router was explicitly configured to
7552 ignore errors (errors_to = "").
7554 If neither of these cases obtains, something has gone wrong. Log the
7555 incident, but then ignore the error. */
7557 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7559 if ( !testflag(addr_failed, af_retry_timedout)
7560 && !addr_failed->prop.ignore_error)
7561 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7562 "failure is neither frozen nor ignored (it's been ignored)");
7564 addr_failed->prop.ignore_error = TRUE;
7567 /* If the first address on the list has af_ignore_error set, just remove
7568 it from the list, throw away any saved message file, log it, and
7569 mark the recipient done. */
7571 if ( addr_failed->prop.ignore_error
7572 || addr_failed->dsn_flags & rf_dsnflags
7573 && !(addr_failed->dsn_flags & rf_notify_failure)
7577 addr_failed = addr->next;
7578 if (addr->return_filename) Uunlink(addr->return_filename);
7580 #ifndef DISABLE_EVENT
7581 msg_event_raise(US"msg:fail:delivery", addr);
7583 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7585 !addr->parent ? US"" : US" <",
7586 !addr->parent ? US"" : addr->parent->address,
7587 !addr->parent ? US"" : US">",
7588 addr->prop.ignore_error
7589 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7591 address_done(addr, logtod);
7592 child_done(addr, logtod);
7593 /* Panic-dies on error */
7594 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7597 /* Otherwise, handle the sending of a message. Find the error address for
7598 the first address, then send a message that includes all failed addresses
7599 that have the same error address. Note the bounce_recipient is a global so
7600 that it can be accessed by $bounce_recipient while creating a customized
7605 if (!(bounce_recipient = addr_failed->prop.errors_address))
7606 bounce_recipient = sender_address;
7608 /* Make a subprocess to send a message */
7610 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7611 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7612 "create child process to send failure message: %s", getpid(),
7613 getppid(), strerror(errno));
7615 /* Creation of child succeeded */
7622 uschar *bcc, *emf_text;
7623 FILE * fp = fdopen(fd, "wb");
7625 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7626 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7627 DELIVER_IN_BUFFER_SIZE;
7629 uschar *dsnlimitmsg;
7630 uschar *dsnnotifyhdr;
7634 debug_printf("sending error message to: %s\n", bounce_recipient);
7636 /* Scan the addresses for all that have the same errors address, removing
7637 them from the addr_failed chain, and putting them on msgchain. */
7639 paddr = &addr_failed;
7640 for (addr = addr_failed; addr; addr = *paddr)
7641 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7642 ? addr->prop.errors_address : sender_address) == 0)
7643 { /* The same - dechain */
7644 *paddr = addr->next;
7647 pmsgchain = &(addr->next);
7650 paddr = &addr->next; /* Not the same; skip */
7652 /* Include X-Failed-Recipients: for automatic interpretation, but do
7653 not let any one header line get too long. We do this by starting a
7654 new header every 50 recipients. Omit any addresses for which the
7655 "hide_child" flag is set. */
7657 for (addr = msgchain; addr; addr = addr->next)
7659 if (testflag(addr, af_hide_child)) continue;
7667 ? "X-Failed-Recipients: "
7669 testflag(addr, af_pfr) && addr->parent
7670 ? string_printing(addr->parent->address)
7671 : string_printing(addr->address));
7673 if (rcount > 0) fprintf(fp, "\n");
7675 /* Output the standard headers */
7677 if (errors_reply_to)
7678 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7679 fprintf(fp, "Auto-Submitted: auto-replied\n");
7680 moan_write_from(fp);
7681 fprintf(fp, "To: %s\n", bounce_recipient);
7682 moan_write_references(fp, NULL);
7684 /* generate boundary string and output MIME-Headers */
7685 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7687 fprintf(fp, "Content-Type: multipart/report;"
7688 " report-type=delivery-status; boundary=%s\n"
7689 "MIME-Version: 1.0\n",
7692 /* Open a template file if one is provided. Log failure to open, but
7693 carry on - default texts will be used. */
7695 if (bounce_message_file)
7696 emf = expand_open(bounce_message_file,
7697 US"bounce_message_file", US"error");
7699 /* Quietly copy to configured additional addresses if required. */
7701 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7702 fprintf(fp, "Bcc: %s\n", bcc);
7704 /* The texts for the message can be read from a template file; if there
7705 isn't one, or if it is too short, built-in texts are used. The first
7706 emf text is a Subject: and any other headers. */
7708 if ((emf_text = next_emf(emf, US"header")))
7709 fprintf(fp, "%s\n", emf_text);
7711 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7712 to_sender? ": returning message to sender" : "");
7714 /* output human readable part as text/plain section */
7715 fprintf(fp, "--%s\n"
7716 "Content-type: text/plain; charset=us-ascii\n\n",
7719 if ((emf_text = next_emf(emf, US"intro")))
7720 fprintf(fp, "%s", CS emf_text);
7724 /* This message has been reworded several times. It seems to be confusing to
7725 somebody, however it is worded. I have retreated to the original, simple
7727 "This message was created automatically by mail delivery software.\n");
7729 if (bounce_message_text)
7730 fprintf(fp, "%s", CS bounce_message_text);
7733 "\nA message that you sent could not be delivered to one or more of its\n"
7734 "recipients. This is a permanent error. The following address(es) failed:\n");
7737 "\nA message sent by\n\n <%s>\n\n"
7738 "could not be delivered to one or more of its recipients. The following\n"
7739 "address(es) failed:\n", sender_address);
7743 /* Process the addresses, leaving them on the msgchain if they have a
7744 file name for a return message. (There has already been a check in
7745 post_process_one() for the existence of data in the message file.) A TRUE
7746 return from print_address_information() means that the address is not
7750 for (addr = msgchain; addr; addr = *paddr)
7752 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7753 print_address_error(addr, fp, US"");
7755 /* End the final line for the address */
7759 /* Leave on msgchain if there's a return file. */
7761 if (addr->return_file >= 0)
7763 paddr = &(addr->next);
7767 /* Else save so that we can tick off the recipient when the
7772 *paddr = addr->next;
7773 addr->next = handled_addr;
7774 handled_addr = addr;
7780 /* Get the next text, whether we need it or not, so as to be
7781 positioned for the one after. */
7783 emf_text = next_emf(emf, US"generated text");
7785 /* If there were any file messages passed by the local transports,
7786 include them in the message. Then put the address on the handled chain.
7787 In the case of a batch of addresses that were all sent to the same
7788 transport, the return_file field in all of them will contain the same
7789 fd, and the return_filename field in the *last* one will be set (to the
7790 name of the file). */
7794 address_item *nextaddr;
7797 fprintf(fp, "%s", CS emf_text);
7800 "The following text was generated during the delivery "
7801 "attempt%s:\n", (filecount > 1)? "s" : "");
7803 for (addr = msgchain; addr; addr = nextaddr)
7806 address_item *topaddr = addr;
7808 /* List all the addresses that relate to this file */
7811 while(addr) /* Insurance */
7813 print_address_information(addr, fp, US"------ ", US"\n ",
7815 if (addr->return_filename) break;
7820 /* Now copy the file */
7822 if (!(fm = Ufopen(addr->return_filename, "rb")))
7823 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7827 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7830 Uunlink(addr->return_filename);
7832 /* Can now add to handled chain, first fishing off the next
7833 address on the msgchain. */
7835 nextaddr = addr->next;
7836 addr->next = handled_addr;
7837 handled_addr = topaddr;
7842 /* output machine readable part */
7844 if (message_smtputf8)
7845 fprintf(fp, "--%s\n"
7846 "Content-type: message/global-delivery-status\n\n"
7847 "Reporting-MTA: dns; %s\n",
7848 bound, smtp_active_hostname);
7851 fprintf(fp, "--%s\n"
7852 "Content-type: message/delivery-status\n\n"
7853 "Reporting-MTA: dns; %s\n",
7854 bound, smtp_active_hostname);
7858 /* must be decoded from xtext: see RFC 3461:6.3a */
7860 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7861 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7863 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7867 for (addr = handled_addr; addr; addr = addr->next)
7871 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7873 if ((hu = addr->host_used) && hu->name)
7875 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7876 #ifdef EXPERIMENTAL_DSN_INFO
7881 uschar * p = hu->port == 25
7882 ? US"" : string_sprintf(":%d", hu->port);
7883 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7885 if ((s = addr->smtp_greeting) && *s)
7886 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %.900s\n", s);
7887 if ((s = addr->helo_response) && *s)
7888 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %.900s\n", s);
7889 if ((s = addr->message) && *s)
7890 fprintf(fp, "X-Exim-Diagnostic: X-str; %.900s\n", s);
7893 print_dsn_diagnostic_code(addr, fp);
7898 /* Now copy the message, trying to give an intelligible comment if
7899 it is too long for it all to be copied. The limit isn't strictly
7900 applied because of the buffering. There is, however, an option
7901 to suppress copying altogether. */
7903 emf_text = next_emf(emf, US"copy");
7906 we ignore the intro text from template and add
7907 the text for bounce_return_size_limit at the end.
7909 bounce_return_message is ignored
7910 in case RET= is defined we honor these values
7911 otherwise bounce_return_body is honored.
7913 bounce_return_size_limit is always honored.
7916 fprintf(fp, "--%s\n", bound);
7918 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7919 dsnnotifyhdr = NULL;
7920 topt = topt_add_return_path;
7922 /* RET=HDRS? top priority */
7923 if (dsn_ret == dsn_ret_hdrs)
7924 topt |= topt_no_body;
7927 struct stat statbuf;
7929 /* no full body return at all? */
7930 if (!bounce_return_body)
7932 topt |= topt_no_body;
7933 /* add header if we overrule RET=FULL */
7934 if (dsn_ret == dsn_ret_full)
7935 dsnnotifyhdr = dsnlimitmsg;
7937 /* line length limited... return headers only if oversize */
7938 /* size limited ... return headers only if limit reached */
7939 else if ( max_received_linelength > bounce_return_linesize_limit
7940 || ( bounce_return_size_limit > 0
7941 && fstat(deliver_datafile, &statbuf) == 0
7942 && statbuf.st_size > max
7945 topt |= topt_no_body;
7946 dsnnotifyhdr = dsnlimitmsg;
7951 if (message_smtputf8)
7952 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7953 : "Content-type: message/global\n\n",
7957 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7958 : "Content-type: message/rfc822\n\n",
7962 transport_filter_argv = NULL; /* Just in case */
7963 return_path = sender_address; /* In case not previously set */
7964 { /* Dummy transport for headers add */
7965 transport_ctx tctx = {{0}};
7966 transport_instance tb = {0};
7968 tctx.u.fd = fileno(fp);
7970 tctx.options = topt;
7971 tb.add_headers = dsnnotifyhdr;
7973 /*XXX no checking for failure! buggy! */
7974 transport_write_message(&tctx, 0);
7978 /* we never add the final text. close the file */
7982 fprintf(fp, "\n--%s--\n", bound);
7984 /* Close the file, which should send an EOF to the child process
7985 that is receiving the message. Wait for it to finish. */
7988 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7990 /* If the process failed, there was some disaster in setting up the
7991 error message. Unless the message is very old, ensure that addr_defer
7992 is non-null, which will have the effect of leaving the message on the
7993 spool. The failed addresses will get tried again next time. However, we
7994 don't really want this to happen too often, so freeze the message unless
7995 there are some genuine deferred addresses to try. To do this we have
7996 to call spool_write_header() here, because with no genuine deferred
7997 addresses the normal code below doesn't get run. */
8002 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
8004 addr_defer = (address_item *)(+1);
8005 f.deliver_freeze = TRUE;
8006 deliver_frozen_at = time(NULL);
8007 /* Panic-dies on error */
8008 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8011 deliver_msglog("Process failed (%d) when writing error message "
8012 "to %s%s", rc, bounce_recipient, s);
8013 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
8014 "to %s%s", rc, bounce_recipient, s);
8017 /* The message succeeded. Ensure that the recipients that failed are
8018 now marked finished with on the spool and their parents updated. */
8022 for (addr = handled_addr; addr; addr = addr->next)
8024 address_done(addr, logtod);
8025 child_done(addr, logtod);
8027 /* Panic-dies on error */
8028 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8034 f.disable_logging = FALSE; /* In case left set */
8036 /* Come here from the mua_wrapper case if routing goes wrong */
8040 /* If there are now no deferred addresses, we are done. Preserve the
8041 message log if so configured, and we are using them. Otherwise, sling it.
8042 Then delete the message itself. */
8050 fname = spool_fname(US"msglog", message_subdir, id, US"");
8051 if (preserve_message_logs)
8054 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8056 if ((rc = Urename(fname, moname)) < 0)
8058 (void)directory_make(spool_directory,
8059 spool_sname(US"msglog.OLD", US""),
8060 MSGLOG_DIRECTORY_MODE, TRUE);
8061 rc = Urename(fname, moname);
8064 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8065 "msglog.OLD directory", fname);
8068 if (Uunlink(fname) < 0)
8069 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8070 fname, strerror(errno));
8073 /* Remove the two message files. */
8075 fname = spool_fname(US"input", message_subdir, id, US"-D");
8076 if (Uunlink(fname) < 0)
8077 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8078 fname, strerror(errno));
8079 fname = spool_fname(US"input", message_subdir, id, US"-H");
8080 if (Uunlink(fname) < 0)
8081 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8082 fname, strerror(errno));
8084 /* Log the end of this message, with queue time if requested. */
8086 if (LOGGING(queue_time_overall))
8087 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8089 log_write(0, LOG_MAIN, "Completed");
8091 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8092 f.deliver_freeze = FALSE;
8094 #ifndef DISABLE_EVENT
8095 (void) event_raise(event_action, US"msg:complete", NULL);
8099 /* If there are deferred addresses, we are keeping this message because it is
8100 not yet completed. Lose any temporary files that were catching output from
8101 pipes for any of the deferred addresses, handle one-time aliases, and see if
8102 the message has been on the queue for so long that it is time to send a warning
8103 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8104 have the same domain, we can set deliver_domain for the expansion of
8105 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8106 the parent's domain.
8108 If all the deferred addresses have an error number that indicates "retry time
8109 not reached", skip sending the warning message, because it won't contain the
8110 reason for the delay. It will get sent at the next real delivery attempt.
8111 Exception: for retries caused by a remote peer we use the error message
8112 store in the retry DB as the reason.
8113 However, if at least one address has tried, we'd better include all of them in
8116 If we can't make a process to send the message, don't worry.
8118 For mailing list expansions we want to send the warning message to the
8119 mailing list manager. We can't do a perfect job here, as some addresses may
8120 have different errors addresses, but if we take the errors address from
8121 each deferred address it will probably be right in most cases.
8123 If addr_defer == +1, it means there was a problem sending an error message
8124 for failed addresses, and there were no "real" deferred addresses. The value
8125 was set just to keep the message on the spool, so there is nothing to do here.
8128 else if (addr_defer != (address_item *)(+1))
8130 uschar *recipients = US"";
8131 BOOL want_warning_msg = FALSE;
8133 deliver_domain = testflag(addr_defer, af_pfr)
8134 ? addr_defer->parent->domain : addr_defer->domain;
8136 for (address_item * addr = addr_defer; addr; addr = addr->next)
8138 address_item *otaddr;
8140 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8144 const uschar *d = testflag(addr, af_pfr)
8145 ? addr->parent->domain : addr->domain;
8147 /* The domain may be unset for an address that has never been routed
8148 because the system filter froze the message. */
8150 if (!d || Ustrcmp(d, deliver_domain) != 0)
8151 deliver_domain = NULL;
8154 if (addr->return_filename) Uunlink(addr->return_filename);
8156 /* Handle the case of one-time aliases. If any address in the ancestry
8157 of this one is flagged, ensure it is in the recipients list, suitably
8158 flagged, and that its parent is marked delivered. */
8160 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8161 if (otaddr->onetime_parent) break;
8166 int t = recipients_count;
8168 for (i = 0; i < recipients_count; i++)
8170 uschar *r = recipients_list[i].address;
8171 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8172 if (Ustrcmp(otaddr->address, r) == 0) break;
8175 /* Didn't find the address already in the list, and did find the
8176 ultimate parent's address in the list, and they really are different
8177 (i.e. not from an identity-redirect). After adding the recipient,
8178 update the errors address in the recipients list. */
8180 if ( i >= recipients_count && t < recipients_count
8181 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8183 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8184 otaddr->address, otaddr->parent->address);
8185 receive_add_recipient(otaddr->address, t);
8186 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8187 tree_add_nonrecipient(otaddr->parent->address);
8188 update_spool = TRUE;
8192 /* Except for error messages, ensure that either the errors address for
8193 this deferred address or, if there is none, the sender address, is on the
8194 list of recipients for a warning message. */
8196 if (sender_address[0])
8198 uschar * s = addr->prop.errors_address;
8199 if (!s) s = sender_address;
8200 if (Ustrstr(recipients, s) == NULL)
8201 recipients = string_sprintf("%s%s%s", recipients,
8202 recipients[0] ? "," : "", s);
8206 /* Send a warning message if the conditions are right. If the condition check
8207 fails because of a lookup defer, there is nothing we can do. The warning
8208 is not sent. Another attempt will be made at the next delivery attempt (if
8211 if ( !f.queue_2stage
8213 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8214 || addr_defer->dsn_flags & rf_notify_delay
8216 && delay_warning[1] > 0
8217 && sender_address[0] != 0
8218 && ( !delay_warning_condition
8219 || expand_check_condition(delay_warning_condition,
8220 US"delay_warning", US"option")
8226 int queue_time = time(NULL) - received_time.tv_sec;
8228 queue_time = test_harness_fudged_queue_time(queue_time);
8230 /* See how many warnings we should have sent by now */
8232 for (count = 0; count < delay_warning[1]; count++)
8233 if (queue_time < delay_warning[count+2]) break;
8235 show_time = delay_warning[count+1];
8237 if (count >= delay_warning[1])
8240 int last_gap = show_time;
8241 if (count > 1) last_gap -= delay_warning[count];
8242 extra = (queue_time - delay_warning[count+1])/last_gap;
8243 show_time += last_gap * extra;
8249 debug_printf("time on queue = %s id %s addr %s\n",
8250 readconf_printtime(queue_time), message_id, addr_defer->address);
8251 debug_printf("warning counts: required %d done %d\n", count,
8255 /* We have computed the number of warnings there should have been by now.
8256 If there haven't been enough, send one, and up the count to what it should
8259 if (warning_count < count)
8263 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8269 FILE * f = fdopen(fd, "wb");
8271 transport_ctx tctx = {{0}};
8273 if (warn_message_file)
8274 wmf = expand_open(warn_message_file,
8275 US"warn_message_file", US"warning");
8277 warnmsg_recipients = recipients;
8278 warnmsg_delay = queue_time < 120*60
8279 ? string_sprintf("%d minutes", show_time/60)
8280 : string_sprintf("%d hours", show_time/3600);
8282 if (errors_reply_to)
8283 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8284 fprintf(f, "Auto-Submitted: auto-replied\n");
8286 fprintf(f, "To: %s\n", recipients);
8287 moan_write_references(f, NULL);
8289 /* generated boundary string and output MIME-Headers */
8290 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8292 fprintf(f, "Content-Type: multipart/report;"
8293 " report-type=delivery-status; boundary=%s\n"
8294 "MIME-Version: 1.0\n",
8297 if ((wmf_text = next_emf(wmf, US"header")))
8298 fprintf(f, "%s\n", wmf_text);
8300 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8301 message_id, warnmsg_delay);
8303 /* output human readable part as text/plain section */
8305 "Content-type: text/plain; charset=us-ascii\n\n",
8308 if ((wmf_text = next_emf(wmf, US"intro")))
8309 fprintf(f, "%s", CS wmf_text);
8313 "This message was created automatically by mail delivery software.\n");
8315 if (Ustrcmp(recipients, sender_address) == 0)
8317 "A message that you sent has not yet been delivered to one or more of its\n"
8318 "recipients after more than ");
8322 "A message sent by\n\n <%s>\n\n"
8323 "has not yet been delivered to one or more of its recipients after more than \n",
8326 fprintf(f, "%s on the queue on %s.\n\n"
8327 "The message identifier is: %s\n",
8328 warnmsg_delay, primary_hostname, message_id);
8330 for (h = header_list; h; h = h->next)
8331 if (strncmpic(h->text, US"Subject:", 8) == 0)
8332 fprintf(f, "The subject of the message is: %s", h->text + 9);
8333 else if (strncmpic(h->text, US"Date:", 5) == 0)
8334 fprintf(f, "The date of the message is: %s", h->text + 6);
8337 fprintf(f, "The address%s to which the message has not yet been "
8339 !addr_defer->next ? "" : "es",
8340 !addr_defer->next ? "is": "are");
8343 /* List the addresses, with error information if allowed */
8346 for (address_item * addr = addr_defer; addr; addr = addr->next)
8348 if (print_address_information(addr, f, US" ", US"\n ", US""))
8349 print_address_error(addr, f, US"Delay reason: ");
8358 if ((wmf_text = next_emf(wmf, US"final")))
8359 fprintf(f, "%s", CS wmf_text);
8365 "No action is required on your part. Delivery attempts will continue for\n"
8366 "some time, and this warning may be repeated at intervals if the message\n"
8367 "remains undelivered. Eventually the mail delivery software will give up,\n"
8368 "and when that happens, the message will be returned to you.\n");
8371 /* output machine readable part */
8372 fprintf(f, "\n--%s\n"
8373 "Content-type: message/delivery-status\n\n"
8374 "Reporting-MTA: dns; %s\n",
8376 smtp_active_hostname);
8381 /* must be decoded from xtext: see RFC 3461:6.3a */
8383 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8384 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8386 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8390 for (address_item * addr = addr_defer; addr; addr = addr->next)
8394 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8396 if ((hu = addr->host_used) && hu->name)
8398 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8399 print_dsn_diagnostic_code(addr, f);
8405 "Content-type: text/rfc822-headers\n\n",
8409 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8410 tctx.u.fd = fileno(f);
8411 tctx.options = topt_add_return_path | topt_no_body;
8412 transport_filter_argv = NULL; /* Just in case */
8413 return_path = sender_address; /* In case not previously set */
8415 /* Write the original email out */
8416 /*XXX no checking for failure! buggy! */
8417 transport_write_message(&tctx, 0);
8420 fprintf(f,"\n--%s--\n", bound);
8424 /* Close and wait for child process to complete, without a timeout.
8425 If there's an error, don't update the count. */
8428 if (child_close(pid, 0) == 0)
8430 warning_count = count;
8431 update_spool = TRUE; /* Ensure spool rewritten */
8437 /* Clear deliver_domain */
8439 deliver_domain = NULL;
8441 /* If this was a first delivery attempt, unset the first time flag, and
8442 ensure that the spool gets updated. */
8444 if (f.deliver_firsttime && !f.queue_2stage)
8446 f.deliver_firsttime = FALSE;
8447 update_spool = TRUE;
8450 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8451 message, unless the message is a local error message (to avoid loops). Then
8452 log the freezing. If the text in "frozen_info" came from a system filter,
8453 it has been escaped into printing characters so as not to mess up log lines.
8454 For the "tell" message, we turn \n back into newline. Also, insert a newline
8455 near the start instead of the ": " string. */
8457 if (f.deliver_freeze)
8459 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8461 uschar *s = string_copy(frozen_info);
8462 uschar *ss = Ustrstr(s, " by the system filter: ");
8473 if (*ss == '\\' && ss[1] == 'n')
8480 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8481 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8485 /* Log freezing just before we update the -H file, to minimize the chance
8486 of a race problem. */
8488 deliver_msglog("*** Frozen%s\n", frozen_info);
8489 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8492 /* If there have been any updates to the non-recipients list, or other things
8493 that get written to the spool, we must now update the spool header file so
8494 that it has the right information for the next delivery attempt. If there
8495 was more than one address being delivered, the header_change update is done
8496 earlier, in case one succeeds and then something crashes. */
8499 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8500 update_spool, f.header_rewritten);
8502 if (update_spool || f.header_rewritten)
8503 /* Panic-dies on error */
8504 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8507 /* Finished with the message log. If the message is complete, it will have
8508 been unlinked or renamed above. */
8510 if (message_logs) (void)fclose(message_log);
8512 /* Now we can close and remove the journal file. Its only purpose is to record
8513 successfully completed deliveries asap so that this information doesn't get
8514 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8515 not serious, as trying it again is not harmful. The journal might not be open
8516 if all addresses were deferred at routing or directing. Nevertheless, we must
8517 remove it if it exists (may have been lying around from a crash during the
8518 previous delivery attempt). We don't remove the journal if a delivery
8519 subprocess failed to pass back delivery information; this is controlled by
8520 the remove_journal flag. When the journal is left, we also don't move the
8521 message off the main spool if frozen and the option is set. It should get moved
8522 at the next attempt, after the journal has been inspected. */
8524 if (journal_fd >= 0) (void)close(journal_fd);
8528 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8530 if (Uunlink(fname) < 0 && errno != ENOENT)
8531 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8534 /* Move the message off the spool if requested */
8536 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8537 if (f.deliver_freeze && move_frozen_messages)
8538 (void)spool_move_message(id, message_subdir, US"", US"F");
8542 /* Closing the data file frees the lock; if the file has been unlinked it
8543 will go away. Otherwise the message becomes available for another process
8546 (void)close(deliver_datafile);
8547 deliver_datafile = -1;
8548 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8549 #ifdef MEASURE_TIMING
8550 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8553 /* It is unlikely that there will be any cached resources, since they are
8554 released after routing, and in the delivery subprocesses. However, it's
8555 possible for an expansion for something afterwards (for example,
8556 expand_check_condition) to do a lookup. We must therefore be sure everything is
8560 acl_where = ACL_WHERE_UNKNOWN;
8569 #ifdef EXIM_TFO_PROBE
8572 f.tcp_fastopen_ok = TRUE;
8578 /* Called from a commandline, or from the daemon, to do a delivery.
8579 We need to regain privs; do this by exec of the exim binary. */
8582 delivery_re_exec(int exec_type)
8586 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8588 int channel_fd = cutthrough.cctx.sock;
8590 smtp_peer_options = cutthrough.peer_options;
8591 continue_sequence = 0;
8594 if (cutthrough.is_tls)
8598 smtp_peer_options |= OPTION_TLS;
8599 sending_ip_address = cutthrough.snd_ip;
8600 sending_port = cutthrough.snd_port;
8602 where = US"socketpair";
8603 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8607 testharness_pause_ms(150);
8608 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8611 if (pid == 0) /* child: will fork again to totally disconnect */
8613 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8615 /* does not return */
8619 waitpid(pid, NULL, 0);
8620 (void) close(channel_fd); /* release the client socket */
8621 channel_fd = pfd[1];
8625 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8626 cutthrough.host.address, message_id, channel_fd);
8630 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8631 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8633 return; /* compiler quietening; control does not reach here. */
8638 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8639 "delivery re-exec %s failed: %s", where, strerror(errno));
8641 /* Get here if exec_type == CEE_EXEC_EXIT.
8642 Note: this must be _exit(), not exit(). */
8644 _exit(EX_EXECFAILED);
8650 /* End of deliver.c */