1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_senddsn = NULL;
71 static FILE *message_log = NULL;
72 static BOOL update_spool;
73 static BOOL remove_journal;
74 static int parcount = 0;
75 static pardata *parlist = NULL;
76 static int return_count;
77 static uschar *frozen_info = US"";
78 static uschar *used_return_path = NULL;
82 /*************************************************
83 * read as much as requested *
84 *************************************************/
86 /* The syscall read(2) doesn't always returns as much as we want. For
87 several reasons it might get less. (Not talking about signals, as syscalls
88 are restartable). When reading from a network or pipe connection the sender
89 might send in smaller chunks, with delays between these chunks. The read(2)
90 may return such a chunk.
92 The more the writer writes and the smaller the pipe between write and read is,
93 the more we get the chance of reading leass than requested. (See bug 2130)
95 This function read(2)s until we got all the data we *requested*.
97 Note: This function may block. Use it only if you're sure about the
98 amount of data you will get.
101 fd the file descriptor to read from
102 buffer pointer to a buffer of size len
103 len the requested(!) amount of bytes
105 Returns: the amount of bytes read
108 readn(int fd, void * buffer, size_t len)
110 void * next = buffer;
111 void * end = buffer + len;
115 ssize_t got = read(fd, next, end - next);
117 /* I'm not sure if there are signals that can interrupt us,
118 for now I assume the worst */
119 if (got == -1 && errno == EINTR) continue;
120 if (got <= 0) return next - buffer;
128 /*************************************************
129 * Make a new address item *
130 *************************************************/
132 /* This function gets the store and initializes with default values. The
133 transport_return value defaults to DEFER, so that any unexpected failure to
134 deliver does not wipe out the message. The default unique string is set to a
135 copy of the address, so that its domain can be lowercased.
138 address the RFC822 address string
139 copy force a copy of the address
141 Returns: a pointer to an initialized address_item
145 deliver_make_addr(uschar *address, BOOL copy)
147 address_item *addr = store_get(sizeof(address_item), FALSE);
148 *addr = address_defaults;
149 if (copy) address = string_copy(address);
150 addr->address = address;
151 addr->unique = string_copy(address);
158 /*************************************************
159 * Set expansion values for an address *
160 *************************************************/
162 /* Certain expansion variables are valid only when handling an address or
163 address list. This function sets them up or clears the values, according to its
167 addr the address in question, or NULL to clear values
172 deliver_set_expansions(address_item *addr)
176 const uschar ***p = address_expansions;
177 while (*p) **p++ = NULL;
181 /* Exactly what gets set depends on whether there is one or more addresses, and
182 what they contain. These first ones are always set, taking their values from
183 the first address. */
185 if (!addr->host_list)
187 deliver_host = deliver_host_address = US"";
188 deliver_host_port = 0;
192 deliver_host = addr->host_list->name;
193 deliver_host_address = addr->host_list->address;
194 deliver_host_port = addr->host_list->port;
197 deliver_recipients = addr;
198 deliver_address_data = addr->prop.address_data;
199 deliver_domain_data = addr->prop.domain_data;
200 deliver_localpart_data = addr->prop.localpart_data;
201 router_var = addr->prop.variables;
203 /* These may be unset for multiple addresses */
205 deliver_domain = addr->domain;
206 self_hostname = addr->self_hostname;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver = 1; /* deliver by default */
210 bmi_alt_location = NULL;
211 bmi_base64_verdict = NULL;
212 bmi_base64_tracker_verdict = NULL;
215 /* If there's only one address we can set everything. */
219 address_item *addr_orig;
221 deliver_localpart = addr->local_part;
222 deliver_localpart_prefix = addr->prefix;
223 deliver_localpart_suffix = addr->suffix;
225 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
226 deliver_domain_orig = addr_orig->domain;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig = !addr_orig->router
235 ? addr_orig->local_part
236 : addr_orig->router->caseful_local_part
237 ? addr_orig->cc_local_part
238 : addr_orig->lc_local_part;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent = addr->parent->domain;
248 deliver_localpart_parent = !addr->parent->router
249 ? addr->parent->local_part
250 : addr->parent->router->caseful_local_part
251 ? addr->parent->cc_local_part
252 : addr->parent->lc_local_part;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr, af_pfr))
259 if (testflag(addr, af_file)) address_file = addr->local_part;
260 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
261 deliver_localpart = addr->parent->local_part;
262 deliver_localpart_prefix = addr->parent->prefix;
263 deliver_localpart_suffix = addr->parent->suffix;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
270 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver == 1)
275 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
287 if (testflag(addr, af_pfr))
289 if (testflag(addr, af_file)) address_file = addr->local_part;
290 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
292 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
294 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
295 deliver_domain = NULL;
297 && ( !addr2->self_hostname
298 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
300 self_hostname = NULL;
301 if (!deliver_domain && !self_hostname) break;
309 /*************************************************
310 * Open a msglog file *
311 *************************************************/
313 /* This function is used both for normal message logs, and for files in the
314 msglog directory that are used to catch output from pipes. Try to create the
315 directory if it does not exist. From release 4.21, normal message logs should
316 be created when the message is received.
318 Called from deliver_message(), can be operating as root.
321 filename the file name
322 mode the mode required
323 error used for saying what failed
325 Returns: a file descriptor, or -1 (with errno set)
329 open_msglog_file(uschar *filename, int mode, uschar **error)
331 for (int i = 2; i > 0; i--)
333 int fd = Uopen(filename,
340 O_WRONLY|O_APPEND|O_CREAT, mode);
343 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
344 function is called as root). Double check the mode, because the group setting
345 doesn't always get set automatically. */
348 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
350 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
355 if (fchmod(fd, mode) < 0)
365 (void)directory_make(spool_directory,
366 spool_sname(US"msglog", message_subdir),
367 MSGLOG_DIRECTORY_MODE, TRUE);
370 *error = US"create or open";
377 /*************************************************
378 * Write to msglog if required *
379 *************************************************/
381 /* Write to the message log, if configured. This function may also be called
385 format a string format
391 deliver_msglog(const char *format, ...)
394 if (!message_logs) return;
395 va_start(ap, format);
396 vfprintf(message_log, format, ap);
404 /*************************************************
405 * Replicate status for batch *
406 *************************************************/
408 /* When a transport handles a batch of addresses, it may treat them
409 individually, or it may just put the status in the first one, and return FALSE,
410 requesting that the status be copied to all the others externally. This is the
411 replication function. As well as the status, it copies the transport pointer,
412 which may have changed if appendfile passed the addresses on to a different
415 Argument: pointer to the first address in a chain
420 replicate_status(address_item *addr)
422 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
424 addr2->transport = addr->transport;
425 addr2->transport_return = addr->transport_return;
426 addr2->basic_errno = addr->basic_errno;
427 addr2->more_errno = addr->more_errno;
428 addr2->delivery_usec = addr->delivery_usec;
429 addr2->special_action = addr->special_action;
430 addr2->message = addr->message;
431 addr2->user_message = addr->user_message;
437 /*************************************************
438 * Compare lists of hosts *
439 *************************************************/
441 /* This function is given two pointers to chains of host items, and it yields
442 TRUE if the lists refer to the same hosts in the same order, except that
444 (1) Multiple hosts with the same non-negative MX values are permitted to appear
445 in different orders. Round-robinning nameservers can cause this to happen.
447 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
448 permitted to appear in different orders. This is caused by randomizing
451 This enables Exim to use a single SMTP transaction for sending to two entirely
452 different domains that happen to end up pointing at the same hosts.
455 one points to the first host list
456 two points to the second host list
458 Returns: TRUE if the lists refer to the same host set
462 same_hosts(host_item *one, host_item *two)
466 if (Ustrcmp(one->name, two->name) != 0)
469 host_item *end_one = one;
470 host_item *end_two = two;
472 /* Batch up only if there was no MX and the list was not randomized */
474 if (mx == MX_NONE) return FALSE;
476 /* Find the ends of the shortest sequence of identical MX values */
478 while ( end_one->next && end_one->next->mx == mx
479 && end_two->next && end_two->next->mx == mx)
481 end_one = end_one->next;
482 end_two = end_two->next;
485 /* If there aren't any duplicates, there's no match. */
487 if (end_one == one) return FALSE;
489 /* For each host in the 'one' sequence, check that it appears in the 'two'
490 sequence, returning FALSE if not. */
495 for (hi = two; hi != end_two->next; hi = hi->next)
496 if (Ustrcmp(one->name, hi->name) == 0) break;
497 if (hi == end_two->next) return FALSE;
498 if (one == end_one) break;
502 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
503 Ensure both are pointing at the last host, and carry on as for equality. */
508 /* if the names matched but ports do not, mismatch */
509 else if (one->port != two->port)
518 /* True if both are NULL */
525 /*************************************************
526 * Compare header lines *
527 *************************************************/
529 /* This function is given two pointers to chains of header items, and it yields
530 TRUE if they are the same header texts in the same order.
533 one points to the first header list
534 two points to the second header list
536 Returns: TRUE if the lists refer to the same header set
540 same_headers(header_line *one, header_line *two)
542 for (;; one = one->next, two = two->next)
544 if (one == two) return TRUE; /* Includes the case where both NULL */
545 if (!one || !two) return FALSE;
546 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
552 /*************************************************
553 * Compare string settings *
554 *************************************************/
556 /* This function is given two pointers to strings, and it returns
557 TRUE if they are the same pointer, or if the two strings are the same.
560 one points to the first string
561 two points to the second string
563 Returns: TRUE or FALSE
567 same_strings(uschar *one, uschar *two)
569 if (one == two) return TRUE; /* Includes the case where both NULL */
570 if (!one || !two) return FALSE;
571 return (Ustrcmp(one, two) == 0);
576 /*************************************************
577 * Compare uid/gid for addresses *
578 *************************************************/
580 /* This function is given a transport and two addresses. It yields TRUE if the
581 uid/gid/initgroups settings for the two addresses are going to be the same when
586 addr1 the first address
587 addr2 the second address
589 Returns: TRUE or FALSE
593 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
595 if ( !tp->uid_set && !tp->expand_uid
596 && !tp->deliver_as_creator
597 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
598 || ( testflag(addr1, af_uid_set)
599 && ( addr1->uid != addr2->uid
600 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
604 if ( !tp->gid_set && !tp->expand_gid
605 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
606 || ( testflag(addr1, af_gid_set)
607 && addr1->gid != addr2->gid
617 /*************************************************
618 * Record that an address is complete *
619 *************************************************/
621 /* This function records that an address is complete. This is straightforward
622 for most addresses, where the unique address is just the full address with the
623 domain lower cased. For homonyms (addresses that are the same as one of their
624 ancestors) their are complications. Their unique addresses have \x\ prepended
625 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
628 Exim used to record the unique addresses of homonyms as "complete". This,
629 however, fails when the pattern of redirection varies over time (e.g. if taking
630 unseen copies at only some times of day) because the prepended numbers may vary
631 from one delivery run to the next. This problem is solved by never recording
632 prepended unique addresses as complete. Instead, when a homonymic address has
633 actually been delivered via a transport, we record its basic unique address
634 followed by the name of the transport. This is checked in subsequent delivery
635 runs whenever an address is routed to a transport.
637 If the completed address is a top-level one (has no parent, which means it
638 cannot be homonymic) we also add the original address to the non-recipients
639 tree, so that it gets recorded in the spool file and therefore appears as
640 "done" in any spool listings. The original address may differ from the unique
641 address in the case of the domain.
643 Finally, this function scans the list of duplicates, marks as done any that
644 match this address, and calls child_done() for their ancestors.
647 addr address item that has been completed
648 now current time as a string
654 address_done(address_item *addr, uschar *now)
656 update_spool = TRUE; /* Ensure spool gets updated */
658 /* Top-level address */
662 tree_add_nonrecipient(addr->unique);
663 tree_add_nonrecipient(addr->address);
666 /* Homonymous child address */
668 else if (testflag(addr, af_homonym))
671 tree_add_nonrecipient(
672 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
675 /* Non-homonymous child address */
677 else tree_add_nonrecipient(addr->unique);
679 /* Check the list of duplicate addresses and ensure they are now marked
682 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
683 if (Ustrcmp(addr->unique, dup->unique) == 0)
685 tree_add_nonrecipient(dup->unique);
686 child_done(dup, now);
693 /*************************************************
694 * Decrease counts in parents and mark done *
695 *************************************************/
697 /* This function is called when an address is complete. If there is a parent
698 address, its count of children is decremented. If there are still other
699 children outstanding, the function exits. Otherwise, if the count has become
700 zero, address_done() is called to mark the parent and its duplicates complete.
701 Then loop for any earlier ancestors.
704 addr points to the completed address item
705 now the current time as a string, for writing to the message log
711 child_done(address_item *addr, uschar *now)
718 if (--addr->child_count > 0) return; /* Incomplete parent */
719 address_done(addr, now);
721 /* Log the completion of all descendents only when there is no ancestor with
722 the same original address. */
724 for (aa = addr->parent; aa; aa = aa->parent)
725 if (Ustrcmp(aa->address, addr->address) == 0) break;
728 deliver_msglog("%s %s: children all complete\n", now, addr->address);
729 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
735 /*************************************************
736 * Delivery logging support functions *
737 *************************************************/
739 /* The LOGGING() checks in d_log_interface() are complicated for backwards
740 compatibility. When outgoing interface logging was originally added, it was
741 conditional on just incoming_interface (which is off by default). The
742 outgoing_interface option is on by default to preserve this behaviour, but
743 you can enable incoming_interface and disable outgoing_interface to get I=
744 fields on incoming lines only.
748 addr The address to be logged
750 Returns: New value for s
754 d_log_interface(gstring * g)
756 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
757 && sending_ip_address)
759 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
760 if (LOGGING(outgoing_port))
761 g = string_fmt_append(g, ":%d", sending_port);
769 d_hostlog(gstring * g, address_item * addr)
771 host_item * h = addr->host_used;
773 g = string_append(g, 2, US" H=", h->name);
775 if (LOGGING(dnssec) && h->dnssec == DS_YES)
776 g = string_catn(g, US" DS", 3);
778 g = string_append(g, 3, US" [", h->address, US"]");
780 if (LOGGING(outgoing_port))
781 g = string_fmt_append(g, ":%d", h->port);
784 if (LOGGING(proxy) && proxy_local_address)
786 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
787 if (LOGGING(outgoing_port))
788 g = string_fmt_append(g, ":%d", proxy_local_port);
792 g = d_log_interface(g);
794 if (testflag(addr, af_tcp_fastopen))
795 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
806 d_tlslog(gstring * g, address_item * addr)
808 if (LOGGING(tls_cipher) && addr->cipher)
810 g = string_append(g, 2, US" X=", addr->cipher);
811 #ifdef EXPERIMENTAL_TLS_RESUME
812 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
813 g = string_catn(g, US"*", 1);
816 if (LOGGING(tls_certificate_verified) && addr->cipher)
817 g = string_append(g, 2, US" CV=",
818 testflag(addr, af_cert_verified)
821 testflag(addr, af_dane_verified)
827 if (LOGGING(tls_peerdn) && addr->peerdn)
828 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
836 #ifndef DISABLE_EVENT
838 event_raise(uschar * action, const uschar * event, uschar * ev_data)
844 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
846 action, deliver_host_address);
849 event_data = ev_data;
851 if (!(s = expand_string(action)) && *expand_string_message)
852 log_write(0, LOG_MAIN|LOG_PANIC,
853 "failed to expand event_action %s in %s: %s\n",
854 event, transport_name ? transport_name : US"main", expand_string_message);
856 event_name = event_data = NULL;
858 /* If the expansion returns anything but an empty string, flag for
859 the caller to modify his normal processing
864 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
873 msg_event_raise(const uschar * event, const address_item * addr)
875 const uschar * save_domain = deliver_domain;
876 uschar * save_local = deliver_localpart;
877 const uschar * save_host = deliver_host;
878 const uschar * save_address = deliver_host_address;
879 const int save_port = deliver_host_port;
881 router_name = addr->router ? addr->router->name : NULL;
882 deliver_domain = addr->domain;
883 deliver_localpart = addr->local_part;
884 deliver_host = addr->host_used ? addr->host_used->name : NULL;
886 if (!addr->transport)
888 if (Ustrcmp(event, "msg:fail:delivery") == 0)
890 /* An address failed with no transport involved. This happens when
891 a filter was used which triggered a fail command (in such a case
892 a transport isn't needed). Convert it to an internal fail event. */
894 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
899 transport_name = addr->transport->name;
901 (void) event_raise(addr->transport->event_action, event,
903 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
904 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
905 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
906 ? addr->message : NULL);
909 deliver_host_port = save_port;
910 deliver_host_address = save_address;
911 deliver_host = save_host;
912 deliver_localpart = save_local;
913 deliver_domain = save_domain;
914 router_name = transport_name = NULL;
916 #endif /*DISABLE_EVENT*/
920 /******************************************************************************/
923 /*************************************************
924 * Generate local prt for logging *
925 *************************************************/
927 /* This function is a subroutine for use in string_log_address() below.
930 addr the address being logged
931 yield the current dynamic buffer pointer
933 Returns: the new value of the buffer pointer
937 string_get_localpart(address_item * addr, gstring * yield)
942 if (testflag(addr, af_include_affixes) && s)
945 if (testflag(addr, af_utf8_downcvt))
946 s = string_localpart_utf8_to_alabel(s, NULL);
948 yield = string_cat(yield, s);
951 s = addr->local_part;
953 if (testflag(addr, af_utf8_downcvt))
954 s = string_localpart_utf8_to_alabel(s, NULL);
956 yield = string_cat(yield, s);
959 if (testflag(addr, af_include_affixes) && s)
962 if (testflag(addr, af_utf8_downcvt))
963 s = string_localpart_utf8_to_alabel(s, NULL);
965 yield = string_cat(yield, s);
972 /*************************************************
973 * Generate log address list *
974 *************************************************/
976 /* This function generates a list consisting of an address and its parents, for
977 use in logging lines. For saved onetime aliased addresses, the onetime parent
978 field is used. If the address was delivered by a transport with rcpt_include_
979 affixes set, the af_include_affixes bit will be set in the address. In that
980 case, we include the affixes here too.
983 g points to growing-string struct
984 addr bottom (ultimate) address
985 all_parents if TRUE, include all parents
986 success TRUE for successful delivery
988 Returns: a growable string in dynamic store
992 string_log_address(gstring * g,
993 address_item *addr, BOOL all_parents, BOOL success)
995 BOOL add_topaddr = TRUE;
996 address_item *topaddr;
998 /* Find the ultimate parent */
1000 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1002 /* We start with just the local part for pipe, file, and reply deliveries, and
1003 for successful local deliveries from routers that have the log_as_local flag
1004 set. File deliveries from filters can be specified as non-absolute paths in
1005 cases where the transport is going to complete the path. If there is an error
1006 before this happens (expansion failure) the local part will not be updated, and
1007 so won't necessarily look like a path. Add extra text for this case. */
1009 if ( testflag(addr, af_pfr)
1011 && addr->router && addr->router->log_as_local
1012 && addr->transport && addr->transport->info->local
1015 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1016 g = string_catn(g, CUS"save ", 5);
1017 g = string_get_localpart(addr, g);
1020 /* Other deliveries start with the full address. It we have split it into local
1021 part and domain, use those fields. Some early failures can happen before the
1022 splitting is done; in those cases use the original field. */
1027 int off = g->ptr; /* start of the "full address" */
1029 if (addr->local_part)
1032 g = string_get_localpart(addr, g);
1033 g = string_catn(g, US"@", 1);
1036 if (testflag(addr, af_utf8_downcvt))
1037 s = string_localpart_utf8_to_alabel(s, NULL);
1039 g = string_cat(g, s);
1042 g = string_cat(g, addr->address);
1044 /* If the address we are going to print is the same as the top address,
1045 and all parents are not being included, don't add on the top address. First
1046 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1047 on the local parts. */
1049 cmp = g->s + off; /* only now, as rebuffer likely done */
1050 string_from_gstring(g); /* ensure nul-terminated */
1051 if ( strcmpic(cmp, topaddr->address) == 0
1052 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1053 && !addr->onetime_parent
1054 && (!all_parents || !addr->parent || addr->parent == topaddr)
1056 add_topaddr = FALSE;
1059 /* If all parents are requested, or this is a local pipe/file/reply, and
1060 there is at least one intermediate parent, show it in brackets, and continue
1061 with all of them if all are wanted. */
1063 if ( (all_parents || testflag(addr, af_pfr))
1065 && addr->parent != topaddr)
1068 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1070 g = string_catn(g, s, 2);
1071 g = string_cat (g, addr2->address);
1072 if (!all_parents) break;
1075 g = string_catn(g, US")", 1);
1078 /* Add the top address if it is required */
1081 g = string_append(g, 3,
1083 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1092 timesince(struct timeval * diff, struct timeval * then)
1094 gettimeofday(diff, NULL);
1095 diff->tv_sec -= then->tv_sec;
1096 if ((diff->tv_usec -= then->tv_usec) < 0)
1099 diff->tv_usec += 1000*1000;
1106 string_timediff(struct timeval * diff)
1108 static uschar buf[sizeof("0.000s")];
1110 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1111 return readconf_printtime((int)diff->tv_sec);
1113 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1119 string_timesince(struct timeval * then)
1121 struct timeval diff;
1123 timesince(&diff, then);
1124 return string_timediff(&diff);
1127 /******************************************************************************/
1131 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1132 this is a nonstandard call; no two-character delivery flag is written
1133 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1136 flags passed to log_write()
1139 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1141 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1144 /* Log the delivery on the main log. We use an extensible string to build up
1145 the log line, and reset the store afterwards. Remote deliveries should always
1146 have a pointer to the host item that succeeded; local deliveries can have a
1147 pointer to a single host item in their host list, for use by the transport. */
1149 #ifndef DISABLE_EVENT
1150 /* presume no successful remote delivery */
1151 lookup_dnssec_authenticated = NULL;
1154 reset_point = store_mark();
1155 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1158 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1161 g->s[0] = logchar; g->ptr = 1;
1162 g = string_catn(g, US"> ", 2);
1164 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1166 if (LOGGING(sender_on_delivery) || msg)
1167 g = string_append(g, 3, US" F=<",
1169 testflag(addr, af_utf8_downcvt)
1170 ? string_address_utf8_to_alabel(sender_address, NULL)
1177 g = string_append(g, 2, US" Q=", queue_name);
1179 #ifdef EXPERIMENTAL_SRS
1180 if(addr->prop.srs_sender)
1181 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1184 /* You might think that the return path must always be set for a successful
1185 delivery; indeed, I did for some time, until this statement crashed. The case
1186 when it is not set is for a delivery to /dev/null which is optimised by not
1187 being run at all. */
1189 if (used_return_path && LOGGING(return_path_on_delivery))
1190 g = string_append(g, 3, US" P=<", used_return_path, US">");
1193 g = string_append(g, 2, US" ", msg);
1195 /* For a delivery from a system filter, there may not be a router */
1197 g = string_append(g, 2, US" R=", addr->router->name);
1199 g = string_append(g, 2, US" T=", addr->transport->name);
1201 if (LOGGING(delivery_size))
1202 g = string_fmt_append(g, " S=%d", transport_count);
1204 /* Local delivery */
1206 if (addr->transport->info->local)
1208 if (addr->host_list)
1209 g = string_append(g, 2, US" H=", addr->host_list->name);
1210 g = d_log_interface(g);
1211 if (addr->shadow_message)
1212 g = string_cat(g, addr->shadow_message);
1215 /* Remote delivery */
1219 if (addr->host_used)
1221 g = d_hostlog(g, addr);
1222 if (continue_sequence > 1)
1223 g = string_catn(g, US"*", 1);
1225 #ifndef DISABLE_EVENT
1226 deliver_host_address = addr->host_used->address;
1227 deliver_host_port = addr->host_used->port;
1228 deliver_host = addr->host_used->name;
1230 /* DNS lookup status */
1231 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1232 : addr->host_used->dnssec==DS_NO ? US"no"
1238 g = d_tlslog(g, addr);
1241 if (addr->authenticator)
1243 g = string_append(g, 2, US" A=", addr->authenticator);
1246 g = string_append(g, 2, US":", addr->auth_id);
1247 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1248 g = string_append(g, 2, US":", addr->auth_sndr);
1252 if (LOGGING(pipelining))
1254 if (testflag(addr, af_pipelining))
1255 g = string_catn(g, US" L", 2);
1256 #ifdef SUPPORT_PIPE_CONNECT
1257 if (testflag(addr, af_early_pipe))
1258 g = string_catn(g, US"*", 1);
1262 #ifndef DISABLE_PRDR
1263 if (testflag(addr, af_prdr_used))
1264 g = string_catn(g, US" PRDR", 5);
1267 if (testflag(addr, af_chunking_used))
1268 g = string_catn(g, US" K", 2);
1271 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1273 if ( LOGGING(smtp_confirmation)
1275 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1278 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1279 uschar *p = big_buffer;
1280 uschar *ss = addr->message;
1282 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1284 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1289 g = string_append(g, 2, US" C=", big_buffer);
1292 /* Time on queue and actual time taken to deliver */
1294 if (LOGGING(queue_time))
1295 g = string_append(g, 2, US" QT=",
1296 string_timesince(&received_time));
1298 if (LOGGING(deliver_time))
1300 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1301 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1304 /* string_cat() always leaves room for the terminator. Release the
1305 store we used to build the line after writing it. */
1307 log_write(0, flags, "%s", string_from_gstring(g));
1309 #ifndef DISABLE_EVENT
1310 if (!msg) msg_event_raise(US"msg:delivery", addr);
1313 store_reset(reset_point);
1320 deferral_log(address_item * addr, uschar * now,
1321 int logflags, uschar * driver_name, uschar * driver_kind)
1323 rmark reset_point = store_mark();
1324 gstring * g = string_get(256);
1326 /* Build up the line that is used for both the message log and the main
1329 /* Create the address string for logging. Must not do this earlier, because
1330 an OK result may be changed to FAIL when a pipe returns text. */
1332 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1335 g = string_append(g, 2, US" Q=", queue_name);
1337 /* Either driver_name contains something and driver_kind contains
1338 " router" or " transport" (note the leading space), or driver_name is
1339 a null string and driver_kind contains "routing" without the leading
1340 space, if all routing has been deferred. When a domain has been held,
1341 so nothing has been done at all, both variables contain null strings. */
1345 if (driver_kind[1] == 't' && addr->router)
1346 g = string_append(g, 2, US" R=", addr->router->name);
1347 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1349 else if (driver_kind)
1350 g = string_append(g, 2, US" ", driver_kind);
1352 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1354 if (addr->basic_errno > 0)
1355 g = string_append(g, 2, US": ",
1356 US strerror(addr->basic_errno));
1358 if (addr->host_used)
1360 g = string_append(g, 5,
1361 US" H=", addr->host_used->name,
1362 US" [", addr->host_used->address, US"]");
1363 if (LOGGING(outgoing_port))
1365 int port = addr->host_used->port;
1366 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1371 g = string_append(g, 2, US": ", addr->message);
1373 (void) string_from_gstring(g);
1375 /* Log the deferment in the message log, but don't clutter it
1376 up with retry-time defers after the first delivery attempt. */
1378 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1379 deliver_msglog("%s %s\n", now, g->s);
1381 /* Write the main log and reset the store.
1382 For errors of the type "retry time not reached" (also remotes skipped
1383 on queue run), logging is controlled by L_retry_defer. Note that this kind
1384 of error number is negative, and all the retry ones are less than any
1388 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1391 store_reset(reset_point);
1398 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1400 rmark reset_point = store_mark();
1401 gstring * g = string_get(256);
1403 #ifndef DISABLE_EVENT
1404 /* Message failures for which we will send a DSN get their event raised
1405 later so avoid doing it here. */
1407 if ( !addr->prop.ignore_error
1408 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1410 msg_event_raise(US"msg:fail:delivery", addr);
1413 /* Build up the log line for the message and main logs */
1415 /* Create the address string for logging. Must not do this earlier, because
1416 an OK result may be changed to FAIL when a pipe returns text. */
1418 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1420 if (LOGGING(sender_on_delivery))
1421 g = string_append(g, 3, US" F=<", sender_address, US">");
1424 g = string_append(g, 2, US" Q=", queue_name);
1426 /* Return path may not be set if no delivery actually happened */
1428 if (used_return_path && LOGGING(return_path_on_delivery))
1429 g = string_append(g, 3, US" P=<", used_return_path, US">");
1432 g = string_append(g, 2, US" R=", addr->router->name);
1433 if (addr->transport)
1434 g = string_append(g, 2, US" T=", addr->transport->name);
1436 if (addr->host_used)
1437 g = d_hostlog(g, addr);
1440 g = d_tlslog(g, addr);
1443 if (addr->basic_errno > 0)
1444 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1447 g = string_append(g, 2, US": ", addr->message);
1449 (void) string_from_gstring(g);
1451 /* Do the logging. For the message log, "routing failed" for those cases,
1452 just to make it clearer. */
1455 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1457 deliver_msglog("%s %s\n", now, g->s);
1459 log_write(0, LOG_MAIN, "** %s", g->s);
1461 store_reset(reset_point);
1467 /*************************************************
1468 * Actions at the end of handling an address *
1469 *************************************************/
1471 /* This is a function for processing a single address when all that can be done
1472 with it has been done.
1475 addr points to the address block
1476 result the result of the delivery attempt
1477 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1478 driver_type indicates which type of driver (transport, or router) was last
1479 to process the address
1480 logchar '=' or '-' for use when logging deliveries with => or ->
1486 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1489 uschar *now = tod_stamp(tod_log);
1490 uschar *driver_kind = NULL;
1491 uschar *driver_name = NULL;
1493 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1495 /* Set up driver kind and name for logging. Disable logging if the router or
1496 transport has disabled it. */
1498 if (driver_type == EXIM_DTYPE_TRANSPORT)
1500 if (addr->transport)
1502 driver_name = addr->transport->name;
1503 driver_kind = US" transport";
1504 f.disable_logging = addr->transport->disable_logging;
1506 else driver_kind = US"transporting";
1508 else if (driver_type == EXIM_DTYPE_ROUTER)
1512 driver_name = addr->router->name;
1513 driver_kind = US" router";
1514 f.disable_logging = addr->router->disable_logging;
1516 else driver_kind = US"routing";
1519 /* If there's an error message set, ensure that it contains only printing
1520 characters - it should, but occasionally things slip in and this at least
1521 stops the log format from getting wrecked. We also scan the message for an LDAP
1522 expansion item that has a password setting, and flatten the password. This is a
1523 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1524 malformed, it won't ever have gone near LDAP.) */
1528 const uschar * s = string_printing(addr->message);
1530 /* deconst cast ok as string_printing known to have alloc'n'copied */
1531 addr->message = expand_hide_passwords(US s);
1534 /* If we used a transport that has one of the "return_output" options set, and
1535 if it did in fact generate some output, then for return_output we treat the
1536 message as failed if it was not already set that way, so that the output gets
1537 returned to the sender, provided there is a sender to send it to. For
1538 return_fail_output, do this only if the delivery failed. Otherwise we just
1539 unlink the file, and remove the name so that if the delivery failed, we don't
1540 try to send back an empty or unwanted file. The log_output options operate only
1541 on a non-empty file.
1543 In any case, we close the message file, because we cannot afford to leave a
1544 file-descriptor for one address while processing (maybe very many) others. */
1546 if (addr->return_file >= 0 && addr->return_filename)
1548 BOOL return_output = FALSE;
1549 struct stat statbuf;
1550 (void)EXIMfsync(addr->return_file);
1552 /* If there is no output, do nothing. */
1554 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1556 transport_instance *tb = addr->transport;
1558 /* Handle logging options */
1561 || result == FAIL && tb->log_fail_output
1562 || result == DEFER && tb->log_defer_output
1566 FILE *f = Ufopen(addr->return_filename, "rb");
1568 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1569 "from %s transport: %s", addr->return_filename, tb->name,
1572 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1574 uschar *p = big_buffer + Ustrlen(big_buffer);
1576 while (p > big_buffer && isspace(p[-1])) p--;
1578 sp = string_printing(big_buffer);
1579 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1580 addr->address, tb->name, sp);
1585 /* Handle returning options, but only if there is an address to return
1588 if (sender_address[0] != 0 || addr->prop.errors_address)
1589 if (tb->return_output)
1591 addr->transport_return = result = FAIL;
1592 if (addr->basic_errno == 0 && !addr->message)
1593 addr->message = US"return message generated";
1594 return_output = TRUE;
1597 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1600 /* Get rid of the file unless it might be returned, but close it in
1605 Uunlink(addr->return_filename);
1606 addr->return_filename = NULL;
1607 addr->return_file = -1;
1610 (void)close(addr->return_file);
1613 /* The success case happens only after delivery by a transport. */
1617 addr->next = addr_succeed;
1618 addr_succeed = addr;
1620 /* Call address_done() to ensure that we don't deliver to this address again,
1621 and write appropriate things to the message log. If it is a child address, we
1622 call child_done() to scan the ancestors and mark them complete if this is the
1623 last child to complete. */
1625 address_done(addr, now);
1626 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1629 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1630 driver_name, driver_kind);
1633 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1634 addr->parent->address, driver_name, driver_kind);
1635 child_done(addr, now);
1638 /* Certificates for logging (via events) */
1640 tls_out.ourcert = addr->ourcert;
1641 addr->ourcert = NULL;
1642 tls_out.peercert = addr->peercert;
1643 addr->peercert = NULL;
1645 tls_out.cipher = addr->cipher;
1646 tls_out.peerdn = addr->peerdn;
1647 tls_out.ocsp = addr->ocsp;
1648 # ifdef SUPPORT_DANE
1649 tls_out.dane_verified = testflag(addr, af_dane_verified);
1653 delivery_log(LOG_MAIN, addr, logchar, NULL);
1656 tls_free_cert(&tls_out.ourcert);
1657 tls_free_cert(&tls_out.peercert);
1658 tls_out.cipher = NULL;
1659 tls_out.peerdn = NULL;
1660 tls_out.ocsp = OCSP_NOT_REQ;
1661 # ifdef SUPPORT_DANE
1662 tls_out.dane_verified = FALSE;
1668 /* Soft failure, or local delivery process failed; freezing may be
1671 else if (result == DEFER || result == PANIC)
1673 if (result == PANIC) logflags |= LOG_PANIC;
1675 /* This puts them on the chain in reverse order. Do not change this, because
1676 the code for handling retries assumes that the one with the retry
1677 information is last. */
1679 addr->next = addr_defer;
1682 /* The only currently implemented special action is to freeze the
1683 message. Logging of this is done later, just before the -H file is
1686 if (addr->special_action == SPECIAL_FREEZE)
1688 f.deliver_freeze = TRUE;
1689 deliver_frozen_at = time(NULL);
1690 update_spool = TRUE;
1693 /* If doing a 2-stage queue run, we skip writing to either the message
1694 log or the main log for SMTP defers. */
1696 if (!f.queue_2stage || addr->basic_errno != 0)
1697 deferral_log(addr, now, logflags, driver_name, driver_kind);
1701 /* Hard failure. If there is an address to which an error message can be sent,
1702 put this address on the failed list. If not, put it on the deferred list and
1703 freeze the mail message for human attention. The latter action can also be
1704 explicitly requested by a router or transport. */
1708 /* If this is a delivery error, or a message for which no replies are
1709 wanted, and the message's age is greater than ignore_bounce_errors_after,
1710 force the af_ignore_error flag. This will cause the address to be discarded
1711 later (with a log entry). */
1713 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1714 addr->prop.ignore_error = TRUE;
1716 /* Freeze the message if requested, or if this is a bounce message (or other
1717 message with null sender) and this address does not have its own errors
1718 address. However, don't freeze if errors are being ignored. The actual code
1719 to ignore occurs later, instead of sending a message. Logging of freezing
1720 occurs later, just before writing the -H file. */
1722 if ( !addr->prop.ignore_error
1723 && ( addr->special_action == SPECIAL_FREEZE
1724 || (sender_address[0] == 0 && !addr->prop.errors_address)
1727 frozen_info = addr->special_action == SPECIAL_FREEZE
1729 : f.sender_local && !f.local_error_message
1730 ? US" (message created with -f <>)"
1731 : US" (delivery error message)";
1732 f.deliver_freeze = TRUE;
1733 deliver_frozen_at = time(NULL);
1734 update_spool = TRUE;
1736 /* The address is put on the defer rather than the failed queue, because
1737 the message is being retained. */
1739 addr->next = addr_defer;
1743 /* Don't put the address on the nonrecipients tree yet; wait until an
1744 error message has been successfully sent. */
1748 addr->next = addr_failed;
1752 failure_log(addr, driver_name ? NULL : driver_kind, now);
1755 /* Ensure logging is turned on again in all cases */
1757 f.disable_logging = FALSE;
1763 /*************************************************
1764 * Address-independent error *
1765 *************************************************/
1767 /* This function is called when there's an error that is not dependent on a
1768 particular address, such as an expansion string failure. It puts the error into
1769 all the addresses in a batch, logs the incident on the main and panic logs, and
1770 clears the expansions. It is mostly called from local_deliver(), but can be
1771 called for a remote delivery via findugid().
1774 logit TRUE if (MAIN+PANIC) logging required
1775 addr the first of the chain of addresses
1777 format format string for error message, or NULL if already set in addr
1778 ... arguments for the format
1784 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1786 addr->basic_errno = code;
1793 va_start(ap, format);
1794 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1796 addr->message = string_from_gstring(g);
1799 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1801 addr2->basic_errno = code;
1802 addr2->message = addr->message;
1805 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1806 deliver_set_expansions(NULL);
1812 /*************************************************
1813 * Check a "never users" list *
1814 *************************************************/
1816 /* This function is called to check whether a uid is on one of the two "never
1820 uid the uid to be checked
1821 nusers the list to be scanned; the first item in the list is the count
1823 Returns: TRUE if the uid is on the list
1827 check_never_users(uid_t uid, uid_t *nusers)
1829 if (!nusers) return FALSE;
1830 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1836 /*************************************************
1837 * Find uid and gid for a transport *
1838 *************************************************/
1840 /* This function is called for both local and remote deliveries, to find the
1841 uid/gid under which to run the delivery. The values are taken preferentially
1842 from the transport (either explicit or deliver_as_creator), then from the
1843 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1844 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1845 panic error is logged, and the function fails (which normally leads to delivery
1849 addr the address (possibly a chain)
1851 uidp pointer to uid field
1852 gidp pointer to gid field
1853 igfp pointer to the use_initgroups field
1855 Returns: FALSE if failed - error has been set in address(es)
1859 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1863 BOOL gid_set = FALSE;
1865 /* Default initgroups flag comes from the transport */
1867 *igfp = tp->initgroups;
1869 /* First see if there's a gid on the transport, either fixed or expandable.
1870 The expanding function always logs failure itself. */
1877 else if (tp->expand_gid)
1879 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1882 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1888 /* If the transport did not set a group, see if the router did. */
1890 if (!gid_set && testflag(addr, af_gid_set))
1896 /* Pick up a uid from the transport if one is set. */
1898 if (tp->uid_set) *uidp = tp->uid;
1900 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1901 it does not provide a passwd value from which a gid can be taken. */
1903 else if (tp->expand_uid)
1906 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1907 uidp, &(addr->message)))
1909 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1919 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1921 else if (tp->deliver_as_creator)
1923 *uidp = originator_uid;
1926 *gidp = originator_gid;
1931 /* Otherwise see if the address specifies the uid and if so, take it and its
1934 else if (testflag(addr, af_uid_set))
1937 *igfp = testflag(addr, af_initgroups);
1940 /* Nothing has specified the uid - default to the Exim user, and group if the
1953 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1954 defaulting to the Exim uid. In other words, if the configuration has specified
1955 a uid, it must also provide a gid. */
1959 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1960 "%s transport", tp->name);
1964 /* Check that the uid is not on the lists of banned uids that may not be used
1965 for delivery processes. */
1967 nuname = check_never_users(*uidp, never_users)
1969 : check_never_users(*uidp, fixed_never_users)
1970 ? US"fixed_never_users"
1974 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1975 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1987 /*************************************************
1988 * Check the size of a message for a transport *
1989 *************************************************/
1991 /* Checks that the message isn't too big for the selected transport.
1992 This is called only when it is known that the limit is set.
1996 addr the (first) address being delivered
1999 DEFER expansion failed or did not yield an integer
2000 FAIL message too big
2004 check_message_size(transport_instance *tp, address_item *addr)
2009 deliver_set_expansions(addr);
2010 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2011 deliver_set_expansions(NULL);
2013 if (expand_string_message)
2016 addr->message = size_limit == -1
2017 ? string_sprintf("failed to expand message_size_limit "
2018 "in %s transport: %s", tp->name, expand_string_message)
2019 : string_sprintf("invalid message_size_limit "
2020 "in %s transport: %s", tp->name, expand_string_message);
2022 else if (size_limit > 0 && message_size > size_limit)
2026 string_sprintf("message is too big (transport limit = %d)",
2035 /*************************************************
2036 * Transport-time check for a previous delivery *
2037 *************************************************/
2039 /* Check that this base address hasn't previously been delivered to its routed
2040 transport. If it has been delivered, mark it done. The check is necessary at
2041 delivery time in order to handle homonymic addresses correctly in cases where
2042 the pattern of redirection changes between delivery attempts (so the unique
2043 fields change). Non-homonymic previous delivery is detected earlier, at routing
2044 time (which saves unnecessary routing).
2047 addr the address item
2048 testing TRUE if testing wanted only, without side effects
2050 Returns: TRUE if previously delivered by the transport
2054 previously_transported(address_item *addr, BOOL testing)
2056 uschar * s = string_sprintf("%s/%s",
2057 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2059 if (tree_search(tree_nonrecipients, s) != 0)
2061 DEBUG(D_deliver|D_route|D_transport)
2062 debug_printf("%s was previously delivered (%s transport): discarded\n",
2063 addr->address, addr->transport->name);
2064 if (!testing) child_done(addr, tod_stamp(tod_log));
2073 /******************************************************
2074 * Check for a given header in a header string *
2075 ******************************************************/
2077 /* This function is used when generating quota warnings. The configuration may
2078 specify any header lines it likes in quota_warn_message. If certain of them are
2079 missing, defaults are inserted, so we need to be able to test for the presence
2083 hdr the required header name
2084 hstring the header string
2086 Returns: TRUE the header is in the string
2087 FALSE the header is not in the string
2091 contains_header(uschar *hdr, uschar *hstring)
2093 int len = Ustrlen(hdr);
2094 uschar *p = hstring;
2097 if (strncmpic(p, hdr, len) == 0)
2100 while (*p == ' ' || *p == '\t') p++;
2101 if (*p == ':') return TRUE;
2103 while (*p != 0 && *p != '\n') p++;
2104 if (*p == '\n') p++;
2112 /*************************************************
2113 * Perform a local delivery *
2114 *************************************************/
2116 /* Each local delivery is performed in a separate process which sets its
2117 uid and gid as specified. This is a safer way than simply changing and
2118 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2119 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2120 all systems have seteuid().
2122 If the uid/gid are specified in the transport_instance, they are used; the
2123 transport initialization must ensure that either both or neither are set.
2124 Otherwise, the values associated with the address are used. If neither are set,
2125 it is a configuration error.
2127 The transport or the address may specify a home directory (transport over-
2128 rides), and if they do, this is set as $home. If neither have set a working
2129 directory, this value is used for that as well. Otherwise $home is left unset
2130 and the cwd is set to "/" - a directory that should be accessible to all users.
2132 Using a separate process makes it more complicated to get error information
2133 back. We use a pipe to pass the return code and also an error code and error
2134 text string back to the parent process.
2137 addr points to an address block for this delivery; for "normal" local
2138 deliveries this is the only address to be delivered, but for
2139 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2140 a number of addresses can be handled simultaneously, and in this
2141 case addr will point to a chain of addresses with the same
2144 shadowing TRUE if running a shadow transport; this causes output from pipes
2151 deliver_local(address_item *addr, BOOL shadowing)
2153 BOOL use_initgroups;
2156 int status, len, rc;
2159 uschar *working_directory;
2160 address_item *addr2;
2161 transport_instance *tp = addr->transport;
2163 /* Set up the return path from the errors or sender address. If the transport
2164 has its own return path setting, expand it and replace the existing value. */
2166 if(addr->prop.errors_address)
2167 return_path = addr->prop.errors_address;
2168 #ifdef EXPERIMENTAL_SRS
2169 else if (addr->prop.srs_sender)
2170 return_path = addr->prop.srs_sender;
2173 return_path = sender_address;
2175 if (tp->return_path)
2177 uschar *new_return_path = expand_string(tp->return_path);
2178 if (!new_return_path)
2180 if (!f.expand_string_forcedfail)
2182 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2183 US"Failed to expand return path \"%s\" in %s transport: %s",
2184 tp->return_path, tp->name, expand_string_message);
2188 else return_path = new_return_path;
2191 /* For local deliveries, one at a time, the value used for logging can just be
2192 set directly, once and for all. */
2194 used_return_path = return_path;
2196 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2197 gets put into the address(es), and the expansions are unset, so we can just
2200 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2202 /* See if either the transport or the address specifies a home directory. A
2203 home directory set in the address may already be expanded; a flag is set to
2204 indicate that. In other cases we must expand it. */
2206 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2207 || ( (deliver_home = addr->home_dir) /* Set in address and */
2208 && !testflag(addr, af_home_expanded) /* not expanded */
2211 uschar *rawhome = deliver_home;
2212 deliver_home = NULL; /* in case it contains $home */
2213 if (!(deliver_home = expand_string(rawhome)))
2215 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2216 "to expand for %s transport: %s", rawhome, tp->name,
2217 expand_string_message);
2220 if (*deliver_home != '/')
2222 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2223 "is not absolute for %s transport", deliver_home, tp->name);
2228 /* See if either the transport or the address specifies a current directory,
2229 and if so, expand it. If nothing is set, use the home directory, unless it is
2230 also unset in which case use "/", which is assumed to be a directory to which
2231 all users have access. It is necessary to be in a visible directory for some
2232 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2233 2.5) require this. */
2235 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2236 if (working_directory)
2238 uschar *raw = working_directory;
2239 if (!(working_directory = expand_string(raw)))
2241 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2242 "failed to expand for %s transport: %s", raw, tp->name,
2243 expand_string_message);
2246 if (*working_directory != '/')
2248 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2249 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2253 else working_directory = deliver_home ? deliver_home : US"/";
2255 /* If one of the return_output flags is set on the transport, create and open a
2256 file in the message log directory for the transport to write its output onto.
2257 This is mainly used by pipe transports. The file needs to be unique to the
2258 address. This feature is not available for shadow transports. */
2261 && ( tp->return_output || tp->return_fail_output
2262 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2267 addr->return_filename =
2268 spool_fname(US"msglog", message_subdir, message_id,
2269 string_sprintf("-%d-%d", getpid(), return_count++));
2271 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2273 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2274 "to return message: %s", error, tp->name, strerror(errno));
2279 /* Create the pipe for inter-process communication. */
2283 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2288 /* Now fork the process to do the real work in the subprocess, but first
2289 ensure that all cached resources are freed so that the subprocess starts with
2290 a clean slate and doesn't interfere with the parent process. */
2294 if ((pid = fork()) == 0)
2296 BOOL replicate = TRUE;
2298 /* Prevent core dumps, as we don't want them in users' home directories.
2299 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2300 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2301 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2302 complain if the error is "not supported".
2304 There are two scenarios where changing the max limit has an effect. In one,
2305 the user is using a .forward and invoking a command of their choice via pipe;
2306 for these, we do need the max limit to be 0 unless the admin chooses to
2307 permit an increased limit. In the other, the command is invoked directly by
2308 the transport and is under administrator control, thus being able to raise
2309 the limit aids in debugging. So there's no general always-right answer.
2311 Thus we inhibit core-dumps completely but let individual transports, while
2312 still root, re-raise the limits back up to aid debugging. We make the
2313 default be no core-dumps -- few enough people can use core dumps in
2314 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2321 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2323 # ifdef SETRLIMIT_NOT_SUPPORTED
2324 if (errno != ENOSYS && errno != ENOTSUP)
2326 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2331 /* Reset the random number generator, so different processes don't all
2332 have the same sequence. */
2336 /* If the transport has a setup entry, call this first, while still
2337 privileged. (Appendfile uses this to expand quota, for example, while
2338 able to read private files.) */
2340 if (addr->transport->setup)
2341 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2345 addr->transport_return = DEFER;
2349 addr->transport_return = PANIC;
2353 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2354 when the process becomes unprivileged, it won't be able to write to the
2355 process log. SIGHUP is ignored throughout exim, except when it is being
2358 signal(SIGINT, SIG_IGN);
2359 signal(SIGTERM, SIG_IGN);
2360 signal(SIGUSR1, SIG_IGN);
2362 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2363 half - for transports that exec things (e.g. pipe). Then set the required
2366 (void)close(pfd[pipe_read]);
2367 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2369 exim_setugid(uid, gid, use_initgroups,
2370 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2371 addr->address, addr->transport->name));
2375 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2376 for (address_item * batched = addr->next; batched; batched = batched->next)
2377 debug_printf("additional batched address: %s\n", batched->address);
2380 /* Set an appropriate working directory. */
2382 if (Uchdir(working_directory) < 0)
2384 addr->transport_return = DEFER;
2385 addr->basic_errno = errno;
2386 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2389 /* If successful, call the transport */
2394 set_process_info("delivering %s to %s using %s", message_id,
2395 addr->local_part, addr->transport->name);
2397 /* Setting this global in the subprocess means we need never clear it */
2398 transport_name = addr->transport->name;
2400 /* If a transport filter has been specified, set up its argument list.
2401 Any errors will get put into the address, and FALSE yielded. */
2403 if (addr->transport->filter_command)
2405 ok = transport_set_up_command(&transport_filter_argv,
2406 addr->transport->filter_command,
2407 TRUE, PANIC, addr, US"transport filter", NULL);
2408 transport_filter_timeout = addr->transport->filter_timeout;
2410 else transport_filter_argv = NULL;
2414 debug_print_string(addr->transport->debug_string);
2415 replicate = !(addr->transport->info->code)(addr->transport, addr);
2419 /* Pass the results back down the pipe. If necessary, first replicate the
2420 status in the top address to the others in the batch. The label is the
2421 subject of a goto when a call to the transport's setup function fails. We
2422 pass the pointer to the transport back in case it got changed as a result of
2423 file_format in appendfile. */
2427 if (replicate) replicate_status(addr);
2428 for (addr2 = addr; addr2; addr2 = addr2->next)
2431 int local_part_length = Ustrlen(addr2->local_part);
2435 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2436 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2437 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2438 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2439 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2440 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2441 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2442 || (ret = write(pfd[pipe_write], &addr2->transport,
2443 sizeof(transport_instance *))) != sizeof(transport_instance *)
2445 /* For a file delivery, pass back the local part, in case the original
2446 was only part of the final delivery path. This gives more complete
2449 || (testflag(addr2, af_file)
2450 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2451 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2455 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2456 ret == -1 ? strerror(errno) : "short write");
2458 /* Now any messages */
2460 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2462 int message_length = s ? Ustrlen(s) + 1 : 0;
2463 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2464 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2466 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2467 ret == -1 ? strerror(errno) : "short write");
2471 /* OK, this process is now done. Free any cached resources that it opened,
2472 and close the pipe we were writing down before exiting. */
2474 (void)close(pfd[pipe_write]);
2479 /* Back in the main process: panic if the fork did not succeed. This seems
2480 better than returning an error - if forking is failing it is probably best
2481 not to try other deliveries for this message. */
2484 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2487 /* Read the pipe to get the delivery status codes and error messages. Our copy
2488 of the writing end must be closed first, as otherwise read() won't return zero
2489 on an empty pipe. We check that a status exists for each address before
2490 overwriting the address structure. If data is missing, the default DEFER status
2491 will remain. Afterwards, close the reading end. */
2493 (void)close(pfd[pipe_write]);
2495 for (addr2 = addr; addr2; addr2 = addr2->next)
2497 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2502 addr2->transport_return = status;
2503 len = read(pfd[pipe_read], &transport_count,
2504 sizeof(transport_count));
2505 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2506 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2507 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2508 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2509 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2510 len = read(pfd[pipe_read], &addr2->transport,
2511 sizeof(transport_instance *));
2513 if (testflag(addr2, af_file))
2516 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2517 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2520 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2521 " from delivery subprocess");
2524 /* sanity-checked llen so disable the Coverity error */
2525 /* coverity[tainted_data] */
2526 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2528 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2529 " from delivery subprocess");
2532 big_buffer[llen] = 0;
2533 addr2->local_part = string_copy(big_buffer);
2536 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2539 len = read(pfd[pipe_read], &message_length, sizeof(int));
2540 if (message_length > 0)
2542 len = read(pfd[pipe_read], big_buffer, message_length);
2543 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2544 if (len > 0) *sptr = string_copy(big_buffer);
2551 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2552 "from delivery subprocess", addr2->unique);
2557 (void)close(pfd[pipe_read]);
2559 /* Unless shadowing, write all successful addresses immediately to the journal
2560 file, to ensure they are recorded asap. For homonymic addresses, use the base
2561 address plus the transport name. Failure to write the journal is panic-worthy,
2562 but don't stop, as it may prove possible subsequently to update the spool file
2563 in order to record the delivery. */
2567 for (addr2 = addr; addr2; addr2 = addr2->next)
2568 if (addr2->transport_return == OK)
2570 if (testflag(addr2, af_homonym))
2571 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2573 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2575 /* In the test harness, wait just a bit to let the subprocess finish off
2576 any debug output etc first. */
2578 if (f.running_in_test_harness) millisleep(300);
2580 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2581 len = Ustrlen(big_buffer);
2582 if (write(journal_fd, big_buffer, len) != len)
2583 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2584 big_buffer, strerror(errno));
2587 /* Ensure the journal file is pushed out to disk. */
2589 if (EXIMfsync(journal_fd) < 0)
2590 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2594 /* Wait for the process to finish. If it terminates with a non-zero code,
2595 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2596 status values of all the addresses as they are. Take care to handle the case
2597 when the subprocess doesn't seem to exist. This has been seen on one system
2598 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2599 happens, wait() doesn't recognize the termination of child processes. Exim now
2600 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2602 while ((rc = wait(&status)) != pid)
2603 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2605 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2606 addr->transport->driver_name);
2611 if ((status & 0xffff) != 0)
2613 int msb = (status >> 8) & 255;
2614 int lsb = status & 255;
2615 int code = (msb == 0)? (lsb & 0x7f) : msb;
2616 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2617 addr->special_action = SPECIAL_FREEZE;
2618 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2619 "status 0x%04x: %s %d",
2620 addr->transport->driver_name,
2622 msb == 0 ? "terminated by signal" : "exit code",
2626 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2628 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2631 uschar *warn_message;
2634 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2636 if (!(warn_message = expand_string(addr->transport->warn_message)))
2637 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2638 "message for %s transport): %s", addr->transport->warn_message,
2639 addr->transport->name, expand_string_message);
2641 else if ((pid = child_open_exim(&fd)) > 0)
2643 FILE *f = fdopen(fd, "wb");
2644 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2645 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2646 fprintf(f, "Auto-Submitted: auto-replied\n");
2647 if (!contains_header(US"From", warn_message))
2649 fprintf(f, "%s", CS warn_message);
2651 /* Close and wait for child process to complete, without a timeout. */
2654 (void)child_close(pid, 0);
2657 addr->special_action = SPECIAL_NONE;
2664 /* Check transport for the given concurrency limit. Return TRUE if over
2665 the limit (or an expansion failure), else FALSE and if there was a limit,
2666 the key for the hints database used for the concurrency count. */
2669 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2671 unsigned max_parallel;
2673 if (!tp->max_parallel) return FALSE;
2675 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2676 if (expand_string_message)
2678 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2679 "in %s transport (%s): %s", tp->name, addr->address,
2680 expand_string_message);
2684 if (max_parallel > 0)
2686 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2687 if (!enq_start(serialize_key, max_parallel))
2689 address_item * next;
2691 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2692 tp->name, max_parallel);
2696 addr->message = US"concurrency limit reached for transport";
2697 addr->basic_errno = ERRNO_TRETRY;
2698 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2699 } while ((addr = next));
2702 *key = serialize_key;
2709 /*************************************************
2710 * Do local deliveries *
2711 *************************************************/
2713 /* This function processes the list of addresses in addr_local. True local
2714 deliveries are always done one address at a time. However, local deliveries can
2715 be batched up in some cases. Typically this is when writing batched SMTP output
2716 files for use by some external transport mechanism, or when running local
2717 deliveries over LMTP.
2724 do_local_deliveries(void)
2727 open_db *dbm_file = NULL;
2728 time_t now = time(NULL);
2730 /* Loop until we have exhausted the supply of local deliveries */
2734 struct timeval delivery_start;
2735 struct timeval deliver_time;
2736 address_item *addr2, *addr3, *nextaddr;
2737 int logflags = LOG_MAIN;
2738 int logchar = f.dont_deliver? '*' : '=';
2739 transport_instance *tp;
2740 uschar * serialize_key = NULL;
2742 /* Pick the first undelivered address off the chain */
2744 address_item *addr = addr_local;
2745 addr_local = addr->next;
2748 DEBUG(D_deliver|D_transport)
2749 debug_printf("--------> %s <--------\n", addr->address);
2751 /* An internal disaster if there is no transport. Should not occur! */
2753 if (!(tp = addr->transport))
2755 logflags |= LOG_PANIC;
2756 f.disable_logging = FALSE; /* Jic */
2757 addr->message = addr->router
2758 ? string_sprintf("No transport set by %s router", addr->router->name)
2759 : US"No transport set by system filter";
2760 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2764 /* Check that this base address hasn't previously been delivered to this
2765 transport. The check is necessary at this point to handle homonymic addresses
2766 correctly in cases where the pattern of redirection changes between delivery
2767 attempts. Non-homonymic previous delivery is detected earlier, at routing
2770 if (previously_transported(addr, FALSE)) continue;
2772 /* There are weird cases where logging is disabled */
2774 f.disable_logging = tp->disable_logging;
2776 /* Check for batched addresses and possible amalgamation. Skip all the work
2777 if either batch_max <= 1 or there aren't any other addresses for local
2780 if (tp->batch_max > 1 && addr_local)
2782 int batch_count = 1;
2783 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2784 BOOL uses_lp = ( testflag(addr, af_pfr)
2785 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2787 || readconf_depends((driver_instance *)tp, US"local_part");
2788 uschar *batch_id = NULL;
2789 address_item **anchor = &addr_local;
2790 address_item *last = addr;
2793 /* Expand the batch_id string for comparison with other addresses.
2794 Expansion failure suppresses batching. */
2798 deliver_set_expansions(addr);
2799 batch_id = expand_string(tp->batch_id);
2800 deliver_set_expansions(NULL);
2803 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2804 "in %s transport (%s): %s", tp->name, addr->address,
2805 expand_string_message);
2806 batch_count = tp->batch_max;
2810 /* Until we reach the batch_max limit, pick off addresses which have the
2811 same characteristics. These are:
2814 not previously delivered (see comment about 50 lines above)
2815 same local part if the transport's configuration contains $local_part
2816 or if this is a file or pipe delivery from a redirection
2817 same domain if the transport's configuration contains $domain
2819 same additional headers
2820 same headers to be removed
2821 same uid/gid for running the transport
2822 same first host if a host list is set
2825 while ((next = *anchor) && batch_count < tp->batch_max)
2828 tp == next->transport
2829 && !previously_transported(next, TRUE)
2830 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2831 && testflag(addr, af_file) == testflag(next, af_file)
2832 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2833 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2834 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2835 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2836 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2837 && same_ugid(tp, addr, next)
2838 && ( !addr->host_list && !next->host_list
2841 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2844 /* If the transport has a batch_id setting, batch_id will be non-NULL
2845 from the expansion outside the loop. Expand for this address and compare.
2846 Expansion failure makes this address ineligible for batching. */
2851 address_item *save_nextnext = next->next;
2852 next->next = NULL; /* Expansion for a single address */
2853 deliver_set_expansions(next);
2854 next->next = save_nextnext;
2855 bid = expand_string(tp->batch_id);
2856 deliver_set_expansions(NULL);
2859 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2860 "in %s transport (%s): %s", tp->name, next->address,
2861 expand_string_message);
2864 else ok = (Ustrcmp(batch_id, bid) == 0);
2867 /* Take address into batch if OK. */
2871 *anchor = next->next; /* Include the address */
2877 else anchor = &next->next; /* Skip the address */
2881 /* We now have one or more addresses that can be delivered in a batch. Check
2882 whether the transport is prepared to accept a message of this size. If not,
2883 fail them all forthwith. If the expansion fails, or does not yield an
2884 integer, defer delivery. */
2886 if (tp->message_size_limit)
2888 int rc = check_message_size(tp, addr);
2891 replicate_status(addr);
2895 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2898 continue; /* With next batch of addresses */
2902 /* If we are not running the queue, or if forcing, all deliveries will be
2903 attempted. Otherwise, we must respect the retry times for each address. Even
2904 when not doing this, we need to set up the retry key string, and determine
2905 whether a retry record exists, because after a successful delivery, a delete
2906 retry item must be set up. Keep the retry database open only for the duration
2907 of these checks, rather than for all local deliveries, because some local
2908 deliveries (e.g. to pipes) can take a substantial time. */
2910 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2912 DEBUG(D_deliver|D_retry|D_hints_lookup)
2913 debug_printf("no retry data available\n");
2920 BOOL ok = TRUE; /* to deliver this address */
2923 /* Set up the retry key to include the domain or not, and change its
2924 leading character from "R" to "T". Must make a copy before doing this,
2925 because the old key may be pointed to from a "delete" retry item after
2928 retry_key = string_copy(
2929 tp->retry_use_local_part ? addr2->address_retry_key :
2930 addr2->domain_retry_key);
2933 /* Inspect the retry data. If there is no hints file, delivery happens. */
2937 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2939 /* If there is no retry record, delivery happens. If there is,
2940 remember it exists so it can be deleted after a successful delivery. */
2944 setflag(addr2, af_lt_retry_exists);
2946 /* A retry record exists for this address. If queue running and not
2947 forcing, inspect its contents. If the record is too old, or if its
2948 retry time has come, or if it has passed its cutoff time, delivery
2953 debug_printf("retry record exists: age=%s ",
2954 readconf_printtime(now - retry_record->time_stamp));
2955 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2956 debug_printf(" time to retry = %s expired = %d\n",
2957 readconf_printtime(retry_record->next_try - now),
2958 retry_record->expired);
2961 if (f.queue_running && !f.deliver_force)
2963 ok = (now - retry_record->time_stamp > retry_data_expire)
2964 || (now >= retry_record->next_try)
2965 || retry_record->expired;
2967 /* If we haven't reached the retry time, there is one more check
2968 to do, which is for the ultimate address timeout. */
2971 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2975 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2978 /* This address is to be delivered. Leave it on the chain. */
2983 addr2 = addr2->next;
2986 /* This address is to be deferred. Take it out of the chain, and
2987 post-process it as complete. Must take it out of the chain first,
2988 because post processing puts it on another chain. */
2992 address_item *this = addr2;
2993 this->message = US"Retry time not yet reached";
2994 this->basic_errno = ERRNO_LRETRY;
2995 addr2 = addr3 ? (addr3->next = addr2->next)
2996 : (addr = addr2->next);
2997 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3001 if (dbm_file) dbfn_close(dbm_file);
3003 /* If there are no addresses left on the chain, they all deferred. Loop
3004 for the next set of addresses. */
3006 if (!addr) continue;
3008 /* If the transport is limited for parallellism, enforce that here.
3009 We use a hints DB entry, incremented here and decremented after
3010 the transport (and any shadow transport) completes. */
3012 if (tpt_parallel_check(tp, addr, &serialize_key))
3014 if (expand_string_message)
3016 logflags |= LOG_PANIC;
3020 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3021 } while ((addr = addr2));
3023 continue; /* Loop for the next set of addresses. */
3027 /* So, finally, we do have some addresses that can be passed to the
3028 transport. Before doing so, set up variables that are relevant to a
3031 deliver_set_expansions(addr);
3033 gettimeofday(&delivery_start, NULL);
3034 deliver_local(addr, FALSE);
3035 timesince(&deliver_time, &delivery_start);
3037 /* If a shadow transport (which must perforce be another local transport), is
3038 defined, and its condition is met, we must pass the message to the shadow
3039 too, but only those addresses that succeeded. We do this by making a new
3040 chain of addresses - also to keep the original chain uncontaminated. We must
3041 use a chain rather than doing it one by one, because the shadow transport may
3044 NOTE: if the condition fails because of a lookup defer, there is nothing we
3048 && ( !tp->shadow_condition
3049 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3052 transport_instance *stp;
3053 address_item *shadow_addr = NULL;
3054 address_item **last = &shadow_addr;
3056 for (stp = transports; stp; stp = stp->next)
3057 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3060 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3063 /* Pick off the addresses that have succeeded, and make clones. Put into
3064 the shadow_message field a pointer to the shadow_message field of the real
3067 else for (addr2 = addr; addr2; addr2 = addr2->next)
3068 if (addr2->transport_return == OK)
3070 addr3 = store_get(sizeof(address_item), FALSE);
3073 addr3->shadow_message = US &addr2->shadow_message;
3074 addr3->transport = stp;
3075 addr3->transport_return = DEFER;
3076 addr3->return_filename = NULL;
3077 addr3->return_file = -1;
3079 last = &addr3->next;
3082 /* If we found any addresses to shadow, run the delivery, and stick any
3083 message back into the shadow_message field in the original. */
3087 int save_count = transport_count;
3089 DEBUG(D_deliver|D_transport)
3090 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3091 deliver_local(shadow_addr, TRUE);
3093 for(; shadow_addr; shadow_addr = shadow_addr->next)
3095 int sresult = shadow_addr->transport_return;
3096 *(uschar **)shadow_addr->shadow_message =
3098 ? string_sprintf(" ST=%s", stp->name)
3099 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3100 shadow_addr->basic_errno <= 0
3102 : US strerror(shadow_addr->basic_errno),
3103 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3106 shadow_addr->message
3107 ? shadow_addr->message
3108 : shadow_addr->basic_errno <= 0
3112 DEBUG(D_deliver|D_transport)
3113 debug_printf("%s shadow transport returned %s for %s\n",
3114 stp->name, rc_to_string(sresult), shadow_addr->address);
3117 DEBUG(D_deliver|D_transport)
3118 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3120 transport_count = save_count; /* Restore original transport count */
3124 /* Cancel the expansions that were set up for the delivery. */
3126 deliver_set_expansions(NULL);
3128 /* If the transport was parallelism-limited, decrement the hints DB record. */
3130 if (serialize_key) enq_end(serialize_key);
3132 /* Now we can process the results of the real transport. We must take each
3133 address off the chain first, because post_process_one() puts it on another
3136 for (addr2 = addr; addr2; addr2 = nextaddr)
3138 int result = addr2->transport_return;
3139 nextaddr = addr2->next;
3141 DEBUG(D_deliver|D_transport)
3142 debug_printf("%s transport returned %s for %s\n",
3143 tp->name, rc_to_string(result), addr2->address);
3145 /* If there is a retry_record, or if delivery is deferred, build a retry
3146 item for setting a new retry time or deleting the old retry record from
3147 the database. These items are handled all together after all addresses
3148 have been handled (so the database is open just for a short time for
3151 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3153 int flags = result == DEFER ? 0 : rf_delete;
3154 uschar *retry_key = string_copy(tp->retry_use_local_part
3155 ? addr2->address_retry_key : addr2->domain_retry_key);
3157 retry_add_item(addr2, retry_key, flags);
3160 /* Done with this address */
3164 addr2->more_errno = deliver_time.tv_sec;
3165 addr2->delivery_usec = deliver_time.tv_usec;
3167 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3169 /* If a pipe delivery generated text to be sent back, the result may be
3170 changed to FAIL, and we must copy this for subsequent addresses in the
3173 if (addr2->transport_return != result)
3175 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3177 addr3->transport_return = addr2->transport_return;
3178 addr3->basic_errno = addr2->basic_errno;
3179 addr3->message = addr2->message;
3181 result = addr2->transport_return;
3184 /* Whether or not the result was changed to FAIL, we need to copy the
3185 return_file value from the first address into all the addresses of the
3186 batch, so they are all listed in the error message. */
3188 addr2->return_file = addr->return_file;
3190 /* Change log character for recording successful deliveries. */
3192 if (result == OK) logchar = '-';
3194 } /* Loop back for next batch of addresses */
3200 /*************************************************
3201 * Sort remote deliveries *
3202 *************************************************/
3204 /* This function is called if remote_sort_domains is set. It arranges that the
3205 chain of addresses for remote deliveries is ordered according to the strings
3206 specified. Try to make this shuffling reasonably efficient by handling
3207 sequences of addresses rather than just single ones.
3214 sort_remote_deliveries(void)
3217 address_item **aptr = &addr_remote;
3218 const uschar *listptr = remote_sort_domains;
3223 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3226 address_item *moved = NULL;
3227 address_item **bptr = &moved;
3231 address_item **next;
3232 deliver_domain = (*aptr)->domain; /* set $domain */
3233 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3234 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3236 aptr = &(*aptr)->next;
3240 next = &(*aptr)->next;
3242 && (deliver_domain = (*next)->domain, /* Set $domain */
3243 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3244 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3246 next = &(*next)->next;
3248 /* If the batch of non-matchers is at the end, add on any that were
3249 extracted further up the chain, and end this iteration. Otherwise,
3250 extract them from the chain and hang on the moved chain. */
3262 aptr = &(*aptr)->next;
3265 /* If the loop ended because the final address matched, *aptr will
3266 be NULL. Add on to the end any extracted non-matching addresses. If
3267 *aptr is not NULL, the loop ended via "break" when *next is null, that
3268 is, there was a string of non-matching addresses at the end. In this
3269 case the extracted addresses have already been added on the end. */
3271 if (!*aptr) *aptr = moved;
3276 debug_printf("remote addresses after sorting:\n");
3277 for (address_item * addr = addr_remote; addr; addr = addr->next)
3278 debug_printf(" %s\n", addr->address);
3284 /*************************************************
3285 * Read from pipe for remote delivery subprocess *
3286 *************************************************/
3288 /* This function is called when the subprocess is complete, but can also be
3289 called before it is complete, in order to empty a pipe that is full (to prevent
3290 deadlock). It must therefore keep track of its progress in the parlist data
3293 We read the pipe to get the delivery status codes and a possible error message
3294 for each address, optionally preceded by unusability data for the hosts and
3295 also by optional retry data.
3297 Read in large chunks into the big buffer and then scan through, interpreting
3298 the data therein. In most cases, only a single read will be necessary. No
3299 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3300 that we read the next chunk when there is less than 2500 bytes left in the
3301 non-final chunk, we can assume each item is complete in the buffer before
3302 handling it. Each item is written using a single write(), which is atomic for
3303 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3304 often bigger) so even if we are reading while the subprocess is still going, we
3305 should never have only a partial item in the buffer.
3307 hs12: This assumption is not true anymore, since we get quite large items (certificate
3308 information and such).
3311 poffset the offset of the parlist item
3312 eop TRUE if the process has completed
3314 Returns: TRUE if the terminating 'Z' item has been read,
3315 or there has been a disaster (i.e. no more data needed);
3320 par_read_pipe(int poffset, BOOL eop)
3323 pardata *p = parlist + poffset;
3324 address_item *addrlist = p->addrlist;
3325 address_item *addr = p->addr;
3329 uschar *msg = p->msg;
3330 BOOL done = p->done;
3332 /* Loop through all items, reading from the pipe when necessary. The pipe
3333 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3334 here, as the preceding select() tells us, if data is available for reading.
3336 A read() on a "selected" handle should never block, but(!) it may return
3337 less data then we expected. (The buffer size we pass to read() shouldn't be
3338 understood as a "request", but as a "limit".)
3340 Each separate item is written to the pipe in a timely manner. But, especially for
3341 larger items, the read(2) may already return partial data from the write(2).
3343 The write is atomic mostly (depending on the amount written), but atomic does
3344 not imply "all or noting", it just is "not intermixed" with other writes on the
3345 same channel (pipe).
3349 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3350 (int)p->pid, eop? "ended" : "not ended yet");
3354 retry_item *r, **rp;
3355 uschar pipeheader[PIPE_HEADER_SIZE+1];
3356 uschar *id = &pipeheader[0];
3357 uschar *subid = &pipeheader[1];
3358 uschar *ptr = big_buffer;
3359 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3362 DEBUG(D_deliver) debug_printf(
3363 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3365 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3366 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3367 If we get less, we can assume the subprocess do be done and do not expect any further
3368 information from it. */
3370 if ((got = readn(fd, pipeheader, required)) != required)
3372 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3373 "from transport process %d for transport %s",
3374 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3379 pipeheader[PIPE_HEADER_SIZE] = '\0';
3381 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3385 /* If we can't decode the pipeheader, the subprocess seems to have a
3386 problem, we do not expect any furher information from it. */
3388 required = Ustrtol(pipeheader+2, &endc, 10);
3391 msg = string_sprintf("failed to read pipe "
3392 "from transport process %d for transport %s: error decoding size from header",
3393 pid, addr->transport->driver_name);
3400 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3401 (u_long)required, pid);
3403 /* Same as above, the transport process will write the bytes announced
3404 in a timely manner, so we can just wait for the bytes, getting less than expected
3405 is considered a problem of the subprocess, we do not expect anything else from it. */
3406 if ((got = readn(fd, big_buffer, required)) != required)
3408 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3409 " bytes (pipedata) from transport process %d for transport %s",
3410 got, required, pid, addr->transport->driver_name);
3415 /* Handle each possible type of item, assuming the complete item is
3416 available in store. */
3420 /* Host items exist only if any hosts were marked unusable. Match
3421 up by checking the IP address. */
3424 for (h = addrlist->host_list; h; h = h->next)
3426 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3434 /* Retry items are sent in a preceding R item for each address. This is
3435 kept separate to keep each message short enough to guarantee it won't
3436 be split in the pipe. Hopefully, in the majority of cases, there won't in
3437 fact be any retry items at all.
3439 The complete set of retry items might include an item to delete a
3440 routing retry if there was a previous routing delay. However, routing
3441 retries are also used when a remote transport identifies an address error.
3442 In that case, there may also be an "add" item for the same key. Arrange
3443 that a "delete" item is dropped in favour of an "add" item. */
3446 if (!addr) goto ADDR_MISMATCH;
3448 DEBUG(D_deliver|D_retry)
3449 debug_printf("reading retry information for %s from subprocess\n",
3452 /* Cut out any "delete" items on the list. */
3454 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3455 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3457 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3458 *rp = r->next; /* Excise a delete item */
3459 DEBUG(D_deliver|D_retry)
3460 debug_printf(" existing delete item dropped\n");
3463 /* We want to add a delete item only if there is no non-delete item;
3464 however we still have to step ptr through the data. */
3466 if (!r || !(*ptr & rf_delete))
3468 r = store_get(sizeof(retry_item), FALSE);
3469 r->next = addr->retries;
3472 r->key = string_copy(ptr);
3474 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3475 ptr += sizeof(r->basic_errno);
3476 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3477 ptr += sizeof(r->more_errno);
3478 r->message = *ptr ? string_copy(ptr) : NULL;
3479 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3480 r->flags & rf_delete ? "delete" : "retry");
3485 DEBUG(D_deliver|D_retry)
3486 debug_printf(" delete item not added: non-delete item exists\n");
3489 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3495 /* Put the amount of data written into the parlist block */
3498 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3499 ptr += sizeof(transport_count);
3502 /* Address items are in the order of items on the address chain. We
3503 remember the current address value in case this function is called
3504 several times to empty the pipe in stages. Information about delivery
3505 over TLS is sent in a preceding X item for each address. We don't put
3506 it in with the other info, in order to keep each message short enough to
3507 guarantee it won't be split in the pipe. */
3511 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3515 addr->cipher = NULL;
3516 addr->peerdn = NULL;
3519 addr->cipher = string_copy(ptr);
3522 addr->peerdn = string_copy(ptr);
3527 (void) tls_import_cert(ptr, &addr->peercert);
3529 addr->peercert = NULL;
3534 (void) tls_import_cert(ptr, &addr->ourcert);
3536 addr->ourcert = NULL;
3539 # ifndef DISABLE_OCSP
3541 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3547 #endif /*DISABLE_TLS*/
3549 case 'C': /* client authenticator information */
3552 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3553 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3554 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3559 #ifndef DISABLE_PRDR
3561 setflag(addr, af_prdr_used);
3568 #ifdef SUPPORT_PIPE_CONNECT
3569 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3571 case 1: setflag(addr, af_pipelining); break;
3576 setflag(addr, af_chunking_used);
3580 setflag(addr, af_tcp_fastopen_conn);
3581 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3582 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3586 if (!addr) goto ADDR_MISMATCH;
3587 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3588 ptr += sizeof(addr->dsn_aware);
3589 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3596 msg = string_sprintf("address count mismatch for data read from pipe "
3597 "for transport process %d for transport %s", pid,
3598 addrlist->transport->driver_name);
3605 #ifdef SUPPORT_SOCKS
3606 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3607 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3612 proxy_local_address = string_copy(ptr);
3614 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3615 ptr += sizeof(proxy_local_port);
3620 #ifdef EXPERIMENTAL_DSN_INFO
3621 case '1': /* must arrive before A0, and applies to that addr */
3622 /* Two strings: smtp_greeting and helo_response */
3623 addr->smtp_greeting = string_copy(ptr);
3625 addr->helo_response = string_copy(ptr);
3631 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3632 addr->transport_return = *ptr++;
3633 addr->special_action = *ptr++;
3634 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3635 ptr += sizeof(addr->basic_errno);
3636 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3637 ptr += sizeof(addr->more_errno);
3638 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3639 ptr += sizeof(addr->delivery_usec);
3640 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3641 ptr += sizeof(addr->flags);
3642 addr->message = *ptr ? string_copy(ptr) : NULL;
3644 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3647 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3651 h = store_get(sizeof(host_item), FALSE);
3652 h->name = string_copy(ptr);
3654 h->address = string_copy(ptr);
3656 memcpy(&h->port, ptr, sizeof(h->port));
3657 ptr += sizeof(h->port);
3658 h->dnssec = *ptr == '2' ? DS_YES
3659 : *ptr == '1' ? DS_NO
3662 addr->host_used = h;
3666 /* Finished with this address */
3673 /* Local interface address/port */
3675 if (*ptr) sending_ip_address = string_copy(ptr);
3677 if (*ptr) sending_port = atoi(CS ptr);
3681 /* Z marks the logical end of the data. It is followed by '0' if
3682 continue_transport was NULL at the end of transporting, otherwise '1'.
3683 We need to know when it becomes NULL during a delivery down a passed SMTP
3684 channel so that we don't try to pass anything more down it. Of course, for
3685 most normal messages it will remain NULL all the time. */
3690 continue_transport = NULL;
3691 continue_hostname = NULL;
3694 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3697 /* Anything else is a disaster. */
3700 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3701 "process %d for transport %s", ptr[-1], pid,
3702 addr->transport->driver_name);
3708 /* The done flag is inspected externally, to determine whether or not to
3709 call the function again when the process finishes. */
3713 /* If the process hadn't finished, and we haven't seen the end of the data
3714 or if we suffered a disaster, update the rest of the state, and return FALSE to
3715 indicate "not finished". */
3724 /* Close our end of the pipe, to prevent deadlock if the far end is still
3725 pushing stuff into it. */
3730 /* If we have finished without error, but haven't had data for every address,
3731 something is wrong. */
3734 msg = string_sprintf("insufficient address data read from pipe "
3735 "for transport process %d for transport %s", pid,
3736 addr->transport->driver_name);
3738 /* If an error message is set, something has gone wrong in getting back
3739 the delivery data. Put the message into each address and freeze it. */
3742 for (addr = addrlist; addr; addr = addr->next)
3744 addr->transport_return = DEFER;
3745 addr->special_action = SPECIAL_FREEZE;
3746 addr->message = msg;
3747 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3750 /* Return TRUE to indicate we have got all we need from this process, even
3751 if it hasn't actually finished yet. */
3758 /*************************************************
3759 * Post-process a set of remote addresses *
3760 *************************************************/
3762 /* Do what has to be done immediately after a remote delivery for each set of
3763 addresses, then re-write the spool if necessary. Note that post_process_one
3764 puts the address on an appropriate queue; hence we must fish off the next
3765 one first. This function is also called if there is a problem with setting
3766 up a subprocess to do a remote delivery in parallel. In this case, the final
3767 argument contains a message, and the action must be forced to DEFER.
3770 addr pointer to chain of address items
3771 logflags flags for logging
3772 msg NULL for normal cases; -> error message for unexpected problems
3773 fallback TRUE if processing fallback hosts
3779 remote_post_process(address_item *addr, int logflags, uschar *msg,
3782 /* If any host addresses were found to be unusable, add them to the unusable
3783 tree so that subsequent deliveries don't try them. */
3785 for (host_item * h = addr->host_list; h; h = h->next)
3787 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3789 /* Now handle each address on the chain. The transport has placed '=' or '-'
3790 into the special_action field for each successful delivery. */
3794 address_item *next = addr->next;
3796 /* If msg == NULL (normal processing) and the result is DEFER and we are
3797 processing the main hosts and there are fallback hosts available, put the
3798 address on the list for fallback delivery. */
3800 if ( addr->transport_return == DEFER
3801 && addr->fallback_hosts
3806 addr->host_list = addr->fallback_hosts;
3807 addr->next = addr_fallback;
3808 addr_fallback = addr;
3809 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3812 /* If msg is set (=> unexpected problem), set it in the address before
3813 doing the ordinary post processing. */
3819 addr->message = msg;
3820 addr->transport_return = DEFER;
3822 (void)post_process_one(addr, addr->transport_return, logflags,
3823 EXIM_DTYPE_TRANSPORT, addr->special_action);
3831 /* If we have just delivered down a passed SMTP channel, and that was
3832 the last address, the channel will have been closed down. Now that
3833 we have logged that delivery, set continue_sequence to 1 so that
3834 any subsequent deliveries don't get "*" incorrectly logged. */
3836 if (!continue_transport) continue_sequence = 1;
3841 /*************************************************
3842 * Wait for one remote delivery subprocess *
3843 *************************************************/
3845 /* This function is called while doing remote deliveries when either the
3846 maximum number of processes exist and we need one to complete so that another
3847 can be created, or when waiting for the last ones to complete. It must wait for
3848 the completion of one subprocess, empty the control block slot, and return a
3849 pointer to the address chain.
3852 Returns: pointer to the chain of addresses handled by the process;
3853 NULL if no subprocess found - this is an unexpected error
3856 static address_item *
3859 int poffset, status;
3860 address_item *addr, *addrlist;
3863 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3864 "to finish", message_id);
3866 /* Loop until either a subprocess completes, or there are no subprocesses in
3867 existence - in which case give an error return. We cannot proceed just by
3868 waiting for a completion, because a subprocess may have filled up its pipe, and
3869 be waiting for it to be emptied. Therefore, if no processes have finished, we
3870 wait for one of the pipes to acquire some data by calling select(), with a
3871 timeout just in case.
3873 The simple approach is just to iterate after reading data from a ready pipe.
3874 This leads to non-ideal behaviour when the subprocess has written its final Z
3875 item, closed the pipe, and is in the process of exiting (the common case). A
3876 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3877 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3880 To avoid this, if all the data that is needed has been read from a subprocess
3881 after select(), an explicit wait() for it is done. We know that all it is doing
3882 is writing to the pipe and then exiting, so the wait should not be long.
3884 The non-blocking waitpid() is to some extent just insurance; if we could
3885 reliably detect end-of-file on the pipe, we could always know when to do a
3886 blocking wait() for a completed process. However, because some systems use
3887 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3888 use code that functions without the need to recognize EOF.
3890 There's a double loop here just in case we end up with a process that is not in
3891 the list of remote delivery processes. Something has obviously gone wrong if
3892 this is the case. (For example, a process that is incorrectly left over from
3893 routing or local deliveries might be found.) The damage can be minimized by
3894 looping back and looking for another process. If there aren't any, the error
3895 return will happen. */
3897 for (;;) /* Normally we do not repeat this loop */
3899 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3902 fd_set select_pipes;
3903 int maxpipe, readycount;
3905 /* A return value of -1 can mean several things. If errno != ECHILD, it
3906 either means invalid options (which we discount), or that this process was
3907 interrupted by a signal. Just loop to try the waitpid() again.
3909 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3910 in existence. This should never happen, and is an unexpected error.
3911 However, there is a nasty complication when running under Linux. If "strace
3912 -f" is being used under Linux to trace this process and its children,
3913 subprocesses are "stolen" from their parents and become the children of the
3914 tracing process. A general wait such as the one we've just obeyed returns
3915 as if there are no children while subprocesses are running. Once a
3916 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3917 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3920 This does not happen using "truss" on Solaris, nor (I think) with other
3921 tracing facilities on other OS. It seems to be specific to Linux.
3923 What we do to get round this is to use kill() to see if any of our
3924 subprocesses are still in existence. If kill() gives an OK return, we know
3925 it must be for one of our processes - it can't be for a re-use of the pid,
3926 because if our process had finished, waitpid() would have found it. If any
3927 of our subprocesses are in existence, we proceed to use select() as if
3928 waitpid() had returned zero. I think this is safe. */
3932 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3935 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3936 "for process existence\n");
3938 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3940 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3942 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3943 "stolen by strace\n", (int)pid);
3944 break; /* With poffset set */
3948 if (poffset >= remote_max_parallel)
3950 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3951 return NULL; /* This is the error return */
3955 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3956 been handled above. A return value of zero means that there is at least one
3957 subprocess, but there are no completed subprocesses. See if any pipes are
3958 ready with any data for reading. */
3960 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3963 FD_ZERO(&select_pipes);
3964 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3965 if (parlist[poffset].pid != 0)
3967 int fd = parlist[poffset].fd;
3968 FD_SET(fd, &select_pipes);
3969 if (fd > maxpipe) maxpipe = fd;
3972 /* Stick in a 60-second timeout, just in case. */
3977 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3980 /* Scan through the pipes and read any that are ready; use the count
3981 returned by select() to stop when there are no more. Select() can return
3982 with no processes (e.g. if interrupted). This shouldn't matter.
3984 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3985 read, or there was a disaster. In either case, we are finished with this
3986 process. Do an explicit wait() for the process and break the main loop if
3989 It turns out that we have to deal with the case of an interrupted system
3990 call, which can happen on some operating systems if the signal handling is
3991 set up to do that by default. */
3994 readycount > 0 && poffset < remote_max_parallel;
3997 if ( (pid = parlist[poffset].pid) != 0
3998 && FD_ISSET(parlist[poffset].fd, &select_pipes)
4002 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4003 for (;;) /* Loop for signals */
4005 pid_t endedpid = waitpid(pid, &status, 0);
4006 if (endedpid == pid) goto PROCESS_DONE;
4007 if (endedpid != (pid_t)(-1) || errno != EINTR)
4008 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4009 "%d (errno = %d) from waitpid() for process %d",
4010 (int)endedpid, errno, (int)pid);
4015 /* Now go back and look for a completed subprocess again. */
4018 /* A completed process was detected by the non-blocking waitpid(). Find the
4019 data block that corresponds to this subprocess. */
4021 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4022 if (pid == parlist[poffset].pid) break;
4024 /* Found the data block; this is a known remote delivery process. We don't
4025 need to repeat the outer loop. This should be what normally happens. */
4027 if (poffset < remote_max_parallel) break;
4029 /* This situation is an error, but it's probably better to carry on looking
4030 for another process than to give up (as we used to do). */
4032 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4033 "transport process list", pid);
4034 } /* End of the "for" loop */
4036 /* Come here when all the data was completely read after a select(), and
4037 the process in pid has been wait()ed for. */
4044 debug_printf("remote delivery process %d ended\n", (int)pid);
4046 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4050 set_process_info("delivering %s", message_id);
4052 /* Get the chain of processed addresses */
4054 addrlist = parlist[poffset].addrlist;
4056 /* If the process did not finish cleanly, record an error and freeze (except
4057 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4058 in case the delivery did actually happen. */
4060 if ((status & 0xffff) != 0)
4063 int msb = (status >> 8) & 255;
4064 int lsb = status & 255;
4065 int code = (msb == 0)? (lsb & 0x7f) : msb;
4067 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4069 addrlist->transport->driver_name,
4071 (msb == 0)? "terminated by signal" : "exit code",
4074 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4075 addrlist->special_action = SPECIAL_FREEZE;
4077 for (addr = addrlist; addr; addr = addr->next)
4079 addr->transport_return = DEFER;
4080 addr->message = msg;
4083 remove_journal = FALSE;
4086 /* Else complete reading the pipe to get the result of the delivery, if all
4087 the data has not yet been obtained. */
4089 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4091 /* Put the data count and return path into globals, mark the data slot unused,
4092 decrement the count of subprocesses, and return the address chain. */
4094 transport_count = parlist[poffset].transport_count;
4095 used_return_path = parlist[poffset].return_path;
4096 parlist[poffset].pid = 0;
4103 /*************************************************
4104 * Wait for subprocesses and post-process *
4105 *************************************************/
4107 /* This function waits for subprocesses until the number that are still running
4108 is below a given threshold. For each complete subprocess, the addresses are
4109 post-processed. If we can't find a running process, there is some shambles.
4110 Better not bomb out, as that might lead to multiple copies of the message. Just
4111 log and proceed as if all done.
4114 max maximum number of subprocesses to leave running
4115 fallback TRUE if processing fallback hosts
4121 par_reduce(int max, BOOL fallback)
4123 while (parcount > max)
4125 address_item *doneaddr = par_wait();
4128 log_write(0, LOG_MAIN|LOG_PANIC,
4129 "remote delivery process count got out of step");
4134 transport_instance * tp = doneaddr->transport;
4135 if (tp->max_parallel)
4136 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4138 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4144 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4146 uschar pipe_header[PIPE_HEADER_SIZE+1];
4147 size_t total_len = PIPE_HEADER_SIZE + size;
4149 struct iovec iov[2] = {
4150 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4151 { buf, size } /* *the* data */
4156 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4157 /* complain to log if someone tries with buffer sizes we can't handle*/
4159 if (size > BIG_BUFFER_SIZE-1)
4161 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4162 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4164 size = BIG_BUFFER_SIZE;
4167 /* Should we check that we do not write more than PIPE_BUF? What would
4170 /* convert size to human readable string prepended by id and subid */
4171 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4172 id, subid, (long)size))
4173 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4175 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4176 id, subid, (long)size, pipe_header);
4178 if ((ret = writev(fd, iov, 2)) != total_len)
4179 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4180 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4181 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4184 /*************************************************
4185 * Do remote deliveries *
4186 *************************************************/
4188 /* This function is called to process the addresses in addr_remote. We must
4189 pick off the queue all addresses that have the same transport, remote
4190 destination, and errors address, and hand them to the transport in one go,
4191 subject to some configured limitations. If this is a run to continue delivering
4192 to an existing delivery channel, skip all but those addresses that can go to
4193 that channel. The skipped addresses just get deferred.
4195 If mua_wrapper is set, all addresses must be able to be sent in a single
4196 transaction. If not, this function yields FALSE.
4198 In Exim 4, remote deliveries are always done in separate processes, even
4199 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4200 is so that the base process can retain privilege. This makes the
4201 implementation of fallback transports feasible (though not initially done.)
4203 We create up to the configured number of subprocesses, each of which passes
4204 back the delivery state via a pipe. (However, when sending down an existing
4205 connection, remote_max_parallel is forced to 1.)
4208 fallback TRUE if processing fallback hosts
4210 Returns: TRUE normally
4211 FALSE if mua_wrapper is set and the addresses cannot all be sent
4216 do_remote_deliveries(BOOL fallback)
4221 parcount = 0; /* Number of executing subprocesses */
4223 /* When sending down an existing channel, only do one delivery at a time.
4224 We use a local variable (parmax) to hold the maximum number of processes;
4225 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4227 if (continue_transport) remote_max_parallel = 1;
4228 parmax = remote_max_parallel;
4230 /* If the data for keeping a list of processes hasn't yet been
4235 parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4236 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4237 parlist[poffset].pid = 0;
4240 /* Now loop for each remote delivery */
4242 for (int delivery_count = 0; addr_remote; delivery_count++)
4248 int address_count = 1;
4249 int address_count_max;
4251 BOOL use_initgroups;
4252 BOOL pipe_done = FALSE;
4253 transport_instance *tp;
4254 address_item **anchor = &addr_remote;
4255 address_item *addr = addr_remote;
4256 address_item *last = addr;
4259 uschar * serialize_key = NULL;
4261 /* Pull the first address right off the list. */
4263 addr_remote = addr->next;
4266 DEBUG(D_deliver|D_transport)
4267 debug_printf("--------> %s <--------\n", addr->address);
4269 /* If no transport has been set, there has been a big screw-up somewhere. */
4271 if (!(tp = addr->transport))
4273 f.disable_logging = FALSE; /* Jic */
4274 panicmsg = US"No transport set by router";
4275 goto panic_continue;
4278 /* Check that this base address hasn't previously been delivered to this
4279 transport. The check is necessary at this point to handle homonymic addresses
4280 correctly in cases where the pattern of redirection changes between delivery
4281 attempts. Non-homonymic previous delivery is detected earlier, at routing
4284 if (previously_transported(addr, FALSE)) continue;
4286 /* Force failure if the message is too big. */
4288 if (tp->message_size_limit)
4290 int rc = check_message_size(tp, addr);
4293 addr->transport_return = rc;
4294 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4299 /* Get the flag which specifies whether the transport can handle different
4300 domains that nevertheless resolve to the same set of hosts. If it needs
4301 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4302 $host, $host_address, $host_port. */
4303 if (tp->expand_multi_domain)
4304 deliver_set_expansions(addr);
4306 if (exp_bool(addr, US"transport", tp->name, D_transport,
4307 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4308 &multi_domain) != OK)
4310 deliver_set_expansions(NULL);
4311 panicmsg = addr->message;
4312 goto panic_continue;
4315 /* Get the maximum it can handle in one envelope, with zero meaning
4316 unlimited, which is forced for the MUA wrapper case. */
4318 address_count_max = tp->max_addresses;
4319 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4322 /************************************************************************/
4323 /***** This is slightly experimental code, but should be safe. *****/
4325 /* The address_count_max value is the maximum number of addresses that the
4326 transport can send in one envelope. However, the transport must be capable of
4327 dealing with any number of addresses. If the number it gets exceeds its
4328 envelope limitation, it must send multiple copies of the message. This can be
4329 done over a single connection for SMTP, so uses less resources than making
4330 multiple connections. On the other hand, if remote_max_parallel is greater
4331 than one, it is perhaps a good idea to use parallel processing to move the
4332 message faster, even if that results in multiple simultaneous connections to
4335 How can we come to some compromise between these two ideals? What we do is to
4336 limit the number of addresses passed to a single instance of a transport to
4337 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4338 number of addresses routed to remote transports divided by
4339 remote_max_parallel. For example, if the message has 100 remote recipients,
4340 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4341 once. But if rcpt_max is 100, we could send up to 100.
4343 Of course, not all the remotely addresses in a message are going to go to the
4344 same set of hosts (except in smarthost configurations), so this is just a
4345 heuristic way of dividing up the work.
4347 Furthermore (1), because this may not be wanted in some cases, and also to
4348 cope with really pathological cases, there is also a limit to the number of
4349 messages that are sent over one connection. This is the same limit that is
4350 used when sending several different messages over the same connection.
4351 Continue_sequence is set when in this situation, to the number sent so
4352 far, including this message.
4354 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4355 is probably because they are using VERP, in which case they want to pass only
4356 one address at a time to the transport, in order to be able to use
4357 $local_part and $domain in constructing a new return path. We could test for
4358 the use of these variables, but as it is so likely they will be used when the
4359 maximum is 1, we don't bother. Just leave the value alone. */
4361 if ( address_count_max != 1
4362 && address_count_max < remote_delivery_count/remote_max_parallel
4365 int new_max = remote_delivery_count/remote_max_parallel;
4366 int message_max = tp->connection_max_messages;
4367 if (connection_max_messages >= 0) message_max = connection_max_messages;
4368 message_max -= continue_sequence - 1;
4369 if (message_max > 0 && new_max > address_count_max * message_max)
4370 new_max = address_count_max * message_max;
4371 address_count_max = new_max;
4374 /************************************************************************/
4377 /* Pick off all addresses which have the same transport, errors address,
4378 destination, and extra headers. In some cases they point to the same host
4379 list, but we also need to check for identical host lists generated from
4380 entirely different domains. The host list pointers can be NULL in the case
4381 where the hosts are defined in the transport. There is also a configured
4382 maximum limit of addresses that can be handled at once (see comments above
4383 for how it is computed).
4384 If the transport does not handle multiple domains, enforce that also,
4385 and if it might need a per-address check for this, re-evaluate it.
4388 while ((next = *anchor) && address_count < address_count_max)
4391 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4392 && tp == next->transport
4393 && same_hosts(next->host_list, addr->host_list)
4394 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4395 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4396 && same_ugid(tp, next, addr)
4397 && ( next->prop.remove_headers == addr->prop.remove_headers
4398 || ( next->prop.remove_headers
4399 && addr->prop.remove_headers
4400 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4404 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4406 US"transport", next->transport->name, D_transport,
4407 US"multi_domain", next->transport->multi_domain,
4408 next->transport->expand_multi_domain, &md) == OK
4413 *anchor = next->next;
4415 next->first = addr; /* remember top one (for retry processing) */
4420 else anchor = &(next->next);
4421 deliver_set_expansions(NULL);
4424 /* If we are acting as an MUA wrapper, all addresses must go in a single
4425 transaction. If not, put them back on the chain and yield FALSE. */
4427 if (mua_wrapper && addr_remote)
4429 last->next = addr_remote;
4434 /* If the transport is limited for parallellism, enforce that here.
4435 The hints DB entry is decremented in par_reduce(), when we reap the
4436 transport process. */
4438 if (tpt_parallel_check(tp, addr, &serialize_key))
4439 if ((panicmsg = expand_string_message))
4440 goto panic_continue;
4442 continue; /* Loop for the next set of addresses. */
4444 /* Set up the expansion variables for this set of addresses */
4446 deliver_set_expansions(addr);
4448 /* Ensure any transport-set auth info is fresh */
4449 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4451 /* Compute the return path, expanding a new one if required. The old one
4452 must be set first, as it might be referred to in the expansion. */
4454 if(addr->prop.errors_address)
4455 return_path = addr->prop.errors_address;
4456 #ifdef EXPERIMENTAL_SRS
4457 else if(addr->prop.srs_sender)
4458 return_path = addr->prop.srs_sender;
4461 return_path = sender_address;
4463 if (tp->return_path)
4465 uschar *new_return_path = expand_string(tp->return_path);
4466 if (new_return_path)
4467 return_path = new_return_path;
4468 else if (!f.expand_string_forcedfail)
4470 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4471 tp->return_path, expand_string_message);
4476 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4477 logs and sets up error messages, so we just post-process and continue with
4478 the next address. */
4480 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4486 /* If this transport has a setup function, call it now so that it gets
4487 run in this process and not in any subprocess. That way, the results of
4488 any setup that are retained by the transport can be reusable. One of the
4489 things the setup does is to set the fallback host lists in the addresses.
4490 That is why it is called at this point, before the continue delivery
4491 processing, because that might use the fallback hosts. */
4494 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4496 /* If we have a connection still open from a verify stage (lazy-close)
4497 treat it as if it is a continued connection (apart from the counter used
4498 for the log line mark). */
4500 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4503 debug_printf("lazy-callout-close: have conn still open from verification\n");
4504 continue_transport = cutthrough.transport;
4505 continue_hostname = string_copy(cutthrough.host.name);
4506 continue_host_address = string_copy(cutthrough.host.address);
4507 continue_sequence = 1;
4508 sending_ip_address = cutthrough.snd_ip;
4509 sending_port = cutthrough.snd_port;
4510 smtp_peer_options = cutthrough.peer_options;
4513 /* If this is a run to continue delivery down an already-established
4514 channel, check that this set of addresses matches the transport and
4515 the channel. If it does not, defer the addresses. If a host list exists,
4516 we must check that the continue host is on the list. Otherwise, the
4517 host is set in the transport. */
4519 f.continue_more = FALSE; /* In case got set for the last lot */
4520 if (continue_transport)
4522 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4524 /* If the transport is about to override the host list do not check
4525 it here but take the cost of running the transport process to discover
4526 if the continued_hostname connection is suitable. This is a layering
4527 violation which is unfortunate as it requires we haul in the smtp
4532 smtp_transport_options_block * ob;
4534 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4535 && (ob = (smtp_transport_options_block *)tp->options_block)
4536 && ob->hosts_override && ob->hosts
4542 for (host_item * h = addr->host_list; h; h = h->next)
4543 if (Ustrcmp(h->name, continue_hostname) == 0)
4544 /*XXX should also check port here */
4545 { ok = TRUE; break; }
4549 /* Addresses not suitable; defer or queue for fallback hosts (which
4550 might be the continue host) and skip to next address. */
4554 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4555 Ustrcmp(continue_transport, tp->name) != 0
4556 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4557 : string_sprintf("no host matching %s", continue_hostname));
4558 if (serialize_key) enq_end(serialize_key);
4560 if (addr->fallback_hosts && !fallback)
4562 for (next = addr; ; next = next->next)
4564 next->host_list = next->fallback_hosts;
4565 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4566 if (!next->next) break;
4568 next->next = addr_fallback;
4569 addr_fallback = addr;
4574 for (next = addr; ; next = next->next)
4576 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4577 if (!next->next) break;
4579 next->next = addr_defer;
4586 /* Set a flag indicating whether there are further addresses that list
4587 the continued host. This tells the transport to leave the channel open,
4588 but not to pass it to another delivery process. We'd like to do that
4589 for non-continue_transport cases too but the knowlege of which host is
4590 connected to is too hard to manage. Perhaps we need a finer-grain
4591 interface to the transport. */
4593 for (next = addr_remote; next && !f.continue_more; next = next->next)
4594 for (host_item * h = next->host_list; h; h = h->next)
4595 if (Ustrcmp(h->name, continue_hostname) == 0)
4596 { f.continue_more = TRUE; break; }
4599 /* The transports set up the process info themselves as they may connect
4600 to more than one remote machine. They also have to set up the filter
4601 arguments, if required, so that the host name and address are available
4604 transport_filter_argv = NULL;
4606 /* Create the pipe for inter-process communication. If pipe creation
4607 fails, it is probably because the value of remote_max_parallel is so
4608 large that too many file descriptors for pipes have been created. Arrange
4609 to wait for a process to finish, and then try again. If we still can't
4610 create a pipe when all processes have finished, break the retry loop. */
4614 if (pipe(pfd) == 0) pipe_done = TRUE;
4615 else if (parcount > 0) parmax = parcount;
4618 /* We need to make the reading end of the pipe non-blocking. There are
4619 two different options for this. Exim is cunningly (I hope!) coded so
4620 that it can use either of them, though it prefers O_NONBLOCK, which
4621 distinguishes between EOF and no-more-data. */
4623 /* The data appears in a timely manner and we already did a select on
4624 all pipes, so I do not see a reason to use non-blocking IO here
4627 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4629 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4633 /* If the maximum number of subprocesses already exist, wait for a process
4634 to finish. If we ran out of file descriptors, parmax will have been reduced
4635 from its initial value of remote_max_parallel. */
4637 par_reduce(parmax - 1, fallback);
4640 /* If we failed to create a pipe and there were no processes to wait
4641 for, we have to give up on this one. Do this outside the above loop
4642 so that we can continue the main loop. */
4646 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4650 /* Find a free slot in the pardata list. Must do this after the possible
4651 waiting for processes to finish, because a terminating process will free
4654 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4655 if (parlist[poffset].pid == 0)
4658 /* If there isn't one, there has been a horrible disaster. */
4660 if (poffset >= remote_max_parallel)
4662 (void)close(pfd[pipe_write]);
4663 (void)close(pfd[pipe_read]);
4664 panicmsg = US"Unexpectedly no free subprocess slot";
4668 /* Now fork a subprocess to do the remote delivery, but before doing so,
4669 ensure that any cached resources are released so as not to interfere with
4670 what happens in the subprocess. */
4674 if ((pid = fork()) == 0)
4676 int fd = pfd[pipe_write];
4679 /* Setting this global in the subprocess means we need never clear it */
4680 transport_name = tp->name;
4682 /* There are weird circumstances in which logging is disabled */
4683 f.disable_logging = tp->disable_logging;
4685 /* Show pids on debug output if parallelism possible */
4687 if (parmax > 1 && (parcount > 0 || addr_remote))
4689 DEBUG(D_any|D_v) debug_selector |= D_pid;
4690 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4693 /* Reset the random number generator, so different processes don't all
4694 have the same sequence. In the test harness we want different, but
4695 predictable settings for each delivery process, so do something explicit
4696 here rather they rely on the fixed reset in the random number function. */
4698 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4700 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4701 a new process that may be forked to do another delivery down the same
4704 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4706 /* Close open file descriptors for the pipes of other processes
4707 that are running in parallel. */
4709 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4710 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4712 /* This process has inherited a copy of the file descriptor
4713 for the data file, but its file pointer is shared with all the
4714 other processes running in parallel. Therefore, we have to re-open
4715 the file in order to get a new file descriptor with its own
4716 file pointer. We don't need to lock it, as the lock is held by
4717 the parent process. There doesn't seem to be any way of doing
4718 a dup-with-new-file-pointer. */
4720 (void)close(deliver_datafile);
4722 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4724 if ((deliver_datafile = Uopen(fname,
4728 O_RDWR | O_APPEND, 0)) < 0)
4729 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4730 "parallel delivery: %s", fname, strerror(errno));
4733 /* Set the close-on-exec flag */
4735 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4739 /* Set the uid/gid of this process; bombs out on failure. */
4741 exim_setugid(uid, gid, use_initgroups,
4742 string_sprintf("remote delivery to %s with transport=%s",
4743 addr->address, tp->name));
4745 /* Close the unwanted half of this process' pipe, set the process state,
4746 and run the transport. Afterwards, transport_count will contain the number
4747 of bytes written. */
4749 (void)close(pfd[pipe_read]);
4750 set_process_info("delivering %s using %s", message_id, tp->name);
4751 debug_print_string(tp->debug_string);
4752 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4754 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4755 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4757 /* Ensure any cached resources that we used are now released */
4761 /* Pass the result back down the pipe. This is a lot more information
4762 than is needed for a local delivery. We have to send back the error
4763 status for each address, the usability status for each host that is
4764 flagged as unusable, and all the retry items. When TLS is in use, we
4765 send also the cipher and peerdn information. Each type of information
4766 is flagged by an identifying byte, and is then in a fixed format (with
4767 strings terminated by zeros), and there is a final terminator at the
4768 end. The host information and retry information is all attached to
4769 the first address, so that gets sent at the start. */
4771 /* Host unusability information: for most success cases this will
4774 for (h = addr->host_list; h; h = h->next)
4776 if (!h->address || h->status < hstatus_unusable) continue;
4777 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4778 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4781 /* The number of bytes written. This is the same for each address. Even
4782 if we sent several copies of the message down the same connection, the
4783 size of each one is the same, and it's that value we have got because
4784 transport_count gets reset before calling transport_write_message(). */
4786 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4787 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4789 /* Information about what happened to each address. Four item types are
4790 used: an optional 'X' item first, for TLS information, then an optional "C"
4791 item for any client-auth info followed by 'R' items for any retry settings,
4792 and finally an 'A' item for the remaining data. */
4794 for(; addr; addr = addr->next)
4799 /* The certificate verification status goes into the flags */
4800 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4802 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4804 # ifdef EXPERIMENTAL_TLS_RESUME
4805 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4808 /* Use an X item only if there's something to send */
4812 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4816 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4818 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4820 else if (continue_proxy_cipher)
4822 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4824 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4830 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4834 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4839 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4843 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4845 # ifndef DISABLE_OCSP
4846 if (addr->ocsp > OCSP_NOT_REQ)
4848 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4849 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4852 #endif /*DISABLE_TLS*/
4854 if (client_authenticator)
4856 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4857 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4859 if (client_authenticated_id)
4861 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4862 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4864 if (client_authenticated_sender)
4866 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4867 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4870 #ifndef DISABLE_PRDR
4871 if (testflag(addr, af_prdr_used))
4872 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4875 if (testflag(addr, af_pipelining))
4876 #ifdef SUPPORT_PIPE_CONNECT
4877 if (testflag(addr, af_early_pipe))
4878 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4881 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4883 if (testflag(addr, af_chunking_used))
4884 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4886 if (testflag(addr, af_tcp_fastopen_conn))
4887 rmt_dlv_checked_write(fd, 'T',
4888 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4892 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4893 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4895 /* Retry information: for most success cases this will be null. */
4897 for (r = addr->retries; r; r = r->next)
4899 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4900 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4901 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4902 ptr += sizeof(r->basic_errno);
4903 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4904 ptr += sizeof(r->more_errno);
4905 if (!r->message) *ptr++ = 0; else
4907 sprintf(CS ptr, "%.512s", r->message);
4910 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4913 #ifdef SUPPORT_SOCKS
4914 if (LOGGING(proxy) && proxy_session)
4917 if (proxy_local_address)
4919 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4920 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4921 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4922 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4923 ptr += sizeof(proxy_local_port);
4927 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4931 #ifdef EXPERIMENTAL_DSN_INFO
4932 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4933 if (addr->smtp_greeting)
4935 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4936 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4937 if (addr->helo_response)
4939 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4940 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4944 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4948 /* The rest of the information goes in an 'A0' item. */
4950 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4951 ptr = big_buffer + 2;
4952 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4953 ptr += sizeof(addr->basic_errno);
4954 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4955 ptr += sizeof(addr->more_errno);
4956 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4957 ptr += sizeof(addr->delivery_usec);
4958 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4959 ptr += sizeof(addr->flags);
4961 if (!addr->message) *ptr++ = 0; else
4962 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4964 if (!addr->user_message) *ptr++ = 0; else
4965 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4967 if (!addr->host_used) *ptr++ = 0; else
4969 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4970 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4971 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4972 ptr += sizeof(addr->host_used->port);
4974 /* DNS lookup status */
4975 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4976 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4979 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4982 /* Local interface address/port */
4983 #ifdef EXPERIMENTAL_DSN_INFO
4984 if (sending_ip_address)
4986 if (LOGGING(incoming_interface) && sending_ip_address)
4990 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4991 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4992 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4995 /* Add termination flag, close the pipe, and that's it. The character
4996 after 'Z' indicates whether continue_transport is now NULL or not.
4997 A change from non-NULL to NULL indicates a problem with a continuing
5000 big_buffer[0] = continue_transport ? '1' : '0';
5001 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5006 /* Back in the mainline: close the unwanted half of the pipe. */
5008 (void)close(pfd[pipe_write]);
5010 /* If we have a connection still open from a verify stage (lazy-close)
5011 release its TLS library context (if any) as responsibility was passed to
5012 the delivery child process. */
5014 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5017 if (cutthrough.is_tls)
5018 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5020 (void) close(cutthrough.cctx.sock);
5021 release_cutthrough_connection(US"passed to transport proc");
5024 /* Fork failed; defer with error message */
5028 (void)close(pfd[pipe_read]);
5029 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5030 addr->domain, strerror(errno));
5034 /* Fork succeeded; increment the count, and remember relevant data for
5035 when the process finishes. */
5038 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5039 parlist[poffset].pid = pid;
5040 parlist[poffset].fd = pfd[pipe_read];
5041 parlist[poffset].done = FALSE;
5042 parlist[poffset].msg = NULL;
5043 parlist[poffset].return_path = return_path;
5045 /* If the process we've just started is sending a message down an existing
5046 channel, wait for it now. This ensures that only one such process runs at
5047 once, whatever the value of remote_max parallel. Otherwise, we might try to
5048 send two or more messages simultaneously down the same channel. This could
5049 happen if there are different domains that include the same host in otherwise
5050 different host lists.
5052 Also, if the transport closes down the channel, this information gets back
5053 (continue_transport gets set to NULL) before we consider any other addresses
5056 if (continue_transport) par_reduce(0, fallback);
5058 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5059 newly created process get going before we create another process. This should
5060 ensure repeatability in the tests. We only need to wait a tad. */
5062 else if (f.running_in_test_harness) millisleep(500);
5067 if (serialize_key) enq_end(serialize_key);
5069 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5073 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5074 are still running and post-process their addresses. */
5076 par_reduce(0, fallback);
5083 /*************************************************
5084 * Split an address into local part and domain *
5085 *************************************************/
5087 /* This function initializes an address for routing by splitting it up into a
5088 local part and a domain. The local part is set up twice - once in its original
5089 casing, and once in lower case, and it is dequoted. We also do the "percent
5090 hack" for configured domains. This may lead to a DEFER result if a lookup
5091 defers. When a percent-hacking takes place, we insert a copy of the original
5092 address as a new parent of this address, as if we have had a redirection.
5095 addr points to an addr_item block containing the address
5098 DEFER - could not determine if domain is %-hackable
5102 deliver_split_address(address_item * addr)
5104 uschar * address = addr->address;
5109 if (!(domain = Ustrrchr(address, '@')))
5110 return DEFER; /* should always have a domain, but just in case... */
5112 len = domain - address;
5113 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5115 /* The implication in the RFCs (though I can't say I've seen it spelled out
5116 explicitly) is that quoting should be removed from local parts at the point
5117 where they are locally interpreted. [The new draft "821" is more explicit on
5118 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5119 removing quoting backslashes and any unquoted doublequotes. */
5121 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5125 if (c == '\"') continue;
5135 /* We do the percent hack only for those domains that are listed in
5136 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5138 if (percent_hack_domains)
5141 uschar *new_address = NULL;
5142 uschar *local_part = addr->cc_local_part;
5144 deliver_domain = addr->domain; /* set $domain */
5146 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5147 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5149 && (t = Ustrrchr(local_part, '%')) != NULL
5152 new_address = string_copy(local_part);
5153 new_address[t - local_part] = '@';
5154 deliver_domain = string_copylc(t+1);
5155 local_part = string_copyn(local_part, t - local_part);
5158 if (rc == DEFER) return DEFER; /* lookup deferred */
5160 /* If hackery happened, set up new parent and alter the current address. */
5164 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5165 *new_parent = *addr;
5166 addr->parent = new_parent;
5167 new_parent->child_count = 1;
5168 addr->address = new_address;
5169 addr->unique = string_copy(new_address);
5170 addr->domain = deliver_domain;
5171 addr->cc_local_part = local_part;
5172 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5177 /* Create the lowercased version of the final local part, and make that the
5178 default one to be used. */
5180 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5187 /*************************************************
5188 * Get next error message text *
5189 *************************************************/
5191 /* If f is not NULL, read the next "paragraph", from a customized error message
5192 text file, terminated by a line containing ****, and expand it.
5195 f NULL or a file to read from
5196 which string indicating which string (for errors)
5198 Returns: NULL or an expanded string
5202 next_emf(FILE *f, uschar *which)
5208 if (!f) return NULL;
5210 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5213 para = string_get(256);
5216 para = string_cat(para, buffer);
5217 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5220 if ((yield = expand_string(string_from_gstring(para))))
5223 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5224 "bounce_message_file or warn_message_file (%s): %s", which,
5225 expand_string_message);
5232 /*************************************************
5233 * Close down a passed transport channel *
5234 *************************************************/
5236 /* This function is called when a passed transport channel cannot be used.
5237 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5238 so that the function call can be the argument of a "return" statement.
5241 Returns: DELIVER_NOT_ATTEMPTED
5245 continue_closedown(void)
5247 if (continue_transport)
5248 for (transport_instance * t = transports; t; t = t->next)
5249 if (Ustrcmp(t->name, continue_transport) == 0)
5251 if (t->info->closedown) (t->info->closedown)(t);
5254 return DELIVER_NOT_ATTEMPTED;
5260 /*************************************************
5261 * Print address information *
5262 *************************************************/
5264 /* This function is called to output an address, or information about an
5265 address, for bounce or defer messages. If the hide_child flag is set, all we
5266 output is the original ancestor address.
5269 addr points to the address
5270 f the FILE to print to
5271 si an initial string
5272 sc a continuation string for before "generated"
5275 Returns: TRUE if the address is not hidden
5279 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5283 uschar *printed = US"";
5284 address_item *ancestor = addr;
5285 while (ancestor->parent) ancestor = ancestor->parent;
5287 fprintf(f, "%s", CS si);
5289 if (addr->parent && testflag(addr, af_hide_child))
5291 printed = US"an undisclosed address";
5294 else if (!testflag(addr, af_pfr) || !addr->parent)
5295 printed = addr->address;
5299 uschar *s = addr->address;
5302 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5303 else if (addr->address[0] == '|') ss = US"pipe";
5306 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5307 printed = addr->parent->address;
5310 fprintf(f, "%s", CS string_printing(printed));
5312 if (ancestor != addr)
5314 uschar *original = ancestor->onetime_parent;
5315 if (!original) original= ancestor->address;
5316 if (strcmpic(original, printed) != 0)
5317 fprintf(f, "%s(%sgenerated from %s)", sc,
5318 ancestor != addr->parent ? "ultimately " : "",
5319 string_printing(original));
5322 if (addr->host_used)
5323 fprintf(f, "\n host %s [%s]",
5324 addr->host_used->name, addr->host_used->address);
5326 fprintf(f, "%s", CS se);
5334 /*************************************************
5335 * Print error for an address *
5336 *************************************************/
5338 /* This function is called to print the error information out of an address for
5339 a bounce or a warning message. It tries to format the message reasonably by
5340 introducing newlines. All lines are indented by 4; the initial printing
5341 position must be set before calling.
5343 This function used always to print the error. Nowadays we want to restrict it
5344 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5345 and filter "fail". We no longer pass other information willy-nilly in bounce
5346 and warning messages. Text in user_message is always output; text in message
5347 only if the af_pass_message flag is set.
5351 f the FILE to print on
5358 print_address_error(address_item *addr, FILE *f, uschar *t)
5360 int count = Ustrlen(t);
5361 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5363 if (!s && !(s = addr->user_message))
5366 fprintf(f, "\n %s", t);
5369 if (*s == '\\' && s[1] == 'n')
5379 if (*s++ == ':' && isspace(*s) && count > 45)
5381 fprintf(f, "\n "); /* sic (because space follows) */
5388 /***********************************************************
5389 * Print Diagnostic-Code for an address *
5390 ************************************************************/
5392 /* This function is called to print the error information out of an address for
5393 a bounce or a warning message. It tries to format the message reasonably as
5394 required by RFC 3461 by adding a space after each newline
5396 it uses the same logic as print_address_error() above. if af_pass_message is true
5397 and addr->message is set it uses the remote host answer. if not addr->user_message
5398 is used instead if available.
5402 f the FILE to print on
5408 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5410 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5412 /* af_pass_message and addr->message set ? print remote host answer */
5416 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5418 /* search first ": ". we assume to find the remote-MTA answer there */
5419 if (!(s = Ustrstr(addr->message, ": ")))
5420 return; /* not found, bail out */
5421 s += 2; /* skip ": " */
5422 fprintf(f, "Diagnostic-Code: smtp; ");
5424 /* no message available. do nothing */
5428 if (*s == '\\' && s[1] == 'n')
5430 fputs("\n ", f); /* as defined in RFC 3461 */
5440 /*************************************************
5441 * Check list of addresses for duplication *
5442 *************************************************/
5444 /* This function was introduced when the test for duplicate addresses that are
5445 not pipes, files, or autoreplies was moved from the middle of routing to when
5446 routing was complete. That was to fix obscure cases when the routing history
5447 affects the subsequent routing of identical addresses. This function is called
5448 after routing, to check that the final routed addresses are not duplicates.
5450 If we detect a duplicate, we remember what it is a duplicate of. Note that
5451 pipe, file, and autoreply de-duplication is handled during routing, so we must
5452 leave such "addresses" alone here, as otherwise they will incorrectly be
5455 Argument: address of list anchor
5460 do_duplicate_check(address_item **anchor)
5463 while ((addr = *anchor))
5466 if (testflag(addr, af_pfr))
5468 anchor = &(addr->next);
5470 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5472 DEBUG(D_deliver|D_route)
5473 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5474 *anchor = addr->next;
5475 addr->dupof = tnode->data.ptr;
5476 addr->next = addr_duplicate;
5477 addr_duplicate = addr;
5481 tree_add_duplicate(addr->unique, addr);
5482 anchor = &(addr->next);
5490 /************************************************/
5493 print_dsn_addr_action(FILE * f, address_item * addr,
5494 uschar * action, uschar * status)
5498 if (addr->dsn_orcpt)
5499 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5501 for (pa = addr; pa->parent; ) pa = pa->parent;
5502 fprintf(f, "Action: %s\n"
5503 "Final-Recipient: rfc822;%s\n"
5505 action, pa->address, status);
5509 /*************************************************
5510 * Deliver one message *
5511 *************************************************/
5513 /* This is the function which is called when a message is to be delivered. It
5514 is passed the id of the message. It is possible that the message no longer
5515 exists, if some other process has delivered it, and it is also possible that
5516 the message is being worked on by another process, in which case the data file
5519 If no delivery is attempted for any of the above reasons, the function returns
5520 DELIVER_NOT_ATTEMPTED.
5522 If the give_up flag is set true, do not attempt any deliveries, but instead
5523 fail all outstanding addresses and return the message to the sender (or
5526 A delivery operation has a process all to itself; we never deliver more than
5527 one message in the same process. Therefore we needn't worry too much about
5530 Liable to be called as root.
5533 id the id of the message to be delivered
5534 forced TRUE if delivery was forced by an administrator; this overrides
5535 retry delays and causes a delivery to be tried regardless
5536 give_up TRUE if an administrator has requested that delivery attempts
5539 Returns: When the global variable mua_wrapper is FALSE:
5540 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5541 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5542 When the global variable mua_wrapper is TRUE:
5543 DELIVER_MUA_SUCCEEDED if delivery succeeded
5544 DELIVER_MUA_FAILED if delivery failed
5545 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5549 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5552 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5553 time_t now = time(NULL);
5554 address_item *addr_last = NULL;
5555 uschar *filter_message = NULL;
5556 int process_recipients = RECIP_ACCEPT;
5559 extern int acl_where;
5561 uschar *info = queue_run_pid == (pid_t)0
5562 ? string_sprintf("delivering %s", id)
5563 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5565 /* If the D_process_info bit is on, set_process_info() will output debugging
5566 information. If not, we want to show this initial information if D_deliver or
5567 D_queue_run is set or in verbose mode. */
5569 set_process_info("%s", info);
5571 if ( !(debug_selector & D_process_info)
5572 && (debug_selector & (D_deliver|D_queue_run|D_v))
5574 debug_printf("%s\n", info);
5576 /* Ensure that we catch any subprocesses that are created. Although Exim
5577 sets SIG_DFL as its initial default, some routes through the code end up
5578 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5579 has been forked, but no re-exec has been done. We use sigaction rather than
5580 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5581 sure it is turned off. (There was a problem on AIX with this.) */
5585 struct sigaction act;
5586 act.sa_handler = SIG_DFL;
5587 sigemptyset(&(act.sa_mask));
5589 sigaction(SIGCHLD, &act, NULL);
5592 signal(SIGCHLD, SIG_DFL);
5595 /* Make the forcing flag available for routers and transports, set up the
5596 global message id field, and initialize the count for returned files and the
5597 message size. This use of strcpy() is OK because the length id is checked when
5598 it is obtained from a command line (the -M or -q options), and otherwise it is
5599 known to be a valid message id. */
5601 if (id != message_id)
5602 Ustrcpy(message_id, id);
5603 f.deliver_force = forced;
5607 /* Initialize some flags */
5609 update_spool = FALSE;
5610 remove_journal = TRUE;
5612 /* Set a known context for any ACLs we call via expansions */
5613 acl_where = ACL_WHERE_DELIVERY;
5615 /* Reset the random number generator, so that if several delivery processes are
5616 started from a queue runner that has already used random numbers (for sorting),
5617 they don't all get the same sequence. */
5621 /* Open and lock the message's data file. Exim locks on this one because the
5622 header file may get replaced as it is re-written during the delivery process.
5623 Any failures cause messages to be written to the log, except for missing files
5624 while queue running - another process probably completed delivery. As part of
5625 opening the data file, message_subdir gets set. */
5627 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5628 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5630 /* The value of message_size at this point has been set to the data length,
5631 plus one for the blank line that notionally precedes the data. */
5633 /* Now read the contents of the header file, which will set up the headers in
5634 store, and also the list of recipients and the tree of non-recipients and
5635 assorted flags. It updates message_size. If there is a reading or format error,
5636 give up; if the message has been around for sufficiently long, remove it. */
5639 uschar * spoolname = string_sprintf("%s-H", id);
5640 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5642 if (errno == ERRNO_SPOOLFORMAT)
5644 struct stat statbuf;
5645 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5647 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5648 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5650 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5653 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5656 /* If we managed to read the envelope data, received_time contains the
5657 time the message was received. Otherwise, we can calculate it from the
5660 if (rc != spool_read_hdrerror)
5662 received_time.tv_sec = received_time.tv_usec = 0;
5663 /*XXX subsec precision?*/
5664 for (i = 0; i < 6; i++)
5665 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5668 /* If we've had this malformed message too long, sling it. */
5670 if (now - received_time.tv_sec > keep_malformed)
5672 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5673 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5674 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5675 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5676 log_write(0, LOG_MAIN, "Message removed because older than %s",
5677 readconf_printtime(keep_malformed));
5680 (void)close(deliver_datafile);
5681 deliver_datafile = -1;
5682 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5686 /* The spool header file has been read. Look to see if there is an existing
5687 journal file for this message. If there is, it means that a previous delivery
5688 attempt crashed (program or host) before it could update the spool header file.
5689 Read the list of delivered addresses from the journal and add them to the
5690 nonrecipients tree. Then update the spool file. We can leave the journal in
5691 existence, as it will get further successful deliveries added to it in this
5692 run, and it will be deleted if this function gets to its end successfully.
5693 Otherwise it might be needed again. */
5696 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5699 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5707 && lseek(journal_fd, 0, SEEK_SET) == 0
5708 && (jread = fdopen(journal_fd, "rb"))
5711 while (Ufgets(big_buffer, big_buffer_size, jread))
5713 int n = Ustrlen(big_buffer);
5714 big_buffer[n-1] = 0;
5715 tree_add_nonrecipient(big_buffer);
5716 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5717 "journal file\n", big_buffer);
5720 if ((journal_fd = dup(fileno(jread))) < 0)
5721 journal_fd = fileno(jread);
5723 (void) fclose(jread); /* Try to not leak the FILE resource */
5725 /* Panic-dies on error */
5726 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5728 else if (errno != ENOENT)
5730 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5731 "%s", strerror(errno));
5732 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5735 /* A null recipients list indicates some kind of disaster. */
5737 if (!recipients_list)
5739 (void)close(deliver_datafile);
5740 deliver_datafile = -1;
5741 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5742 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5747 /* Handle a message that is frozen. There are a number of different things that
5748 can happen, but in the default situation, unless forced, no delivery is
5751 if (f.deliver_freeze)
5753 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5754 /* Moving to another directory removes the message from Exim's view. Other
5755 tools must be used to deal with it. Logging of this action happens in
5756 spool_move_message() and its subfunctions. */
5758 if ( move_frozen_messages
5759 && spool_move_message(id, message_subdir, US"", US"F")
5761 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5764 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5765 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5766 flag causing all recipients to be failed. The time is the age of the
5767 message, not the time since freezing. */
5769 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5771 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5772 process_recipients = RECIP_FAIL_TIMEOUT;
5775 /* For bounce messages (and others with no sender), thaw if the error message
5776 ignore timer is exceeded. The message will be discarded if this delivery
5779 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5780 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5782 /* If this is a bounce message, or there's no auto thaw, or we haven't
5783 reached the auto thaw time yet, and this delivery is not forced by an admin
5784 user, do not attempt delivery of this message. Note that forced is set for
5785 continuing messages down the same channel, in order to skip load checking and
5786 ignore hold domains, but we don't want unfreezing in that case. */
5790 if ( ( sender_address[0] == 0
5792 || now <= deliver_frozen_at + auto_thaw
5794 && ( !forced || !f.deliver_force_thaw
5795 || !f.admin_user || continue_hostname
5798 (void)close(deliver_datafile);
5799 deliver_datafile = -1;
5800 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5801 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5804 /* If delivery was forced (by an admin user), assume a manual thaw.
5805 Otherwise it's an auto thaw. */
5809 f.deliver_manual_thaw = TRUE;
5810 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5812 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5815 /* We get here if any of the rules for unfreezing have triggered. */
5817 f.deliver_freeze = FALSE;
5818 update_spool = TRUE;
5822 /* Open the message log file if we are using them. This records details of
5823 deliveries, deferments, and failures for the benefit of the mail administrator.
5824 The log is not used by exim itself to track the progress of a message; that is
5825 done by rewriting the header spool file. */
5829 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5833 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5835 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5836 fname, strerror(errno));
5837 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5840 /* Make a C stream out of it. */
5842 if (!(message_log = fdopen(fd, "a")))
5844 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5845 fname, strerror(errno));
5846 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5851 /* If asked to give up on a message, log who did it, and set the action for all
5856 struct passwd *pw = getpwuid(real_uid);
5857 log_write(0, LOG_MAIN, "cancelled by %s",
5858 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5859 process_recipients = RECIP_FAIL;
5862 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5864 else if (received_count > received_headers_max)
5865 process_recipients = RECIP_FAIL_LOOP;
5867 /* Otherwise, if a system-wide, address-independent message filter is
5868 specified, run it now, except in the case when we are failing all recipients as
5869 a result of timeout_frozen_after. If the system filter yields "delivered", then
5870 ignore the true recipients of the message. Failure of the filter file is
5871 logged, and the delivery attempt fails. */
5873 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5878 redirect_block redirect;
5880 if (system_filter_uid_set)
5882 ugid.uid = system_filter_uid;
5883 ugid.gid = system_filter_gid;
5884 ugid.uid_set = ugid.gid_set = TRUE;
5887 ugid.uid_set = ugid.gid_set = FALSE;
5889 return_path = sender_address;
5890 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5891 f.system_filtering = TRUE;
5893 /* Any error in the filter file causes a delivery to be abandoned. */
5895 redirect.string = system_filter;
5896 redirect.isfile = TRUE;
5897 redirect.check_owner = redirect.check_group = FALSE;
5898 redirect.owners = NULL;
5899 redirect.owngroups = NULL;
5901 redirect.modemask = 0;
5903 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5906 &redirect, /* Where the data is */
5907 RDO_DEFER | /* Turn on all the enabling options */
5908 RDO_FAIL | /* Leave off all the disabling options */
5913 NULL, /* No :include: restriction (not used in filter) */
5914 NULL, /* No sieve vacation directory (not sieve!) */
5915 NULL, /* No sieve enotify mailto owner (not sieve!) */
5916 NULL, /* No sieve user address (not sieve!) */
5917 NULL, /* No sieve subaddress (not sieve!) */
5918 &ugid, /* uid/gid data */
5919 &addr_new, /* Where to hang generated addresses */
5920 &filter_message, /* Where to put error message */
5921 NULL, /* Don't skip syntax errors */
5922 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5923 US"system filter"); /* For error messages */
5925 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5927 if (rc == FF_ERROR || rc == FF_NONEXIST)
5929 (void)close(deliver_datafile);
5930 deliver_datafile = -1;
5931 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5932 string_printing(filter_message));
5933 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5936 /* Reset things. If the filter message is an empty string, which can happen
5937 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5939 f.system_filtering = FALSE;
5940 f.enable_dollar_recipients = FALSE;
5941 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5943 /* Save the values of the system filter variables so that user filters
5946 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5948 /* The filter can request that delivery of the original addresses be
5953 process_recipients = RECIP_DEFER;
5954 deliver_msglog("Delivery deferred by system filter\n");
5955 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5958 /* The filter can request that a message be frozen, but this does not
5959 take place if the message has been manually thawed. In that case, we must
5960 unset "delivered", which is forced by the "freeze" command to make -bF
5963 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5965 f.deliver_freeze = TRUE;
5966 deliver_frozen_at = time(NULL);
5967 process_recipients = RECIP_DEFER;
5968 frozen_info = string_sprintf(" by the system filter%s%s",
5969 filter_message ? US": " : US"",
5970 filter_message ? filter_message : US"");
5973 /* The filter can request that a message be failed. The error message may be
5974 quite long - it is sent back to the sender in the bounce - but we don't want
5975 to fill up the log with repetitions of it. If it starts with << then the text
5976 between << and >> is written to the log, with the rest left for the bounce
5979 else if (rc == FF_FAIL)
5981 uschar *colon = US"";
5982 uschar *logmsg = US"";
5985 process_recipients = RECIP_FAIL_FILTER;
5991 if ( filter_message[0] == '<'
5992 && filter_message[1] == '<'
5993 && (logend = Ustrstr(filter_message, ">>"))
5996 logmsg = filter_message + 2;
5997 loglen = logend - logmsg;
5998 filter_message = logend + 2;
5999 if (filter_message[0] == 0) filter_message = NULL;
6003 logmsg = filter_message;
6004 loglen = Ustrlen(filter_message);
6008 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6012 /* Delivery can be restricted only to those recipients (if any) that the
6013 filter specified. */
6015 else if (rc == FF_DELIVERED)
6017 process_recipients = RECIP_IGNORE;
6019 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6021 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6024 /* If any new addresses were created by the filter, fake up a "parent"
6025 for them. This is necessary for pipes, etc., which are expected to have
6026 parents, and it also gives some sensible logging for others. Allow
6027 pipes, files, and autoreplies, and run them as the filter uid if set,
6028 otherwise as the current uid. */
6032 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6033 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6035 /* The text "system-filter" is tested in transport_set_up_command() and in
6036 set_up_shell_command() in the pipe transport, to enable them to permit
6037 $recipients, so don't change it here without also changing it there. */
6039 address_item *p = addr_new;
6040 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6042 parent->domain = string_copylc(qualify_domain_recipient);
6043 parent->local_part = US"system-filter";
6045 /* As part of this loop, we arrange for addr_last to end up pointing
6046 at the final address. This is used if we go on to add addresses for the
6047 original recipients. */
6051 if (parent->child_count == USHRT_MAX)
6052 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6053 "than %d delivery addresses", USHRT_MAX);
6054 parent->child_count++;
6057 if (testflag(p, af_pfr))
6063 setflag(p, af_uid_set);
6064 setflag(p, af_gid_set);
6065 setflag(p, af_allow_file);
6066 setflag(p, af_allow_pipe);
6067 setflag(p, af_allow_reply);
6069 /* Find the name of the system filter's appropriate pfr transport */
6071 if (p->address[0] == '|')
6074 tpname = system_filter_pipe_transport;
6075 address_pipe = p->address;
6077 else if (p->address[0] == '>')
6080 tpname = system_filter_reply_transport;
6084 if (p->address[Ustrlen(p->address)-1] == '/')
6086 type = US"directory";
6087 tpname = system_filter_directory_transport;
6092 tpname = system_filter_file_transport;
6094 address_file = p->address;
6097 /* Now find the actual transport, first expanding the name. We have
6098 set address_file or address_pipe above. */
6102 uschar *tmp = expand_string(tpname);
6103 address_file = address_pipe = NULL;
6105 p->message = string_sprintf("failed to expand \"%s\" as a "
6106 "system filter transport name", tpname);
6107 if (is_tainted(tmp))
6108 p->message = string_sprintf("attempt to used tainted value '%s' for"
6109 "transport '%s' as a system filter", tmp, tpname);
6113 p->message = string_sprintf("system_filter_%s_transport is unset",
6118 transport_instance *tp;
6119 for (tp = transports; tp; tp = tp->next)
6120 if (Ustrcmp(tp->name, tpname) == 0)
6126 p->message = string_sprintf("failed to find \"%s\" transport "
6127 "for system filter delivery", tpname);
6130 /* If we couldn't set up a transport, defer the delivery, putting the
6131 error on the panic log as well as the main log. */
6135 address_item *badp = p;
6137 if (!addr_last) addr_new = p; else addr_last->next = p;
6138 badp->local_part = badp->address; /* Needed for log line */
6139 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6142 } /* End of pfr handling */
6144 /* Either a non-pfr delivery, or we found a transport */
6146 DEBUG(D_deliver|D_filter)
6147 debug_printf("system filter added %s\n", p->address);
6151 } /* Loop through all addr_new addresses */
6156 /* Scan the recipients list, and for every one that is not in the non-
6157 recipients tree, add an addr item to the chain of new addresses. If the pno
6158 value is non-negative, we must set the onetime parent from it. This which
6159 points to the relevant entry in the recipients list.
6161 This processing can be altered by the setting of the process_recipients
6162 variable, which is changed if recipients are to be ignored, failed, or
6163 deferred. This can happen as a result of system filter activity, or if the -Mg
6164 option is used to fail all of them.
6166 Duplicate addresses are handled later by a different tree structure; we can't
6167 just extend the non-recipients tree, because that will be re-written to the
6168 spool if the message is deferred, and in any case there are casing
6169 complications for local addresses. */
6171 if (process_recipients != RECIP_IGNORE)
6172 for (i = 0; i < recipients_count; i++)
6173 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6175 recipient_item *r = recipients_list + i;
6176 address_item *new = deliver_make_addr(r->address, FALSE);
6177 new->prop.errors_address = r->errors_to;
6179 if ((new->prop.utf8_msg = message_smtputf8))
6181 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6182 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6183 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6184 new->prop.utf8_downcvt ? "yes"
6185 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6191 new->onetime_parent = recipients_list[r->pno].address;
6193 /* If DSN support is enabled, set the dsn flags and the original receipt
6194 to be passed on to other DSN enabled MTAs */
6195 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6196 new->dsn_orcpt = r->orcpt;
6197 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6198 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6200 switch (process_recipients)
6202 /* RECIP_DEFER is set when a system filter freezes a message. */
6205 new->next = addr_defer;
6210 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6213 case RECIP_FAIL_FILTER:
6215 filter_message ? filter_message : US"delivery cancelled";
6216 setflag(new, af_pass_message);
6217 goto RECIP_QUEUE_FAILED; /* below */
6220 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6221 than the value in timeout_frozen_after. Treat non-bounce messages
6222 similarly to -Mg; for bounce messages we just want to discard, so
6223 don't put the address on the failed list. The timeout has already
6226 case RECIP_FAIL_TIMEOUT:
6227 new->message = US"delivery cancelled; message timed out";
6228 goto RECIP_QUEUE_FAILED; /* below */
6231 /* RECIP_FAIL is set when -Mg has been used. */
6234 new->message = US"delivery cancelled by administrator";
6237 /* Common code for the failure cases above. If this is not a bounce
6238 message, put the address on the failed list so that it is used to
6239 create a bounce. Otherwise do nothing - this just discards the address.
6240 The incident has already been logged. */
6243 if (sender_address[0])
6245 new->next = addr_failed;
6251 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6252 in the message. Process each address as a routing failure; if this
6253 is a bounce message, it will get frozen. */
6255 case RECIP_FAIL_LOOP:
6256 new->message = US"Too many \"Received\" headers - suspected mail loop";
6257 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6261 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6264 if (!addr_new) addr_new = new; else addr_last->next = new;
6269 #ifndef DISABLE_EVENT
6270 if (process_recipients != RECIP_ACCEPT && event_action)
6272 uschar * save_local = deliver_localpart;
6273 const uschar * save_domain = deliver_domain;
6274 uschar * addr = new->address, * errmsg = NULL;
6275 int start, end, dom;
6277 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6278 log_write(0, LOG_MAIN|LOG_PANIC,
6279 "failed to parse address '%.100s': %s\n", addr, errmsg);
6283 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6284 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6286 event_raise(event_action, US"msg:fail:internal", new->message);
6288 deliver_localpart = save_local;
6289 deliver_domain = save_domain;
6297 debug_printf("Delivery address list:\n");
6298 for (address_item * p = addr_new; p; p = p->next)
6299 debug_printf(" %s %s\n", p->address,
6300 p->onetime_parent ? p->onetime_parent : US"");
6303 /* Set up the buffers used for copying over the file when delivering. */
6305 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6306 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6310 /* Until there are no more new addresses, handle each one as follows:
6312 . If this is a generated address (indicated by the presence of a parent
6313 pointer) then check to see whether it is a pipe, file, or autoreply, and
6314 if so, handle it directly here. The router that produced the address will
6315 have set the allow flags into the address, and also set the uid/gid required.
6316 Having the routers generate new addresses and then checking them here at
6317 the outer level is tidier than making each router do the checking, and
6318 means that routers don't need access to the failed address queue.
6320 . Break up the address into local part and domain, and make lowercased
6321 versions of these strings. We also make unquoted versions of the local part.
6323 . Handle the percent hack for those domains for which it is valid.
6325 . For child addresses, determine if any of the parents have the same address.
6326 If so, generate a different string for previous delivery checking. Without
6327 this code, if the address spqr generates spqr via a forward or alias file,
6328 delivery of the generated spqr stops further attempts at the top level spqr,
6329 which is not what is wanted - it may have generated other addresses.
6331 . Check on the retry database to see if routing was previously deferred, but
6332 only if in a queue run. Addresses that are to be routed are put on the
6333 addr_route chain. Addresses that are to be deferred are put on the
6334 addr_defer chain. We do all the checking first, so as not to keep the
6335 retry database open any longer than necessary.
6337 . Now we run the addresses through the routers. A router may put the address
6338 on either the addr_local or the addr_remote chain for local or remote
6339 delivery, respectively, or put it on the addr_failed chain if it is
6340 undeliveable, or it may generate child addresses and put them on the
6341 addr_new chain, or it may defer an address. All the chain anchors are
6342 passed as arguments so that the routers can be called for verification
6345 . If new addresses have been generated by the routers, da capo.
6348 f.header_rewritten = FALSE; /* No headers rewritten yet */
6349 while (addr_new) /* Loop until all addresses dealt with */
6351 address_item *addr, *parent;
6353 /* Failure to open the retry database is treated the same as if it does
6354 not exist. In both cases, dbm_file is NULL. */
6356 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6357 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6358 debug_printf("no retry data available\n");
6360 /* Scan the current batch of new addresses, to handle pipes, files and
6361 autoreplies, and determine which others are ready for routing. */
6368 dbdata_retry *domain_retry_record;
6369 dbdata_retry *address_retry_record;
6372 addr_new = addr->next;
6374 DEBUG(D_deliver|D_retry|D_route)
6376 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6377 debug_printf("Considering: %s\n", addr->address);
6380 /* Handle generated address that is a pipe or a file or an autoreply. */
6382 if (testflag(addr, af_pfr))
6384 /* If an autoreply in a filter could not generate a syntactically valid
6385 address, give up forthwith. Set af_ignore_error so that we don't try to
6386 generate a bounce. */
6388 if (testflag(addr, af_bad_reply))
6390 addr->basic_errno = ERRNO_BADADDRESS2;
6391 addr->local_part = addr->address;
6393 US"filter autoreply generated syntactically invalid recipient";
6394 addr->prop.ignore_error = TRUE;
6395 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6396 continue; /* with the next new address */
6399 /* If two different users specify delivery to the same pipe or file or
6400 autoreply, there should be two different deliveries, so build a unique
6401 string that incorporates the original address, and use this for
6402 duplicate testing and recording delivery, and also for retrying. */
6405 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6406 (testflag(addr->parent, af_homonym)? 3:0));
6408 addr->address_retry_key = addr->domain_retry_key =
6409 string_sprintf("T:%s", addr->unique);
6411 /* If a filter file specifies two deliveries to the same pipe or file,
6412 we want to de-duplicate, but this is probably not wanted for two mail
6413 commands to the same address, where probably both should be delivered.
6414 So, we have to invent a different unique string in that case. Just
6415 keep piling '>' characters on the front. */
6417 if (addr->address[0] == '>')
6418 while (tree_search(tree_duplicates, addr->unique))
6419 addr->unique = string_sprintf(">%s", addr->unique);
6421 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6423 DEBUG(D_deliver|D_route)
6424 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6425 addr->dupof = tnode->data.ptr;
6426 addr->next = addr_duplicate;
6427 addr_duplicate = addr;
6431 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6433 /* Check for previous delivery */
6435 if (tree_search(tree_nonrecipients, addr->unique))
6437 DEBUG(D_deliver|D_route)
6438 debug_printf("%s was previously delivered: discarded\n", addr->address);
6439 child_done(addr, tod_stamp(tod_log));
6443 /* Save for checking future duplicates */
6445 tree_add_duplicate(addr->unique, addr);
6447 /* Set local part and domain */
6449 addr->local_part = addr->address;
6450 addr->domain = addr->parent->domain;
6452 /* Ensure that the delivery is permitted. */
6454 if (testflag(addr, af_file))
6456 if (!testflag(addr, af_allow_file))
6458 addr->basic_errno = ERRNO_FORBIDFILE;
6459 addr->message = US"delivery to file forbidden";
6460 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6461 continue; /* with the next new address */
6464 else if (addr->address[0] == '|')
6466 if (!testflag(addr, af_allow_pipe))
6468 addr->basic_errno = ERRNO_FORBIDPIPE;
6469 addr->message = US"delivery to pipe forbidden";
6470 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6471 continue; /* with the next new address */
6474 else if (!testflag(addr, af_allow_reply))
6476 addr->basic_errno = ERRNO_FORBIDREPLY;
6477 addr->message = US"autoreply forbidden";
6478 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6479 continue; /* with the next new address */
6482 /* If the errno field is already set to BADTRANSPORT, it indicates
6483 failure to expand a transport string, or find the associated transport,
6484 or an unset transport when one is required. Leave this test till now so
6485 that the forbid errors are given in preference. */
6487 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6489 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6493 /* Treat /dev/null as a special case and abandon the delivery. This
6494 avoids having to specify a uid on the transport just for this case.
6495 Arrange for the transport name to be logged as "**bypassed**". */
6497 if (Ustrcmp(addr->address, "/dev/null") == 0)
6499 uschar *save = addr->transport->name;
6500 addr->transport->name = US"**bypassed**";
6501 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6502 addr->transport->name = save;
6503 continue; /* with the next new address */
6506 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6509 DEBUG(D_deliver|D_route)
6510 debug_printf("queued for %s transport\n", addr->transport->name);
6511 addr->next = addr_local;
6513 continue; /* with the next new address */
6516 /* Handle normal addresses. First, split up into local part and domain,
6517 handling the %-hack if necessary. There is the possibility of a defer from
6518 a lookup in percent_hack_domains. */
6520 if ((rc = deliver_split_address(addr)) == DEFER)
6522 addr->message = US"cannot check percent_hack_domains";
6523 addr->basic_errno = ERRNO_LISTDEFER;
6524 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6528 /* Check to see if the domain is held. If so, proceed only if the
6529 delivery was forced by hand. */
6531 deliver_domain = addr->domain; /* set $domain */
6532 if ( !forced && hold_domains
6533 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6534 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6540 addr->message = US"hold_domains lookup deferred";
6541 addr->basic_errno = ERRNO_LISTDEFER;
6545 addr->message = US"domain is held";
6546 addr->basic_errno = ERRNO_HELD;
6548 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6552 /* Now we can check for duplicates and previously delivered addresses. In
6553 order to do this, we have to generate a "unique" value for each address,
6554 because there may be identical actual addresses in a line of descendents.
6555 The "unique" field is initialized to the same value as the "address" field,
6556 but gets changed here to cope with identically-named descendents. */
6558 for (parent = addr->parent; parent; parent = parent->parent)
6559 if (strcmpic(addr->address, parent->address) == 0) break;
6561 /* If there's an ancestor with the same name, set the homonym flag. This
6562 influences how deliveries are recorded. Then add a prefix on the front of
6563 the unique address. We use \n\ where n starts at 0 and increases each time.
6564 It is unlikely to pass 9, but if it does, it may look odd but will still
6565 work. This means that siblings or cousins with the same names are treated
6566 as duplicates, which is what we want. */
6570 setflag(addr, af_homonym);
6571 if (parent->unique[0] != '\\')
6572 addr->unique = string_sprintf("\\0\\%s", addr->address);
6574 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6578 /* Ensure that the domain in the unique field is lower cased, because
6579 domains are always handled caselessly. */
6581 p = Ustrrchr(addr->unique, '@');
6582 while (*p != 0) { *p = tolower(*p); p++; }
6584 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6586 if (tree_search(tree_nonrecipients, addr->unique))
6588 DEBUG(D_deliver|D_route)
6589 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6590 child_done(addr, tod_stamp(tod_log));
6594 /* Get the routing retry status, saving the two retry keys (with and
6595 without the local part) for subsequent use. If there is no retry record for
6596 the standard address routing retry key, we look for the same key with the
6597 sender attached, because this form is used by the smtp transport after a
6598 4xx response to RCPT when address_retry_include_sender is true. */
6600 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6601 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6606 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6607 if ( domain_retry_record
6608 && now - domain_retry_record->time_stamp > retry_data_expire
6611 DEBUG(D_deliver|D_retry)
6612 debug_printf("domain retry record present but expired\n");
6613 domain_retry_record = NULL; /* Ignore if too old */
6616 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6617 if ( address_retry_record
6618 && now - address_retry_record->time_stamp > retry_data_expire
6621 DEBUG(D_deliver|D_retry)
6622 debug_printf("address retry record present but expired\n");
6623 address_retry_record = NULL; /* Ignore if too old */
6626 if (!address_retry_record)
6628 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6630 address_retry_record = dbfn_read(dbm_file, altkey);
6631 if ( address_retry_record
6632 && now - address_retry_record->time_stamp > retry_data_expire)
6634 DEBUG(D_deliver|D_retry)
6635 debug_printf("address<sender> retry record present but expired\n");
6636 address_retry_record = NULL; /* Ignore if too old */
6641 domain_retry_record = address_retry_record = NULL;
6643 DEBUG(D_deliver|D_retry)
6645 if (!domain_retry_record)
6646 debug_printf("no domain retry record\n");
6648 debug_printf("have domain retry record; next_try = now%+d\n",
6649 f.running_in_test_harness ? 0 :
6650 (int)(domain_retry_record->next_try - now));
6652 if (!address_retry_record)
6653 debug_printf("no address retry record\n");
6655 debug_printf("have address retry record; next_try = now%+d\n",
6656 f.running_in_test_harness ? 0 :
6657 (int)(address_retry_record->next_try - now));
6660 /* If we are sending a message down an existing SMTP connection, we must
6661 assume that the message which created the connection managed to route
6662 an address to that connection. We do not want to run the risk of taking
6663 a long time over routing here, because if we do, the server at the other
6664 end of the connection may time it out. This is especially true for messages
6665 with lots of addresses. For this kind of delivery, queue_running is not
6666 set, so we would normally route all addresses. We take a pragmatic approach
6667 and defer routing any addresses that have any kind of domain retry record.
6668 That is, we don't even look at their retry times. It doesn't matter if this
6669 doesn't work occasionally. This is all just an optimization, after all.
6671 The reason for not doing the same for address retries is that they normally
6672 arise from 4xx responses, not DNS timeouts. */
6674 if (continue_hostname && domain_retry_record)
6676 addr->message = US"reusing SMTP connection skips previous routing defer";
6677 addr->basic_errno = ERRNO_RRETRY;
6678 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6680 addr->message = domain_retry_record->text;
6681 setflag(addr, af_pass_message);
6684 /* If we are in a queue run, defer routing unless there is no retry data or
6685 we've passed the next retry time, or this message is forced. In other
6686 words, ignore retry data when not in a queue run.
6688 However, if the domain retry time has expired, always allow the routing
6689 attempt. If it fails again, the address will be failed. This ensures that
6690 each address is routed at least once, even after long-term routing
6693 If there is an address retry, check that too; just wait for the next
6694 retry time. This helps with the case when the temporary error on the
6695 address was really message-specific rather than address specific, since
6696 it allows other messages through.
6698 We also wait for the next retry time if this is a message sent down an
6699 existing SMTP connection (even though that will be forced). Otherwise there
6700 will be far too many attempts for an address that gets a 4xx error. In
6701 fact, after such an error, we should not get here because, the host should
6702 not be remembered as one this message needs. However, there was a bug that
6703 used to cause this to happen, so it is best to be on the safe side.
6705 Even if we haven't reached the retry time in the hints, there is one more
6706 check to do, which is for the ultimate address timeout. We only do this
6707 check if there is an address retry record and there is not a domain retry
6708 record; this implies that previous attempts to handle the address had the
6709 retry_use_local_parts option turned on. We use this as an approximation
6710 for the destination being like a local delivery, for example delivery over
6711 LMTP to an IMAP message store. In this situation users are liable to bump
6712 into their quota and thereby have intermittently successful deliveries,
6713 which keep the retry record fresh, which can lead to us perpetually
6714 deferring messages. */
6716 else if ( ( f.queue_running && !f.deliver_force
6717 || continue_hostname
6719 && ( ( domain_retry_record
6720 && now < domain_retry_record->next_try
6721 && !domain_retry_record->expired
6723 || ( address_retry_record
6724 && now < address_retry_record->next_try
6726 && ( domain_retry_record
6727 || !address_retry_record
6728 || !retry_ultimate_address_timeout(addr->address_retry_key,
6729 addr->domain, address_retry_record, now)
6732 addr->message = US"retry time not reached";
6733 addr->basic_errno = ERRNO_RRETRY;
6734 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6736 /* For remote-retry errors (here and just above) that we've not yet
6737 hit the rery time, use the error recorded in the retry database
6738 as info in the warning message. This lets us send a message even
6739 when we're not failing on a fresh attempt. We assume that this
6740 info is not sensitive. */
6742 addr->message = domain_retry_record
6743 ? domain_retry_record->text : address_retry_record->text;
6744 setflag(addr, af_pass_message);
6747 /* The domain is OK for routing. Remember if retry data exists so it
6748 can be cleaned up after a successful delivery. */
6752 if (domain_retry_record || address_retry_record)
6753 setflag(addr, af_dr_retry_exists);
6754 addr->next = addr_route;
6756 DEBUG(D_deliver|D_route)
6757 debug_printf("%s: queued for routing\n", addr->address);
6761 /* The database is closed while routing is actually happening. Requests to
6762 update it are put on a chain and all processed together at the end. */
6764 if (dbm_file) dbfn_close(dbm_file);
6766 /* If queue_domains is set, we don't even want to try routing addresses in
6767 those domains. During queue runs, queue_domains is forced to be unset.
6768 Optimize by skipping this pass through the addresses if nothing is set. */
6770 if (!f.deliver_force && queue_domains)
6772 address_item *okaddr = NULL;
6775 address_item *addr = addr_route;
6776 addr_route = addr->next;
6778 deliver_domain = addr->domain; /* set $domain */
6779 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6780 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6784 addr->basic_errno = ERRNO_LISTDEFER;
6785 addr->message = US"queue_domains lookup deferred";
6786 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6790 addr->next = okaddr;
6795 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6796 addr->message = US"domain is in queue_domains";
6797 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6801 addr_route = okaddr;
6804 /* Now route those addresses that are not deferred. */
6809 address_item *addr = addr_route;
6810 const uschar *old_domain = addr->domain;
6811 uschar *old_unique = addr->unique;
6812 addr_route = addr->next;
6815 /* Just in case some router parameter refers to it. */
6817 if (!(return_path = addr->prop.errors_address))
6818 return_path = sender_address;
6820 /* If a router defers an address, add a retry item. Whether or not to
6821 use the local part in the key is a property of the router. */
6823 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6824 &addr_succeed, v_none)) == DEFER)
6825 retry_add_item(addr,
6826 addr->router->retry_use_local_part
6827 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6828 : string_sprintf("R:%s", addr->domain),
6831 /* Otherwise, if there is an existing retry record in the database, add
6832 retry items to delete both forms. We must also allow for the possibility
6833 of a routing retry that includes the sender address. Since the domain might
6834 have been rewritten (expanded to fully qualified) as a result of routing,
6835 ensure that the rewritten form is also deleted. */
6837 else if (testflag(addr, af_dr_retry_exists))
6839 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6841 retry_add_item(addr, altkey, rf_delete);
6842 retry_add_item(addr, addr->address_retry_key, rf_delete);
6843 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6844 if (Ustrcmp(addr->domain, old_domain) != 0)
6845 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6848 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6849 logged, but we need to ensure the address (and maybe parents) is marked
6854 address_done(addr, tod_stamp(tod_log));
6855 continue; /* route next address */
6858 /* The address is finished with (failed or deferred). */
6862 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6863 continue; /* route next address */
6866 /* The address has been routed. If the router changed the domain, it will
6867 also have changed the unique address. We have to test whether this address
6868 has already been delivered, because it's the unique address that finally
6871 if ( addr->unique != old_unique
6872 && tree_search(tree_nonrecipients, addr->unique) != 0
6875 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6876 "discarded\n", addr->address);
6877 if (addr_remote == addr) addr_remote = addr->next;
6878 else if (addr_local == addr) addr_local = addr->next;
6881 /* If the router has same_domain_copy_routing set, we are permitted to copy
6882 the routing for any other addresses with the same domain. This is an
6883 optimisation to save repeated DNS lookups for "standard" remote domain
6884 routing. The option is settable only on routers that generate host lists.
6885 We play it very safe, and do the optimization only if the address is routed
6886 to a remote transport, there are no header changes, and the domain was not
6887 modified by the router. */
6889 if ( addr_remote == addr
6890 && addr->router->same_domain_copy_routing
6891 && !addr->prop.extra_headers
6892 && !addr->prop.remove_headers
6893 && old_domain == addr->domain
6896 address_item **chain = &addr_route;
6899 address_item *addr2 = *chain;
6900 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6902 chain = &(addr2->next);
6906 /* Found a suitable address; take it off the routing list and add it to
6907 the remote delivery list. */
6909 *chain = addr2->next;
6910 addr2->next = addr_remote;
6911 addr_remote = addr2;
6913 /* Copy the routing data */
6915 addr2->domain = addr->domain;
6916 addr2->router = addr->router;
6917 addr2->transport = addr->transport;
6918 addr2->host_list = addr->host_list;
6919 addr2->fallback_hosts = addr->fallback_hosts;
6920 addr2->prop.errors_address = addr->prop.errors_address;
6921 copyflag(addr2, addr, af_hide_child);
6922 copyflag(addr2, addr, af_local_host_removed);
6924 DEBUG(D_deliver|D_route)
6925 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6927 "Routing for %s copied from %s\n",
6928 addr2->address, addr2->address, addr->address);
6931 } /* Continue with routing the next address. */
6932 } /* Loop to process any child addresses that the routers created, and
6933 any rerouted addresses that got put back on the new chain. */
6936 /* Debugging: show the results of the routing */
6938 DEBUG(D_deliver|D_retry|D_route)
6940 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6941 debug_printf("After routing:\n Local deliveries:\n");
6942 for (address_item * p = addr_local; p; p = p->next)
6943 debug_printf(" %s\n", p->address);
6945 debug_printf(" Remote deliveries:\n");
6946 for (address_item * p = addr_remote; p; p = p->next)
6947 debug_printf(" %s\n", p->address);
6949 debug_printf(" Failed addresses:\n");
6950 for (address_item * p = addr_failed; p; p = p->next)
6951 debug_printf(" %s\n", p->address);
6953 debug_printf(" Deferred addresses:\n");
6954 for (address_item * p = addr_defer; p; p = p->next)
6955 debug_printf(" %s\n", p->address);
6958 /* Free any resources that were cached during routing. */
6963 /* These two variables are set only during routing, after check_local_user.
6964 Ensure they are not set in transports. */
6966 local_user_gid = (gid_t)(-1);
6967 local_user_uid = (uid_t)(-1);
6969 /* Check for any duplicate addresses. This check is delayed until after
6970 routing, because the flexibility of the routing configuration means that
6971 identical addresses with different parentage may end up being redirected to
6972 different addresses. Checking for duplicates too early (as we previously used
6973 to) makes this kind of thing not work. */
6975 do_duplicate_check(&addr_local);
6976 do_duplicate_check(&addr_remote);
6978 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6979 remote transport. The check that they all end up in one transaction happens in
6980 the do_remote_deliveries() function. */
6983 && (addr_local || addr_failed || addr_defer)
6987 uschar *which, *colon, *msg;
6994 else if (addr_defer)
6997 which = US"deferred";
7005 while (addr->parent) addr = addr->parent;
7010 msg = addr->message;
7012 else colon = msg = US"";
7014 /* We don't need to log here for a forced failure as it will already
7015 have been logged. Defer will also have been logged, but as a defer, so we do
7016 need to do the failure logging. */
7018 if (addr != addr_failed)
7019 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7020 addr->address, which);
7022 /* Always write an error to the caller */
7024 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7027 final_yield = DELIVER_MUA_FAILED;
7028 addr_failed = addr_defer = NULL; /* So that we remove the message */
7029 goto DELIVERY_TIDYUP;
7033 /* If this is a run to continue deliveries to an external channel that is
7034 already set up, defer any local deliveries. */
7036 if (continue_transport)
7040 address_item *addr = addr_defer;
7041 while (addr->next) addr = addr->next;
7042 addr->next = addr_local;
7045 addr_defer = addr_local;
7050 /* Because address rewriting can happen in the routers, we should not really do
7051 ANY deliveries until all addresses have been routed, so that all recipients of
7052 the message get the same headers. However, this is in practice not always
7053 possible, since sometimes remote addresses give DNS timeouts for days on end.
7054 The pragmatic approach is to deliver what we can now, saving any rewritten
7055 headers so that at least the next lot of recipients benefit from the rewriting
7056 that has already been done.
7058 If any headers have been rewritten during routing, update the spool file to
7059 remember them for all subsequent deliveries. This can be delayed till later if
7060 there is only address to be delivered - if it succeeds the spool write need not
7063 if ( f.header_rewritten
7064 && ( addr_local && (addr_local->next || addr_remote)
7065 || addr_remote && addr_remote->next
7068 /* Panic-dies on error */
7069 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7070 f.header_rewritten = FALSE;
7074 /* If there are any deliveries to do and we do not already have the journal
7075 file, create it. This is used to record successful deliveries as soon as
7076 possible after each delivery is known to be complete. A file opened with
7077 O_APPEND is used so that several processes can run simultaneously.
7079 The journal is just insurance against crashes. When the spool file is
7080 ultimately updated at the end of processing, the journal is deleted. If a
7081 journal is found to exist at the start of delivery, the addresses listed
7082 therein are added to the non-recipients. */
7084 if (addr_local || addr_remote)
7088 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7090 if ((journal_fd = Uopen(fname,
7094 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7096 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7097 fname, strerror(errno));
7098 return DELIVER_NOT_ATTEMPTED;
7101 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7102 that the mode is correct - the group setting doesn't always seem to get
7103 set automatically. */
7105 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7106 || fchmod(journal_fd, SPOOL_MODE)
7108 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7112 int ret = Uunlink(fname);
7113 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7114 fname, strerror(errno));
7115 if(ret && errno != ENOENT)
7116 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7117 fname, strerror(errno));
7118 return DELIVER_NOT_ATTEMPTED;
7122 else if (journal_fd >= 0)
7130 /* Now we can get down to the business of actually doing deliveries. Local
7131 deliveries are done first, then remote ones. If ever the problems of how to
7132 handle fallback transports are figured out, this section can be put into a loop
7133 for handling fallbacks, though the uid switching will have to be revised. */
7135 /* Precompile a regex that is used to recognize a parameter in response
7136 to an LHLO command, if is isn't already compiled. This may be used on both
7137 local and remote LMTP deliveries. */
7139 if (!regex_IGNOREQUOTA)
7141 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7143 /* Handle local deliveries */
7147 DEBUG(D_deliver|D_transport)
7148 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7149 do_local_deliveries();
7150 f.disable_logging = FALSE;
7153 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7154 so just queue them all. */
7156 if (f.queue_run_local)
7159 address_item *addr = addr_remote;
7160 addr_remote = addr->next;
7162 addr->basic_errno = ERRNO_LOCAL_ONLY;
7163 addr->message = US"remote deliveries suppressed";
7164 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7167 /* Handle remote deliveries */
7171 DEBUG(D_deliver|D_transport)
7172 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7174 /* Precompile some regex that are used to recognize parameters in response
7175 to an EHLO command, if they aren't already compiled. */
7179 /* Now sort the addresses if required, and do the deliveries. The yield of
7180 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7181 cannot be delivered in one transaction. */
7183 if (remote_sort_domains) sort_remote_deliveries();
7184 if (!do_remote_deliveries(FALSE))
7186 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7187 "be delivered in one transaction");
7188 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7190 final_yield = DELIVER_MUA_FAILED;
7191 addr_failed = addr_defer = NULL; /* So that we remove the message */
7192 goto DELIVERY_TIDYUP;
7195 /* See if any of the addresses that failed got put on the queue for delivery
7196 to their fallback hosts. We do it this way because often the same fallback
7197 host is used for many domains, so all can be sent in a single transaction
7198 (if appropriately configured). */
7200 if (addr_fallback && !mua_wrapper)
7202 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7203 addr_remote = addr_fallback;
7204 addr_fallback = NULL;
7205 if (remote_sort_domains) sort_remote_deliveries();
7206 do_remote_deliveries(TRUE);
7208 f.disable_logging = FALSE;
7212 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7213 phase, to minimize cases of half-done things. */
7216 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7217 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7219 /* Root privilege is no longer needed */
7221 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7223 set_process_info("tidying up after delivering %s", message_id);
7224 signal(SIGTERM, SIG_IGN);
7226 /* When we are acting as an MUA wrapper, the smtp transport will either have
7227 succeeded for all addresses, or failed them all in normal cases. However, there
7228 are some setup situations (e.g. when a named port does not exist) that cause an
7229 immediate exit with deferral of all addresses. Convert those into failures. We
7230 do not ever want to retry, nor do we want to send a bounce message. */
7236 address_item * nextaddr;
7237 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7239 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7240 "delivery", addr->address);
7241 nextaddr = addr->next;
7242 addr->next = addr_failed;
7248 /* Now all should either have succeeded or failed. */
7251 final_yield = DELIVER_MUA_SUCCEEDED;
7255 uschar *s = addr_failed->user_message;
7257 if (!s) s = addr_failed->message;
7259 fprintf(stderr, "Delivery failed: ");
7260 if (addr_failed->basic_errno > 0)
7262 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7263 if (s) fprintf(stderr, ": ");
7265 if ((host = addr_failed->host_used))
7266 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7268 fprintf(stderr, "%s", CS s);
7269 else if (addr_failed->basic_errno <= 0)
7270 fprintf(stderr, "unknown error");
7271 fprintf(stderr, "\n");
7273 final_yield = DELIVER_MUA_FAILED;
7278 /* In a normal configuration, we now update the retry database. This is done in
7279 one fell swoop at the end in order not to keep opening and closing (and
7280 locking) the database. The code for handling retries is hived off into a
7281 separate module for convenience. We pass it the addresses of the various
7282 chains, because deferred addresses can get moved onto the failed chain if the
7283 retry cutoff time has expired for all alternative destinations. Bypass the
7284 updating of the database if the -N flag is set, which is a debugging thing that
7285 prevents actual delivery. */
7287 else if (!f.dont_deliver)
7288 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7290 /* Send DSN for successful messages if requested */
7291 addr_senddsn = NULL;
7293 for (address_item * a = addr_succeed; a; a = a->next)
7295 /* af_ignore_error not honored here. it's not an error */
7296 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7297 "DSN: processing successful delivery address: %s\n"
7298 "DSN: Sender_address: %s\n"
7299 "DSN: orcpt: %s flags: 0x%x\n"
7300 "DSN: envid: %s ret: %d\n"
7301 "DSN: Final recipient: %s\n"
7302 "DSN: Remote SMTP server supports DSN: %d\n",
7303 a->router ? a->router->name : US"(unknown)",
7306 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7308 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7313 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7314 and a report was requested */
7315 if ( ( a->dsn_aware != dsn_support_yes
7316 || a->dsn_flags & rf_dsnlasthop
7318 && a->dsn_flags & rf_notify_success
7321 /* copy and relink address_item and send report with all of them at once later */
7322 address_item * addr_next = addr_senddsn;
7323 addr_senddsn = store_get(sizeof(address_item), FALSE);
7325 addr_senddsn->next = addr_next;
7328 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7336 /* create exim process to send message */
7337 pid = child_open_exim(&fd);
7339 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7341 if (pid < 0) /* Creation of child failed */
7343 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7344 "create child process to send failure message: %s", getpid(),
7345 getppid(), strerror(errno));
7347 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7349 else /* Creation of child succeeded */
7351 FILE * f = fdopen(fd, "wb");
7352 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7354 transport_ctx tctx = {{0}};
7357 debug_printf("sending error message to: %s\n", sender_address);
7359 /* build unique id for MIME boundary */
7360 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7361 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7363 if (errors_reply_to)
7364 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7367 fprintf(f, "Auto-Submitted: auto-generated\n"
7369 "Subject: Delivery Status Notification\n"
7370 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7371 "MIME-Version: 1.0\n\n"
7374 "Content-type: text/plain; charset=us-ascii\n\n"
7376 "This message was created automatically by mail delivery software.\n"
7377 " ----- The following addresses had successful delivery notifications -----\n",
7378 sender_address, bound, bound);
7380 for (address_item * a = addr_senddsn; a; a = a->next)
7381 fprintf(f, "<%s> (relayed %s)\n\n",
7383 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7384 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7385 : "via non \"Remote SMTP\" router"
7389 "Content-type: message/delivery-status\n\n"
7390 "Reporting-MTA: dns; %s\n",
7391 bound, smtp_active_hostname);
7394 { /* must be decoded from xtext: see RFC 3461:6.3a */
7396 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7397 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7399 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7403 for (address_item * a = addr_senddsn; a; a = a->next)
7407 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7409 if ((hu = a->host_used) && hu->name)
7410 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7413 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7414 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7417 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7420 transport_filter_argv = NULL; /* Just in case */
7421 return_path = sender_address; /* In case not previously set */
7423 /* Write the original email out */
7426 tctx.options = topt_add_return_path | topt_no_body;
7427 /*XXX hmm, FALSE(fail) retval ignored.
7428 Could error for any number of reasons, and they are not handled. */
7429 transport_write_message(&tctx, 0);
7432 fprintf(f,"\n--%s--\n", bound);
7436 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7440 /* If any addresses failed, we must send a message to somebody, unless
7441 af_ignore_error is set, in which case no action is taken. It is possible for
7442 several messages to get sent if there are addresses with different
7449 uschar *logtod = tod_stamp(tod_log);
7451 address_item *handled_addr = NULL;
7452 address_item **paddr;
7453 address_item *msgchain = NULL;
7454 address_item **pmsgchain = &msgchain;
7456 /* There are weird cases when logging is disabled in the transport. However,
7457 there may not be a transport (address failed by a router). */
7459 f.disable_logging = FALSE;
7460 if (addr_failed->transport)
7461 f.disable_logging = addr_failed->transport->disable_logging;
7464 debug_printf("processing failed address %s\n", addr_failed->address);
7466 /* There are only two ways an address in a bounce message can get here:
7468 (1) When delivery was initially deferred, but has now timed out (in the call
7469 to retry_update() above). We can detect this by testing for
7470 af_retry_timedout. If the address does not have its own errors address,
7471 we arrange to ignore the error.
7473 (2) If delivery failures for bounce messages are being ignored. We can detect
7474 this by testing for af_ignore_error. This will also be set if a bounce
7475 message has been autothawed and the ignore_bounce_errors_after time has
7476 passed. It might also be set if a router was explicitly configured to
7477 ignore errors (errors_to = "").
7479 If neither of these cases obtains, something has gone wrong. Log the
7480 incident, but then ignore the error. */
7482 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7484 if ( !testflag(addr_failed, af_retry_timedout)
7485 && !addr_failed->prop.ignore_error)
7486 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7487 "failure is neither frozen nor ignored (it's been ignored)");
7489 addr_failed->prop.ignore_error = TRUE;
7492 /* If the first address on the list has af_ignore_error set, just remove
7493 it from the list, throw away any saved message file, log it, and
7494 mark the recipient done. */
7496 if ( addr_failed->prop.ignore_error
7497 || addr_failed->dsn_flags & rf_dsnflags
7498 && !(addr_failed->dsn_flags & rf_notify_failure)
7502 addr_failed = addr->next;
7503 if (addr->return_filename) Uunlink(addr->return_filename);
7505 #ifndef DISABLE_EVENT
7506 msg_event_raise(US"msg:fail:delivery", addr);
7508 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7510 !addr->parent ? US"" : US" <",
7511 !addr->parent ? US"" : addr->parent->address,
7512 !addr->parent ? US"" : US">",
7513 addr->prop.ignore_error
7514 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7516 address_done(addr, logtod);
7517 child_done(addr, logtod);
7518 /* Panic-dies on error */
7519 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7522 /* Otherwise, handle the sending of a message. Find the error address for
7523 the first address, then send a message that includes all failed addresses
7524 that have the same error address. Note the bounce_recipient is a global so
7525 that it can be accessed by $bounce_recipient while creating a customized
7530 if (!(bounce_recipient = addr_failed->prop.errors_address))
7531 bounce_recipient = sender_address;
7533 /* Make a subprocess to send a message */
7535 if ((pid = child_open_exim(&fd)) < 0)
7536 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7537 "create child process to send failure message: %s", getpid(),
7538 getppid(), strerror(errno));
7540 /* Creation of child succeeded */
7547 uschar *bcc, *emf_text;
7548 FILE * fp = fdopen(fd, "wb");
7550 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7551 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7552 DELIVER_IN_BUFFER_SIZE;
7554 uschar *dsnlimitmsg;
7555 uschar *dsnnotifyhdr;
7559 debug_printf("sending error message to: %s\n", bounce_recipient);
7561 /* Scan the addresses for all that have the same errors address, removing
7562 them from the addr_failed chain, and putting them on msgchain. */
7564 paddr = &addr_failed;
7565 for (addr = addr_failed; addr; addr = *paddr)
7566 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7567 ? addr->prop.errors_address : sender_address) == 0)
7568 { /* The same - dechain */
7569 *paddr = addr->next;
7572 pmsgchain = &(addr->next);
7575 paddr = &addr->next; /* Not the same; skip */
7577 /* Include X-Failed-Recipients: for automatic interpretation, but do
7578 not let any one header line get too long. We do this by starting a
7579 new header every 50 recipients. Omit any addresses for which the
7580 "hide_child" flag is set. */
7582 for (addr = msgchain; addr; addr = addr->next)
7584 if (testflag(addr, af_hide_child)) continue;
7592 ? "X-Failed-Recipients: "
7594 testflag(addr, af_pfr) && addr->parent
7595 ? string_printing(addr->parent->address)
7596 : string_printing(addr->address));
7598 if (rcount > 0) fprintf(fp, "\n");
7600 /* Output the standard headers */
7602 if (errors_reply_to)
7603 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7604 fprintf(fp, "Auto-Submitted: auto-replied\n");
7605 moan_write_from(fp);
7606 fprintf(fp, "To: %s\n", bounce_recipient);
7608 /* generate boundary string and output MIME-Headers */
7609 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7611 fprintf(fp, "Content-Type: multipart/report;"
7612 " report-type=delivery-status; boundary=%s\n"
7613 "MIME-Version: 1.0\n",
7616 /* Open a template file if one is provided. Log failure to open, but
7617 carry on - default texts will be used. */
7619 if (bounce_message_file)
7620 if (!(emf = Ufopen(bounce_message_file, "rb")))
7621 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7622 "message texts: %s", bounce_message_file, strerror(errno));
7624 /* Quietly copy to configured additional addresses if required. */
7626 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7627 fprintf(fp, "Bcc: %s\n", bcc);
7629 /* The texts for the message can be read from a template file; if there
7630 isn't one, or if it is too short, built-in texts are used. The first
7631 emf text is a Subject: and any other headers. */
7633 if ((emf_text = next_emf(emf, US"header")))
7634 fprintf(fp, "%s\n", emf_text);
7636 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7637 to_sender? ": returning message to sender" : "");
7639 /* output human readable part as text/plain section */
7640 fprintf(fp, "--%s\n"
7641 "Content-type: text/plain; charset=us-ascii\n\n",
7644 if ((emf_text = next_emf(emf, US"intro")))
7645 fprintf(fp, "%s", CS emf_text);
7649 /* This message has been reworded several times. It seems to be confusing to
7650 somebody, however it is worded. I have retreated to the original, simple
7652 "This message was created automatically by mail delivery software.\n");
7654 if (bounce_message_text)
7655 fprintf(fp, "%s", CS bounce_message_text);
7658 "\nA message that you sent could not be delivered to one or more of its\n"
7659 "recipients. This is a permanent error. The following address(es) failed:\n");
7662 "\nA message sent by\n\n <%s>\n\n"
7663 "could not be delivered to one or more of its recipients. The following\n"
7664 "address(es) failed:\n", sender_address);
7668 /* Process the addresses, leaving them on the msgchain if they have a
7669 file name for a return message. (There has already been a check in
7670 post_process_one() for the existence of data in the message file.) A TRUE
7671 return from print_address_information() means that the address is not
7675 for (addr = msgchain; addr; addr = *paddr)
7677 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7678 print_address_error(addr, fp, US"");
7680 /* End the final line for the address */
7684 /* Leave on msgchain if there's a return file. */
7686 if (addr->return_file >= 0)
7688 paddr = &(addr->next);
7692 /* Else save so that we can tick off the recipient when the
7697 *paddr = addr->next;
7698 addr->next = handled_addr;
7699 handled_addr = addr;
7705 /* Get the next text, whether we need it or not, so as to be
7706 positioned for the one after. */
7708 emf_text = next_emf(emf, US"generated text");
7710 /* If there were any file messages passed by the local transports,
7711 include them in the message. Then put the address on the handled chain.
7712 In the case of a batch of addresses that were all sent to the same
7713 transport, the return_file field in all of them will contain the same
7714 fd, and the return_filename field in the *last* one will be set (to the
7715 name of the file). */
7719 address_item *nextaddr;
7722 fprintf(fp, "%s", CS emf_text);
7725 "The following text was generated during the delivery "
7726 "attempt%s:\n", (filecount > 1)? "s" : "");
7728 for (addr = msgchain; addr; addr = nextaddr)
7731 address_item *topaddr = addr;
7733 /* List all the addresses that relate to this file */
7736 while(addr) /* Insurance */
7738 print_address_information(addr, fp, US"------ ", US"\n ",
7740 if (addr->return_filename) break;
7745 /* Now copy the file */
7747 if (!(fm = Ufopen(addr->return_filename, "rb")))
7748 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7752 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7755 Uunlink(addr->return_filename);
7757 /* Can now add to handled chain, first fishing off the next
7758 address on the msgchain. */
7760 nextaddr = addr->next;
7761 addr->next = handled_addr;
7762 handled_addr = topaddr;
7767 /* output machine readable part */
7769 if (message_smtputf8)
7770 fprintf(fp, "--%s\n"
7771 "Content-type: message/global-delivery-status\n\n"
7772 "Reporting-MTA: dns; %s\n",
7773 bound, smtp_active_hostname);
7776 fprintf(fp, "--%s\n"
7777 "Content-type: message/delivery-status\n\n"
7778 "Reporting-MTA: dns; %s\n",
7779 bound, smtp_active_hostname);
7783 /* must be decoded from xtext: see RFC 3461:6.3a */
7785 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7786 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7788 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7792 for (addr = handled_addr; addr; addr = addr->next)
7796 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7798 if ((hu = addr->host_used) && hu->name)
7800 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7801 #ifdef EXPERIMENTAL_DSN_INFO
7806 uschar * p = hu->port == 25
7807 ? US"" : string_sprintf(":%d", hu->port);
7808 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7810 if ((s = addr->smtp_greeting) && *s)
7811 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7812 if ((s = addr->helo_response) && *s)
7813 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7814 if ((s = addr->message) && *s)
7815 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7818 print_dsn_diagnostic_code(addr, fp);
7823 /* Now copy the message, trying to give an intelligible comment if
7824 it is too long for it all to be copied. The limit isn't strictly
7825 applied because of the buffering. There is, however, an option
7826 to suppress copying altogether. */
7828 emf_text = next_emf(emf, US"copy");
7831 we ignore the intro text from template and add
7832 the text for bounce_return_size_limit at the end.
7834 bounce_return_message is ignored
7835 in case RET= is defined we honor these values
7836 otherwise bounce_return_body is honored.
7838 bounce_return_size_limit is always honored.
7841 fprintf(fp, "--%s\n", bound);
7843 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7844 dsnnotifyhdr = NULL;
7845 topt = topt_add_return_path;
7847 /* RET=HDRS? top priority */
7848 if (dsn_ret == dsn_ret_hdrs)
7849 topt |= topt_no_body;
7852 struct stat statbuf;
7854 /* no full body return at all? */
7855 if (!bounce_return_body)
7857 topt |= topt_no_body;
7858 /* add header if we overrule RET=FULL */
7859 if (dsn_ret == dsn_ret_full)
7860 dsnnotifyhdr = dsnlimitmsg;
7862 /* line length limited... return headers only if oversize */
7863 /* size limited ... return headers only if limit reached */
7864 else if ( max_received_linelength > bounce_return_linesize_limit
7865 || ( bounce_return_size_limit > 0
7866 && fstat(deliver_datafile, &statbuf) == 0
7867 && statbuf.st_size > max
7870 topt |= topt_no_body;
7871 dsnnotifyhdr = dsnlimitmsg;
7876 if (message_smtputf8)
7877 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7878 : "Content-type: message/global\n\n",
7882 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7883 : "Content-type: message/rfc822\n\n",
7887 transport_filter_argv = NULL; /* Just in case */
7888 return_path = sender_address; /* In case not previously set */
7889 { /* Dummy transport for headers add */
7890 transport_ctx tctx = {{0}};
7891 transport_instance tb = {0};
7893 tctx.u.fd = fileno(fp);
7895 tctx.options = topt;
7896 tb.add_headers = dsnnotifyhdr;
7898 /*XXX no checking for failure! buggy! */
7899 transport_write_message(&tctx, 0);
7903 /* we never add the final text. close the file */
7907 fprintf(fp, "\n--%s--\n", bound);
7909 /* Close the file, which should send an EOF to the child process
7910 that is receiving the message. Wait for it to finish. */
7913 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7915 /* In the test harness, let the child do it's thing first. */
7917 if (f.running_in_test_harness) millisleep(500);
7919 /* If the process failed, there was some disaster in setting up the
7920 error message. Unless the message is very old, ensure that addr_defer
7921 is non-null, which will have the effect of leaving the message on the
7922 spool. The failed addresses will get tried again next time. However, we
7923 don't really want this to happen too often, so freeze the message unless
7924 there are some genuine deferred addresses to try. To do this we have
7925 to call spool_write_header() here, because with no genuine deferred
7926 addresses the normal code below doesn't get run. */
7931 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7933 addr_defer = (address_item *)(+1);
7934 f.deliver_freeze = TRUE;
7935 deliver_frozen_at = time(NULL);
7936 /* Panic-dies on error */
7937 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7940 deliver_msglog("Process failed (%d) when writing error message "
7941 "to %s%s", rc, bounce_recipient, s);
7942 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7943 "to %s%s", rc, bounce_recipient, s);
7946 /* The message succeeded. Ensure that the recipients that failed are
7947 now marked finished with on the spool and their parents updated. */
7951 for (addr = handled_addr; addr; addr = addr->next)
7953 address_done(addr, logtod);
7954 child_done(addr, logtod);
7956 /* Panic-dies on error */
7957 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7963 f.disable_logging = FALSE; /* In case left set */
7965 /* Come here from the mua_wrapper case if routing goes wrong */
7969 /* If there are now no deferred addresses, we are done. Preserve the
7970 message log if so configured, and we are using them. Otherwise, sling it.
7971 Then delete the message itself. */
7979 fname = spool_fname(US"msglog", message_subdir, id, US"");
7980 if (preserve_message_logs)
7983 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7985 if ((rc = Urename(fname, moname)) < 0)
7987 (void)directory_make(spool_directory,
7988 spool_sname(US"msglog.OLD", US""),
7989 MSGLOG_DIRECTORY_MODE, TRUE);
7990 rc = Urename(fname, moname);
7993 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7994 "msglog.OLD directory", fname);
7997 if (Uunlink(fname) < 0)
7998 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7999 fname, strerror(errno));
8002 /* Remove the two message files. */
8004 fname = spool_fname(US"input", message_subdir, id, US"-D");
8005 if (Uunlink(fname) < 0)
8006 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8007 fname, strerror(errno));
8008 fname = spool_fname(US"input", message_subdir, id, US"-H");
8009 if (Uunlink(fname) < 0)
8010 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8011 fname, strerror(errno));
8013 /* Log the end of this message, with queue time if requested. */
8015 if (LOGGING(queue_time_overall))
8016 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8018 log_write(0, LOG_MAIN, "Completed");
8020 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8021 f.deliver_freeze = FALSE;
8023 #ifndef DISABLE_EVENT
8024 (void) event_raise(event_action, US"msg:complete", NULL);
8028 /* If there are deferred addresses, we are keeping this message because it is
8029 not yet completed. Lose any temporary files that were catching output from
8030 pipes for any of the deferred addresses, handle one-time aliases, and see if
8031 the message has been on the queue for so long that it is time to send a warning
8032 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8033 have the same domain, we can set deliver_domain for the expansion of
8034 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8035 the parent's domain.
8037 If all the deferred addresses have an error number that indicates "retry time
8038 not reached", skip sending the warning message, because it won't contain the
8039 reason for the delay. It will get sent at the next real delivery attempt.
8040 Exception: for retries caused by a remote peer we use the error message
8041 store in the retry DB as the reason.
8042 However, if at least one address has tried, we'd better include all of them in
8045 If we can't make a process to send the message, don't worry.
8047 For mailing list expansions we want to send the warning message to the
8048 mailing list manager. We can't do a perfect job here, as some addresses may
8049 have different errors addresses, but if we take the errors address from
8050 each deferred address it will probably be right in most cases.
8052 If addr_defer == +1, it means there was a problem sending an error message
8053 for failed addresses, and there were no "real" deferred addresses. The value
8054 was set just to keep the message on the spool, so there is nothing to do here.
8057 else if (addr_defer != (address_item *)(+1))
8059 uschar *recipients = US"";
8060 BOOL want_warning_msg = FALSE;
8062 deliver_domain = testflag(addr_defer, af_pfr)
8063 ? addr_defer->parent->domain : addr_defer->domain;
8065 for (address_item * addr = addr_defer; addr; addr = addr->next)
8067 address_item *otaddr;
8069 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8073 const uschar *d = testflag(addr, af_pfr)
8074 ? addr->parent->domain : addr->domain;
8076 /* The domain may be unset for an address that has never been routed
8077 because the system filter froze the message. */
8079 if (!d || Ustrcmp(d, deliver_domain) != 0)
8080 deliver_domain = NULL;
8083 if (addr->return_filename) Uunlink(addr->return_filename);
8085 /* Handle the case of one-time aliases. If any address in the ancestry
8086 of this one is flagged, ensure it is in the recipients list, suitably
8087 flagged, and that its parent is marked delivered. */
8089 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8090 if (otaddr->onetime_parent) break;
8095 int t = recipients_count;
8097 for (i = 0; i < recipients_count; i++)
8099 uschar *r = recipients_list[i].address;
8100 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8101 if (Ustrcmp(otaddr->address, r) == 0) break;
8104 /* Didn't find the address already in the list, and did find the
8105 ultimate parent's address in the list, and they really are different
8106 (i.e. not from an identity-redirect). After adding the recipient,
8107 update the errors address in the recipients list. */
8109 if ( i >= recipients_count && t < recipients_count
8110 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8112 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8113 otaddr->address, otaddr->parent->address);
8114 receive_add_recipient(otaddr->address, t);
8115 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8116 tree_add_nonrecipient(otaddr->parent->address);
8117 update_spool = TRUE;
8121 /* Except for error messages, ensure that either the errors address for
8122 this deferred address or, if there is none, the sender address, is on the
8123 list of recipients for a warning message. */
8125 if (sender_address[0])
8127 uschar * s = addr->prop.errors_address;
8128 if (!s) s = sender_address;
8129 if (Ustrstr(recipients, s) == NULL)
8130 recipients = string_sprintf("%s%s%s", recipients,
8131 recipients[0] ? "," : "", s);
8135 /* Send a warning message if the conditions are right. If the condition check
8136 fails because of a lookup defer, there is nothing we can do. The warning
8137 is not sent. Another attempt will be made at the next delivery attempt (if
8140 if ( !f.queue_2stage
8142 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8143 || addr_defer->dsn_flags & rf_notify_delay
8145 && delay_warning[1] > 0
8146 && sender_address[0] != 0
8147 && ( !delay_warning_condition
8148 || expand_check_condition(delay_warning_condition,
8149 US"delay_warning", US"option")
8155 int queue_time = time(NULL) - received_time.tv_sec;
8157 /* When running in the test harness, there's an option that allows us to
8158 fudge this time so as to get repeatability of the tests. Take the first
8159 time off the list. In queue runs, the list pointer gets updated in the
8162 if (f.running_in_test_harness && fudged_queue_times[0] != 0)
8164 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8167 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8168 fudged_queue_times);
8173 /* See how many warnings we should have sent by now */
8175 for (count = 0; count < delay_warning[1]; count++)
8176 if (queue_time < delay_warning[count+2]) break;
8178 show_time = delay_warning[count+1];
8180 if (count >= delay_warning[1])
8183 int last_gap = show_time;
8184 if (count > 1) last_gap -= delay_warning[count];
8185 extra = (queue_time - delay_warning[count+1])/last_gap;
8186 show_time += last_gap * extra;
8192 debug_printf("time on queue = %s id %s addr %s\n", readconf_printtime(queue_time), message_id, addr_defer->address);
8193 debug_printf("warning counts: required %d done %d\n", count,
8197 /* We have computed the number of warnings there should have been by now.
8198 If there haven't been enough, send one, and up the count to what it should
8201 if (warning_count < count)
8205 pid_t pid = child_open_exim(&fd);
8211 FILE *f = fdopen(fd, "wb");
8213 transport_ctx tctx = {{0}};
8215 if (warn_message_file)
8216 if (!(wmf = Ufopen(warn_message_file, "rb")))
8217 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8218 "message texts: %s", warn_message_file, strerror(errno));
8220 warnmsg_recipients = recipients;
8221 warnmsg_delay = queue_time < 120*60
8222 ? string_sprintf("%d minutes", show_time/60)
8223 : string_sprintf("%d hours", show_time/3600);
8225 if (errors_reply_to)
8226 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8227 fprintf(f, "Auto-Submitted: auto-replied\n");
8229 fprintf(f, "To: %s\n", recipients);
8231 /* generated boundary string and output MIME-Headers */
8232 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8234 fprintf(f, "Content-Type: multipart/report;"
8235 " report-type=delivery-status; boundary=%s\n"
8236 "MIME-Version: 1.0\n",
8239 if ((wmf_text = next_emf(wmf, US"header")))
8240 fprintf(f, "%s\n", wmf_text);
8242 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8243 message_id, warnmsg_delay);
8245 /* output human readable part as text/plain section */
8247 "Content-type: text/plain; charset=us-ascii\n\n",
8250 if ((wmf_text = next_emf(wmf, US"intro")))
8251 fprintf(f, "%s", CS wmf_text);
8255 "This message was created automatically by mail delivery software.\n");
8257 if (Ustrcmp(recipients, sender_address) == 0)
8259 "A message that you sent has not yet been delivered to one or more of its\n"
8260 "recipients after more than ");
8264 "A message sent by\n\n <%s>\n\n"
8265 "has not yet been delivered to one or more of its recipients after more than \n",
8268 fprintf(f, "%s on the queue on %s.\n\n"
8269 "The message identifier is: %s\n",
8270 warnmsg_delay, primary_hostname, message_id);
8272 for (h = header_list; h; h = h->next)
8273 if (strncmpic(h->text, US"Subject:", 8) == 0)
8274 fprintf(f, "The subject of the message is: %s", h->text + 9);
8275 else if (strncmpic(h->text, US"Date:", 5) == 0)
8276 fprintf(f, "The date of the message is: %s", h->text + 6);
8279 fprintf(f, "The address%s to which the message has not yet been "
8281 !addr_defer->next ? "" : "es",
8282 !addr_defer->next ? "is": "are");
8285 /* List the addresses, with error information if allowed */
8287 /* store addr_defer for machine readable part */
8288 address_item *addr_dsndefer = addr_defer;
8292 address_item *addr = addr_defer;
8293 addr_defer = addr->next;
8294 if (print_address_information(addr, f, US" ", US"\n ", US""))
8295 print_address_error(addr, f, US"Delay reason: ");
8304 if ((wmf_text = next_emf(wmf, US"final")))
8305 fprintf(f, "%s", CS wmf_text);
8311 "No action is required on your part. Delivery attempts will continue for\n"
8312 "some time, and this warning may be repeated at intervals if the message\n"
8313 "remains undelivered. Eventually the mail delivery software will give up,\n"
8314 "and when that happens, the message will be returned to you.\n");
8317 /* output machine readable part */
8318 fprintf(f, "\n--%s\n"
8319 "Content-type: message/delivery-status\n\n"
8320 "Reporting-MTA: dns; %s\n",
8322 smtp_active_hostname);
8327 /* must be decoded from xtext: see RFC 3461:6.3a */
8329 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8330 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8332 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8336 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8340 print_dsn_addr_action(f, addr_dsndefer, US"delayed", US"4.0.0");
8342 if ((hu = addr_dsndefer->host_used) && hu->name)
8344 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8345 print_dsn_diagnostic_code(addr_dsndefer, f);
8351 "Content-type: text/rfc822-headers\n\n",
8355 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8356 tctx.u.fd = fileno(f);
8357 tctx.options = topt_add_return_path | topt_no_body;
8358 transport_filter_argv = NULL; /* Just in case */
8359 return_path = sender_address; /* In case not previously set */
8361 /* Write the original email out */
8362 /*XXX no checking for failure! buggy! */
8363 transport_write_message(&tctx, 0);
8366 fprintf(f,"\n--%s--\n", bound);
8370 /* Close and wait for child process to complete, without a timeout.
8371 If there's an error, don't update the count. */
8374 if (child_close(pid, 0) == 0)
8376 warning_count = count;
8377 update_spool = TRUE; /* Ensure spool rewritten */
8383 /* Clear deliver_domain */
8385 deliver_domain = NULL;
8387 /* If this was a first delivery attempt, unset the first time flag, and
8388 ensure that the spool gets updated. */
8390 if (f.deliver_firsttime)
8392 f.deliver_firsttime = FALSE;
8393 update_spool = TRUE;
8396 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8397 message, unless the message is a local error message (to avoid loops). Then
8398 log the freezing. If the text in "frozen_info" came from a system filter,
8399 it has been escaped into printing characters so as not to mess up log lines.
8400 For the "tell" message, we turn \n back into newline. Also, insert a newline
8401 near the start instead of the ": " string. */
8403 if (f.deliver_freeze)
8405 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8407 uschar *s = string_copy(frozen_info);
8408 uschar *ss = Ustrstr(s, " by the system filter: ");
8419 if (*ss == '\\' && ss[1] == 'n')
8426 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8427 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8431 /* Log freezing just before we update the -H file, to minimize the chance
8432 of a race problem. */
8434 deliver_msglog("*** Frozen%s\n", frozen_info);
8435 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8438 /* If there have been any updates to the non-recipients list, or other things
8439 that get written to the spool, we must now update the spool header file so
8440 that it has the right information for the next delivery attempt. If there
8441 was more than one address being delivered, the header_change update is done
8442 earlier, in case one succeeds and then something crashes. */
8445 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8446 update_spool, f.header_rewritten);
8448 if (update_spool || f.header_rewritten)
8449 /* Panic-dies on error */
8450 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8453 /* Finished with the message log. If the message is complete, it will have
8454 been unlinked or renamed above. */
8456 if (message_logs) (void)fclose(message_log);
8458 /* Now we can close and remove the journal file. Its only purpose is to record
8459 successfully completed deliveries asap so that this information doesn't get
8460 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8461 not serious, as trying it again is not harmful. The journal might not be open
8462 if all addresses were deferred at routing or directing. Nevertheless, we must
8463 remove it if it exists (may have been lying around from a crash during the
8464 previous delivery attempt). We don't remove the journal if a delivery
8465 subprocess failed to pass back delivery information; this is controlled by
8466 the remove_journal flag. When the journal is left, we also don't move the
8467 message off the main spool if frozen and the option is set. It should get moved
8468 at the next attempt, after the journal has been inspected. */
8470 if (journal_fd >= 0) (void)close(journal_fd);
8474 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8476 if (Uunlink(fname) < 0 && errno != ENOENT)
8477 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8480 /* Move the message off the spool if requested */
8482 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8483 if (f.deliver_freeze && move_frozen_messages)
8484 (void)spool_move_message(id, message_subdir, US"", US"F");
8488 /* Closing the data file frees the lock; if the file has been unlinked it
8489 will go away. Otherwise the message becomes available for another process
8492 (void)close(deliver_datafile);
8493 deliver_datafile = -1;
8494 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8496 /* It is unlikely that there will be any cached resources, since they are
8497 released after routing, and in the delivery subprocesses. However, it's
8498 possible for an expansion for something afterwards (for example,
8499 expand_check_condition) to do a lookup. We must therefore be sure everything is
8503 acl_where = ACL_WHERE_UNKNOWN;
8512 #ifdef EXIM_TFO_PROBE
8515 f.tcp_fastopen_ok = TRUE;
8519 if (!regex_PIPELINING) regex_PIPELINING =
8520 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8522 if (!regex_SIZE) regex_SIZE =
8523 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8525 if (!regex_AUTH) regex_AUTH =
8526 regex_must_compile(AUTHS_REGEX, FALSE, TRUE);
8529 if (!regex_STARTTLS) regex_STARTTLS =
8530 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8533 if (!regex_CHUNKING) regex_CHUNKING =
8534 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8536 #ifndef DISABLE_PRDR
8537 if (!regex_PRDR) regex_PRDR =
8538 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8542 if (!regex_UTF8) regex_UTF8 =
8543 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8546 if (!regex_DSN) regex_DSN =
8547 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8549 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8550 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8552 #ifdef SUPPORT_PIPE_CONNECT
8553 if (!regex_EARLY_PIPE) regex_EARLY_PIPE =
8554 regex_must_compile(US"\\n250[\\s\\-]" EARLY_PIPE_FEATURE_NAME "(\\s|\\n|$)", FALSE, TRUE);
8560 deliver_get_sender_address (uschar * id)
8563 uschar * new_sender_address,
8564 * save_sender_address;
8565 BOOL save_qr = f.queue_running;
8568 /* make spool_open_datafile non-noisy on fail */
8570 f.queue_running = TRUE;
8572 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8574 deliver_datafile = spool_open_datafile(id);
8575 f.queue_running = save_qr;
8576 if (deliver_datafile < 0)
8579 /* Save and restore the global sender_address. I'm not sure if we should
8580 not save/restore all the other global variables too, because
8581 spool_read_header() may change all of them. But OTOH, when this
8582 deliver_get_sender_address() gets called, the current message is done
8583 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8585 spoolname = string_sprintf("%s-H", id);
8586 save_sender_address = sender_address;
8588 rc = spool_read_header(spoolname, TRUE, TRUE);
8590 new_sender_address = sender_address;
8591 sender_address = save_sender_address;
8593 if (rc != spool_read_OK)
8596 assert(new_sender_address);
8598 (void)close(deliver_datafile);
8599 deliver_datafile = -1;
8601 return new_sender_address;
8607 delivery_re_exec(int exec_type)
8611 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8613 int channel_fd = cutthrough.cctx.sock;
8615 smtp_peer_options = cutthrough.peer_options;
8616 continue_sequence = 0;
8619 if (cutthrough.is_tls)
8623 smtp_peer_options |= OPTION_TLS;
8624 sending_ip_address = cutthrough.snd_ip;
8625 sending_port = cutthrough.snd_port;
8627 where = US"socketpair";
8628 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8632 if ((pid = fork()) < 0)
8635 else if (pid == 0) /* child: fork again to totally disconnect */
8637 if (f.running_in_test_harness) millisleep(100); /* let parent debug out */
8638 /* does not return */
8639 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8643 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8645 waitpid(pid, NULL, 0);
8646 (void) close(channel_fd); /* release the client socket */
8647 channel_fd = pfd[1];
8651 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8652 cutthrough.host.address, message_id, channel_fd);
8656 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8657 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8659 return; /* compiler quietening; control does not reach here. */
8664 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8665 "delivery re-exec %s failed: %s", where, strerror(errno));
8667 /* Get here if exec_type == CEE_EXEC_EXIT.
8668 Note: this must be _exit(), not exit(). */
8670 _exit(EX_EXECFAILED);
8676 /* End of deliver.c */