1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* The main code for delivering a message. */
14 #include "transports/smtp.h"
19 /* Data block for keeping track of subprocesses for parallel remote
22 typedef struct pardata {
23 address_item *addrlist; /* chain of addresses */
24 address_item *addr; /* next address data expected for */
25 pid_t pid; /* subprocess pid */
26 int fd; /* pipe fd for getting result from subprocess */
27 int transport_count; /* returned transport count value */
28 BOOL done; /* no more data needed */
29 uschar *msg; /* error message */
30 uschar *return_path; /* return_path for these addresses */
33 /* Values for the process_recipients variable */
35 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
36 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
39 /* Mutually recursive functions for marking addresses done. */
41 static void child_done(address_item *, uschar *);
42 static void address_done(address_item *, uschar *);
44 /* Table for turning base-62 numbers into binary */
46 static uschar tab62[] =
47 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
48 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
49 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
50 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
51 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
52 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
56 /*************************************************
57 * Local static variables *
58 *************************************************/
60 /* addr_duplicate is global because it needs to be seen from the Envelope-To
63 static address_item *addr_defer = NULL;
64 static address_item *addr_failed = NULL;
65 static address_item *addr_fallback = NULL;
66 static address_item *addr_local = NULL;
67 static address_item *addr_new = NULL;
68 static address_item *addr_remote = NULL;
69 static address_item *addr_route = NULL;
70 static address_item *addr_succeed = NULL;
71 static address_item *addr_senddsn = NULL;
73 static FILE *message_log = NULL;
74 static BOOL update_spool;
75 static BOOL remove_journal;
76 static int parcount = 0;
77 static pardata *parlist = NULL;
78 static struct pollfd *parpoll;
79 static int return_count;
80 static uschar *frozen_info = US"";
81 static uschar *used_return_path = NULL;
85 /*************************************************
86 * read as much as requested *
87 *************************************************/
89 /* The syscall read(2) doesn't always returns as much as we want. For
90 several reasons it might get less. (Not talking about signals, as syscalls
91 are restartable). When reading from a network or pipe connection the sender
92 might send in smaller chunks, with delays between these chunks. The read(2)
93 may return such a chunk.
95 The more the writer writes and the smaller the pipe between write and read is,
96 the more we get the chance of reading leass than requested. (See bug 2130)
98 This function read(2)s until we got all the data we *requested*.
100 Note: This function may block. Use it only if you're sure about the
101 amount of data you will get.
104 fd the file descriptor to read from
105 buffer pointer to a buffer of size len
106 len the requested(!) amount of bytes
108 Returns: the amount of bytes read
111 readn(int fd, void * buffer, size_t len)
113 uschar * next = buffer;
114 uschar * end = next + len;
118 ssize_t got = read(fd, next, end - next);
120 /* I'm not sure if there are signals that can interrupt us,
121 for now I assume the worst */
122 if (got == -1 && errno == EINTR) continue;
123 if (got <= 0) return next - US buffer;
131 /*************************************************
132 * Make a new address item *
133 *************************************************/
135 /* This function gets the store and initializes with default values. The
136 transport_return value defaults to DEFER, so that any unexpected failure to
137 deliver does not wipe out the message. The default unique string is set to a
138 copy of the address, so that its domain can be lowercased.
141 address the RFC822 address string
142 copy force a copy of the address
144 Returns: a pointer to an initialized address_item
148 deliver_make_addr(uschar *address, BOOL copy)
150 address_item * addr = store_get(sizeof(address_item), GET_UNTAINTED);
151 *addr = address_defaults;
152 if (copy) address = string_copy(address);
153 addr->address = address;
154 addr->unique = string_copy(address);
161 /*************************************************
162 * Set expansion values for an address *
163 *************************************************/
165 /* Certain expansion variables are valid only when handling an address or
166 address list. This function sets them up or clears the values, according to its
170 addr the address in question, or NULL to clear values
175 deliver_set_expansions(address_item *addr)
179 const uschar ***p = address_expansions;
180 while (*p) **p++ = NULL;
184 /* Exactly what gets set depends on whether there is one or more addresses, and
185 what they contain. These first ones are always set, taking their values from
186 the first address. */
188 if (!addr->host_list)
190 deliver_host = deliver_host_address = US"";
191 deliver_host_port = 0;
195 deliver_host = addr->host_list->name;
196 deliver_host_address = addr->host_list->address;
197 deliver_host_port = addr->host_list->port;
200 deliver_recipients = addr;
201 deliver_address_data = addr->prop.address_data;
202 deliver_domain_data = addr->prop.domain_data;
203 deliver_localpart_data = addr->prop.localpart_data;
204 router_var = addr->prop.variables;
206 /* These may be unset for multiple addresses */
208 deliver_domain = addr->domain;
209 self_hostname = addr->self_hostname;
211 #ifdef EXPERIMENTAL_BRIGHTMAIL
212 bmi_deliver = 1; /* deliver by default */
213 bmi_alt_location = NULL;
214 bmi_base64_verdict = NULL;
215 bmi_base64_tracker_verdict = NULL;
218 /* If there's only one address we can set everything. */
222 address_item *addr_orig;
224 deliver_localpart = addr->local_part;
225 deliver_localpart_prefix = addr->prefix;
226 deliver_localpart_prefix_v = addr->prefix_v;
227 deliver_localpart_suffix = addr->suffix;
228 deliver_localpart_suffix_v = addr->suffix_v;
230 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
231 deliver_domain_orig = addr_orig->domain;
233 /* Re-instate any prefix and suffix in the original local part. In all
234 normal cases, the address will have a router associated with it, and we can
235 choose the caseful or caseless version accordingly. However, when a system
236 filter sets up a pipe, file, or autoreply delivery, no router is involved.
237 In this case, though, there won't be any prefix or suffix to worry about. */
239 deliver_localpart_orig = !addr_orig->router
240 ? addr_orig->local_part
241 : addr_orig->router->caseful_local_part
242 ? addr_orig->cc_local_part
243 : addr_orig->lc_local_part;
245 /* If there's a parent, make its domain and local part available, and if
246 delivering to a pipe or file, or sending an autoreply, get the local
247 part from the parent. For pipes and files, put the pipe or file string
248 into address_pipe and address_file. */
252 deliver_domain_parent = addr->parent->domain;
253 deliver_localpart_parent = !addr->parent->router
254 ? addr->parent->local_part
255 : addr->parent->router->caseful_local_part
256 ? addr->parent->cc_local_part
257 : addr->parent->lc_local_part;
259 /* File deliveries have their own flag because they need to be picked out
260 as special more often. */
262 if (testflag(addr, af_pfr))
264 if (testflag(addr, af_file)) address_file = addr->local_part;
265 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
266 deliver_localpart = addr->parent->local_part;
267 deliver_localpart_prefix = addr->parent->prefix;
268 deliver_localpart_prefix_v = addr->parent->prefix_v;
269 deliver_localpart_suffix = addr->parent->suffix;
270 deliver_localpart_suffix_v = addr->parent->suffix_v;
274 #ifdef EXPERIMENTAL_BRIGHTMAIL
275 /* Set expansion variables related to Brightmail AntiSpam */
276 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
277 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
278 /* get message delivery status (0 - don't deliver | 1 - deliver) */
279 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
280 /* if message is to be delivered, get eventual alternate location */
281 if (bmi_deliver == 1)
282 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
287 /* For multiple addresses, don't set local part, and leave the domain and
288 self_hostname set only if it is the same for all of them. It is possible to
289 have multiple pipe and file addresses, but only when all addresses have routed
290 to the same pipe or file. */
294 if (testflag(addr, af_pfr))
296 if (testflag(addr, af_file)) address_file = addr->local_part;
297 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
299 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
301 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
302 deliver_domain = NULL;
304 && ( !addr2->self_hostname
305 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
307 self_hostname = NULL;
308 if (!deliver_domain && !self_hostname) break;
316 /*************************************************
317 * Open a msglog file *
318 *************************************************/
320 /* This function is used both for normal message logs, and for files in the
321 msglog directory that are used to catch output from pipes. Try to create the
322 directory if it does not exist. From release 4.21, normal message logs should
323 be created when the message is received.
325 Called from deliver_message(), can be operating as root.
328 filename the file name
329 mode the mode required
330 error used for saying what failed
332 Returns: a file descriptor, or -1 (with errno set)
336 open_msglog_file(uschar *filename, int mode, uschar **error)
338 if (Ustrstr(filename, US"/../"))
339 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
340 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
342 for (int i = 2; i > 0; i--)
344 int fd = Uopen(filename,
345 EXIM_CLOEXEC | EXIM_NOFOLLOW | O_WRONLY|O_APPEND|O_CREAT, mode);
348 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
349 function is called as root). Double check the mode, because the group setting
350 doesn't always get set automatically. */
353 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
355 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
360 if (fchmod(fd, mode) < 0)
370 (void)directory_make(spool_directory,
371 spool_sname(US"msglog", message_subdir),
372 MSGLOG_DIRECTORY_MODE, TRUE);
375 *error = US"create or open";
382 /*************************************************
383 * Write to msglog if required *
384 *************************************************/
386 /* Write to the message log, if configured. This function may also be called
390 format a string format
396 deliver_msglog(const char *format, ...)
399 if (!message_logs) return;
400 va_start(ap, format);
401 vfprintf(message_log, format, ap);
409 /*************************************************
410 * Replicate status for batch *
411 *************************************************/
413 /* When a transport handles a batch of addresses, it may treat them
414 individually, or it may just put the status in the first one, and return FALSE,
415 requesting that the status be copied to all the others externally. This is the
416 replication function. As well as the status, it copies the transport pointer,
417 which may have changed if appendfile passed the addresses on to a different
420 Argument: pointer to the first address in a chain
425 replicate_status(address_item *addr)
427 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
429 addr2->transport = addr->transport;
430 addr2->transport_return = addr->transport_return;
431 addr2->basic_errno = addr->basic_errno;
432 addr2->more_errno = addr->more_errno;
433 addr2->delivery_time = addr->delivery_time;
434 addr2->special_action = addr->special_action;
435 addr2->message = addr->message;
436 addr2->user_message = addr->user_message;
442 /*************************************************
443 * Compare lists of hosts *
444 *************************************************/
446 /* This function is given two pointers to chains of host items, and it yields
447 TRUE if the lists refer to the same hosts in the same order, except that
449 (1) Multiple hosts with the same non-negative MX values are permitted to appear
450 in different orders. Round-robinning nameservers can cause this to happen.
452 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
453 permitted to appear in different orders. This is caused by randomizing
456 This enables Exim to use a single SMTP transaction for sending to two entirely
457 different domains that happen to end up pointing at the same hosts.
459 We do not try to batch up different A-record host names that refer to the
463 one points to the first host list
464 two points to the second host list
466 Returns: TRUE if the lists refer to the same host set
470 same_hosts(host_item *one, host_item *two)
474 if (Ustrcmp(one->name, two->name) != 0)
477 host_item *end_one = one;
478 host_item *end_two = two;
480 /* Batch up only if there was no MX and the list was not randomized */
482 if (mx == MX_NONE) return FALSE;
484 /* Find the ends of the shortest sequence of identical MX values */
486 while ( end_one->next && end_one->next->mx == mx
487 && end_two->next && end_two->next->mx == mx)
489 end_one = end_one->next;
490 end_two = end_two->next;
493 /* If there aren't any duplicates, there's no match. */
495 if (end_one == one) return FALSE;
497 /* For each host in the 'one' sequence, check that it appears in the 'two'
498 sequence, returning FALSE if not. */
503 for (hi = two; hi != end_two->next; hi = hi->next)
504 if (Ustrcmp(one->name, hi->name) == 0) break;
505 if (hi == end_two->next) return FALSE;
506 if (one == end_one) break;
510 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
511 Ensure both are pointing at the last host, and carry on as for equality. */
516 /* if the names matched but ports do not, mismatch */
517 else if (one->port != two->port)
521 /* DNSSEC equality */
522 if (one->dnssec != two->dnssec) return FALSE;
530 /* True if both are NULL */
537 /*************************************************
538 * Compare header lines *
539 *************************************************/
541 /* This function is given two pointers to chains of header items, and it yields
542 TRUE if they are the same header texts in the same order.
545 one points to the first header list
546 two points to the second header list
548 Returns: TRUE if the lists refer to the same header set
552 same_headers(header_line *one, header_line *two)
554 for (;; one = one->next, two = two->next)
556 if (one == two) return TRUE; /* Includes the case where both NULL */
557 if (!one || !two) return FALSE;
558 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
564 /*************************************************
565 * Compare string settings *
566 *************************************************/
568 /* This function is given two pointers to strings, and it returns
569 TRUE if they are the same pointer, or if the two strings are the same.
572 one points to the first string
573 two points to the second string
575 Returns: TRUE or FALSE
579 same_strings(uschar *one, uschar *two)
581 if (one == two) return TRUE; /* Includes the case where both NULL */
582 if (!one || !two) return FALSE;
583 return (Ustrcmp(one, two) == 0);
588 /*************************************************
589 * Compare uid/gid for addresses *
590 *************************************************/
592 /* This function is given a transport and two addresses. It yields TRUE if the
593 uid/gid/initgroups settings for the two addresses are going to be the same when
598 addr1 the first address
599 addr2 the second address
601 Returns: TRUE or FALSE
605 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
607 if ( !tp->uid_set && !tp->expand_uid
608 && !tp->deliver_as_creator
609 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
610 || ( testflag(addr1, af_uid_set)
611 && ( addr1->uid != addr2->uid
612 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
616 if ( !tp->gid_set && !tp->expand_gid
617 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
618 || ( testflag(addr1, af_gid_set)
619 && addr1->gid != addr2->gid
629 /*************************************************
630 * Record that an address is complete *
631 *************************************************/
633 /* This function records that an address is complete. This is straightforward
634 for most addresses, where the unique address is just the full address with the
635 domain lower cased. For homonyms (addresses that are the same as one of their
636 ancestors) their are complications. Their unique addresses have \x\ prepended
637 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
640 Exim used to record the unique addresses of homonyms as "complete". This,
641 however, fails when the pattern of redirection varies over time (e.g. if taking
642 unseen copies at only some times of day) because the prepended numbers may vary
643 from one delivery run to the next. This problem is solved by never recording
644 prepended unique addresses as complete. Instead, when a homonymic address has
645 actually been delivered via a transport, we record its basic unique address
646 followed by the name of the transport. This is checked in subsequent delivery
647 runs whenever an address is routed to a transport.
649 If the completed address is a top-level one (has no parent, which means it
650 cannot be homonymic) we also add the original address to the non-recipients
651 tree, so that it gets recorded in the spool file and therefore appears as
652 "done" in any spool listings. The original address may differ from the unique
653 address in the case of the domain.
655 Finally, this function scans the list of duplicates, marks as done any that
656 match this address, and calls child_done() for their ancestors.
659 addr address item that has been completed
660 now current time as a string
666 address_done(address_item *addr, uschar *now)
668 update_spool = TRUE; /* Ensure spool gets updated */
670 /* Top-level address */
674 tree_add_nonrecipient(addr->unique);
675 tree_add_nonrecipient(addr->address);
678 /* Homonymous child address */
680 else if (testflag(addr, af_homonym))
683 tree_add_nonrecipient(
684 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
687 /* Non-homonymous child address */
689 else tree_add_nonrecipient(addr->unique);
691 /* Check the list of duplicate addresses and ensure they are now marked
694 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
695 if (Ustrcmp(addr->unique, dup->unique) == 0)
697 tree_add_nonrecipient(dup->unique);
698 child_done(dup, now);
705 /*************************************************
706 * Decrease counts in parents and mark done *
707 *************************************************/
709 /* This function is called when an address is complete. If there is a parent
710 address, its count of children is decremented. If there are still other
711 children outstanding, the function exits. Otherwise, if the count has become
712 zero, address_done() is called to mark the parent and its duplicates complete.
713 Then loop for any earlier ancestors.
716 addr points to the completed address item
717 now the current time as a string, for writing to the message log
723 child_done(address_item *addr, uschar *now)
730 if (--addr->child_count > 0) return; /* Incomplete parent */
731 address_done(addr, now);
733 /* Log the completion of all descendents only when there is no ancestor with
734 the same original address. */
736 for (aa = addr->parent; aa; aa = aa->parent)
737 if (Ustrcmp(aa->address, addr->address) == 0) break;
740 deliver_msglog("%s %s: children all complete\n", now, addr->address);
741 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
747 /*************************************************
748 * Delivery logging support functions *
749 *************************************************/
751 /* The LOGGING() checks in d_log_interface() are complicated for backwards
752 compatibility. When outgoing interface logging was originally added, it was
753 conditional on just incoming_interface (which is off by default). The
754 outgoing_interface option is on by default to preserve this behaviour, but
755 you can enable incoming_interface and disable outgoing_interface to get I=
756 fields on incoming lines only.
760 addr The address to be logged
762 Returns: New value for s
766 d_log_interface(gstring * g)
768 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
769 && sending_ip_address)
771 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
772 if (LOGGING(outgoing_port))
773 g = string_fmt_append(g, ":%d", sending_port);
781 d_hostlog(gstring * g, address_item * addr)
783 host_item * h = addr->host_used;
785 g = string_append(g, 2, US" H=", h->name);
787 if (LOGGING(dnssec) && h->dnssec == DS_YES)
788 g = string_catn(g, US" DS", 3);
790 g = string_append(g, 3, US" [", h->address, US"]");
792 if (LOGGING(outgoing_port))
793 g = string_fmt_append(g, ":%d", h->port);
795 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
796 g = string_catn(g, US"*", 1);
799 if (LOGGING(proxy) && proxy_local_address)
801 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
802 if (LOGGING(outgoing_port))
803 g = string_fmt_append(g, ":%d", proxy_local_port);
807 g = d_log_interface(g);
809 if (testflag(addr, af_tcp_fastopen))
810 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
821 d_tlslog(gstring * g, address_item * addr)
823 if (LOGGING(tls_cipher) && addr->cipher)
825 g = string_append(g, 2, US" X=", addr->cipher);
826 #ifndef DISABLE_TLS_RESUME
827 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
828 g = string_catn(g, US"*", 1);
831 if (LOGGING(tls_certificate_verified) && addr->cipher)
832 g = string_append(g, 2, US" CV=",
833 testflag(addr, af_cert_verified)
836 testflag(addr, af_dane_verified)
842 if (LOGGING(tls_peerdn) && addr->peerdn)
843 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
851 #ifndef DISABLE_EVENT
852 /* Distribute a named event to any listeners.
854 Args: action config option specifying listener
855 event name of the event
856 ev_data associated data for the event
857 errnop pointer to errno for modification, or null
859 Return: string expansion from listener, or NULL
863 event_raise(uschar * action, const uschar * event, uschar * ev_data, int * errnop)
869 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
871 action, deliver_host_address);
874 event_data = ev_data;
876 if (!(s = expand_string(action)) && *expand_string_message)
877 log_write(0, LOG_MAIN|LOG_PANIC,
878 "failed to expand event_action %s in %s: %s\n",
879 event, transport_name ? transport_name : US"main", expand_string_message);
881 event_name = event_data = NULL;
883 /* If the expansion returns anything but an empty string, flag for
884 the caller to modify his normal processing
889 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
891 *errnop = ERRNO_EVENT;
899 msg_event_raise(const uschar * event, const address_item * addr)
901 const uschar * save_domain = deliver_domain;
902 uschar * save_local = deliver_localpart;
903 const uschar * save_host = deliver_host;
904 const uschar * save_address = deliver_host_address;
905 const int save_port = deliver_host_port;
907 router_name = addr->router ? addr->router->name : NULL;
908 deliver_domain = addr->domain;
909 deliver_localpart = addr->local_part;
910 deliver_host = addr->host_used ? addr->host_used->name : NULL;
912 if (!addr->transport)
914 if (Ustrcmp(event, "msg:fail:delivery") == 0)
916 /* An address failed with no transport involved. This happens when
917 a filter was used which triggered a fail command (in such a case
918 a transport isn't needed). Convert it to an internal fail event. */
920 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
925 transport_name = addr->transport->name;
927 (void) event_raise(addr->transport->event_action, event,
929 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
930 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
931 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
932 ? addr->message : NULL,
936 deliver_host_port = save_port;
937 deliver_host_address = save_address;
938 deliver_host = save_host;
939 deliver_localpart = save_local;
940 deliver_domain = save_domain;
941 router_name = transport_name = NULL;
943 #endif /*DISABLE_EVENT*/
947 /******************************************************************************/
950 /*************************************************
951 * Generate local part for logging *
952 *************************************************/
955 string_get_lpart_sub(const address_item * addr, uschar * s)
958 if (testflag(addr, af_utf8_downcvt))
960 uschar * t = string_localpart_utf8_to_alabel(s, NULL);
961 return t ? t : s; /* t is NULL on a failed conversion */
967 /* This function is a subroutine for use in string_log_address() below.
970 addr the address being logged
971 yield the current dynamic buffer pointer
973 Returns: the new value of the buffer pointer
977 string_get_localpart(address_item * addr, gstring * yield)
981 if (testflag(addr, af_include_affixes) && (s = addr->prefix))
982 yield = string_cat(yield, string_get_lpart_sub(addr, s));
984 yield = string_cat(yield, string_get_lpart_sub(addr, addr->local_part));
986 if (testflag(addr, af_include_affixes) && (s = addr->suffix))
987 yield = string_cat(yield, string_get_lpart_sub(addr, s));
993 /*************************************************
994 * Generate log address list *
995 *************************************************/
997 /* This function generates a list consisting of an address and its parents, for
998 use in logging lines. For saved onetime aliased addresses, the onetime parent
999 field is used. If the address was delivered by a transport with rcpt_include_
1000 affixes set, the af_include_affixes bit will be set in the address. In that
1001 case, we include the affixes here too.
1004 g points to growing-string struct
1005 addr bottom (ultimate) address
1006 all_parents if TRUE, include all parents
1007 success TRUE for successful delivery
1009 Returns: a growable string in dynamic store
1013 string_log_address(gstring * g,
1014 address_item *addr, BOOL all_parents, BOOL success)
1016 BOOL add_topaddr = TRUE;
1017 address_item *topaddr;
1019 /* Find the ultimate parent */
1021 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1023 /* We start with just the local part for pipe, file, and reply deliveries, and
1024 for successful local deliveries from routers that have the log_as_local flag
1025 set. File deliveries from filters can be specified as non-absolute paths in
1026 cases where the transport is going to complete the path. If there is an error
1027 before this happens (expansion failure) the local part will not be updated, and
1028 so won't necessarily look like a path. Add extra text for this case. */
1030 if ( testflag(addr, af_pfr)
1032 && addr->router && addr->router->log_as_local
1033 && addr->transport && addr->transport->info->local
1036 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1037 g = string_catn(g, CUS"save ", 5);
1038 g = string_get_localpart(addr, g);
1041 /* Other deliveries start with the full address. It we have split it into local
1042 part and domain, use those fields. Some early failures can happen before the
1043 splitting is done; in those cases use the original field. */
1048 int off = gstring_length(g); /* start of the "full address" */
1050 if (addr->local_part)
1053 g = string_get_localpart(addr, g);
1054 g = string_catn(g, US"@", 1);
1057 if (testflag(addr, af_utf8_downcvt))
1058 s = string_localpart_utf8_to_alabel(s, NULL);
1060 g = string_cat(g, s);
1063 g = string_cat(g, addr->address);
1065 /* If the address we are going to print is the same as the top address,
1066 and all parents are not being included, don't add on the top address. First
1067 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1068 on the local parts. */
1070 cmp = g->s + off; /* only now, as rebuffer likely done */
1071 string_from_gstring(g); /* ensure nul-terminated */
1072 if ( strcmpic(cmp, topaddr->address) == 0
1073 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1074 && !addr->onetime_parent
1075 && (!all_parents || !addr->parent || addr->parent == topaddr)
1077 add_topaddr = FALSE;
1080 /* If all parents are requested, or this is a local pipe/file/reply, and
1081 there is at least one intermediate parent, show it in brackets, and continue
1082 with all of them if all are wanted. */
1084 if ( (all_parents || testflag(addr, af_pfr))
1086 && addr->parent != topaddr)
1089 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1091 g = string_catn(g, s, 2);
1092 g = string_cat (g, addr2->address);
1093 if (!all_parents) break;
1096 g = string_catn(g, US")", 1);
1099 /* Add the top address if it is required */
1102 g = string_append(g, 3,
1104 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1112 /******************************************************************************/
1116 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1117 this is a nonstandard call; no two-character delivery flag is written
1118 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1121 flags passed to log_write()
1124 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1126 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1129 /* Log the delivery on the main log. We use an extensible string to build up
1130 the log line, and reset the store afterwards. Remote deliveries should always
1131 have a pointer to the host item that succeeded; local deliveries can have a
1132 pointer to a single host item in their host list, for use by the transport. */
1134 #ifndef DISABLE_EVENT
1135 /* presume no successful remote delivery */
1136 lookup_dnssec_authenticated = NULL;
1139 reset_point = store_mark();
1140 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1143 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1146 g->s[0] = logchar; g->ptr = 1;
1147 g = string_catn(g, US"> ", 2);
1149 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1151 if (LOGGING(sender_on_delivery) || msg)
1152 g = string_append(g, 3, US" F=<",
1154 testflag(addr, af_utf8_downcvt)
1155 ? string_address_utf8_to_alabel(sender_address, NULL)
1162 g = string_append(g, 2, US" Q=", queue_name);
1164 /* You might think that the return path must always be set for a successful
1165 delivery; indeed, I did for some time, until this statement crashed. The case
1166 when it is not set is for a delivery to /dev/null which is optimised by not
1167 being run at all. */
1169 if (used_return_path && LOGGING(return_path_on_delivery))
1170 g = string_append(g, 3, US" P=<", used_return_path, US">");
1173 g = string_append(g, 2, US" ", msg);
1175 /* For a delivery from a system filter, there may not be a router */
1177 g = string_append(g, 2, US" R=", addr->router->name);
1179 g = string_append(g, 2, US" T=", addr->transport->name);
1181 if (LOGGING(delivery_size))
1182 g = string_fmt_append(g, " S=%d", transport_count);
1184 /* Local delivery */
1186 if (addr->transport->info->local)
1188 if (addr->host_list)
1189 g = string_append(g, 2, US" H=", addr->host_list->name);
1190 g = d_log_interface(g);
1191 if (addr->shadow_message)
1192 g = string_cat(g, addr->shadow_message);
1195 /* Remote delivery */
1199 if (addr->host_used)
1201 g = d_hostlog(g, addr);
1203 #ifndef DISABLE_EVENT
1204 deliver_host_address = addr->host_used->address;
1205 deliver_host_port = addr->host_used->port;
1206 deliver_host = addr->host_used->name;
1208 /* DNS lookup status */
1209 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1210 : addr->host_used->dnssec==DS_NO ? US"no"
1216 g = d_tlslog(g, addr);
1219 if (addr->authenticator)
1221 g = string_append(g, 2, US" A=", addr->authenticator);
1224 g = string_append(g, 2, US":", addr->auth_id);
1225 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1226 g = string_append(g, 2, US":", addr->auth_sndr);
1230 if (LOGGING(pipelining))
1232 if (testflag(addr, af_pipelining))
1233 g = string_catn(g, US" L", 2);
1234 #ifndef DISABLE_PIPE_CONNECT
1235 if (testflag(addr, af_early_pipe))
1236 g = string_catn(g, US"*", 1);
1240 #ifndef DISABLE_PRDR
1241 if (testflag(addr, af_prdr_used))
1242 g = string_catn(g, US" PRDR", 5);
1245 if (testflag(addr, af_chunking_used))
1246 g = string_catn(g, US" K", 2);
1249 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1251 if ( LOGGING(smtp_confirmation)
1253 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1256 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1257 uschar *p = big_buffer;
1258 uschar *ss = addr->message;
1260 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1262 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1267 g = string_append(g, 2, US" C=", big_buffer);
1270 /* Time on queue and actual time taken to deliver */
1272 if (LOGGING(queue_time))
1273 g = string_append(g, 2, US" QT=", string_timesince(
1274 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1276 if (LOGGING(deliver_time))
1277 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1279 /* string_cat() always leaves room for the terminator. Release the
1280 store we used to build the line after writing it. */
1282 log_write(0, flags, "%s", string_from_gstring(g));
1284 #ifndef DISABLE_EVENT
1285 if (!msg) msg_event_raise(US"msg:delivery", addr);
1288 store_reset(reset_point);
1295 deferral_log(address_item * addr, uschar * now,
1296 int logflags, uschar * driver_name, uschar * driver_kind)
1298 rmark reset_point = store_mark();
1299 gstring * g = string_get(256);
1301 /* Build up the line that is used for both the message log and the main
1304 /* Create the address string for logging. Must not do this earlier, because
1305 an OK result may be changed to FAIL when a pipe returns text. */
1307 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1310 g = string_append(g, 2, US" Q=", queue_name);
1312 /* Either driver_name contains something and driver_kind contains
1313 " router" or " transport" (note the leading space), or driver_name is
1314 a null string and driver_kind contains "routing" without the leading
1315 space, if all routing has been deferred. When a domain has been held,
1316 so nothing has been done at all, both variables contain null strings. */
1320 if (driver_kind[1] == 't' && addr->router)
1321 g = string_append(g, 2, US" R=", addr->router->name);
1322 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1324 else if (driver_kind)
1325 g = string_append(g, 2, US" ", driver_kind);
1327 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1329 if (addr->basic_errno > 0)
1330 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1332 if (addr->host_used)
1333 g = d_hostlog(g, addr);
1335 if (LOGGING(deliver_time))
1336 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1339 g = string_append(g, 2, US": ", addr->message);
1342 const uschar * s = string_from_gstring(g);
1344 /* Log the deferment in the message log, but don't clutter it
1345 up with retry-time defers after the first delivery attempt. */
1347 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1348 deliver_msglog("%s %s\n", now, s);
1350 /* Write the main log and reset the store.
1351 For errors of the type "retry time not reached" (also remotes skipped
1352 on queue run), logging is controlled by L_retry_defer. Note that this kind
1353 of error number is negative, and all the retry ones are less than any
1357 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1361 store_reset(reset_point);
1368 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1370 rmark reset_point = store_mark();
1371 gstring * g = string_get(256);
1373 #ifndef DISABLE_EVENT
1374 /* Message failures for which we will send a DSN get their event raised
1375 later so avoid doing it here. */
1377 if ( !addr->prop.ignore_error
1378 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1380 msg_event_raise(US"msg:fail:delivery", addr);
1383 /* Build up the log line for the message and main logs */
1385 /* Create the address string for logging. Must not do this earlier, because
1386 an OK result may be changed to FAIL when a pipe returns text. */
1388 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1390 if (LOGGING(sender_on_delivery))
1391 g = string_append(g, 3, US" F=<", sender_address, US">");
1394 g = string_append(g, 2, US" Q=", queue_name);
1396 /* Return path may not be set if no delivery actually happened */
1398 if (used_return_path && LOGGING(return_path_on_delivery))
1399 g = string_append(g, 3, US" P=<", used_return_path, US">");
1402 g = string_append(g, 2, US" R=", addr->router->name);
1403 if (addr->transport)
1404 g = string_append(g, 2, US" T=", addr->transport->name);
1406 if (addr->host_used)
1407 g = d_hostlog(g, addr);
1410 g = d_tlslog(g, addr);
1413 if (addr->basic_errno > 0)
1414 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1417 g = string_append(g, 2, US": ", addr->message);
1419 if (LOGGING(deliver_time))
1420 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1422 /* Do the logging. For the message log, "routing failed" for those cases,
1423 just to make it clearer. */
1426 const uschar * s = string_from_gstring(g);
1429 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1431 deliver_msglog("%s %s\n", now, s);
1433 log_write(0, LOG_MAIN, "** %s", 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;
2152 return_path = sender_address;
2154 if (tp->return_path)
2156 uschar * new_return_path = expand_string(tp->return_path);
2157 if (new_return_path)
2158 return_path = new_return_path;
2159 else if (!f.expand_string_forcedfail)
2161 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2162 US"Failed to expand return path \"%s\" in %s transport: %s",
2163 tp->return_path, tp->name, expand_string_message);
2168 /* For local deliveries, one at a time, the value used for logging can just be
2169 set directly, once and for all. */
2171 used_return_path = return_path;
2173 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2174 gets put into the address(es), and the expansions are unset, so we can just
2177 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2179 /* See if either the transport or the address specifies a home directory. A
2180 home directory set in the address may already be expanded; a flag is set to
2181 indicate that. In other cases we must expand it. */
2183 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2184 || ( (deliver_home = addr->home_dir) /* Set in address and */
2185 && !testflag(addr, af_home_expanded) /* not expanded */
2188 uschar *rawhome = deliver_home;
2189 deliver_home = NULL; /* in case it contains $home */
2190 if (!(deliver_home = expand_string(rawhome)))
2192 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2193 "to expand for %s transport: %s", rawhome, tp->name,
2194 expand_string_message);
2197 if (*deliver_home != '/')
2199 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2200 "is not absolute for %s transport", deliver_home, tp->name);
2205 /* See if either the transport or the address specifies a current directory,
2206 and if so, expand it. If nothing is set, use the home directory, unless it is
2207 also unset in which case use "/", which is assumed to be a directory to which
2208 all users have access. It is necessary to be in a visible directory for some
2209 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2210 2.5) require this. */
2212 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2213 if (working_directory)
2215 uschar *raw = working_directory;
2216 if (!(working_directory = expand_string(raw)))
2218 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2219 "failed to expand for %s transport: %s", raw, tp->name,
2220 expand_string_message);
2223 if (*working_directory != '/')
2225 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2226 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2230 else working_directory = deliver_home ? deliver_home : US"/";
2232 /* If one of the return_output flags is set on the transport, create and open a
2233 file in the message log directory for the transport to write its output onto.
2234 This is mainly used by pipe transports. The file needs to be unique to the
2235 address. This feature is not available for shadow transports. */
2238 && ( tp->return_output || tp->return_fail_output
2239 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2244 addr->return_filename =
2245 spool_fname(US"msglog", message_subdir, message_id,
2246 string_sprintf("-%d-%d", getpid(), return_count++));
2248 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2250 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2251 "to return message: %s", error, tp->name, strerror(errno));
2256 /* Create the pipe for inter-process communication. */
2260 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2265 /* Now fork the process to do the real work in the subprocess, but first
2266 ensure that all cached resources are freed so that the subprocess starts with
2267 a clean slate and doesn't interfere with the parent process. */
2271 if ((pid = exim_fork(US"delivery-local")) == 0)
2273 BOOL replicate = TRUE;
2275 /* Prevent core dumps, as we don't want them in users' home directories.
2276 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2277 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2278 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2279 complain if the error is "not supported".
2281 There are two scenarios where changing the max limit has an effect. In one,
2282 the user is using a .forward and invoking a command of their choice via pipe;
2283 for these, we do need the max limit to be 0 unless the admin chooses to
2284 permit an increased limit. In the other, the command is invoked directly by
2285 the transport and is under administrator control, thus being able to raise
2286 the limit aids in debugging. So there's no general always-right answer.
2288 Thus we inhibit core-dumps completely but let individual transports, while
2289 still root, re-raise the limits back up to aid debugging. We make the
2290 default be no core-dumps -- few enough people can use core dumps in
2291 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2298 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2300 # ifdef SETRLIMIT_NOT_SUPPORTED
2301 if (errno != ENOSYS && errno != ENOTSUP)
2303 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2308 /* Reset the random number generator, so different processes don't all
2309 have the same sequence. */
2313 /* If the transport has a setup entry, call this first, while still
2314 privileged. (Appendfile uses this to expand quota, for example, while
2315 able to read private files.) */
2317 if (addr->transport->setup)
2318 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2322 addr->transport_return = DEFER;
2326 addr->transport_return = PANIC;
2330 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2331 when the process becomes unprivileged, it won't be able to write to the
2332 process log. SIGHUP is ignored throughout exim, except when it is being
2335 signal(SIGINT, SIG_IGN);
2336 signal(SIGTERM, SIG_IGN);
2337 signal(SIGUSR1, SIG_IGN);
2339 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2340 half - for transports that exec things (e.g. pipe). Then set the required
2343 (void)close(pfd[pipe_read]);
2344 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2346 exim_setugid(uid, gid, use_initgroups,
2347 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2348 addr->address, addr->transport->name));
2352 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2353 for (address_item * batched = addr->next; batched; batched = batched->next)
2354 debug_printf("additional batched address: %s\n", batched->address);
2357 /* Set an appropriate working directory. */
2359 if (Uchdir(working_directory) < 0)
2361 addr->transport_return = DEFER;
2362 addr->basic_errno = errno;
2363 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2366 /* If successful, call the transport */
2371 set_process_info("delivering %s to %s using %s", message_id,
2372 addr->local_part, tp->name);
2374 /* Setting these globals in the subprocess means we need never clear them */
2375 transport_name = addr->transport->name;
2376 driver_srcfile = tp->srcfile;
2377 driver_srcline = tp->srcline;
2379 /* If a transport filter has been specified, set up its argument list.
2380 Any errors will get put into the address, and FALSE yielded. */
2382 if (tp->filter_command)
2384 ok = transport_set_up_command(&transport_filter_argv,
2386 TRUE, PANIC, addr, FALSE, US"transport filter", NULL);
2387 transport_filter_timeout = tp->filter_timeout;
2389 else transport_filter_argv = NULL;
2393 debug_print_string(tp->debug_string);
2394 replicate = !(tp->info->code)(addr->transport, addr);
2398 /* Pass the results back down the pipe. If necessary, first replicate the
2399 status in the top address to the others in the batch. The label is the
2400 subject of a goto when a call to the transport's setup function fails. We
2401 pass the pointer to the transport back in case it got changed as a result of
2402 file_format in appendfile. */
2406 if (replicate) replicate_status(addr);
2407 for (addr2 = addr; addr2; addr2 = addr2->next)
2410 int local_part_length = Ustrlen(addr2->local_part);
2414 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2415 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2416 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2417 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2418 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2419 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2420 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2421 || (ret = write(pfd[pipe_write], &addr2->transport,
2422 sizeof(transport_instance *))) != sizeof(transport_instance *)
2424 /* For a file delivery, pass back the local part, in case the original
2425 was only part of the final delivery path. This gives more complete
2428 || (testflag(addr2, af_file)
2429 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2430 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2434 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2435 ret == -1 ? strerror(errno) : "short write");
2437 /* Now any messages */
2439 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2441 int message_length = s ? Ustrlen(s) + 1 : 0;
2442 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2443 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2445 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2446 ret == -1 ? strerror(errno) : "short write");
2450 /* OK, this process is now done. Free any cached resources that it opened,
2451 and close the pipe we were writing down before exiting. */
2453 (void)close(pfd[pipe_write]);
2458 /* Back in the main process: panic if the fork did not succeed. This seems
2459 better than returning an error - if forking is failing it is probably best
2460 not to try other deliveries for this message. */
2463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2466 /* Read the pipe to get the delivery status codes and error messages. Our copy
2467 of the writing end must be closed first, as otherwise read() won't return zero
2468 on an empty pipe. We check that a status exists for each address before
2469 overwriting the address structure. If data is missing, the default DEFER status
2470 will remain. Afterwards, close the reading end. */
2472 (void)close(pfd[pipe_write]);
2474 for (addr2 = addr; addr2; addr2 = addr2->next)
2476 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2481 addr2->transport_return = status;
2482 len = read(pfd[pipe_read], &transport_count,
2483 sizeof(transport_count));
2484 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2485 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2486 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2487 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2488 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2489 len = read(pfd[pipe_read], &addr2->transport,
2490 sizeof(transport_instance *));
2492 if (testflag(addr2, af_file))
2495 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2496 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2499 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2500 " from delivery subprocess");
2503 /* sanity-checked llen so disable the Coverity error */
2504 /* coverity[tainted_data] */
2505 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2507 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2508 " from delivery subprocess");
2511 big_buffer[llen] = 0;
2512 addr2->local_part = string_copy(big_buffer);
2515 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2518 len = read(pfd[pipe_read], &message_length, sizeof(int));
2519 if (message_length > 0)
2521 len = read(pfd[pipe_read], big_buffer, message_length);
2522 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2523 if (len > 0) *sptr = string_copy(big_buffer);
2530 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2531 "from delivery subprocess", addr2->unique);
2536 (void)close(pfd[pipe_read]);
2538 /* Unless shadowing, write all successful addresses immediately to the journal
2539 file, to ensure they are recorded asap. For homonymic addresses, use the base
2540 address plus the transport name. Failure to write the journal is panic-worthy,
2541 but don't stop, as it may prove possible subsequently to update the spool file
2542 in order to record the delivery. */
2546 for (addr2 = addr; addr2; addr2 = addr2->next)
2547 if (addr2->transport_return == OK)
2549 if (testflag(addr2, af_homonym))
2550 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2552 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2554 /* In the test harness, wait just a bit to let the subprocess finish off
2555 any debug output etc first. */
2557 testharness_pause_ms(300);
2559 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2560 len = Ustrlen(big_buffer);
2561 if (write(journal_fd, big_buffer, len) != len)
2562 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2563 big_buffer, strerror(errno));
2566 /* Ensure the journal file is pushed out to disk. */
2568 if (EXIMfsync(journal_fd) < 0)
2569 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2573 /* Wait for the process to finish. If it terminates with a non-zero code,
2574 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2575 status values of all the addresses as they are. Take care to handle the case
2576 when the subprocess doesn't seem to exist. This has been seen on one system
2577 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2578 happens, wait() doesn't recognize the termination of child processes. Exim now
2579 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2581 while ((rc = wait(&status)) != pid)
2582 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2584 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2585 addr->transport->driver_name);
2590 if ((status & 0xffff) != 0)
2592 int msb = (status >> 8) & 255;
2593 int lsb = status & 255;
2594 int code = (msb == 0)? (lsb & 0x7f) : msb;
2595 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2596 addr->special_action = SPECIAL_FREEZE;
2597 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2598 "status 0x%04x: %s %d",
2599 addr->transport->driver_name,
2601 msb == 0 ? "terminated by signal" : "exit code",
2605 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2607 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2610 uschar *warn_message;
2613 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2615 if (!(warn_message = expand_string(addr->transport->warn_message)))
2616 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2617 "message for %s transport): %s", addr->transport->warn_message,
2618 addr->transport->name, expand_string_message);
2620 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2622 FILE *f = fdopen(fd, "wb");
2623 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2624 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2625 fprintf(f, "Auto-Submitted: auto-replied\n");
2626 if (!contains_header(US"From", warn_message))
2628 fprintf(f, "%s", CS warn_message);
2630 /* Close and wait for child process to complete, without a timeout. */
2633 (void)child_close(pid, 0);
2636 addr->special_action = SPECIAL_NONE;
2643 /* Check transport for the given concurrency limit. Return TRUE if over
2644 the limit (or an expansion failure), else FALSE and if there was a limit,
2645 the key for the hints database used for the concurrency count. */
2648 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2650 unsigned max_parallel;
2652 if (!tp->max_parallel) return FALSE;
2654 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2655 if (expand_string_message)
2657 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2658 "in %s transport (%s): %s", tp->name, addr->address,
2659 expand_string_message);
2663 if (max_parallel > 0)
2665 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2666 if (!enq_start(serialize_key, max_parallel))
2668 address_item * next;
2670 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2671 tp->name, max_parallel);
2675 addr->message = US"concurrency limit reached for transport";
2676 addr->basic_errno = ERRNO_TRETRY;
2677 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2678 } while ((addr = next));
2681 *key = serialize_key;
2688 /*************************************************
2689 * Do local deliveries *
2690 *************************************************/
2692 /* This function processes the list of addresses in addr_local. True local
2693 deliveries are always done one address at a time. However, local deliveries can
2694 be batched up in some cases. Typically this is when writing batched SMTP output
2695 files for use by some external transport mechanism, or when running local
2696 deliveries over LMTP.
2703 do_local_deliveries(void)
2706 open_db *dbm_file = NULL;
2707 time_t now = time(NULL);
2709 /* Loop until we have exhausted the supply of local deliveries */
2713 struct timeval delivery_start;
2714 struct timeval deliver_time;
2715 address_item *addr2, *addr3, *nextaddr;
2716 int logflags = LOG_MAIN;
2717 int logchar = f.dont_deliver? '*' : '=';
2718 transport_instance *tp;
2719 uschar * serialize_key = NULL;
2721 /* Pick the first undelivered address off the chain */
2723 address_item *addr = addr_local;
2724 addr_local = addr->next;
2727 DEBUG(D_deliver|D_transport)
2728 debug_printf("--------> %s <--------\n", addr->address);
2730 /* An internal disaster if there is no transport. Should not occur! */
2732 if (!(tp = addr->transport))
2734 logflags |= LOG_PANIC;
2735 f.disable_logging = FALSE; /* Jic */
2736 addr->message = addr->router
2737 ? string_sprintf("No transport set by %s router", addr->router->name)
2738 : US"No transport set by system filter";
2739 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2743 /* Check that this base address hasn't previously been delivered to this
2744 transport. The check is necessary at this point to handle homonymic addresses
2745 correctly in cases where the pattern of redirection changes between delivery
2746 attempts. Non-homonymic previous delivery is detected earlier, at routing
2749 if (previously_transported(addr, FALSE)) continue;
2751 /* There are weird cases where logging is disabled */
2753 f.disable_logging = tp->disable_logging;
2755 /* Check for batched addresses and possible amalgamation. Skip all the work
2756 if either batch_max <= 1 or there aren't any other addresses for local
2759 if (tp->batch_max > 1 && addr_local)
2761 int batch_count = 1;
2762 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2763 BOOL uses_lp = ( testflag(addr, af_pfr)
2764 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2766 || readconf_depends((driver_instance *)tp, US"local_part");
2767 uschar *batch_id = NULL;
2768 address_item **anchor = &addr_local;
2769 address_item *last = addr;
2772 /* Expand the batch_id string for comparison with other addresses.
2773 Expansion failure suppresses batching. */
2777 deliver_set_expansions(addr);
2778 batch_id = expand_string(tp->batch_id);
2779 deliver_set_expansions(NULL);
2782 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2783 "in %s transport (%s): %s", tp->name, addr->address,
2784 expand_string_message);
2785 batch_count = tp->batch_max;
2789 /* Until we reach the batch_max limit, pick off addresses which have the
2790 same characteristics. These are:
2793 not previously delivered (see comment about 50 lines above)
2794 same local part if the transport's configuration contains $local_part
2795 or if this is a file or pipe delivery from a redirection
2796 same domain if the transport's configuration contains $domain
2798 same additional headers
2799 same headers to be removed
2800 same uid/gid for running the transport
2801 same first host if a host list is set
2804 while ((next = *anchor) && batch_count < tp->batch_max)
2807 tp == next->transport
2808 && !previously_transported(next, TRUE)
2809 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2810 && testflag(addr, af_file) == testflag(next, af_file)
2811 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2812 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2813 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2814 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2815 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2816 && same_ugid(tp, addr, next)
2817 && ( !addr->host_list && !next->host_list
2820 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2823 /* If the transport has a batch_id setting, batch_id will be non-NULL
2824 from the expansion outside the loop. Expand for this address and compare.
2825 Expansion failure makes this address ineligible for batching. */
2830 address_item *save_nextnext = next->next;
2831 next->next = NULL; /* Expansion for a single address */
2832 deliver_set_expansions(next);
2833 next->next = save_nextnext;
2834 bid = expand_string(tp->batch_id);
2835 deliver_set_expansions(NULL);
2838 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2839 "in %s transport (%s): %s", tp->name, next->address,
2840 expand_string_message);
2843 else ok = (Ustrcmp(batch_id, bid) == 0);
2846 /* Take address into batch if OK. */
2850 *anchor = next->next; /* Include the address */
2856 else anchor = &next->next; /* Skip the address */
2860 /* We now have one or more addresses that can be delivered in a batch. Check
2861 whether the transport is prepared to accept a message of this size. If not,
2862 fail them all forthwith. If the expansion fails, or does not yield an
2863 integer, defer delivery. */
2865 if (tp->message_size_limit)
2867 int rc = check_message_size(tp, addr);
2870 replicate_status(addr);
2874 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2877 continue; /* With next batch of addresses */
2881 /* If we are not running the queue, or if forcing, all deliveries will be
2882 attempted. Otherwise, we must respect the retry times for each address. Even
2883 when not doing this, we need to set up the retry key string, and determine
2884 whether a retry record exists, because after a successful delivery, a delete
2885 retry item must be set up. Keep the retry database open only for the duration
2886 of these checks, rather than for all local deliveries, because some local
2887 deliveries (e.g. to pipes) can take a substantial time. */
2889 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2890 DEBUG(D_deliver|D_retry|D_hints_lookup)
2891 debug_printf("no retry data available\n");
2897 BOOL ok = TRUE; /* to deliver this address */
2900 /* Set up the retry key to include the domain or not, and change its
2901 leading character from "R" to "T". Must make a copy before doing this,
2902 because the old key may be pointed to from a "delete" retry item after
2905 retry_key = string_copy(
2906 tp->retry_use_local_part ? addr2->address_retry_key :
2907 addr2->domain_retry_key);
2910 /* Inspect the retry data. If there is no hints file, delivery happens. */
2914 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2916 /* If there is no retry record, delivery happens. If there is,
2917 remember it exists so it can be deleted after a successful delivery. */
2921 setflag(addr2, af_lt_retry_exists);
2923 /* A retry record exists for this address. If queue running and not
2924 forcing, inspect its contents. If the record is too old, or if its
2925 retry time has come, or if it has passed its cutoff time, delivery
2930 debug_printf("retry record exists: age=%s ",
2931 readconf_printtime(now - retry_record->time_stamp));
2932 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2933 debug_printf(" time to retry = %s expired = %d\n",
2934 readconf_printtime(retry_record->next_try - now),
2935 retry_record->expired);
2938 if (f.queue_running && !f.deliver_force)
2940 ok = (now - retry_record->time_stamp > retry_data_expire)
2941 || (now >= retry_record->next_try)
2942 || retry_record->expired;
2944 /* If we haven't reached the retry time, there is one more check
2945 to do, which is for the ultimate address timeout. */
2948 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2952 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2955 /* This address is to be delivered. Leave it on the chain. */
2960 addr2 = addr2->next;
2963 /* This address is to be deferred. Take it out of the chain, and
2964 post-process it as complete. Must take it out of the chain first,
2965 because post processing puts it on another chain. */
2969 address_item *this = addr2;
2970 this->message = US"Retry time not yet reached";
2971 this->basic_errno = ERRNO_LRETRY;
2972 addr2 = addr3 ? (addr3->next = addr2->next)
2973 : (addr = addr2->next);
2974 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2978 if (dbm_file) dbfn_close(dbm_file);
2980 /* If there are no addresses left on the chain, they all deferred. Loop
2981 for the next set of addresses. */
2983 if (!addr) continue;
2985 /* If the transport is limited for parallellism, enforce that here.
2986 We use a hints DB entry, incremented here and decremented after
2987 the transport (and any shadow transport) completes. */
2989 if (tpt_parallel_check(tp, addr, &serialize_key))
2991 if (expand_string_message)
2993 logflags |= LOG_PANIC;
2997 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2998 } while ((addr = addr2));
3000 continue; /* Loop for the next set of addresses. */
3004 /* So, finally, we do have some addresses that can be passed to the
3005 transport. Before doing so, set up variables that are relevant to a
3008 deliver_set_expansions(addr);
3010 gettimeofday(&delivery_start, NULL);
3011 deliver_local(addr, FALSE);
3012 timesince(&deliver_time, &delivery_start);
3014 /* If a shadow transport (which must perforce be another local transport), is
3015 defined, and its condition is met, we must pass the message to the shadow
3016 too, but only those addresses that succeeded. We do this by making a new
3017 chain of addresses - also to keep the original chain uncontaminated. We must
3018 use a chain rather than doing it one by one, because the shadow transport may
3021 NOTE: if the condition fails because of a lookup defer, there is nothing we
3025 && ( !tp->shadow_condition
3026 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3029 transport_instance *stp;
3030 address_item *shadow_addr = NULL;
3031 address_item **last = &shadow_addr;
3033 for (stp = transports; stp; stp = stp->next)
3034 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3037 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3040 /* Pick off the addresses that have succeeded, and make clones. Put into
3041 the shadow_message field a pointer to the shadow_message field of the real
3044 else for (addr2 = addr; addr2; addr2 = addr2->next)
3045 if (addr2->transport_return == OK)
3047 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3050 addr3->shadow_message = US &addr2->shadow_message;
3051 addr3->transport = stp;
3052 addr3->transport_return = DEFER;
3053 addr3->return_filename = NULL;
3054 addr3->return_file = -1;
3056 last = &addr3->next;
3059 /* If we found any addresses to shadow, run the delivery, and stick any
3060 message back into the shadow_message field in the original. */
3064 int save_count = transport_count;
3066 DEBUG(D_deliver|D_transport)
3067 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3068 deliver_local(shadow_addr, TRUE);
3070 for(; shadow_addr; shadow_addr = shadow_addr->next)
3072 int sresult = shadow_addr->transport_return;
3073 *(uschar **)shadow_addr->shadow_message =
3075 ? string_sprintf(" ST=%s", stp->name)
3076 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3077 shadow_addr->basic_errno <= 0
3079 : US strerror(shadow_addr->basic_errno),
3080 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3083 shadow_addr->message
3084 ? shadow_addr->message
3085 : shadow_addr->basic_errno <= 0
3089 DEBUG(D_deliver|D_transport)
3090 debug_printf("%s shadow transport returned %s for %s\n",
3091 stp->name, rc_to_string(sresult), shadow_addr->address);
3094 DEBUG(D_deliver|D_transport)
3095 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3097 transport_count = save_count; /* Restore original transport count */
3101 /* Cancel the expansions that were set up for the delivery. */
3103 deliver_set_expansions(NULL);
3105 /* If the transport was parallelism-limited, decrement the hints DB record. */
3107 if (serialize_key) enq_end(serialize_key);
3109 /* Now we can process the results of the real transport. We must take each
3110 address off the chain first, because post_process_one() puts it on another
3113 for (addr2 = addr; addr2; addr2 = nextaddr)
3115 int result = addr2->transport_return;
3116 nextaddr = addr2->next;
3118 DEBUG(D_deliver|D_transport)
3119 debug_printf("%s transport returned %s for %s\n",
3120 tp->name, rc_to_string(result), addr2->address);
3122 /* If there is a retry_record, or if delivery is deferred, build a retry
3123 item for setting a new retry time or deleting the old retry record from
3124 the database. These items are handled all together after all addresses
3125 have been handled (so the database is open just for a short time for
3128 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3130 int flags = result == DEFER ? 0 : rf_delete;
3131 uschar *retry_key = string_copy(tp->retry_use_local_part
3132 ? addr2->address_retry_key : addr2->domain_retry_key);
3134 retry_add_item(addr2, retry_key, flags);
3137 /* Done with this address */
3139 addr2->delivery_time = deliver_time;
3140 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3142 /* If a pipe delivery generated text to be sent back, the result may be
3143 changed to FAIL, and we must copy this for subsequent addresses in the
3146 if (addr2->transport_return != result)
3148 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3150 addr3->transport_return = addr2->transport_return;
3151 addr3->basic_errno = addr2->basic_errno;
3152 addr3->message = addr2->message;
3154 result = addr2->transport_return;
3157 /* Whether or not the result was changed to FAIL, we need to copy the
3158 return_file value from the first address into all the addresses of the
3159 batch, so they are all listed in the error message. */
3161 addr2->return_file = addr->return_file;
3163 /* Change log character for recording successful deliveries. */
3165 if (result == OK) logchar = '-';
3167 } /* Loop back for next batch of addresses */
3173 /*************************************************
3174 * Sort remote deliveries *
3175 *************************************************/
3177 /* This function is called if remote_sort_domains is set. It arranges that the
3178 chain of addresses for remote deliveries is ordered according to the strings
3179 specified. Try to make this shuffling reasonably efficient by handling
3180 sequences of addresses rather than just single ones.
3187 sort_remote_deliveries(void)
3190 address_item **aptr = &addr_remote;
3191 const uschar *listptr = remote_sort_domains;
3195 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3197 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3200 address_item *moved = NULL;
3201 address_item **bptr = &moved;
3205 address_item **next;
3206 deliver_domain = (*aptr)->domain; /* set $domain */
3207 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3208 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3210 aptr = &(*aptr)->next;
3214 next = &(*aptr)->next;
3216 && (deliver_domain = (*next)->domain, /* Set $domain */
3217 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3218 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3220 next = &(*next)->next;
3222 /* If the batch of non-matchers is at the end, add on any that were
3223 extracted further up the chain, and end this iteration. Otherwise,
3224 extract them from the chain and hang on the moved chain. */
3236 aptr = &(*aptr)->next;
3239 /* If the loop ended because the final address matched, *aptr will
3240 be NULL. Add on to the end any extracted non-matching addresses. If
3241 *aptr is not NULL, the loop ended via "break" when *next is null, that
3242 is, there was a string of non-matching addresses at the end. In this
3243 case the extracted addresses have already been added on the end. */
3245 if (!*aptr) *aptr = moved;
3250 debug_printf("remote addresses after sorting:\n");
3251 for (address_item * addr = addr_remote; addr; addr = addr->next)
3252 debug_printf(" %s\n", addr->address);
3258 /*************************************************
3259 * Read from pipe for remote delivery subprocess *
3260 *************************************************/
3262 /* This function is called when the subprocess is complete, but can also be
3263 called before it is complete, in order to empty a pipe that is full (to prevent
3264 deadlock). It must therefore keep track of its progress in the parlist data
3267 We read the pipe to get the delivery status codes and a possible error message
3268 for each address, optionally preceded by unusability data for the hosts and
3269 also by optional retry data.
3271 Read in large chunks into the big buffer and then scan through, interpreting
3272 the data therein. In most cases, only a single read will be necessary. No
3273 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3274 that we read the next chunk when there is less than 2500 bytes left in the
3275 non-final chunk, we can assume each item is complete in the buffer before
3276 handling it. Each item is written using a single write(), which is atomic for
3277 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3278 often bigger) so even if we are reading while the subprocess is still going, we
3279 should never have only a partial item in the buffer.
3281 hs12: This assumption is not true anymore, since we get quite large items (certificate
3282 information and such).
3285 poffset the offset of the parlist item
3286 eop TRUE if the process has completed
3288 Returns: TRUE if the terminating 'Z' item has been read,
3289 or there has been a disaster (i.e. no more data needed);
3294 par_read_pipe(int poffset, BOOL eop)
3297 pardata *p = parlist + poffset;
3298 address_item *addrlist = p->addrlist;
3299 address_item *addr = p->addr;
3303 uschar *msg = p->msg;
3304 BOOL done = p->done;
3306 /* Loop through all items, reading from the pipe when necessary. The pipe
3307 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3308 here, as the preceding poll() tells us, if data is available for reading.
3310 A read() on a "selected" handle should never block, but(!) it may return
3311 less data then we expected. (The buffer size we pass to read() shouldn't be
3312 understood as a "request", but as a "limit".)
3314 Each separate item is written to the pipe in a timely manner. But, especially for
3315 larger items, the read(2) may already return partial data from the write(2).
3317 The write is atomic mostly (depending on the amount written), but atomic does
3318 not imply "all or noting", it just is "not intermixed" with other writes on the
3319 same channel (pipe).
3323 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3324 (int)p->pid, eop? "ended" : "not ended yet");
3328 retry_item *r, **rp;
3329 uschar pipeheader[PIPE_HEADER_SIZE+1];
3330 uschar *id = &pipeheader[0];
3331 uschar *subid = &pipeheader[1];
3332 uschar *ptr = big_buffer;
3333 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3336 DEBUG(D_deliver) debug_printf(
3337 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3339 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3340 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3341 If we get less, we can assume the subprocess do be done and do not expect any further
3342 information from it. */
3344 if ((got = readn(fd, pipeheader, required)) != required)
3346 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3347 "from transport process %d for transport %s",
3348 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3353 pipeheader[PIPE_HEADER_SIZE] = '\0';
3355 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3359 /* If we can't decode the pipeheader, the subprocess seems to have a
3360 problem, we do not expect any furher information from it. */
3362 required = Ustrtol(pipeheader+2, &endc, 10);
3365 msg = string_sprintf("failed to read pipe "
3366 "from transport process %d for transport %s: error decoding size from header",
3367 pid, addr->transport->driver_name);
3374 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3375 (u_long)required, pid);
3377 /* Same as above, the transport process will write the bytes announced
3378 in a timely manner, so we can just wait for the bytes, getting less than expected
3379 is considered a problem of the subprocess, we do not expect anything else from it. */
3380 if ((got = readn(fd, big_buffer, required)) != required)
3382 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3383 " bytes (pipedata) from transport process %d for transport %s",
3384 got, required, pid, addr->transport->driver_name);
3389 /* Handle each possible type of item, assuming the complete item is
3390 available in store. */
3394 /* Host items exist only if any hosts were marked unusable. Match
3395 up by checking the IP address. */
3398 for (h = addrlist->host_list; h; h = h->next)
3400 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3408 /* Retry items are sent in a preceding R item for each address. This is
3409 kept separate to keep each message short enough to guarantee it won't
3410 be split in the pipe. Hopefully, in the majority of cases, there won't in
3411 fact be any retry items at all.
3413 The complete set of retry items might include an item to delete a
3414 routing retry if there was a previous routing delay. However, routing
3415 retries are also used when a remote transport identifies an address error.
3416 In that case, there may also be an "add" item for the same key. Arrange
3417 that a "delete" item is dropped in favour of an "add" item. */
3420 if (!addr) goto ADDR_MISMATCH;
3422 DEBUG(D_deliver|D_retry)
3423 debug_printf("reading retry information for %s from subprocess\n",
3426 /* Cut out any "delete" items on the list. */
3428 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3429 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3431 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3432 *rp = r->next; /* Excise a delete item */
3433 DEBUG(D_deliver|D_retry)
3434 debug_printf(" existing delete item dropped\n");
3437 /* We want to add a delete item only if there is no non-delete item;
3438 however we still have to step ptr through the data. */
3440 if (!r || !(*ptr & rf_delete))
3442 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3443 r->next = addr->retries;
3446 r->key = string_copy(ptr);
3448 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3449 ptr += sizeof(r->basic_errno);
3450 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3451 ptr += sizeof(r->more_errno);
3452 r->message = *ptr ? string_copy(ptr) : NULL;
3453 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3454 r->flags & rf_delete ? "delete" : "retry");
3459 DEBUG(D_deliver|D_retry)
3460 debug_printf(" delete item not added: non-delete item exists\n");
3463 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3469 /* Put the amount of data written into the parlist block */
3472 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3473 ptr += sizeof(transport_count);
3476 /* Address items are in the order of items on the address chain. We
3477 remember the current address value in case this function is called
3478 several times to empty the pipe in stages. Information about delivery
3479 over TLS is sent in a preceding X item for each address. We don't put
3480 it in with the other info, in order to keep each message short enough to
3481 guarantee it won't be split in the pipe. */
3485 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3489 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3493 addr->cipher = string_copy(ptr);
3494 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3498 addr->peerdn = string_copy(ptr);
3503 (void) tls_import_cert(ptr, &addr->peercert);
3505 addr->peercert = NULL;
3510 (void) tls_import_cert(ptr, &addr->ourcert);
3512 addr->ourcert = NULL;
3515 # ifndef DISABLE_OCSP
3517 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3523 #endif /*DISABLE_TLS*/
3525 case 'C': /* client authenticator information */
3528 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3529 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3530 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3535 #ifndef DISABLE_PRDR
3537 setflag(addr, af_prdr_used);
3544 #ifndef DISABLE_PIPE_CONNECT
3545 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3547 case 1: setflag(addr, af_pipelining); break;
3552 setflag(addr, af_chunking_used);
3556 setflag(addr, af_tcp_fastopen_conn);
3557 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3558 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3562 if (!addr) goto ADDR_MISMATCH;
3563 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3564 ptr += sizeof(addr->dsn_aware);
3565 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3572 msg = string_sprintf("address count mismatch for data read from pipe "
3573 "for transport process %d for transport %s", pid,
3574 addrlist->transport->driver_name);
3581 case 3: /* explicit notification of continued-connection (non)use;
3582 overrides caller's knowlege. */
3583 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3584 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3587 #ifdef SUPPORT_SOCKS
3588 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3589 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3594 proxy_local_address = string_copy(ptr);
3596 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3597 ptr += sizeof(proxy_local_port);
3602 #ifdef EXPERIMENTAL_DSN_INFO
3603 case '1': /* must arrive before A0, and applies to that addr */
3604 /* Two strings: smtp_greeting and helo_response */
3605 addr->smtp_greeting = string_copy(ptr);
3607 addr->helo_response = string_copy(ptr);
3613 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3614 addr->transport_return = *ptr++;
3615 addr->special_action = *ptr++;
3616 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3617 ptr += sizeof(addr->basic_errno);
3618 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3619 ptr += sizeof(addr->more_errno);
3620 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3621 ptr += sizeof(addr->delivery_time);
3622 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3623 ptr += sizeof(addr->flags);
3624 addr->message = *ptr ? string_copy(ptr) : NULL;
3626 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3629 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3633 h = store_get(sizeof(host_item), GET_UNTAINTED);
3634 h->name = string_copy(ptr);
3636 h->address = string_copy(ptr);
3638 memcpy(&h->port, ptr, sizeof(h->port));
3639 ptr += sizeof(h->port);
3640 h->dnssec = *ptr == '2' ? DS_YES
3641 : *ptr == '1' ? DS_NO
3644 addr->host_used = h;
3648 /* Finished with this address */
3655 /* Local interface address/port */
3657 if (*ptr) sending_ip_address = string_copy(ptr);
3659 if (*ptr) sending_port = atoi(CS ptr);
3663 /* Z marks the logical end of the data. It is followed by '0' if
3664 continue_transport was NULL at the end of transporting, otherwise '1'.
3665 We need to know when it becomes NULL during a delivery down a passed SMTP
3666 channel so that we don't try to pass anything more down it. Of course, for
3667 most normal messages it will remain NULL all the time. */
3672 continue_transport = NULL;
3673 continue_hostname = NULL;
3676 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3679 /* Anything else is a disaster. */
3682 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3683 "process %d for transport %s", ptr[-1], pid,
3684 addr->transport->driver_name);
3690 /* The done flag is inspected externally, to determine whether or not to
3691 call the function again when the process finishes. */
3695 /* If the process hadn't finished, and we haven't seen the end of the data
3696 or if we suffered a disaster, update the rest of the state, and return FALSE to
3697 indicate "not finished". */
3706 /* Close our end of the pipe, to prevent deadlock if the far end is still
3707 pushing stuff into it. */
3712 /* If we have finished without error, but haven't had data for every address,
3713 something is wrong. */
3716 msg = string_sprintf("insufficient address data read from pipe "
3717 "for transport process %d for transport %s", pid,
3718 addr->transport->driver_name);
3720 /* If an error message is set, something has gone wrong in getting back
3721 the delivery data. Put the message into each address and freeze it. */
3724 for (addr = addrlist; addr; addr = addr->next)
3726 addr->transport_return = DEFER;
3727 addr->special_action = SPECIAL_FREEZE;
3728 addr->message = msg;
3729 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3732 /* Return TRUE to indicate we have got all we need from this process, even
3733 if it hasn't actually finished yet. */
3740 /*************************************************
3741 * Post-process a set of remote addresses *
3742 *************************************************/
3744 /* Do what has to be done immediately after a remote delivery for each set of
3745 addresses, then re-write the spool if necessary. Note that post_process_one
3746 puts the address on an appropriate queue; hence we must fish off the next
3747 one first. This function is also called if there is a problem with setting
3748 up a subprocess to do a remote delivery in parallel. In this case, the final
3749 argument contains a message, and the action must be forced to DEFER.
3752 addr pointer to chain of address items
3753 logflags flags for logging
3754 msg NULL for normal cases; -> error message for unexpected problems
3755 fallback TRUE if processing fallback hosts
3761 remote_post_process(address_item *addr, int logflags, uschar *msg,
3764 /* If any host addresses were found to be unusable, add them to the unusable
3765 tree so that subsequent deliveries don't try them. */
3767 for (host_item * h = addr->host_list; h; h = h->next)
3769 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3771 /* Now handle each address on the chain. The transport has placed '=' or '-'
3772 into the special_action field for each successful delivery. */
3776 address_item *next = addr->next;
3778 /* If msg == NULL (normal processing) and the result is DEFER and we are
3779 processing the main hosts and there are fallback hosts available, put the
3780 address on the list for fallback delivery. */
3782 if ( addr->transport_return == DEFER
3783 && addr->fallback_hosts
3788 addr->host_list = addr->fallback_hosts;
3789 addr->next = addr_fallback;
3790 addr_fallback = addr;
3791 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3794 /* If msg is set (=> unexpected problem), set it in the address before
3795 doing the ordinary post processing. */
3801 addr->message = msg;
3802 addr->transport_return = DEFER;
3804 (void)post_process_one(addr, addr->transport_return, logflags,
3805 EXIM_DTYPE_TRANSPORT, addr->special_action);
3813 /* If we have just delivered down a passed SMTP channel, and that was
3814 the last address, the channel will have been closed down. Now that
3815 we have logged that delivery, set continue_sequence to 1 so that
3816 any subsequent deliveries don't get "*" incorrectly logged. */
3818 if (!continue_transport) continue_sequence = 1;
3823 /*************************************************
3824 * Wait for one remote delivery subprocess *
3825 *************************************************/
3827 /* This function is called while doing remote deliveries when either the
3828 maximum number of processes exist and we need one to complete so that another
3829 can be created, or when waiting for the last ones to complete. It must wait for
3830 the completion of one subprocess, empty the control block slot, and return a
3831 pointer to the address chain.
3834 Returns: pointer to the chain of addresses handled by the process;
3835 NULL if no subprocess found - this is an unexpected error
3838 static address_item *
3841 int poffset, status;
3842 address_item * addr, * addrlist;
3845 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3846 "to finish", message_id);
3848 /* Loop until either a subprocess completes, or there are no subprocesses in
3849 existence - in which case give an error return. We cannot proceed just by
3850 waiting for a completion, because a subprocess may have filled up its pipe, and
3851 be waiting for it to be emptied. Therefore, if no processes have finished, we
3852 wait for one of the pipes to acquire some data by calling poll(), with a
3853 timeout just in case.
3855 The simple approach is just to iterate after reading data from a ready pipe.
3856 This leads to non-ideal behaviour when the subprocess has written its final Z
3857 item, closed the pipe, and is in the process of exiting (the common case). A
3858 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3859 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3862 To avoid this, if all the data that is needed has been read from a subprocess
3863 after poll(), an explicit wait() for it is done. We know that all it is doing
3864 is writing to the pipe and then exiting, so the wait should not be long.
3866 The non-blocking waitpid() is to some extent just insurance; if we could
3867 reliably detect end-of-file on the pipe, we could always know when to do a
3868 blocking wait() for a completed process. However, because some systems use
3869 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3870 use code that functions without the need to recognize EOF.
3872 There's a double loop here just in case we end up with a process that is not in
3873 the list of remote delivery processes. Something has obviously gone wrong if
3874 this is the case. (For example, a process that is incorrectly left over from
3875 routing or local deliveries might be found.) The damage can be minimized by
3876 looping back and looking for another process. If there aren't any, the error
3877 return will happen. */
3879 for (;;) /* Normally we do not repeat this loop */
3881 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3885 /* A return value of -1 can mean several things. If errno != ECHILD, it
3886 either means invalid options (which we discount), or that this process was
3887 interrupted by a signal. Just loop to try the waitpid() again.
3889 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3890 in existence. This should never happen, and is an unexpected error.
3891 However, there is a nasty complication when running under Linux. If "strace
3892 -f" is being used under Linux to trace this process and its children,
3893 subprocesses are "stolen" from their parents and become the children of the
3894 tracing process. A general wait such as the one we've just obeyed returns
3895 as if there are no children while subprocesses are running. Once a
3896 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3897 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3900 This does not happen using "truss" on Solaris, nor (I think) with other
3901 tracing facilities on other OS. It seems to be specific to Linux.
3903 What we do to get round this is to use kill() to see if any of our
3904 subprocesses are still in existence. If kill() gives an OK return, we know
3905 it must be for one of our processes - it can't be for a re-use of the pid,
3906 because if our process had finished, waitpid() would have found it. If any
3907 of our subprocesses are in existence, we proceed to use poll() as if
3908 waitpid() had returned zero. I think this is safe. */
3912 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3915 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3916 "for process existence\n");
3918 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3920 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3922 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3923 "stolen by strace\n", (int)pid);
3924 break; /* With poffset set */
3928 if (poffset >= remote_max_parallel)
3930 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3931 return NULL; /* This is the error return */
3935 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3936 been handled above. A return value of zero means that there is at least one
3937 subprocess, but there are no completed subprocesses. See if any pipes are
3938 ready with any data for reading. */
3940 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3942 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3943 if (parlist[poffset].pid != 0)
3945 parpoll[poffset].fd = parlist[poffset].fd;
3946 parpoll[poffset].events = POLLIN;
3949 parpoll[poffset].fd = -1;
3951 /* Stick in a 60-second timeout, just in case. */
3953 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3955 /* Scan through the pipes and read any that are ready; use the count
3956 returned by poll() to stop when there are no more. Select() can return
3957 with no processes (e.g. if interrupted). This shouldn't matter.
3959 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3960 read, or there was a disaster. In either case, we are finished with this
3961 process. Do an explicit wait() for the process and break the main loop if
3964 It turns out that we have to deal with the case of an interrupted system
3965 call, which can happen on some operating systems if the signal handling is
3966 set up to do that by default. */
3969 readycount > 0 && poffset < remote_max_parallel;
3972 if ( (pid = parlist[poffset].pid) != 0
3973 && parpoll[poffset].revents
3977 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3978 for (;;) /* Loop for signals */
3980 pid_t endedpid = waitpid(pid, &status, 0);
3981 if (endedpid == pid) goto PROCESS_DONE;
3982 if (endedpid != (pid_t)(-1) || errno != EINTR)
3983 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3984 "%d (errno = %d) from waitpid() for process %d",
3985 (int)endedpid, errno, (int)pid);
3990 /* Now go back and look for a completed subprocess again. */
3993 /* A completed process was detected by the non-blocking waitpid(). Find the
3994 data block that corresponds to this subprocess. */
3996 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3997 if (pid == parlist[poffset].pid) break;
3999 /* Found the data block; this is a known remote delivery process. We don't
4000 need to repeat the outer loop. This should be what normally happens. */
4002 if (poffset < remote_max_parallel) break;
4004 /* This situation is an error, but it's probably better to carry on looking
4005 for another process than to give up (as we used to do). */
4007 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4008 "transport process list", pid);
4009 } /* End of the "for" loop */
4011 /* Come here when all the data was completely read after a poll(), and
4012 the process in pid has been wait()ed for. */
4019 debug_printf("remote delivery process %d ended\n", (int)pid);
4021 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4025 set_process_info("delivering %s", message_id);
4027 /* Get the chain of processed addresses */
4029 addrlist = parlist[poffset].addrlist;
4031 /* If the process did not finish cleanly, record an error and freeze (except
4032 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4033 in case the delivery did actually happen. */
4035 if ((status & 0xffff) != 0)
4038 int msb = (status >> 8) & 255;
4039 int lsb = status & 255;
4040 int code = (msb == 0)? (lsb & 0x7f) : msb;
4042 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4044 addrlist->transport->driver_name,
4046 msb == 0 ? "terminated by signal" : "exit code",
4049 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4050 addrlist->special_action = SPECIAL_FREEZE;
4052 for (addr = addrlist; addr; addr = addr->next)
4054 addr->transport_return = DEFER;
4055 addr->message = msg;
4058 remove_journal = FALSE;
4061 /* Else complete reading the pipe to get the result of the delivery, if all
4062 the data has not yet been obtained. */
4064 else if (!parlist[poffset].done)
4065 (void) par_read_pipe(poffset, TRUE);
4067 /* Put the data count and return path into globals, mark the data slot unused,
4068 decrement the count of subprocesses, and return the address chain. */
4070 transport_count = parlist[poffset].transport_count;
4071 used_return_path = parlist[poffset].return_path;
4072 parlist[poffset].pid = 0;
4079 /*************************************************
4080 * Wait for subprocesses and post-process *
4081 *************************************************/
4083 /* This function waits for subprocesses until the number that are still running
4084 is below a given threshold. For each complete subprocess, the addresses are
4085 post-processed. If we can't find a running process, there is some shambles.
4086 Better not bomb out, as that might lead to multiple copies of the message. Just
4087 log and proceed as if all done.
4090 max maximum number of subprocesses to leave running
4091 fallback TRUE if processing fallback hosts
4097 par_reduce(int max, BOOL fallback)
4099 while (parcount > max)
4101 address_item *doneaddr = par_wait();
4104 log_write(0, LOG_MAIN|LOG_PANIC,
4105 "remote delivery process count got out of step");
4110 transport_instance * tp = doneaddr->transport;
4111 if (tp->max_parallel)
4112 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4114 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4120 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4122 uschar pipe_header[PIPE_HEADER_SIZE+1];
4123 size_t total_len = PIPE_HEADER_SIZE + size;
4125 struct iovec iov[2] = {
4126 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4127 { buf, size } /* *the* data */
4132 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4133 /* complain to log if someone tries with buffer sizes we can't handle*/
4135 if (size > BIG_BUFFER_SIZE-1)
4137 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4138 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4140 size = BIG_BUFFER_SIZE;
4143 /* Should we check that we do not write more than PIPE_BUF? What would
4146 /* convert size to human readable string prepended by id and subid */
4147 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4148 id, subid, (long)size))
4149 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4151 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4152 id, subid, (long)size, pipe_header);
4154 if ((ret = writev(fd, iov, 2)) != total_len)
4155 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4156 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4157 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4160 /*************************************************
4161 * Do remote deliveries *
4162 *************************************************/
4164 /* This function is called to process the addresses in addr_remote. We must
4165 pick off the queue all addresses that have the same transport, remote
4166 destination, and errors address, and hand them to the transport in one go,
4167 subject to some configured limitations. If this is a run to continue delivering
4168 to an existing delivery channel, skip all but those addresses that can go to
4169 that channel. The skipped addresses just get deferred.
4171 If mua_wrapper is set, all addresses must be able to be sent in a single
4172 transaction. If not, this function yields FALSE.
4174 In Exim 4, remote deliveries are always done in separate processes, even
4175 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4176 is so that the base process can retain privilege. This makes the
4177 implementation of fallback transports feasible (though not initially done.)
4179 We create up to the configured number of subprocesses, each of which passes
4180 back the delivery state via a pipe. (However, when sending down an existing
4181 connection, remote_max_parallel is forced to 1.)
4184 fallback TRUE if processing fallback hosts
4186 Returns: TRUE normally
4187 FALSE if mua_wrapper is set and the addresses cannot all be sent
4192 do_remote_deliveries(BOOL fallback)
4197 parcount = 0; /* Number of executing subprocesses */
4199 /* When sending down an existing channel, only do one delivery at a time.
4200 We use a local variable (parmax) to hold the maximum number of processes;
4201 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4203 if (continue_transport) remote_max_parallel = 1;
4204 parmax = remote_max_parallel;
4206 /* If the data for keeping a list of processes hasn't yet been
4211 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4212 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4213 parlist[poffset].pid = 0;
4214 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4217 /* Now loop for each remote delivery */
4219 for (int delivery_count = 0; addr_remote; delivery_count++)
4225 int address_count = 1;
4226 int address_count_max;
4228 BOOL use_initgroups;
4229 BOOL pipe_done = FALSE;
4230 transport_instance *tp;
4231 address_item **anchor = &addr_remote;
4232 address_item *addr = addr_remote;
4233 address_item *last = addr;
4236 uschar * serialize_key = NULL;
4238 /* Pull the first address right off the list. */
4240 addr_remote = addr->next;
4243 DEBUG(D_deliver|D_transport)
4244 debug_printf("--------> %s <--------\n", addr->address);
4246 /* If no transport has been set, there has been a big screw-up somewhere. */
4248 if (!(tp = addr->transport))
4250 f.disable_logging = FALSE; /* Jic */
4251 panicmsg = US"No transport set by router";
4252 goto panic_continue;
4255 /* Check that this base address hasn't previously been delivered to this
4256 transport. The check is necessary at this point to handle homonymic addresses
4257 correctly in cases where the pattern of redirection changes between delivery
4258 attempts. Non-homonymic previous delivery is detected earlier, at routing
4261 if (previously_transported(addr, FALSE)) continue;
4263 /* Force failure if the message is too big. */
4265 if (tp->message_size_limit)
4267 int rc = check_message_size(tp, addr);
4270 addr->transport_return = rc;
4271 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4276 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4277 So look out for the place it gets used.
4280 /* Get the flag which specifies whether the transport can handle different
4281 domains that nevertheless resolve to the same set of hosts. If it needs
4282 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4283 $host, $host_address, $host_port. */
4284 if (tp->expand_multi_domain)
4285 deliver_set_expansions(addr);
4287 if (exp_bool(addr, US"transport", tp->name, D_transport,
4288 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4289 &multi_domain) != OK)
4291 deliver_set_expansions(NULL);
4292 panicmsg = addr->message;
4293 goto panic_continue;
4296 /* Get the maximum it can handle in one envelope, with zero meaning
4297 unlimited, which is forced for the MUA wrapper case and if the
4298 value could vary depending on the messages.
4299 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4300 transport splitting further by max_rcp. So we potentially lose some
4303 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4304 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4307 /************************************************************************/
4308 /***** This is slightly experimental code, but should be safe. *****/
4310 /* The address_count_max value is the maximum number of addresses that the
4311 transport can send in one envelope. However, the transport must be capable of
4312 dealing with any number of addresses. If the number it gets exceeds its
4313 envelope limitation, it must send multiple copies of the message. This can be
4314 done over a single connection for SMTP, so uses less resources than making
4315 multiple connections. On the other hand, if remote_max_parallel is greater
4316 than one, it is perhaps a good idea to use parallel processing to move the
4317 message faster, even if that results in multiple simultaneous connections to
4320 How can we come to some compromise between these two ideals? What we do is to
4321 limit the number of addresses passed to a single instance of a transport to
4322 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4323 number of addresses routed to remote transports divided by
4324 remote_max_parallel. For example, if the message has 100 remote recipients,
4325 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4326 once. But if rcpt_max is 100, we could send up to 100.
4328 Of course, not all the remotely addresses in a message are going to go to the
4329 same set of hosts (except in smarthost configurations), so this is just a
4330 heuristic way of dividing up the work.
4332 Furthermore (1), because this may not be wanted in some cases, and also to
4333 cope with really pathological cases, there is also a limit to the number of
4334 messages that are sent over one connection. This is the same limit that is
4335 used when sending several different messages over the same connection.
4336 Continue_sequence is set when in this situation, to the number sent so
4337 far, including this message.
4339 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4340 is probably because they are using VERP, in which case they want to pass only
4341 one address at a time to the transport, in order to be able to use
4342 $local_part and $domain in constructing a new return path. We could test for
4343 the use of these variables, but as it is so likely they will be used when the
4344 maximum is 1, we don't bother. Just leave the value alone. */
4346 if ( address_count_max != 1
4347 && address_count_max < remote_delivery_count/remote_max_parallel
4350 int new_max = remote_delivery_count/remote_max_parallel;
4351 int message_max = tp->connection_max_messages;
4352 if (connection_max_messages >= 0) message_max = connection_max_messages;
4353 message_max -= continue_sequence - 1;
4354 if (message_max > 0 && new_max > address_count_max * message_max)
4355 new_max = address_count_max * message_max;
4356 address_count_max = new_max;
4359 /************************************************************************/
4362 /*XXX don't know yet if DANE will be used. So tpt will have to
4363 check at the point if gets next addr from list, and skip/defer any
4367 /* Pick off all addresses which have the same transport, errors address,
4368 destination, and extra headers. In some cases they point to the same host
4369 list, but we also need to check for identical host lists generated from
4370 entirely different domains. The host list pointers can be NULL in the case
4371 where the hosts are defined in the transport. There is also a configured
4372 maximum limit of addresses that can be handled at once (see comments above
4373 for how it is computed).
4374 If the transport does not handle multiple domains, enforce that also,
4375 and if it might need a per-address check for this, re-evaluate it.
4378 while ((next = *anchor) && address_count < address_count_max)
4381 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4382 && tp == next->transport
4383 && same_hosts(next->host_list, addr->host_list)
4384 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4385 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4386 && same_ugid(tp, next, addr)
4387 && ( next->prop.remove_headers == addr->prop.remove_headers
4388 || ( next->prop.remove_headers
4389 && addr->prop.remove_headers
4390 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4394 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4396 US"transport", next->transport->name, D_transport,
4397 US"multi_domain", next->transport->multi_domain,
4398 next->transport->expand_multi_domain, &md) == OK
4403 *anchor = next->next;
4405 next->first = addr; /* remember top one (for retry processing) */
4410 else anchor = &(next->next);
4411 deliver_set_expansions(NULL);
4414 /* If we are acting as an MUA wrapper, all addresses must go in a single
4415 transaction. If not, put them back on the chain and yield FALSE. */
4417 if (mua_wrapper && addr_remote)
4419 last->next = addr_remote;
4424 /* If the transport is limited for parallellism, enforce that here.
4425 The hints DB entry is decremented in par_reduce(), when we reap the
4426 transport process. */
4428 if (tpt_parallel_check(tp, addr, &serialize_key))
4429 if ((panicmsg = expand_string_message))
4430 goto panic_continue;
4432 continue; /* Loop for the next set of addresses. */
4434 /* Set up the expansion variables for this set of addresses */
4436 deliver_set_expansions(addr);
4438 /* Ensure any transport-set auth info is fresh */
4439 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4441 /* Compute the return path, expanding a new one if required. The old one
4442 must be set first, as it might be referred to in the expansion. */
4444 if(addr->prop.errors_address)
4445 return_path = addr->prop.errors_address;
4447 return_path = sender_address;
4449 if (tp->return_path)
4451 uschar *new_return_path = expand_string(tp->return_path);
4452 if (new_return_path)
4453 return_path = new_return_path;
4454 else if (!f.expand_string_forcedfail)
4456 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4457 tp->return_path, expand_string_message);
4462 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4463 logs and sets up error messages, so we just post-process and continue with
4464 the next address. */
4466 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4472 /* If this transport has a setup function, call it now so that it gets
4473 run in this process and not in any subprocess. That way, the results of
4474 any setup that are retained by the transport can be reusable. One of the
4475 things the setup does is to set the fallback host lists in the addresses.
4476 That is why it is called at this point, before the continue delivery
4477 processing, because that might use the fallback hosts. */
4480 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4482 /* If we have a connection still open from a verify stage (lazy-close)
4483 treat it as if it is a continued connection (apart from the counter used
4484 for the log line mark). */
4486 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4489 debug_printf("lazy-callout-close: have conn still open from verification\n");
4490 continue_transport = cutthrough.transport;
4491 continue_hostname = string_copy(cutthrough.host.name);
4492 continue_host_address = string_copy(cutthrough.host.address);
4493 continue_sequence = 1;
4494 sending_ip_address = cutthrough.snd_ip;
4495 sending_port = cutthrough.snd_port;
4496 smtp_peer_options = cutthrough.peer_options;
4499 /* If this is a run to continue delivery down an already-established
4500 channel, check that this set of addresses matches the transport and
4501 the channel. If it does not, defer the addresses. If a host list exists,
4502 we must check that the continue host is on the list. Otherwise, the
4503 host is set in the transport. */
4505 f.continue_more = FALSE; /* In case got set for the last lot */
4506 if (continue_transport)
4508 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4509 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4511 /* If the transport is about to override the host list do not check
4512 it here but take the cost of running the transport process to discover
4513 if the continued_hostname connection is suitable. This is a layering
4514 violation which is unfortunate as it requires we haul in the smtp
4519 smtp_transport_options_block * ob;
4521 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4522 && (ob = (smtp_transport_options_block *)tp->options_block)
4523 && ob->hosts_override && ob->hosts
4529 for (host_item * h = addr->host_list; h; h = h->next)
4530 if (Ustrcmp(h->name, continue_hostname) == 0)
4531 /*XXX should also check port here */
4532 { ok = TRUE; break; }
4536 /* Addresses not suitable; defer or queue for fallback hosts (which
4537 might be the continue host) and skip to next address. */
4541 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4542 Ustrcmp(continue_transport, tp->name) != 0
4543 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4544 : string_sprintf("no host matching %s", continue_hostname));
4545 if (serialize_key) enq_end(serialize_key);
4547 if (addr->fallback_hosts && !fallback)
4549 for (next = addr; ; next = next->next)
4551 next->host_list = next->fallback_hosts;
4552 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4553 if (!next->next) break;
4555 next->next = addr_fallback;
4556 addr_fallback = addr;
4561 for (next = addr; ; next = next->next)
4563 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4564 if (!next->next) break;
4566 next->next = addr_defer;
4573 /* Set a flag indicating whether there are further addresses that list
4574 the continued host. This tells the transport to leave the channel open,
4575 but not to pass it to another delivery process. We'd like to do that
4576 for non-continue_transport cases too but the knowlege of which host is
4577 connected to is too hard to manage. Perhaps we need a finer-grain
4578 interface to the transport. */
4580 for (next = addr_remote; next && !f.continue_more; next = next->next)
4581 for (host_item * h = next->host_list; h; h = h->next)
4582 if (Ustrcmp(h->name, continue_hostname) == 0)
4583 { f.continue_more = TRUE; break; }
4586 /* The transports set up the process info themselves as they may connect
4587 to more than one remote machine. They also have to set up the filter
4588 arguments, if required, so that the host name and address are available
4591 transport_filter_argv = NULL;
4593 /* Create the pipe for inter-process communication. If pipe creation
4594 fails, it is probably because the value of remote_max_parallel is so
4595 large that too many file descriptors for pipes have been created. Arrange
4596 to wait for a process to finish, and then try again. If we still can't
4597 create a pipe when all processes have finished, break the retry loop. */
4601 if (pipe(pfd) == 0) pipe_done = TRUE;
4602 else if (parcount > 0) parmax = parcount;
4605 /* We need to make the reading end of the pipe non-blocking. There are
4606 two different options for this. Exim is cunningly (I hope!) coded so
4607 that it can use either of them, though it prefers O_NONBLOCK, which
4608 distinguishes between EOF and no-more-data. */
4610 /* The data appears in a timely manner and we already did a poll on
4611 all pipes, so I do not see a reason to use non-blocking IO here
4614 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4616 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4620 /* If the maximum number of subprocesses already exist, wait for a process
4621 to finish. If we ran out of file descriptors, parmax will have been reduced
4622 from its initial value of remote_max_parallel. */
4624 par_reduce(parmax - 1, fallback);
4627 /* If we failed to create a pipe and there were no processes to wait
4628 for, we have to give up on this one. Do this outside the above loop
4629 so that we can continue the main loop. */
4633 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4637 /* Find a free slot in the pardata list. Must do this after the possible
4638 waiting for processes to finish, because a terminating process will free
4641 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4642 if (parlist[poffset].pid == 0)
4645 /* If there isn't one, there has been a horrible disaster. */
4647 if (poffset >= remote_max_parallel)
4649 (void)close(pfd[pipe_write]);
4650 (void)close(pfd[pipe_read]);
4651 panicmsg = US"Unexpectedly no free subprocess slot";
4655 /* Now fork a subprocess to do the remote delivery, but before doing so,
4656 ensure that any cached resources are released so as not to interfere with
4657 what happens in the subprocess. */
4661 if ((pid = exim_fork(US"transport")) == 0)
4663 int fd = pfd[pipe_write];
4666 /* Setting these globals in the subprocess means we need never clear them */
4667 transport_name = addr->transport->name;
4668 driver_srcfile = tp->srcfile;
4669 driver_srcline = tp->srcline;
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, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4712 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4713 "parallel delivery: %s", fname, strerror(errno));
4716 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4717 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4721 /* Set the uid/gid of this process; bombs out on failure. */
4723 exim_setugid(uid, gid, use_initgroups,
4724 string_sprintf("remote delivery to %s with transport=%s",
4725 addr->address, tp->name));
4727 /* Close the unwanted half of this process' pipe, set the process state,
4728 and run the transport. Afterwards, transport_count will contain the number
4729 of bytes written. */
4731 (void)close(pfd[pipe_read]);
4732 set_process_info("delivering %s using %s", message_id, tp->name);
4733 debug_print_string(tp->debug_string);
4734 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4736 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4737 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4739 /* Ensure any cached resources that we used are now released */
4743 /* Pass the result back down the pipe. This is a lot more information
4744 than is needed for a local delivery. We have to send back the error
4745 status for each address, the usability status for each host that is
4746 flagged as unusable, and all the retry items. When TLS is in use, we
4747 send also the cipher and peerdn information. Each type of information
4748 is flagged by an identifying byte, and is then in a fixed format (with
4749 strings terminated by zeros), and there is a final terminator at the
4750 end. The host information and retry information is all attached to
4751 the first address, so that gets sent at the start. */
4753 /* Host unusability information: for most success cases this will
4756 for (h = addr->host_list; h; h = h->next)
4758 if (!h->address || h->status < hstatus_unusable) continue;
4759 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4760 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4763 /* The number of bytes written. This is the same for each address. Even
4764 if we sent several copies of the message down the same connection, the
4765 size of each one is the same, and it's that value we have got because
4766 transport_count gets reset before calling transport_write_message(). */
4768 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4769 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4771 /* Information about what happened to each address. Four item types are
4772 used: an optional 'X' item first, for TLS information, then an optional "C"
4773 item for any client-auth info followed by 'R' items for any retry settings,
4774 and finally an 'A' item for the remaining data. */
4776 for(; addr; addr = addr->next)
4780 /* The certificate verification status goes into the flags */
4781 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4783 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4785 # ifndef DISABLE_TLS_RESUME
4786 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4789 /* Use an X item only if there's something to send */
4793 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4797 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4799 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4801 else if (continue_proxy_cipher)
4803 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4805 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4811 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4815 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4820 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4824 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4826 # ifndef DISABLE_OCSP
4827 if (addr->ocsp > OCSP_NOT_REQ)
4829 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4830 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4833 #endif /*DISABLE_TLS*/
4835 if (client_authenticator)
4837 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4838 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4840 if (client_authenticated_id)
4842 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4843 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4845 if (client_authenticated_sender)
4847 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4848 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4851 #ifndef DISABLE_PRDR
4852 if (testflag(addr, af_prdr_used))
4853 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4856 if (testflag(addr, af_pipelining))
4857 #ifndef DISABLE_PIPE_CONNECT
4858 if (testflag(addr, af_early_pipe))
4859 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4862 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4864 if (testflag(addr, af_chunking_used))
4865 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4867 if (testflag(addr, af_tcp_fastopen_conn))
4868 rmt_dlv_checked_write(fd, 'T',
4869 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4873 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4874 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4876 /* Retry information: for most success cases this will be null. */
4878 for (retry_item * r = addr->retries; r; r = r->next)
4880 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4881 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4882 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4883 ptr += sizeof(r->basic_errno);
4884 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4885 ptr += sizeof(r->more_errno);
4886 if (!r->message) *ptr++ = 0; else
4888 sprintf(CS ptr, "%.512s", r->message);
4891 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4894 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4896 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4897 testflag(addr, af_new_conn) ? "non-" : "");
4898 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4899 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4902 #ifdef SUPPORT_SOCKS
4903 if (LOGGING(proxy) && proxy_session)
4906 if (proxy_local_address)
4908 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4909 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4910 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4911 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4912 ptr += sizeof(proxy_local_port);
4916 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4920 #ifdef EXPERIMENTAL_DSN_INFO
4921 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4922 if (addr->smtp_greeting)
4924 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4925 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4926 if (addr->helo_response)
4928 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4929 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4933 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4937 /* The rest of the information goes in an 'A0' item. */
4939 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4940 ptr = big_buffer + 2;
4941 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4942 ptr += sizeof(addr->basic_errno);
4943 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4944 ptr += sizeof(addr->more_errno);
4945 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4946 ptr += sizeof(addr->delivery_time);
4947 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4948 ptr += sizeof(addr->flags);
4950 if (!addr->message) *ptr++ = 0; else
4951 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4953 if (!addr->user_message) *ptr++ = 0; else
4954 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4956 if (!addr->host_used) *ptr++ = 0; else
4958 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4959 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4960 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4961 ptr += sizeof(addr->host_used->port);
4963 /* DNS lookup status */
4964 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4965 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4968 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4971 /* Local interface address/port */
4972 #ifdef EXPERIMENTAL_DSN_INFO
4973 if (sending_ip_address)
4975 if (LOGGING(incoming_interface) && sending_ip_address)
4979 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4980 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4981 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4984 /* Add termination flag, close the pipe, and that's it. The character
4985 after 'Z' indicates whether continue_transport is now NULL or not.
4986 A change from non-NULL to NULL indicates a problem with a continuing
4989 big_buffer[0] = continue_transport ? '1' : '0';
4990 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4995 /* Back in the mainline: close the unwanted half of the pipe. */
4997 (void)close(pfd[pipe_write]);
4999 /* If we have a connection still open from a verify stage (lazy-close)
5000 release its TLS library context (if any) as responsibility was passed to
5001 the delivery child process. */
5003 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5006 if (cutthrough.is_tls)
5007 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5009 (void) close(cutthrough.cctx.sock);
5010 release_cutthrough_connection(US"passed to transport proc");
5013 /* Fork failed; defer with error message */
5017 (void)close(pfd[pipe_read]);
5018 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5019 addr->domain, strerror(errno));
5023 /* Fork succeeded; increment the count, and remember relevant data for
5024 when the process finishes. */
5027 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5028 parlist[poffset].pid = pid;
5029 parlist[poffset].fd = pfd[pipe_read];
5030 parlist[poffset].done = FALSE;
5031 parlist[poffset].msg = NULL;
5032 parlist[poffset].return_path = return_path;
5034 /* If the process we've just started is sending a message down an existing
5035 channel, wait for it now. This ensures that only one such process runs at
5036 once, whatever the value of remote_max parallel. Otherwise, we might try to
5037 send two or more messages simultaneously down the same channel. This could
5038 happen if there are different domains that include the same host in otherwise
5039 different host lists.
5041 Also, if the transport closes down the channel, this information gets back
5042 (continue_transport gets set to NULL) before we consider any other addresses
5045 if (continue_transport) par_reduce(0, fallback);
5047 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5048 newly created process get going before we create another process. This should
5049 ensure repeatability in the tests. Wait long enough for most cases to complete
5052 else testharness_pause_ms(600);
5057 if (serialize_key) enq_end(serialize_key);
5059 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5063 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5064 are still running and post-process their addresses. */
5066 par_reduce(0, fallback);
5073 /*************************************************
5074 * Split an address into local part and domain *
5075 *************************************************/
5077 /* This function initializes an address for routing by splitting it up into a
5078 local part and a domain. The local part is set up twice - once in its original
5079 casing, and once in lower case, and it is dequoted. We also do the "percent
5080 hack" for configured domains. This may lead to a DEFER result if a lookup
5081 defers. When a percent-hacking takes place, we insert a copy of the original
5082 address as a new parent of this address, as if we have had a redirection.
5085 addr points to an addr_item block containing the address
5088 DEFER - could not determine if domain is %-hackable
5092 deliver_split_address(address_item * addr)
5094 uschar * address = addr->address;
5099 if (!(domain = Ustrrchr(address, '@')))
5100 return DEFER; /* should always have a domain, but just in case... */
5102 len = domain - address;
5103 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5105 /* The implication in the RFCs (though I can't say I've seen it spelled out
5106 explicitly) is that quoting should be removed from local parts at the point
5107 where they are locally interpreted. [The new draft "821" is more explicit on
5108 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5109 removing quoting backslashes and any unquoted doublequotes. */
5111 t = addr->cc_local_part = store_get(len+1, address);
5115 if (c == '\"') continue;
5125 /* We do the percent hack only for those domains that are listed in
5126 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5128 if (percent_hack_domains)
5131 uschar *new_address = NULL;
5132 uschar *local_part = addr->cc_local_part;
5134 deliver_domain = addr->domain; /* set $domain */
5136 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5137 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5139 && (t = Ustrrchr(local_part, '%')) != NULL
5142 new_address = string_copy(local_part);
5143 new_address[t - local_part] = '@';
5144 deliver_domain = string_copylc(t+1);
5145 local_part = string_copyn(local_part, t - local_part);
5148 if (rc == DEFER) return DEFER; /* lookup deferred */
5150 /* If hackery happened, set up new parent and alter the current address. */
5154 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5155 *new_parent = *addr;
5156 addr->parent = new_parent;
5157 new_parent->child_count = 1;
5158 addr->address = new_address;
5159 addr->unique = string_copy(new_address);
5160 addr->domain = deliver_domain;
5161 addr->cc_local_part = local_part;
5162 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5167 /* Create the lowercased version of the final local part, and make that the
5168 default one to be used. */
5170 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5177 /*************************************************
5178 * Get next error message text *
5179 *************************************************/
5181 /* If f is not NULL, read the next "paragraph", from a customized error message
5182 text file, terminated by a line containing ****, and expand it.
5185 f NULL or a file to read from
5186 which string indicating which string (for errors)
5188 Returns: NULL or an expanded string
5192 next_emf(FILE *f, uschar *which)
5198 if (!f) return NULL;
5200 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5203 para = string_get(256);
5206 para = string_cat(para, buffer);
5207 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5210 if ((yield = expand_string(string_from_gstring(para))))
5213 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5214 "bounce_message_file or warn_message_file (%s): %s", which,
5215 expand_string_message);
5222 /*************************************************
5223 * Close down a passed transport channel *
5224 *************************************************/
5226 /* This function is called when a passed transport channel cannot be used.
5227 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5228 so that the function call can be the argument of a "return" statement.
5231 Returns: DELIVER_NOT_ATTEMPTED
5235 continue_closedown(void)
5237 if (continue_transport)
5238 for (transport_instance * t = transports; t; t = t->next)
5239 if (Ustrcmp(t->name, continue_transport) == 0)
5241 if (t->info->closedown) (t->info->closedown)(t);
5244 return DELIVER_NOT_ATTEMPTED;
5250 /*************************************************
5251 * Print address information *
5252 *************************************************/
5254 /* This function is called to output an address, or information about an
5255 address, for bounce or defer messages. If the hide_child flag is set, all we
5256 output is the original ancestor address.
5259 addr points to the address
5260 f the FILE to print to
5261 si an initial string
5262 sc a continuation string for before "generated"
5265 Returns: TRUE if the address is not hidden
5269 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5273 uschar *printed = US"";
5274 address_item *ancestor = addr;
5275 while (ancestor->parent) ancestor = ancestor->parent;
5277 fprintf(f, "%s", CS si);
5279 if (addr->parent && testflag(addr, af_hide_child))
5281 printed = US"an undisclosed address";
5284 else if (!testflag(addr, af_pfr) || !addr->parent)
5285 printed = addr->address;
5289 uschar *s = addr->address;
5292 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5293 else if (addr->address[0] == '|') ss = US"pipe";
5296 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5297 printed = addr->parent->address;
5300 fprintf(f, "%s", CS string_printing(printed));
5302 if (ancestor != addr)
5304 uschar *original = ancestor->onetime_parent;
5305 if (!original) original= ancestor->address;
5306 if (strcmpic(original, printed) != 0)
5307 fprintf(f, "%s(%sgenerated from %s)", sc,
5308 ancestor != addr->parent ? "ultimately " : "",
5309 string_printing(original));
5312 if (addr->host_used)
5313 fprintf(f, "\n host %s [%s]",
5314 addr->host_used->name, addr->host_used->address);
5316 fprintf(f, "%s", CS se);
5324 /*************************************************
5325 * Print error for an address *
5326 *************************************************/
5328 /* This function is called to print the error information out of an address for
5329 a bounce or a warning message. It tries to format the message reasonably by
5330 introducing newlines. All lines are indented by 4; the initial printing
5331 position must be set before calling.
5333 This function used always to print the error. Nowadays we want to restrict it
5334 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5335 and filter "fail". We no longer pass other information willy-nilly in bounce
5336 and warning messages. Text in user_message is always output; text in message
5337 only if the af_pass_message flag is set.
5341 f the FILE to print on
5348 print_address_error(address_item * addr, FILE * f, const uschar * t)
5350 int count = Ustrlen(t);
5351 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5353 if (!s && !(s = addr->user_message))
5356 fprintf(f, "\n %s", t);
5359 if (*s == '\\' && s[1] == 'n')
5369 if (*s++ == ':' && isspace(*s) && count > 45)
5371 fprintf(f, "\n "); /* sic (because space follows) */
5378 /***********************************************************
5379 * Print Diagnostic-Code for an address *
5380 ************************************************************/
5382 /* This function is called to print the error information out of an address for
5383 a bounce or a warning message. It tries to format the message reasonably as
5384 required by RFC 3461 by adding a space after each newline
5386 it uses the same logic as print_address_error() above. if af_pass_message is true
5387 and addr->message is set it uses the remote host answer. if not addr->user_message
5388 is used instead if available.
5392 f the FILE to print on
5398 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5400 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5403 /* af_pass_message and addr->message set ? print remote host answer */
5407 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5409 /* search first ": ". we assume to find the remote-MTA answer there */
5410 if (!(s = Ustrstr(addr->message, ": ")))
5411 return; /* not found, bail out */
5412 s += 2; /* skip ": " */
5413 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5415 /* no message available. do nothing */
5420 if (cnt > 950) /* RFC line length limit: 998 */
5422 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5423 fputs("[truncated]", f);
5427 if (*s == '\\' && s[1] == 'n')
5429 fputs("\n ", f); /* as defined in RFC 3461 */
5444 /*************************************************
5445 * Check list of addresses for duplication *
5446 *************************************************/
5448 /* This function was introduced when the test for duplicate addresses that are
5449 not pipes, files, or autoreplies was moved from the middle of routing to when
5450 routing was complete. That was to fix obscure cases when the routing history
5451 affects the subsequent routing of identical addresses. This function is called
5452 after routing, to check that the final routed addresses are not duplicates.
5454 If we detect a duplicate, we remember what it is a duplicate of. Note that
5455 pipe, file, and autoreply de-duplication is handled during routing, so we must
5456 leave such "addresses" alone here, as otherwise they will incorrectly be
5459 Argument: address of list anchor
5464 do_duplicate_check(address_item **anchor)
5467 while ((addr = *anchor))
5470 if (testflag(addr, af_pfr))
5472 anchor = &(addr->next);
5474 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5476 DEBUG(D_deliver|D_route)
5477 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5478 *anchor = addr->next;
5479 addr->dupof = tnode->data.ptr;
5480 addr->next = addr_duplicate;
5481 addr_duplicate = addr;
5485 tree_add_duplicate(addr->unique, addr);
5486 anchor = &(addr->next);
5494 /************************************************/
5497 print_dsn_addr_action(FILE * f, address_item * addr,
5498 uschar * action, uschar * status)
5502 if (addr->dsn_orcpt)
5503 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5505 for (pa = addr; pa->parent; ) pa = pa->parent;
5506 fprintf(f, "Action: %s\n"
5507 "Final-Recipient: rfc822;%s\n"
5509 action, pa->address, status);
5514 /* When running in the test harness, there's an option that allows us to
5515 fudge this time so as to get repeatability of the tests. Take the first
5516 time off the list. In queue runs, the list pointer gets updated in the
5520 test_harness_fudged_queue_time(int actual_time)
5523 if ( f.running_in_test_harness && *fudged_queue_times
5524 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5526 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5527 fudged_queue_times);
5533 /************************************************/
5536 expand_open(const uschar * filename,
5537 const uschar * varname, const uschar * reason)
5539 const uschar * s = expand_cstring(filename);
5543 log_write(0, LOG_MAIN|LOG_PANIC,
5544 "Failed to expand %s: '%s'\n", varname, filename);
5545 else if (*s != '/' || is_tainted(s))
5546 log_write(0, LOG_MAIN|LOG_PANIC,
5547 "%s is not %s after expansion: '%s'\n",
5548 varname, *s == '/' ? "untainted" : "absolute", s);
5549 else if (!(fp = Ufopen(s, "rb")))
5550 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5551 "message texts: %s", s, reason, strerror(errno));
5555 /*************************************************
5556 * Deliver one message *
5557 *************************************************/
5559 /* This is the function which is called when a message is to be delivered. It
5560 is passed the id of the message. It is possible that the message no longer
5561 exists, if some other process has delivered it, and it is also possible that
5562 the message is being worked on by another process, in which case the data file
5565 If no delivery is attempted for any of the above reasons, the function returns
5566 DELIVER_NOT_ATTEMPTED.
5568 If the give_up flag is set true, do not attempt any deliveries, but instead
5569 fail all outstanding addresses and return the message to the sender (or
5572 A delivery operation has a process all to itself; we never deliver more than
5573 one message in the same process. Therefore we needn't worry too much about
5576 Liable to be called as root.
5579 id the id of the message to be delivered
5580 forced TRUE if delivery was forced by an administrator; this overrides
5581 retry delays and causes a delivery to be tried regardless
5582 give_up TRUE if an administrator has requested that delivery attempts
5585 Returns: When the global variable mua_wrapper is FALSE:
5586 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5587 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5588 When the global variable mua_wrapper is TRUE:
5589 DELIVER_MUA_SUCCEEDED if delivery succeeded
5590 DELIVER_MUA_FAILED if delivery failed
5591 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5595 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5598 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5599 time_t now = time(NULL);
5600 address_item *addr_last = NULL;
5601 uschar *filter_message = NULL;
5602 int process_recipients = RECIP_ACCEPT;
5605 extern int acl_where;
5608 #ifdef MEASURE_TIMING
5609 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5612 info = queue_run_pid == (pid_t)0
5613 ? string_sprintf("delivering %s", id)
5614 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5616 /* If the D_process_info bit is on, set_process_info() will output debugging
5617 information. If not, we want to show this initial information if D_deliver or
5618 D_queue_run is set or in verbose mode. */
5620 set_process_info("%s", info);
5622 if ( !(debug_selector & D_process_info)
5623 && (debug_selector & (D_deliver|D_queue_run|D_v))
5625 debug_printf("%s\n", info);
5627 /* Ensure that we catch any subprocesses that are created. Although Exim
5628 sets SIG_DFL as its initial default, some routes through the code end up
5629 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5630 has been forked, but no re-exec has been done. We use sigaction rather than
5631 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5632 sure it is turned off. (There was a problem on AIX with this.) */
5636 struct sigaction act;
5637 act.sa_handler = SIG_DFL;
5638 sigemptyset(&(act.sa_mask));
5640 sigaction(SIGCHLD, &act, NULL);
5643 signal(SIGCHLD, SIG_DFL);
5646 /* Make the forcing flag available for routers and transports, set up the
5647 global message id field, and initialize the count for returned files and the
5648 message size. This use of strcpy() is OK because the length id is checked when
5649 it is obtained from a command line (the -M or -q options), and otherwise it is
5650 known to be a valid message id. */
5652 if (id != message_id)
5653 Ustrcpy(message_id, id);
5654 f.deliver_force = forced;
5658 /* Initialize some flags */
5660 update_spool = FALSE;
5661 remove_journal = TRUE;
5663 /* Set a known context for any ACLs we call via expansions */
5664 acl_where = ACL_WHERE_DELIVERY;
5666 /* Reset the random number generator, so that if several delivery processes are
5667 started from a queue runner that has already used random numbers (for sorting),
5668 they don't all get the same sequence. */
5672 /* Open and lock the message's data file. Exim locks on this one because the
5673 header file may get replaced as it is re-written during the delivery process.
5674 Any failures cause messages to be written to the log, except for missing files
5675 while queue running - another process probably completed delivery. As part of
5676 opening the data file, message_subdir gets set. */
5678 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5679 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5681 /* The value of message_size at this point has been set to the data length,
5682 plus one for the blank line that notionally precedes the data. */
5684 /* Now read the contents of the header file, which will set up the headers in
5685 store, and also the list of recipients and the tree of non-recipients and
5686 assorted flags. It updates message_size. If there is a reading or format error,
5687 give up; if the message has been around for sufficiently long, remove it. */
5690 uschar * spoolname = string_sprintf("%s-H", id);
5691 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5693 if (errno == ERRNO_SPOOLFORMAT)
5695 struct stat statbuf;
5696 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5698 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5699 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5701 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5704 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5707 /* If we managed to read the envelope data, received_time contains the
5708 time the message was received. Otherwise, we can calculate it from the
5711 if (rc != spool_read_hdrerror)
5713 received_time.tv_sec = received_time.tv_usec = 0;
5714 /*XXX subsec precision?*/
5715 for (i = 0; i < 6; i++)
5716 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5719 /* If we've had this malformed message too long, sling it. */
5721 if (now - received_time.tv_sec > keep_malformed)
5723 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5724 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5725 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5726 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5727 log_write(0, LOG_MAIN, "Message removed because older than %s",
5728 readconf_printtime(keep_malformed));
5731 (void)close(deliver_datafile);
5732 deliver_datafile = -1;
5733 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5737 /* The spool header file has been read. Look to see if there is an existing
5738 journal file for this message. If there is, it means that a previous delivery
5739 attempt crashed (program or host) before it could update the spool header file.
5740 Read the list of delivered addresses from the journal and add them to the
5741 nonrecipients tree. Then update the spool file. We can leave the journal in
5742 existence, as it will get further successful deliveries added to it in this
5743 run, and it will be deleted if this function gets to its end successfully.
5744 Otherwise it might be needed again. */
5747 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5750 if ( (journal_fd = Uopen(fname,
5751 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
5752 && lseek(journal_fd, 0, SEEK_SET) == 0
5753 && (jread = fdopen(journal_fd, "rb"))
5756 while (Ufgets(big_buffer, big_buffer_size, jread))
5758 int n = Ustrlen(big_buffer);
5759 big_buffer[n-1] = 0;
5760 tree_add_nonrecipient(big_buffer);
5761 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5762 "journal file\n", big_buffer);
5765 if ((journal_fd = dup(fileno(jread))) < 0)
5766 journal_fd = fileno(jread);
5768 (void) fclose(jread); /* Try to not leak the FILE resource */
5770 /* Panic-dies on error */
5771 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5773 else if (errno != ENOENT)
5775 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5776 "%s", strerror(errno));
5777 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5780 /* A null recipients list indicates some kind of disaster. */
5782 if (!recipients_list)
5784 (void)close(deliver_datafile);
5785 deliver_datafile = -1;
5786 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5787 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5792 /* Handle a message that is frozen. There are a number of different things that
5793 can happen, but in the default situation, unless forced, no delivery is
5796 if (f.deliver_freeze)
5798 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5799 /* Moving to another directory removes the message from Exim's view. Other
5800 tools must be used to deal with it. Logging of this action happens in
5801 spool_move_message() and its subfunctions. */
5803 if ( move_frozen_messages
5804 && spool_move_message(id, message_subdir, US"", US"F")
5806 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5809 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5810 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5811 flag causing all recipients to be failed. The time is the age of the
5812 message, not the time since freezing. */
5814 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5816 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5817 process_recipients = RECIP_FAIL_TIMEOUT;
5820 /* For bounce messages (and others with no sender), thaw if the error message
5821 ignore timer is exceeded. The message will be discarded if this delivery
5824 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5825 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5827 /* If this is a bounce message, or there's no auto thaw, or we haven't
5828 reached the auto thaw time yet, and this delivery is not forced by an admin
5829 user, do not attempt delivery of this message. Note that forced is set for
5830 continuing messages down the same channel, in order to skip load checking and
5831 ignore hold domains, but we don't want unfreezing in that case. */
5835 if ( ( sender_address[0] == 0
5837 || now <= deliver_frozen_at + auto_thaw
5839 && ( !forced || !f.deliver_force_thaw
5840 || !f.admin_user || continue_hostname
5843 (void)close(deliver_datafile);
5844 deliver_datafile = -1;
5845 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5846 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5849 /* If delivery was forced (by an admin user), assume a manual thaw.
5850 Otherwise it's an auto thaw. */
5854 f.deliver_manual_thaw = TRUE;
5855 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5857 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5860 /* We get here if any of the rules for unfreezing have triggered. */
5862 f.deliver_freeze = FALSE;
5863 update_spool = TRUE;
5867 /* Open the message log file if we are using them. This records details of
5868 deliveries, deferments, and failures for the benefit of the mail administrator.
5869 The log is not used by exim itself to track the progress of a message; that is
5870 done by rewriting the header spool file. */
5874 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5878 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5880 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5881 fname, strerror(errno));
5882 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5885 /* Make a stdio stream out of it. */
5887 if (!(message_log = fdopen(fd, "a")))
5889 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5890 fname, strerror(errno));
5891 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5896 /* If asked to give up on a message, log who did it, and set the action for all
5901 struct passwd *pw = getpwuid(real_uid);
5902 log_write(0, LOG_MAIN, "cancelled by %s",
5903 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5904 process_recipients = RECIP_FAIL;
5907 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5909 else if (received_count > received_headers_max)
5910 process_recipients = RECIP_FAIL_LOOP;
5912 /* Otherwise, if a system-wide, address-independent message filter is
5913 specified, run it now, except in the case when we are failing all recipients as
5914 a result of timeout_frozen_after. If the system filter yields "delivered", then
5915 ignore the true recipients of the message. Failure of the filter file is
5916 logged, and the delivery attempt fails. */
5918 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5923 redirect_block redirect;
5925 if (system_filter_uid_set)
5927 ugid.uid = system_filter_uid;
5928 ugid.gid = system_filter_gid;
5929 ugid.uid_set = ugid.gid_set = TRUE;
5932 ugid.uid_set = ugid.gid_set = FALSE;
5934 return_path = sender_address;
5935 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5936 f.system_filtering = TRUE;
5938 /* Any error in the filter file causes a delivery to be abandoned. */
5940 redirect.string = system_filter;
5941 redirect.isfile = TRUE;
5942 redirect.check_owner = redirect.check_group = FALSE;
5943 redirect.owners = NULL;
5944 redirect.owngroups = NULL;
5946 redirect.modemask = 0;
5948 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5951 &redirect, /* Where the data is */
5952 RDO_DEFER | /* Turn on all the enabling options */
5953 RDO_FAIL | /* Leave off all the disabling options */
5958 NULL, /* No :include: restriction (not used in filter) */
5959 NULL, /* No sieve vacation directory (not sieve!) */
5960 NULL, /* No sieve enotify mailto owner (not sieve!) */
5961 NULL, /* No sieve user address (not sieve!) */
5962 NULL, /* No sieve subaddress (not sieve!) */
5963 &ugid, /* uid/gid data */
5964 &addr_new, /* Where to hang generated addresses */
5965 &filter_message, /* Where to put error message */
5966 NULL, /* Don't skip syntax errors */
5967 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5968 US"system filter"); /* For error messages */
5970 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5972 if (rc == FF_ERROR || rc == FF_NONEXIST)
5974 (void)close(deliver_datafile);
5975 deliver_datafile = -1;
5976 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5977 string_printing(filter_message));
5978 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5981 /* Reset things. If the filter message is an empty string, which can happen
5982 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5984 f.system_filtering = FALSE;
5985 f.enable_dollar_recipients = FALSE;
5986 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5988 /* Save the values of the system filter variables so that user filters
5991 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5993 /* The filter can request that delivery of the original addresses be
5998 process_recipients = RECIP_DEFER;
5999 deliver_msglog("Delivery deferred by system filter\n");
6000 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6003 /* The filter can request that a message be frozen, but this does not
6004 take place if the message has been manually thawed. In that case, we must
6005 unset "delivered", which is forced by the "freeze" command to make -bF
6008 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6010 f.deliver_freeze = TRUE;
6011 deliver_frozen_at = time(NULL);
6012 process_recipients = RECIP_DEFER;
6013 frozen_info = string_sprintf(" by the system filter%s%s",
6014 filter_message ? US": " : US"",
6015 filter_message ? filter_message : US"");
6018 /* The filter can request that a message be failed. The error message may be
6019 quite long - it is sent back to the sender in the bounce - but we don't want
6020 to fill up the log with repetitions of it. If it starts with << then the text
6021 between << and >> is written to the log, with the rest left for the bounce
6024 else if (rc == FF_FAIL)
6026 uschar *colon = US"";
6027 uschar *logmsg = US"";
6030 process_recipients = RECIP_FAIL_FILTER;
6036 if ( filter_message[0] == '<'
6037 && filter_message[1] == '<'
6038 && (logend = Ustrstr(filter_message, ">>"))
6041 logmsg = filter_message + 2;
6042 loglen = logend - logmsg;
6043 filter_message = logend + 2;
6044 if (filter_message[0] == 0) filter_message = NULL;
6048 logmsg = filter_message;
6049 loglen = Ustrlen(filter_message);
6053 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6057 /* Delivery can be restricted only to those recipients (if any) that the
6058 filter specified. */
6060 else if (rc == FF_DELIVERED)
6062 process_recipients = RECIP_IGNORE;
6064 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6066 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6069 /* If any new addresses were created by the filter, fake up a "parent"
6070 for them. This is necessary for pipes, etc., which are expected to have
6071 parents, and it also gives some sensible logging for others. Allow
6072 pipes, files, and autoreplies, and run them as the filter uid if set,
6073 otherwise as the current uid. */
6077 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6078 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6080 /* The text "system-filter" is tested in transport_set_up_command() and in
6081 set_up_shell_command() in the pipe transport, to enable them to permit
6082 $recipients, so don't change it here without also changing it there. */
6084 address_item *p = addr_new;
6085 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6087 parent->domain = string_copylc(qualify_domain_recipient);
6088 parent->local_part = US"system-filter";
6090 /* As part of this loop, we arrange for addr_last to end up pointing
6091 at the final address. This is used if we go on to add addresses for the
6092 original recipients. */
6096 if (parent->child_count == USHRT_MAX)
6097 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6098 "than %d delivery addresses", USHRT_MAX);
6099 parent->child_count++;
6102 if (testflag(p, af_pfr))
6108 setflag(p, af_uid_set);
6109 setflag(p, af_gid_set);
6110 setflag(p, af_allow_file);
6111 setflag(p, af_allow_pipe);
6112 setflag(p, af_allow_reply);
6114 /* Find the name of the system filter's appropriate pfr transport */
6116 if (p->address[0] == '|')
6119 tpname = system_filter_pipe_transport;
6120 address_pipe = p->address;
6122 else if (p->address[0] == '>')
6125 tpname = system_filter_reply_transport;
6129 if (p->address[Ustrlen(p->address)-1] == '/')
6131 type = US"directory";
6132 tpname = system_filter_directory_transport;
6137 tpname = system_filter_file_transport;
6139 address_file = p->address;
6142 /* Now find the actual transport, first expanding the name. We have
6143 set address_file or address_pipe above. */
6147 uschar *tmp = expand_string(tpname);
6148 address_file = address_pipe = NULL;
6150 p->message = string_sprintf("failed to expand \"%s\" as a "
6151 "system filter transport name", tpname);
6152 if (is_tainted(tmp))
6153 p->message = string_sprintf("attempt to used tainted value '%s' for"
6154 "transport '%s' as a system filter", tmp, tpname);
6158 p->message = string_sprintf("system_filter_%s_transport is unset",
6163 transport_instance *tp;
6164 for (tp = transports; tp; tp = tp->next)
6165 if (Ustrcmp(tp->name, tpname) == 0)
6171 p->message = string_sprintf("failed to find \"%s\" transport "
6172 "for system filter delivery", tpname);
6175 /* If we couldn't set up a transport, defer the delivery, putting the
6176 error on the panic log as well as the main log. */
6180 address_item *badp = p;
6182 if (!addr_last) addr_new = p; else addr_last->next = p;
6183 badp->local_part = badp->address; /* Needed for log line */
6184 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6187 } /* End of pfr handling */
6189 /* Either a non-pfr delivery, or we found a transport */
6191 DEBUG(D_deliver|D_filter)
6192 debug_printf("system filter added %s\n", p->address);
6196 } /* Loop through all addr_new addresses */
6201 /* Scan the recipients list, and for every one that is not in the non-
6202 recipients tree, add an addr item to the chain of new addresses. If the pno
6203 value is non-negative, we must set the onetime parent from it. This which
6204 points to the relevant entry in the recipients list.
6206 This processing can be altered by the setting of the process_recipients
6207 variable, which is changed if recipients are to be ignored, failed, or
6208 deferred. This can happen as a result of system filter activity, or if the -Mg
6209 option is used to fail all of them.
6211 Duplicate addresses are handled later by a different tree structure; we can't
6212 just extend the non-recipients tree, because that will be re-written to the
6213 spool if the message is deferred, and in any case there are casing
6214 complications for local addresses. */
6216 if (process_recipients != RECIP_IGNORE)
6217 for (i = 0; i < recipients_count; i++)
6218 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6220 recipient_item *r = recipients_list + i;
6221 address_item *new = deliver_make_addr(r->address, FALSE);
6222 new->prop.errors_address = r->errors_to;
6224 if ((new->prop.utf8_msg = message_smtputf8))
6226 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6227 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6228 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6229 new->prop.utf8_downcvt ? "yes"
6230 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6236 new->onetime_parent = recipients_list[r->pno].address;
6238 /* If DSN support is enabled, set the dsn flags and the original receipt
6239 to be passed on to other DSN enabled MTAs */
6241 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6242 new->dsn_orcpt = r->orcpt;
6243 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6244 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6246 switch (process_recipients)
6248 /* RECIP_DEFER is set when a system filter freezes a message. */
6251 new->next = addr_defer;
6256 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6259 case RECIP_FAIL_FILTER:
6261 filter_message ? filter_message : US"delivery cancelled";
6262 setflag(new, af_pass_message);
6263 goto RECIP_QUEUE_FAILED; /* below */
6266 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6267 than the value in timeout_frozen_after. Treat non-bounce messages
6268 similarly to -Mg; for bounce messages we just want to discard, so
6269 don't put the address on the failed list. The timeout has already
6272 case RECIP_FAIL_TIMEOUT:
6273 new->message = US"delivery cancelled; message timed out";
6274 goto RECIP_QUEUE_FAILED; /* below */
6277 /* RECIP_FAIL is set when -Mg has been used. */
6280 new->message = US"delivery cancelled by administrator";
6283 /* Common code for the failure cases above. If this is not a bounce
6284 message, put the address on the failed list so that it is used to
6285 create a bounce. Otherwise do nothing - this just discards the address.
6286 The incident has already been logged. */
6289 if (sender_address[0])
6291 new->next = addr_failed;
6297 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6298 in the message. Process each address as a routing failure; if this
6299 is a bounce message, it will get frozen. */
6301 case RECIP_FAIL_LOOP:
6302 new->message = US"Too many \"Received\" headers - suspected mail loop";
6303 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6307 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6310 if (!addr_new) addr_new = new; else addr_last->next = new;
6315 #ifndef DISABLE_EVENT
6316 if (process_recipients != RECIP_ACCEPT && event_action)
6318 uschar * save_local = deliver_localpart;
6319 const uschar * save_domain = deliver_domain;
6320 uschar * addr = new->address, * errmsg = NULL;
6321 int start, end, dom;
6323 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6324 log_write(0, LOG_MAIN|LOG_PANIC,
6325 "failed to parse address '%.100s': %s\n", addr, errmsg);
6329 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6330 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6332 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
6334 deliver_localpart = save_local;
6335 deliver_domain = save_domain;
6343 debug_printf("Delivery address list:\n");
6344 for (address_item * p = addr_new; p; p = p->next)
6345 debug_printf(" %s %s\n", p->address,
6346 p->onetime_parent ? p->onetime_parent : US"");
6349 /* Set up the buffers used for copying over the file when delivering. */
6351 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6352 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6356 /* Until there are no more new addresses, handle each one as follows:
6358 . If this is a generated address (indicated by the presence of a parent
6359 pointer) then check to see whether it is a pipe, file, or autoreply, and
6360 if so, handle it directly here. The router that produced the address will
6361 have set the allow flags into the address, and also set the uid/gid required.
6362 Having the routers generate new addresses and then checking them here at
6363 the outer level is tidier than making each router do the checking, and
6364 means that routers don't need access to the failed address queue.
6366 . Break up the address into local part and domain, and make lowercased
6367 versions of these strings. We also make unquoted versions of the local part.
6369 . Handle the percent hack for those domains for which it is valid.
6371 . For child addresses, determine if any of the parents have the same address.
6372 If so, generate a different string for previous delivery checking. Without
6373 this code, if the address spqr generates spqr via a forward or alias file,
6374 delivery of the generated spqr stops further attempts at the top level spqr,
6375 which is not what is wanted - it may have generated other addresses.
6377 . Check on the retry database to see if routing was previously deferred, but
6378 only if in a queue run. Addresses that are to be routed are put on the
6379 addr_route chain. Addresses that are to be deferred are put on the
6380 addr_defer chain. We do all the checking first, so as not to keep the
6381 retry database open any longer than necessary.
6383 . Now we run the addresses through the routers. A router may put the address
6384 on either the addr_local or the addr_remote chain for local or remote
6385 delivery, respectively, or put it on the addr_failed chain if it is
6386 undeliveable, or it may generate child addresses and put them on the
6387 addr_new chain, or it may defer an address. All the chain anchors are
6388 passed as arguments so that the routers can be called for verification
6391 . If new addresses have been generated by the routers, da capo.
6394 f.header_rewritten = FALSE; /* No headers rewritten yet */
6395 while (addr_new) /* Loop until all addresses dealt with */
6397 address_item *addr, *parent;
6399 /* Failure to open the retry database is treated the same as if it does
6400 not exist. In both cases, dbm_file is NULL. */
6402 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6403 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6404 debug_printf("no retry data available\n");
6406 /* Scan the current batch of new addresses, to handle pipes, files and
6407 autoreplies, and determine which others are ready for routing. */
6413 dbdata_retry * domain_retry_record, * address_retry_record;
6416 addr_new = addr->next;
6418 DEBUG(D_deliver|D_retry|D_route)
6420 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6421 debug_printf("Considering: %s\n", addr->address);
6424 /* Handle generated address that is a pipe or a file or an autoreply. */
6426 if (testflag(addr, af_pfr))
6428 /* If an autoreply in a filter could not generate a syntactically valid
6429 address, give up forthwith. Set af_ignore_error so that we don't try to
6430 generate a bounce. */
6432 if (testflag(addr, af_bad_reply))
6434 addr->basic_errno = ERRNO_BADADDRESS2;
6435 addr->local_part = addr->address;
6437 US"filter autoreply generated syntactically invalid recipient";
6438 addr->prop.ignore_error = TRUE;
6439 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6440 continue; /* with the next new address */
6443 /* If two different users specify delivery to the same pipe or file or
6444 autoreply, there should be two different deliveries, so build a unique
6445 string that incorporates the original address, and use this for
6446 duplicate testing and recording delivery, and also for retrying. */
6449 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6450 (testflag(addr->parent, af_homonym)? 3:0));
6452 addr->address_retry_key = addr->domain_retry_key =
6453 string_sprintf("T:%s", addr->unique);
6455 /* If a filter file specifies two deliveries to the same pipe or file,
6456 we want to de-duplicate, but this is probably not wanted for two mail
6457 commands to the same address, where probably both should be delivered.
6458 So, we have to invent a different unique string in that case. Just
6459 keep piling '>' characters on the front. */
6461 if (addr->address[0] == '>')
6462 while (tree_search(tree_duplicates, addr->unique))
6463 addr->unique = string_sprintf(">%s", addr->unique);
6465 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6467 DEBUG(D_deliver|D_route)
6468 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6469 addr->dupof = tnode->data.ptr;
6470 addr->next = addr_duplicate;
6471 addr_duplicate = addr;
6475 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6477 /* Check for previous delivery */
6479 if (tree_search(tree_nonrecipients, addr->unique))
6481 DEBUG(D_deliver|D_route)
6482 debug_printf("%s was previously delivered: discarded\n", addr->address);
6483 child_done(addr, tod_stamp(tod_log));
6487 /* Save for checking future duplicates */
6489 tree_add_duplicate(addr->unique, addr);
6491 /* Set local part and domain */
6493 addr->local_part = addr->address;
6494 addr->domain = addr->parent->domain;
6496 /* Ensure that the delivery is permitted. */
6498 if (testflag(addr, af_file))
6500 if (!testflag(addr, af_allow_file))
6502 addr->basic_errno = ERRNO_FORBIDFILE;
6503 addr->message = US"delivery to file forbidden";
6504 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6505 continue; /* with the next new address */
6508 else if (addr->address[0] == '|')
6510 if (!testflag(addr, af_allow_pipe))
6512 addr->basic_errno = ERRNO_FORBIDPIPE;
6513 addr->message = US"delivery to pipe forbidden";
6514 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6515 continue; /* with the next new address */
6518 else if (!testflag(addr, af_allow_reply))
6520 addr->basic_errno = ERRNO_FORBIDREPLY;
6521 addr->message = US"autoreply forbidden";
6522 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6523 continue; /* with the next new address */
6526 /* If the errno field is already set to BADTRANSPORT, it indicates
6527 failure to expand a transport string, or find the associated transport,
6528 or an unset transport when one is required. Leave this test till now so
6529 that the forbid errors are given in preference. */
6531 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6533 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6537 /* Treat /dev/null as a special case and abandon the delivery. This
6538 avoids having to specify a uid on the transport just for this case.
6539 Arrange for the transport name to be logged as "**bypassed**".
6540 Copy the transport for this fairly unusual case rather than having
6541 to make all transports mutable. */
6543 if (Ustrcmp(addr->address, "/dev/null") == 0)
6545 transport_instance * save_t = addr->transport;
6546 transport_instance * t = store_get(sizeof(*t), save_t);
6548 t->name = US"**bypassed**";
6549 addr->transport = t;
6550 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6551 addr->transport= save_t;
6552 continue; /* with the next new address */
6555 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6558 DEBUG(D_deliver|D_route)
6559 debug_printf("queued for %s transport\n", addr->transport->name);
6560 addr->next = addr_local;
6562 continue; /* with the next new address */
6565 /* Handle normal addresses. First, split up into local part and domain,
6566 handling the %-hack if necessary. There is the possibility of a defer from
6567 a lookup in percent_hack_domains. */
6569 if ((rc = deliver_split_address(addr)) == DEFER)
6571 addr->message = US"cannot check percent_hack_domains";
6572 addr->basic_errno = ERRNO_LISTDEFER;
6573 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6577 /* Check to see if the domain is held. If so, proceed only if the
6578 delivery was forced by hand. */
6580 deliver_domain = addr->domain; /* set $domain */
6581 if ( !forced && hold_domains
6582 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6583 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6589 addr->message = US"hold_domains lookup deferred";
6590 addr->basic_errno = ERRNO_LISTDEFER;
6594 addr->message = US"domain is held";
6595 addr->basic_errno = ERRNO_HELD;
6597 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6601 /* Now we can check for duplicates and previously delivered addresses. In
6602 order to do this, we have to generate a "unique" value for each address,
6603 because there may be identical actual addresses in a line of descendents.
6604 The "unique" field is initialized to the same value as the "address" field,
6605 but gets changed here to cope with identically-named descendents. */
6607 for (parent = addr->parent; parent; parent = parent->parent)
6608 if (strcmpic(addr->address, parent->address) == 0) break;
6610 /* If there's an ancestor with the same name, set the homonym flag. This
6611 influences how deliveries are recorded. Then add a prefix on the front of
6612 the unique address. We use \n\ where n starts at 0 and increases each time.
6613 It is unlikely to pass 9, but if it does, it may look odd but will still
6614 work. This means that siblings or cousins with the same names are treated
6615 as duplicates, which is what we want. */
6619 setflag(addr, af_homonym);
6620 if (parent->unique[0] != '\\')
6621 addr->unique = string_sprintf("\\0\\%s", addr->address);
6623 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6627 /* Ensure that the domain in the unique field is lower cased, because
6628 domains are always handled caselessly. */
6630 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
6632 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6634 if (tree_search(tree_nonrecipients, addr->unique))
6636 DEBUG(D_deliver|D_route)
6637 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6638 child_done(addr, tod_stamp(tod_log));
6642 /* Get the routing retry status, saving the two retry keys (with and
6643 without the local part) for subsequent use. If there is no retry record for
6644 the standard address routing retry key, we look for the same key with the
6645 sender attached, because this form is used by the smtp transport after a
6646 4xx response to RCPT when address_retry_include_sender is true. */
6648 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6649 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6654 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6655 if ( domain_retry_record
6656 && now - domain_retry_record->time_stamp > retry_data_expire
6659 DEBUG(D_deliver|D_retry)
6660 debug_printf("domain retry record present but expired\n");
6661 domain_retry_record = NULL; /* Ignore if too old */
6664 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6665 if ( address_retry_record
6666 && now - address_retry_record->time_stamp > retry_data_expire
6669 DEBUG(D_deliver|D_retry)
6670 debug_printf("address retry record present but expired\n");
6671 address_retry_record = NULL; /* Ignore if too old */
6674 if (!address_retry_record)
6676 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6678 address_retry_record = dbfn_read(dbm_file, altkey);
6679 if ( address_retry_record
6680 && now - address_retry_record->time_stamp > retry_data_expire)
6682 DEBUG(D_deliver|D_retry)
6683 debug_printf("address<sender> retry record present but expired\n");
6684 address_retry_record = NULL; /* Ignore if too old */
6689 domain_retry_record = address_retry_record = NULL;
6691 DEBUG(D_deliver|D_retry)
6693 if (!domain_retry_record)
6694 debug_printf("no domain retry record\n");
6696 debug_printf("have domain retry record; next_try = now%+d\n",
6697 f.running_in_test_harness ? 0 :
6698 (int)(domain_retry_record->next_try - now));
6700 if (!address_retry_record)
6701 debug_printf("no address retry record\n");
6703 debug_printf("have address retry record; next_try = now%+d\n",
6704 f.running_in_test_harness ? 0 :
6705 (int)(address_retry_record->next_try - now));
6708 /* If we are sending a message down an existing SMTP connection, we must
6709 assume that the message which created the connection managed to route
6710 an address to that connection. We do not want to run the risk of taking
6711 a long time over routing here, because if we do, the server at the other
6712 end of the connection may time it out. This is especially true for messages
6713 with lots of addresses. For this kind of delivery, queue_running is not
6714 set, so we would normally route all addresses. We take a pragmatic approach
6715 and defer routing any addresses that have any kind of domain retry record.
6716 That is, we don't even look at their retry times. It doesn't matter if this
6717 doesn't work occasionally. This is all just an optimization, after all.
6719 The reason for not doing the same for address retries is that they normally
6720 arise from 4xx responses, not DNS timeouts. */
6722 if (continue_hostname && domain_retry_record)
6724 addr->message = US"reusing SMTP connection skips previous routing defer";
6725 addr->basic_errno = ERRNO_RRETRY;
6726 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6728 addr->message = domain_retry_record->text;
6729 setflag(addr, af_pass_message);
6732 /* If we are in a queue run, defer routing unless there is no retry data or
6733 we've passed the next retry time, or this message is forced. In other
6734 words, ignore retry data when not in a queue run.
6736 However, if the domain retry time has expired, always allow the routing
6737 attempt. If it fails again, the address will be failed. This ensures that
6738 each address is routed at least once, even after long-term routing
6741 If there is an address retry, check that too; just wait for the next
6742 retry time. This helps with the case when the temporary error on the
6743 address was really message-specific rather than address specific, since
6744 it allows other messages through.
6746 We also wait for the next retry time if this is a message sent down an
6747 existing SMTP connection (even though that will be forced). Otherwise there
6748 will be far too many attempts for an address that gets a 4xx error. In
6749 fact, after such an error, we should not get here because, the host should
6750 not be remembered as one this message needs. However, there was a bug that
6751 used to cause this to happen, so it is best to be on the safe side.
6753 Even if we haven't reached the retry time in the hints, there is one more
6754 check to do, which is for the ultimate address timeout. We only do this
6755 check if there is an address retry record and there is not a domain retry
6756 record; this implies that previous attempts to handle the address had the
6757 retry_use_local_parts option turned on. We use this as an approximation
6758 for the destination being like a local delivery, for example delivery over
6759 LMTP to an IMAP message store. In this situation users are liable to bump
6760 into their quota and thereby have intermittently successful deliveries,
6761 which keep the retry record fresh, which can lead to us perpetually
6762 deferring messages. */
6764 else if ( ( f.queue_running && !f.deliver_force
6765 || continue_hostname
6767 && ( ( domain_retry_record
6768 && now < domain_retry_record->next_try
6769 && !domain_retry_record->expired
6771 || ( address_retry_record
6772 && now < address_retry_record->next_try
6774 && ( domain_retry_record
6775 || !address_retry_record
6776 || !retry_ultimate_address_timeout(addr->address_retry_key,
6777 addr->domain, address_retry_record, now)
6780 addr->message = US"retry time not reached";
6781 addr->basic_errno = ERRNO_RRETRY;
6782 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6784 /* For remote-retry errors (here and just above) that we've not yet
6785 hit the retry time, use the error recorded in the retry database
6786 as info in the warning message. This lets us send a message even
6787 when we're not failing on a fresh attempt. We assume that this
6788 info is not sensitive. */
6790 addr->message = domain_retry_record
6791 ? domain_retry_record->text : address_retry_record->text;
6792 setflag(addr, af_pass_message);
6795 /* The domain is OK for routing. Remember if retry data exists so it
6796 can be cleaned up after a successful delivery. */
6800 if (domain_retry_record || address_retry_record)
6801 setflag(addr, af_dr_retry_exists);
6802 addr->next = addr_route;
6804 DEBUG(D_deliver|D_route)
6805 debug_printf("%s: queued for routing\n", addr->address);
6809 /* The database is closed while routing is actually happening. Requests to
6810 update it are put on a chain and all processed together at the end. */
6812 if (dbm_file) dbfn_close(dbm_file);
6814 /* If queue_domains is set, we don't even want to try routing addresses in
6815 those domains. During queue runs, queue_domains is forced to be unset.
6816 Optimize by skipping this pass through the addresses if nothing is set. */
6818 if (!f.deliver_force && queue_domains)
6820 address_item *okaddr = NULL;
6823 address_item *addr = addr_route;
6824 addr_route = addr->next;
6826 deliver_domain = addr->domain; /* set $domain */
6827 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
6828 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6832 addr->basic_errno = ERRNO_LISTDEFER;
6833 addr->message = US"queue_domains lookup deferred";
6834 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6838 addr->next = okaddr;
6843 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6844 addr->message = US"domain is in queue_domains";
6845 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6849 addr_route = okaddr;
6852 /* Now route those addresses that are not deferred. */
6857 address_item *addr = addr_route;
6858 const uschar *old_domain = addr->domain;
6859 uschar *old_unique = addr->unique;
6860 addr_route = addr->next;
6863 /* Just in case some router parameter refers to it. */
6865 if (!(return_path = addr->prop.errors_address))
6866 return_path = sender_address;
6868 /* If a router defers an address, add a retry item. Whether or not to
6869 use the local part in the key is a property of the router. */
6871 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6872 &addr_succeed, v_none)) == DEFER)
6873 retry_add_item(addr,
6874 addr->router->retry_use_local_part
6875 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6876 : string_sprintf("R:%s", addr->domain),
6879 /* Otherwise, if there is an existing retry record in the database, add
6880 retry items to delete both forms. We must also allow for the possibility
6881 of a routing retry that includes the sender address. Since the domain might
6882 have been rewritten (expanded to fully qualified) as a result of routing,
6883 ensure that the rewritten form is also deleted. */
6885 else if (testflag(addr, af_dr_retry_exists))
6887 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6889 retry_add_item(addr, altkey, rf_delete);
6890 retry_add_item(addr, addr->address_retry_key, rf_delete);
6891 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6892 if (Ustrcmp(addr->domain, old_domain) != 0)
6893 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6896 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6897 logged, but we need to ensure the address (and maybe parents) is marked
6902 address_done(addr, tod_stamp(tod_log));
6903 continue; /* route next address */
6906 /* The address is finished with (failed or deferred). */
6910 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6911 continue; /* route next address */
6914 /* The address has been routed. If the router changed the domain, it will
6915 also have changed the unique address. We have to test whether this address
6916 has already been delivered, because it's the unique address that finally
6919 if ( addr->unique != old_unique
6920 && tree_search(tree_nonrecipients, addr->unique) != 0
6923 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6924 "discarded\n", addr->address);
6925 if (addr_remote == addr) addr_remote = addr->next;
6926 else if (addr_local == addr) addr_local = addr->next;
6929 /* If the router has same_domain_copy_routing set, we are permitted to copy
6930 the routing for any other addresses with the same domain. This is an
6931 optimisation to save repeated DNS lookups for "standard" remote domain
6932 routing. The option is settable only on routers that generate host lists.
6933 We play it very safe, and do the optimization only if the address is routed
6934 to a remote transport, there are no header changes, and the domain was not
6935 modified by the router. */
6937 if ( addr_remote == addr
6938 && addr->router->same_domain_copy_routing
6939 && !addr->prop.extra_headers
6940 && !addr->prop.remove_headers
6941 && old_domain == addr->domain
6944 address_item **chain = &addr_route;
6947 address_item *addr2 = *chain;
6948 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6950 chain = &(addr2->next);
6954 /* Found a suitable address; take it off the routing list and add it to
6955 the remote delivery list. */
6957 *chain = addr2->next;
6958 addr2->next = addr_remote;
6959 addr_remote = addr2;
6961 /* Copy the routing data */
6963 addr2->domain = addr->domain;
6964 addr2->router = addr->router;
6965 addr2->transport = addr->transport;
6966 addr2->host_list = addr->host_list;
6967 addr2->fallback_hosts = addr->fallback_hosts;
6968 addr2->prop.errors_address = addr->prop.errors_address;
6969 copyflag(addr2, addr, af_hide_child);
6970 copyflag(addr2, addr, af_local_host_removed);
6972 DEBUG(D_deliver|D_route)
6973 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6975 "Routing for %s copied from %s\n",
6976 addr2->address, addr2->address, addr->address);
6979 } /* Continue with routing the next address. */
6980 } /* Loop to process any child addresses that the routers created, and
6981 any rerouted addresses that got put back on the new chain. */
6984 /* Debugging: show the results of the routing */
6986 DEBUG(D_deliver|D_retry|D_route)
6988 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6989 debug_printf("After routing:\n Local deliveries:\n");
6990 for (address_item * p = addr_local; p; p = p->next)
6991 debug_printf(" %s\n", p->address);
6993 debug_printf(" Remote deliveries:\n");
6994 for (address_item * p = addr_remote; p; p = p->next)
6995 debug_printf(" %s\n", p->address);
6997 debug_printf(" Failed addresses:\n");
6998 for (address_item * p = addr_failed; p; p = p->next)
6999 debug_printf(" %s\n", p->address);
7001 debug_printf(" Deferred addresses:\n");
7002 for (address_item * p = addr_defer; p; p = p->next)
7003 debug_printf(" %s\n", p->address);
7006 /* Free any resources that were cached during routing. */
7011 /* These two variables are set only during routing, after check_local_user.
7012 Ensure they are not set in transports. */
7014 local_user_gid = (gid_t)(-1);
7015 local_user_uid = (uid_t)(-1);
7017 /* Check for any duplicate addresses. This check is delayed until after
7018 routing, because the flexibility of the routing configuration means that
7019 identical addresses with different parentage may end up being redirected to
7020 different addresses. Checking for duplicates too early (as we previously used
7021 to) makes this kind of thing not work. */
7023 do_duplicate_check(&addr_local);
7024 do_duplicate_check(&addr_remote);
7026 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7027 remote transport. The check that they all end up in one transaction happens in
7028 the do_remote_deliveries() function. */
7031 && (addr_local || addr_failed || addr_defer)
7035 uschar *which, *colon, *msg;
7042 else if (addr_defer)
7045 which = US"deferred";
7053 while (addr->parent) addr = addr->parent;
7058 msg = addr->message;
7060 else colon = msg = US"";
7062 /* We don't need to log here for a forced failure as it will already
7063 have been logged. Defer will also have been logged, but as a defer, so we do
7064 need to do the failure logging. */
7066 if (addr != addr_failed)
7067 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7068 addr->address, which);
7070 /* Always write an error to the caller */
7072 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7075 final_yield = DELIVER_MUA_FAILED;
7076 addr_failed = addr_defer = NULL; /* So that we remove the message */
7077 goto DELIVERY_TIDYUP;
7081 /* If this is a run to continue deliveries to an external channel that is
7082 already set up, defer any local deliveries.
7084 jgh 2020/12/20: I don't see why; locals should be quick.
7085 The defer goes back to version 1.62 in 1997. A local being still deliverable
7086 during a continued run might result from something like a defer during the
7087 original delivery, eg. in a DB lookup. Unlikely but possible.
7089 To avoid delaying a local when combined with a callout-hold for a remote
7090 delivery, test continue_sequence rather than continue_transport. */
7092 if (continue_sequence > 1 && addr_local)
7094 DEBUG(D_deliver|D_retry|D_route)
7095 debug_printf("deferring local deliveries due to continued-transport\n");
7098 address_item * addr = addr_defer;
7099 while (addr->next) addr = addr->next;
7100 addr->next = addr_local;
7103 addr_defer = addr_local;
7108 /* Because address rewriting can happen in the routers, we should not really do
7109 ANY deliveries until all addresses have been routed, so that all recipients of
7110 the message get the same headers. However, this is in practice not always
7111 possible, since sometimes remote addresses give DNS timeouts for days on end.
7112 The pragmatic approach is to deliver what we can now, saving any rewritten
7113 headers so that at least the next lot of recipients benefit from the rewriting
7114 that has already been done.
7116 If any headers have been rewritten during routing, update the spool file to
7117 remember them for all subsequent deliveries. This can be delayed till later if
7118 there is only address to be delivered - if it succeeds the spool write need not
7121 if ( f.header_rewritten
7122 && ( addr_local && (addr_local->next || addr_remote)
7123 || addr_remote && addr_remote->next
7126 /* Panic-dies on error */
7127 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7128 f.header_rewritten = FALSE;
7132 /* If there are any deliveries to do and we do not already have the journal
7133 file, create it. This is used to record successful deliveries as soon as
7134 possible after each delivery is known to be complete. A file opened with
7135 O_APPEND is used so that several processes can run simultaneously.
7137 The journal is just insurance against crashes. When the spool file is
7138 ultimately updated at the end of processing, the journal is deleted. If a
7139 journal is found to exist at the start of delivery, the addresses listed
7140 therein are added to the non-recipients. */
7142 if (addr_local || addr_remote)
7146 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7148 if ((journal_fd = Uopen(fname,
7149 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7151 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7152 fname, strerror(errno));
7153 return DELIVER_NOT_ATTEMPTED;
7156 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7157 that the mode is correct - the group setting doesn't always seem to get
7158 set automatically. */
7160 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7161 || fchmod(journal_fd, SPOOL_MODE)
7163 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7167 int ret = Uunlink(fname);
7168 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7169 fname, strerror(errno));
7170 if(ret && errno != ENOENT)
7171 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7172 fname, strerror(errno));
7173 return DELIVER_NOT_ATTEMPTED;
7177 else if (journal_fd >= 0)
7185 /* Now we can get down to the business of actually doing deliveries. Local
7186 deliveries are done first, then remote ones. If ever the problems of how to
7187 handle fallback transports are figured out, this section can be put into a loop
7188 for handling fallbacks, though the uid switching will have to be revised. */
7190 /* Precompile a regex that is used to recognize a parameter in response
7191 to an LHLO command, if is isn't already compiled. This may be used on both
7192 local and remote LMTP deliveries. */
7194 if (!regex_IGNOREQUOTA)
7196 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
7198 /* Handle local deliveries */
7202 DEBUG(D_deliver|D_transport)
7203 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7204 do_local_deliveries();
7205 f.disable_logging = FALSE;
7208 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7209 so just queue them all. */
7211 if (f.queue_run_local)
7214 address_item *addr = addr_remote;
7215 addr_remote = addr->next;
7217 addr->basic_errno = ERRNO_LOCAL_ONLY;
7218 addr->message = US"remote deliveries suppressed";
7219 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7222 /* Handle remote deliveries */
7226 DEBUG(D_deliver|D_transport)
7227 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7229 /* Precompile some regex that are used to recognize parameters in response
7230 to an EHLO command, if they aren't already compiled. */
7232 smtp_deliver_init();
7234 /* Now sort the addresses if required, and do the deliveries. The yield of
7235 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7236 cannot be delivered in one transaction. */
7238 if (remote_sort_domains) sort_remote_deliveries();
7239 if (!do_remote_deliveries(FALSE))
7241 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7242 "be delivered in one transaction");
7243 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7245 final_yield = DELIVER_MUA_FAILED;
7246 addr_failed = addr_defer = NULL; /* So that we remove the message */
7247 goto DELIVERY_TIDYUP;
7250 /* See if any of the addresses that failed got put on the queue for delivery
7251 to their fallback hosts. We do it this way because often the same fallback
7252 host is used for many domains, so all can be sent in a single transaction
7253 (if appropriately configured). */
7255 if (addr_fallback && !mua_wrapper)
7257 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7258 addr_remote = addr_fallback;
7259 addr_fallback = NULL;
7260 if (remote_sort_domains) sort_remote_deliveries();
7261 do_remote_deliveries(TRUE);
7263 f.disable_logging = FALSE;
7267 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7268 phase, to minimize cases of half-done things. */
7271 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7272 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7274 /* Root privilege is no longer needed */
7276 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7278 set_process_info("tidying up after delivering %s", message_id);
7279 signal(SIGTERM, SIG_IGN);
7281 /* When we are acting as an MUA wrapper, the smtp transport will either have
7282 succeeded for all addresses, or failed them all in normal cases. However, there
7283 are some setup situations (e.g. when a named port does not exist) that cause an
7284 immediate exit with deferral of all addresses. Convert those into failures. We
7285 do not ever want to retry, nor do we want to send a bounce message. */
7291 address_item * nextaddr;
7292 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7294 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7295 "delivery", addr->address);
7296 nextaddr = addr->next;
7297 addr->next = addr_failed;
7303 /* Now all should either have succeeded or failed. */
7306 final_yield = DELIVER_MUA_SUCCEEDED;
7310 uschar *s = addr_failed->user_message;
7312 if (!s) s = addr_failed->message;
7314 fprintf(stderr, "Delivery failed: ");
7315 if (addr_failed->basic_errno > 0)
7317 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7318 if (s) fprintf(stderr, ": ");
7320 if ((host = addr_failed->host_used))
7321 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7323 fprintf(stderr, "%s", CS s);
7324 else if (addr_failed->basic_errno <= 0)
7325 fprintf(stderr, "unknown error");
7326 fprintf(stderr, "\n");
7328 final_yield = DELIVER_MUA_FAILED;
7333 /* In a normal configuration, we now update the retry database. This is done in
7334 one fell swoop at the end in order not to keep opening and closing (and
7335 locking) the database. The code for handling retries is hived off into a
7336 separate module for convenience. We pass it the addresses of the various
7337 chains, because deferred addresses can get moved onto the failed chain if the
7338 retry cutoff time has expired for all alternative destinations. Bypass the
7339 updating of the database if the -N flag is set, which is a debugging thing that
7340 prevents actual delivery. */
7342 else if (!f.dont_deliver)
7343 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7345 /* Send DSN for successful messages if requested */
7346 addr_senddsn = NULL;
7348 for (address_item * a = addr_succeed; a; a = a->next)
7350 /* af_ignore_error not honored here. it's not an error */
7351 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7352 "DSN: processing successful delivery address: %s\n"
7353 "DSN: Sender_address: %s\n"
7354 "DSN: orcpt: %s flags: 0x%x\n"
7355 "DSN: envid: %s ret: %d\n"
7356 "DSN: Final recipient: %s\n"
7357 "DSN: Remote SMTP server supports DSN: %d\n",
7358 a->router ? a->router->name : US"(unknown)",
7361 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7363 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7368 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7369 and a report was requested */
7371 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7372 && a->dsn_flags & rf_notify_success
7375 /* copy and relink address_item and send report with all of them at once later */
7376 address_item * addr_next = addr_senddsn;
7377 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
7379 addr_senddsn->next = addr_next;
7382 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7390 /* create exim process to send message */
7391 pid = child_open_exim(&fd, US"DSN");
7393 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7395 if (pid < 0) /* Creation of child failed */
7397 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7398 "create child process to send success-dsn message: %s", getpid(),
7399 getppid(), strerror(errno));
7401 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7403 else /* Creation of child succeeded */
7405 FILE * f = fdopen(fd, "wb");
7406 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7408 transport_ctx tctx = {{0}};
7411 debug_printf("sending success-dsn to: %s\n", sender_address);
7413 /* build unique id for MIME boundary */
7414 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7415 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7417 if (errors_reply_to)
7418 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7421 fprintf(f, "Auto-Submitted: auto-generated\n"
7423 "Subject: Delivery Status Notification\n",
7425 moan_write_references(f, NULL);
7426 fprintf(f, "Content-Type: multipart/report;"
7427 " report-type=delivery-status; boundary=%s\n"
7428 "MIME-Version: 1.0\n\n"
7431 "Content-type: text/plain; charset=us-ascii\n\n"
7433 "This message was created automatically by mail delivery software.\n"
7434 " ----- The following addresses had successful delivery notifications -----\n",
7437 for (address_item * a = addr_senddsn; a; a = a->next)
7438 fprintf(f, "<%s> (relayed %s)\n\n",
7440 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7441 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7442 : "via non \"Remote SMTP\" router"
7446 "Content-type: message/delivery-status\n\n"
7447 "Reporting-MTA: dns; %s\n",
7448 bound, smtp_active_hostname);
7451 { /* must be decoded from xtext: see RFC 3461:6.3a */
7453 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7454 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7456 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7460 for (address_item * a = addr_senddsn; a; a = a->next)
7464 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7466 if ((hu = a->host_used) && hu->name)
7467 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7470 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7471 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7474 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7477 transport_filter_argv = NULL; /* Just in case */
7478 return_path = sender_address; /* In case not previously set */
7480 /* Write the original email out */
7483 tctx.options = topt_add_return_path | topt_no_body;
7484 /*XXX hmm, FALSE(fail) retval ignored.
7485 Could error for any number of reasons, and they are not handled. */
7486 transport_write_message(&tctx, 0);
7489 fprintf(f,"\n--%s--\n", bound);
7493 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7497 /* If any addresses failed, we must send a message to somebody, unless
7498 af_ignore_error is set, in which case no action is taken. It is possible for
7499 several messages to get sent if there are addresses with different
7506 uschar *logtod = tod_stamp(tod_log);
7508 address_item *handled_addr = NULL;
7509 address_item **paddr;
7510 address_item *msgchain = NULL;
7511 address_item **pmsgchain = &msgchain;
7513 /* There are weird cases when logging is disabled in the transport. However,
7514 there may not be a transport (address failed by a router). */
7516 f.disable_logging = FALSE;
7517 if (addr_failed->transport)
7518 f.disable_logging = addr_failed->transport->disable_logging;
7521 debug_printf("processing failed address %s\n", addr_failed->address);
7523 /* There are only two ways an address in a bounce message can get here:
7525 (1) When delivery was initially deferred, but has now timed out (in the call
7526 to retry_update() above). We can detect this by testing for
7527 af_retry_timedout. If the address does not have its own errors address,
7528 we arrange to ignore the error.
7530 (2) If delivery failures for bounce messages are being ignored. We can detect
7531 this by testing for af_ignore_error. This will also be set if a bounce
7532 message has been autothawed and the ignore_bounce_errors_after time has
7533 passed. It might also be set if a router was explicitly configured to
7534 ignore errors (errors_to = "").
7536 If neither of these cases obtains, something has gone wrong. Log the
7537 incident, but then ignore the error. */
7539 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7541 if ( !testflag(addr_failed, af_retry_timedout)
7542 && !addr_failed->prop.ignore_error)
7543 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7544 "failure is neither frozen nor ignored (it's been ignored)");
7546 addr_failed->prop.ignore_error = TRUE;
7549 /* If the first address on the list has af_ignore_error set, just remove
7550 it from the list, throw away any saved message file, log it, and
7551 mark the recipient done. */
7553 if ( addr_failed->prop.ignore_error
7554 || addr_failed->dsn_flags & rf_dsnflags
7555 && !(addr_failed->dsn_flags & rf_notify_failure)
7559 addr_failed = addr->next;
7560 if (addr->return_filename) Uunlink(addr->return_filename);
7562 #ifndef DISABLE_EVENT
7563 msg_event_raise(US"msg:fail:delivery", addr);
7565 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7567 !addr->parent ? US"" : US" <",
7568 !addr->parent ? US"" : addr->parent->address,
7569 !addr->parent ? US"" : US">",
7570 addr->prop.ignore_error
7571 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7573 address_done(addr, logtod);
7574 child_done(addr, logtod);
7575 /* Panic-dies on error */
7576 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7579 /* Otherwise, handle the sending of a message. Find the error address for
7580 the first address, then send a message that includes all failed addresses
7581 that have the same error address. Note the bounce_recipient is a global so
7582 that it can be accessed by $bounce_recipient while creating a customized
7587 if (!(bounce_recipient = addr_failed->prop.errors_address))
7588 bounce_recipient = sender_address;
7590 /* Make a subprocess to send a message */
7592 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7593 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7594 "create child process to send failure message: %s", getpid(),
7595 getppid(), strerror(errno));
7597 /* Creation of child succeeded */
7604 uschar *bcc, *emf_text;
7605 FILE * fp = fdopen(fd, "wb");
7607 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7608 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7609 DELIVER_IN_BUFFER_SIZE;
7611 uschar *dsnlimitmsg;
7612 uschar *dsnnotifyhdr;
7616 debug_printf("sending error message to: %s\n", bounce_recipient);
7618 /* Scan the addresses for all that have the same errors address, removing
7619 them from the addr_failed chain, and putting them on msgchain. */
7621 paddr = &addr_failed;
7622 for (addr = addr_failed; addr; addr = *paddr)
7623 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7624 ? addr->prop.errors_address : sender_address) == 0)
7625 { /* The same - dechain */
7626 *paddr = addr->next;
7629 pmsgchain = &(addr->next);
7632 paddr = &addr->next; /* Not the same; skip */
7634 /* Include X-Failed-Recipients: for automatic interpretation, but do
7635 not let any one header line get too long. We do this by starting a
7636 new header every 50 recipients. Omit any addresses for which the
7637 "hide_child" flag is set. */
7639 for (addr = msgchain; addr; addr = addr->next)
7641 if (testflag(addr, af_hide_child)) continue;
7649 ? "X-Failed-Recipients: "
7651 testflag(addr, af_pfr) && addr->parent
7652 ? string_printing(addr->parent->address)
7653 : string_printing(addr->address));
7655 if (rcount > 0) fprintf(fp, "\n");
7657 /* Output the standard headers */
7659 if (errors_reply_to)
7660 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7661 fprintf(fp, "Auto-Submitted: auto-replied\n");
7662 moan_write_from(fp);
7663 fprintf(fp, "To: %s\n", bounce_recipient);
7664 moan_write_references(fp, NULL);
7666 /* generate boundary string and output MIME-Headers */
7667 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7669 fprintf(fp, "Content-Type: multipart/report;"
7670 " report-type=delivery-status; boundary=%s\n"
7671 "MIME-Version: 1.0\n",
7674 /* Open a template file if one is provided. Log failure to open, but
7675 carry on - default texts will be used. */
7677 if (bounce_message_file)
7678 emf = expand_open(bounce_message_file,
7679 US"bounce_message_file", US"error");
7681 /* Quietly copy to configured additional addresses if required. */
7683 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7684 fprintf(fp, "Bcc: %s\n", bcc);
7686 /* The texts for the message can be read from a template file; if there
7687 isn't one, or if it is too short, built-in texts are used. The first
7688 emf text is a Subject: and any other headers. */
7690 if ((emf_text = next_emf(emf, US"header")))
7691 fprintf(fp, "%s\n", emf_text);
7693 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7694 to_sender? ": returning message to sender" : "");
7696 /* output human readable part as text/plain section */
7697 fprintf(fp, "--%s\n"
7698 "Content-type: text/plain; charset=us-ascii\n\n",
7701 if ((emf_text = next_emf(emf, US"intro")))
7702 fprintf(fp, "%s", CS emf_text);
7706 /* This message has been reworded several times. It seems to be confusing to
7707 somebody, however it is worded. I have retreated to the original, simple
7709 "This message was created automatically by mail delivery software.\n");
7711 if (bounce_message_text)
7712 fprintf(fp, "%s", CS bounce_message_text);
7715 "\nA message that you sent could not be delivered to one or more of its\n"
7716 "recipients. This is a permanent error. The following address(es) failed:\n");
7719 "\nA message sent by\n\n <%s>\n\n"
7720 "could not be delivered to one or more of its recipients. The following\n"
7721 "address(es) failed:\n", sender_address);
7725 /* Process the addresses, leaving them on the msgchain if they have a
7726 file name for a return message. (There has already been a check in
7727 post_process_one() for the existence of data in the message file.) A TRUE
7728 return from print_address_information() means that the address is not
7732 for (addr = msgchain; addr; addr = *paddr)
7734 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7735 print_address_error(addr, fp, US"");
7737 /* End the final line for the address */
7741 /* Leave on msgchain if there's a return file. */
7743 if (addr->return_file >= 0)
7745 paddr = &(addr->next);
7749 /* Else save so that we can tick off the recipient when the
7754 *paddr = addr->next;
7755 addr->next = handled_addr;
7756 handled_addr = addr;
7762 /* Get the next text, whether we need it or not, so as to be
7763 positioned for the one after. */
7765 emf_text = next_emf(emf, US"generated text");
7767 /* If there were any file messages passed by the local transports,
7768 include them in the message. Then put the address on the handled chain.
7769 In the case of a batch of addresses that were all sent to the same
7770 transport, the return_file field in all of them will contain the same
7771 fd, and the return_filename field in the *last* one will be set (to the
7772 name of the file). */
7776 address_item *nextaddr;
7779 fprintf(fp, "%s", CS emf_text);
7782 "The following text was generated during the delivery "
7783 "attempt%s:\n", (filecount > 1)? "s" : "");
7785 for (addr = msgchain; addr; addr = nextaddr)
7788 address_item *topaddr = addr;
7790 /* List all the addresses that relate to this file */
7793 while(addr) /* Insurance */
7795 print_address_information(addr, fp, US"------ ", US"\n ",
7797 if (addr->return_filename) break;
7802 /* Now copy the file */
7804 if (!(fm = Ufopen(addr->return_filename, "rb")))
7805 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7809 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7812 Uunlink(addr->return_filename);
7814 /* Can now add to handled chain, first fishing off the next
7815 address on the msgchain. */
7817 nextaddr = addr->next;
7818 addr->next = handled_addr;
7819 handled_addr = topaddr;
7824 /* output machine readable part */
7826 if (message_smtputf8)
7827 fprintf(fp, "--%s\n"
7828 "Content-type: message/global-delivery-status\n\n"
7829 "Reporting-MTA: dns; %s\n",
7830 bound, smtp_active_hostname);
7833 fprintf(fp, "--%s\n"
7834 "Content-type: message/delivery-status\n\n"
7835 "Reporting-MTA: dns; %s\n",
7836 bound, smtp_active_hostname);
7840 /* must be decoded from xtext: see RFC 3461:6.3a */
7842 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7843 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7845 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7849 for (addr = handled_addr; addr; addr = addr->next)
7853 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7855 if ((hu = addr->host_used) && hu->name)
7857 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7858 #ifdef EXPERIMENTAL_DSN_INFO
7863 uschar * p = hu->port == 25
7864 ? US"" : string_sprintf(":%d", hu->port);
7865 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7867 if ((s = addr->smtp_greeting) && *s)
7868 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %.900s\n", s);
7869 if ((s = addr->helo_response) && *s)
7870 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %.900s\n", s);
7871 if ((s = addr->message) && *s)
7872 fprintf(fp, "X-Exim-Diagnostic: X-str; %.900s\n", s);
7875 print_dsn_diagnostic_code(addr, fp);
7880 /* Now copy the message, trying to give an intelligible comment if
7881 it is too long for it all to be copied. The limit isn't strictly
7882 applied because of the buffering. There is, however, an option
7883 to suppress copying altogether. */
7885 emf_text = next_emf(emf, US"copy");
7888 we ignore the intro text from template and add
7889 the text for bounce_return_size_limit at the end.
7891 bounce_return_message is ignored
7892 in case RET= is defined we honor these values
7893 otherwise bounce_return_body is honored.
7895 bounce_return_size_limit is always honored.
7898 fprintf(fp, "--%s\n", bound);
7900 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7901 dsnnotifyhdr = NULL;
7902 topt = topt_add_return_path;
7904 /* RET=HDRS? top priority */
7905 if (dsn_ret == dsn_ret_hdrs)
7906 topt |= topt_no_body;
7909 struct stat statbuf;
7911 /* no full body return at all? */
7912 if (!bounce_return_body)
7914 topt |= topt_no_body;
7915 /* add header if we overrule RET=FULL */
7916 if (dsn_ret == dsn_ret_full)
7917 dsnnotifyhdr = dsnlimitmsg;
7919 /* line length limited... return headers only if oversize */
7920 /* size limited ... return headers only if limit reached */
7921 else if ( max_received_linelength > bounce_return_linesize_limit
7922 || ( bounce_return_size_limit > 0
7923 && fstat(deliver_datafile, &statbuf) == 0
7924 && statbuf.st_size > max
7927 topt |= topt_no_body;
7928 dsnnotifyhdr = dsnlimitmsg;
7933 if (message_smtputf8)
7934 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7935 : "Content-type: message/global\n\n",
7939 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7940 : "Content-type: message/rfc822\n\n",
7944 transport_filter_argv = NULL; /* Just in case */
7945 return_path = sender_address; /* In case not previously set */
7946 { /* Dummy transport for headers add */
7947 transport_ctx tctx = {{0}};
7948 transport_instance tb = {0};
7950 tctx.u.fd = fileno(fp);
7952 tctx.options = topt;
7953 tb.add_headers = dsnnotifyhdr;
7955 /*XXX no checking for failure! buggy! */
7956 transport_write_message(&tctx, 0);
7960 /* we never add the final text. close the file */
7964 fprintf(fp, "\n--%s--\n", bound);
7966 /* Close the file, which should send an EOF to the child process
7967 that is receiving the message. Wait for it to finish. */
7970 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7972 /* If the process failed, there was some disaster in setting up the
7973 error message. Unless the message is very old, ensure that addr_defer
7974 is non-null, which will have the effect of leaving the message on the
7975 spool. The failed addresses will get tried again next time. However, we
7976 don't really want this to happen too often, so freeze the message unless
7977 there are some genuine deferred addresses to try. To do this we have
7978 to call spool_write_header() here, because with no genuine deferred
7979 addresses the normal code below doesn't get run. */
7984 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7986 addr_defer = (address_item *)(+1);
7987 f.deliver_freeze = TRUE;
7988 deliver_frozen_at = time(NULL);
7989 /* Panic-dies on error */
7990 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7993 deliver_msglog("Process failed (%d) when writing error message "
7994 "to %s%s", rc, bounce_recipient, s);
7995 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7996 "to %s%s", rc, bounce_recipient, s);
7999 /* The message succeeded. Ensure that the recipients that failed are
8000 now marked finished with on the spool and their parents updated. */
8004 for (addr = handled_addr; addr; addr = addr->next)
8006 address_done(addr, logtod);
8007 child_done(addr, logtod);
8009 /* Panic-dies on error */
8010 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8016 f.disable_logging = FALSE; /* In case left set */
8018 /* Come here from the mua_wrapper case if routing goes wrong */
8022 /* If there are now no deferred addresses, we are done. Preserve the
8023 message log if so configured, and we are using them. Otherwise, sling it.
8024 Then delete the message itself. */
8032 fname = spool_fname(US"msglog", message_subdir, id, US"");
8033 if (preserve_message_logs)
8036 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8038 if ((rc = Urename(fname, moname)) < 0)
8040 (void)directory_make(spool_directory,
8041 spool_sname(US"msglog.OLD", US""),
8042 MSGLOG_DIRECTORY_MODE, TRUE);
8043 rc = Urename(fname, moname);
8046 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8047 "msglog.OLD directory", fname);
8050 if (Uunlink(fname) < 0)
8051 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8052 fname, strerror(errno));
8055 /* Remove the two message files. */
8057 fname = spool_fname(US"input", message_subdir, id, US"-D");
8058 if (Uunlink(fname) < 0)
8059 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8060 fname, strerror(errno));
8061 fname = spool_fname(US"input", message_subdir, id, US"-H");
8062 if (Uunlink(fname) < 0)
8063 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8064 fname, strerror(errno));
8066 /* Log the end of this message, with queue time if requested. */
8068 if (LOGGING(queue_time_overall))
8069 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8071 log_write(0, LOG_MAIN, "Completed");
8073 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8074 f.deliver_freeze = FALSE;
8076 #ifndef DISABLE_EVENT
8077 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8081 /* If there are deferred addresses, we are keeping this message because it is
8082 not yet completed. Lose any temporary files that were catching output from
8083 pipes for any of the deferred addresses, handle one-time aliases, and see if
8084 the message has been on the queue for so long that it is time to send a warning
8085 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8086 have the same domain, we can set deliver_domain for the expansion of
8087 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8088 the parent's domain.
8090 If all the deferred addresses have an error number that indicates "retry time
8091 not reached", skip sending the warning message, because it won't contain the
8092 reason for the delay. It will get sent at the next real delivery attempt.
8093 Exception: for retries caused by a remote peer we use the error message
8094 store in the retry DB as the reason.
8095 However, if at least one address has tried, we'd better include all of them in
8098 If we can't make a process to send the message, don't worry.
8100 For mailing list expansions we want to send the warning message to the
8101 mailing list manager. We can't do a perfect job here, as some addresses may
8102 have different errors addresses, but if we take the errors address from
8103 each deferred address it will probably be right in most cases.
8105 If addr_defer == +1, it means there was a problem sending an error message
8106 for failed addresses, and there were no "real" deferred addresses. The value
8107 was set just to keep the message on the spool, so there is nothing to do here.
8110 else if (addr_defer != (address_item *)(+1))
8112 uschar *recipients = US"";
8113 BOOL want_warning_msg = FALSE;
8115 deliver_domain = testflag(addr_defer, af_pfr)
8116 ? addr_defer->parent->domain : addr_defer->domain;
8118 for (address_item * addr = addr_defer; addr; addr = addr->next)
8120 address_item *otaddr;
8122 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8126 const uschar *d = testflag(addr, af_pfr)
8127 ? addr->parent->domain : addr->domain;
8129 /* The domain may be unset for an address that has never been routed
8130 because the system filter froze the message. */
8132 if (!d || Ustrcmp(d, deliver_domain) != 0)
8133 deliver_domain = NULL;
8136 if (addr->return_filename) Uunlink(addr->return_filename);
8138 /* Handle the case of one-time aliases. If any address in the ancestry
8139 of this one is flagged, ensure it is in the recipients list, suitably
8140 flagged, and that its parent is marked delivered. */
8142 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8143 if (otaddr->onetime_parent) break;
8148 int t = recipients_count;
8150 for (i = 0; i < recipients_count; i++)
8152 uschar *r = recipients_list[i].address;
8153 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8154 if (Ustrcmp(otaddr->address, r) == 0) break;
8157 /* Didn't find the address already in the list, and did find the
8158 ultimate parent's address in the list, and they really are different
8159 (i.e. not from an identity-redirect). After adding the recipient,
8160 update the errors address in the recipients list. */
8162 if ( i >= recipients_count && t < recipients_count
8163 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8165 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8166 otaddr->address, otaddr->parent->address);
8167 receive_add_recipient(otaddr->address, t);
8168 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8169 tree_add_nonrecipient(otaddr->parent->address);
8170 update_spool = TRUE;
8174 /* Except for error messages, ensure that either the errors address for
8175 this deferred address or, if there is none, the sender address, is on the
8176 list of recipients for a warning message. */
8178 if (sender_address[0])
8180 uschar * s = addr->prop.errors_address;
8181 if (!s) s = sender_address;
8182 if (Ustrstr(recipients, s) == NULL)
8183 recipients = string_sprintf("%s%s%s", recipients,
8184 recipients[0] ? "," : "", s);
8188 /* Send a warning message if the conditions are right. If the condition check
8189 fails because of a lookup defer, there is nothing we can do. The warning
8190 is not sent. Another attempt will be made at the next delivery attempt (if
8193 if ( !f.queue_2stage
8195 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8196 || addr_defer->dsn_flags & rf_notify_delay
8198 && delay_warning[1] > 0
8199 && sender_address[0] != 0
8200 && ( !delay_warning_condition
8201 || expand_check_condition(delay_warning_condition,
8202 US"delay_warning", US"option")
8208 int queue_time = time(NULL) - received_time.tv_sec;
8210 queue_time = test_harness_fudged_queue_time(queue_time);
8212 /* See how many warnings we should have sent by now */
8214 for (count = 0; count < delay_warning[1]; count++)
8215 if (queue_time < delay_warning[count+2]) break;
8217 show_time = delay_warning[count+1];
8219 if (count >= delay_warning[1])
8222 int last_gap = show_time;
8223 if (count > 1) last_gap -= delay_warning[count];
8224 extra = (queue_time - delay_warning[count+1])/last_gap;
8225 show_time += last_gap * extra;
8231 debug_printf("time on queue = %s id %s addr %s\n",
8232 readconf_printtime(queue_time), message_id, addr_defer->address);
8233 debug_printf("warning counts: required %d done %d\n", count,
8237 /* We have computed the number of warnings there should have been by now.
8238 If there haven't been enough, send one, and up the count to what it should
8241 if (warning_count < count)
8245 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8251 FILE * f = fdopen(fd, "wb");
8253 transport_ctx tctx = {{0}};
8255 if (warn_message_file)
8256 wmf = expand_open(warn_message_file,
8257 US"warn_message_file", US"warning");
8259 warnmsg_recipients = recipients;
8260 warnmsg_delay = queue_time < 120*60
8261 ? string_sprintf("%d minutes", show_time/60)
8262 : string_sprintf("%d hours", show_time/3600);
8264 if (errors_reply_to)
8265 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8266 fprintf(f, "Auto-Submitted: auto-replied\n");
8268 fprintf(f, "To: %s\n", recipients);
8269 moan_write_references(f, NULL);
8271 /* generated boundary string and output MIME-Headers */
8272 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8274 fprintf(f, "Content-Type: multipart/report;"
8275 " report-type=delivery-status; boundary=%s\n"
8276 "MIME-Version: 1.0\n",
8279 if ((wmf_text = next_emf(wmf, US"header")))
8280 fprintf(f, "%s\n", wmf_text);
8282 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8283 message_id, warnmsg_delay);
8285 /* output human readable part as text/plain section */
8287 "Content-type: text/plain; charset=us-ascii\n\n",
8290 if ((wmf_text = next_emf(wmf, US"intro")))
8291 fprintf(f, "%s", CS wmf_text);
8295 "This message was created automatically by mail delivery software.\n");
8297 if (Ustrcmp(recipients, sender_address) == 0)
8299 "A message that you sent has not yet been delivered to one or more of its\n"
8300 "recipients after more than ");
8304 "A message sent by\n\n <%s>\n\n"
8305 "has not yet been delivered to one or more of its recipients after more than \n",
8308 fprintf(f, "%s on the queue on %s.\n\n"
8309 "The message identifier is: %s\n",
8310 warnmsg_delay, primary_hostname, message_id);
8312 for (h = header_list; h; h = h->next)
8313 if (strncmpic(h->text, US"Subject:", 8) == 0)
8314 fprintf(f, "The subject of the message is: %s", h->text + 9);
8315 else if (strncmpic(h->text, US"Date:", 5) == 0)
8316 fprintf(f, "The date of the message is: %s", h->text + 6);
8319 fprintf(f, "The address%s to which the message has not yet been "
8321 !addr_defer->next ? "" : "es",
8322 !addr_defer->next ? "is": "are");
8325 /* List the addresses, with error information if allowed */
8328 for (address_item * addr = addr_defer; addr; addr = addr->next)
8330 if (print_address_information(addr, f, US" ", US"\n ", US""))
8331 print_address_error(addr, f, US"Delay reason: ");
8340 if ((wmf_text = next_emf(wmf, US"final")))
8341 fprintf(f, "%s", CS wmf_text);
8347 "No action is required on your part. Delivery attempts will continue for\n"
8348 "some time, and this warning may be repeated at intervals if the message\n"
8349 "remains undelivered. Eventually the mail delivery software will give up,\n"
8350 "and when that happens, the message will be returned to you.\n");
8353 /* output machine readable part */
8354 fprintf(f, "\n--%s\n"
8355 "Content-type: message/delivery-status\n\n"
8356 "Reporting-MTA: dns; %s\n",
8358 smtp_active_hostname);
8363 /* must be decoded from xtext: see RFC 3461:6.3a */
8365 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8366 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8368 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8372 for (address_item * addr = addr_defer; addr; addr = addr->next)
8376 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8378 if ((hu = addr->host_used) && hu->name)
8380 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8381 print_dsn_diagnostic_code(addr, f);
8387 "Content-type: text/rfc822-headers\n\n",
8391 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8392 tctx.u.fd = fileno(f);
8393 tctx.options = topt_add_return_path | topt_no_body;
8394 transport_filter_argv = NULL; /* Just in case */
8395 return_path = sender_address; /* In case not previously set */
8397 /* Write the original email out */
8398 /*XXX no checking for failure! buggy! */
8399 transport_write_message(&tctx, 0);
8402 fprintf(f,"\n--%s--\n", bound);
8406 /* Close and wait for child process to complete, without a timeout.
8407 If there's an error, don't update the count. */
8410 if (child_close(pid, 0) == 0)
8412 warning_count = count;
8413 update_spool = TRUE; /* Ensure spool rewritten */
8419 /* Clear deliver_domain */
8421 deliver_domain = NULL;
8423 /* If this was a first delivery attempt, unset the first time flag, and
8424 ensure that the spool gets updated. */
8426 if (f.deliver_firsttime && !f.queue_2stage)
8428 f.deliver_firsttime = FALSE;
8429 update_spool = TRUE;
8432 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8433 message, unless the message is a local error message (to avoid loops). Then
8434 log the freezing. If the text in "frozen_info" came from a system filter,
8435 it has been escaped into printing characters so as not to mess up log lines.
8436 For the "tell" message, we turn \n back into newline. Also, insert a newline
8437 near the start instead of the ": " string. */
8439 if (f.deliver_freeze)
8441 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8443 uschar *s = string_copy(frozen_info);
8444 uschar *ss = Ustrstr(s, " by the system filter: ");
8455 if (*ss == '\\' && ss[1] == 'n')
8462 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8463 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8467 /* Log freezing just before we update the -H file, to minimize the chance
8468 of a race problem. */
8470 deliver_msglog("*** Frozen%s\n", frozen_info);
8471 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8474 /* If there have been any updates to the non-recipients list, or other things
8475 that get written to the spool, we must now update the spool header file so
8476 that it has the right information for the next delivery attempt. If there
8477 was more than one address being delivered, the header_change update is done
8478 earlier, in case one succeeds and then something crashes. */
8481 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8482 update_spool, f.header_rewritten);
8484 if (update_spool || f.header_rewritten)
8485 /* Panic-dies on error */
8486 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8489 /* Finished with the message log. If the message is complete, it will have
8490 been unlinked or renamed above. */
8492 if (message_logs) (void)fclose(message_log);
8494 /* Now we can close and remove the journal file. Its only purpose is to record
8495 successfully completed deliveries asap so that this information doesn't get
8496 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8497 not serious, as trying it again is not harmful. The journal might not be open
8498 if all addresses were deferred at routing or directing. Nevertheless, we must
8499 remove it if it exists (may have been lying around from a crash during the
8500 previous delivery attempt). We don't remove the journal if a delivery
8501 subprocess failed to pass back delivery information; this is controlled by
8502 the remove_journal flag. When the journal is left, we also don't move the
8503 message off the main spool if frozen and the option is set. It should get moved
8504 at the next attempt, after the journal has been inspected. */
8506 if (journal_fd >= 0) (void)close(journal_fd);
8510 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8512 if (Uunlink(fname) < 0 && errno != ENOENT)
8513 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8516 /* Move the message off the spool if requested */
8518 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8519 if (f.deliver_freeze && move_frozen_messages)
8520 (void)spool_move_message(id, message_subdir, US"", US"F");
8524 /* Closing the data file frees the lock; if the file has been unlinked it
8525 will go away. Otherwise the message becomes available for another process
8528 (void)close(deliver_datafile);
8529 deliver_datafile = -1;
8530 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8531 #ifdef MEASURE_TIMING
8532 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8535 /* It is unlikely that there will be any cached resources, since they are
8536 released after routing, and in the delivery subprocesses. However, it's
8537 possible for an expansion for something afterwards (for example,
8538 expand_check_condition) to do a lookup. We must therefore be sure everything is
8542 acl_where = ACL_WHERE_UNKNOWN;
8551 #ifdef EXIM_TFO_PROBE
8554 f.tcp_fastopen_ok = TRUE;
8560 /* Called from a commandline, or from the daemon, to do a delivery.
8561 We need to regain privs; do this by exec of the exim binary. */
8564 delivery_re_exec(int exec_type)
8568 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8570 int channel_fd = cutthrough.cctx.sock;
8572 smtp_peer_options = cutthrough.peer_options;
8573 continue_sequence = 0;
8576 if (cutthrough.is_tls)
8580 smtp_peer_options |= OPTION_TLS;
8581 sending_ip_address = cutthrough.snd_ip;
8582 sending_port = cutthrough.snd_port;
8584 where = US"socketpair";
8585 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8589 testharness_pause_ms(150);
8590 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8593 if (pid == 0) /* child: will fork again to totally disconnect */
8595 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8596 pfd, 5*60, cutthrough.host.name);
8597 /* does not return */
8601 waitpid(pid, NULL, 0);
8602 (void) close(channel_fd); /* release the client socket */
8603 channel_fd = pfd[1];
8607 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8608 cutthrough.host.address, message_id, channel_fd);
8612 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8613 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8615 return; /* compiler quietening; control does not reach here. */
8620 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8621 "delivery re-exec %s failed: %s", where, strerror(errno));
8623 /* Get here if exec_type == CEE_EXEC_EXIT.
8624 Note: this must be _exit(), not exit(). */
8626 _exit(EX_EXECFAILED);
8632 /* End of deliver.c */