1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
16 /* Data block for keeping track of subprocesses for parallel remote
19 typedef struct pardata {
20 address_item *addrlist; /* chain of addresses */
21 address_item *addr; /* next address data expected for */
22 pid_t pid; /* subprocess pid */
23 int fd; /* pipe fd for getting result from subprocess */
24 int transport_count; /* returned transport count value */
25 BOOL done; /* no more data needed */
26 uschar *msg; /* error message */
27 uschar *return_path; /* return_path for these addresses */
30 /* Values for the process_recipients variable */
32 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
33 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
36 /* Mutually recursive functions for marking addresses done. */
38 static void child_done(address_item *, uschar *);
39 static void address_done(address_item *, uschar *);
41 /* Table for turning base-62 numbers into binary */
43 static uschar tab62[] =
44 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
45 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
46 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
47 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
48 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
49 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
53 /*************************************************
54 * Local static variables *
55 *************************************************/
57 /* addr_duplicate is global because it needs to be seen from the Envelope-To
60 static address_item *addr_defer = NULL;
61 static address_item *addr_failed = NULL;
62 static address_item *addr_fallback = NULL;
63 static address_item *addr_local = NULL;
64 static address_item *addr_new = NULL;
65 static address_item *addr_remote = NULL;
66 static address_item *addr_route = NULL;
67 static address_item *addr_succeed = NULL;
68 static address_item *addr_dsntmp = 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 * Make a new address item *
84 *************************************************/
86 /* This function gets the store and initializes with default values. The
87 transport_return value defaults to DEFER, so that any unexpected failure to
88 deliver does not wipe out the message. The default unique string is set to a
89 copy of the address, so that its domain can be lowercased.
92 address the RFC822 address string
93 copy force a copy of the address
95 Returns: a pointer to an initialized address_item
99 deliver_make_addr(uschar *address, BOOL copy)
101 address_item *addr = store_get(sizeof(address_item));
102 *addr = address_defaults;
103 if (copy) address = string_copy(address);
104 addr->address = address;
105 addr->unique = string_copy(address);
112 /*************************************************
113 * Set expansion values for an address *
114 *************************************************/
116 /* Certain expansion variables are valid only when handling an address or
117 address list. This function sets them up or clears the values, according to its
121 addr the address in question, or NULL to clear values
126 deliver_set_expansions(address_item *addr)
130 const uschar ***p = address_expansions;
131 while (*p) **p++ = NULL;
135 /* Exactly what gets set depends on whether there is one or more addresses, and
136 what they contain. These first ones are always set, taking their values from
137 the first address. */
139 if (!addr->host_list)
141 deliver_host = deliver_host_address = US"";
142 deliver_host_port = 0;
146 deliver_host = addr->host_list->name;
147 deliver_host_address = addr->host_list->address;
148 deliver_host_port = addr->host_list->port;
151 deliver_recipients = addr;
152 deliver_address_data = addr->prop.address_data;
153 deliver_domain_data = addr->prop.domain_data;
154 deliver_localpart_data = addr->prop.localpart_data;
156 /* These may be unset for multiple addresses */
158 deliver_domain = addr->domain;
159 self_hostname = addr->self_hostname;
161 #ifdef EXPERIMENTAL_BRIGHTMAIL
162 bmi_deliver = 1; /* deliver by default */
163 bmi_alt_location = NULL;
164 bmi_base64_verdict = NULL;
165 bmi_base64_tracker_verdict = NULL;
168 /* If there's only one address we can set everything. */
172 address_item *addr_orig;
174 deliver_localpart = addr->local_part;
175 deliver_localpart_prefix = addr->prefix;
176 deliver_localpart_suffix = addr->suffix;
178 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
179 deliver_domain_orig = addr_orig->domain;
181 /* Re-instate any prefix and suffix in the original local part. In all
182 normal cases, the address will have a router associated with it, and we can
183 choose the caseful or caseless version accordingly. However, when a system
184 filter sets up a pipe, file, or autoreply delivery, no router is involved.
185 In this case, though, there won't be any prefix or suffix to worry about. */
187 deliver_localpart_orig = !addr_orig->router
188 ? addr_orig->local_part
189 : addr_orig->router->caseful_local_part
190 ? addr_orig->cc_local_part
191 : addr_orig->lc_local_part;
193 /* If there's a parent, make its domain and local part available, and if
194 delivering to a pipe or file, or sending an autoreply, get the local
195 part from the parent. For pipes and files, put the pipe or file string
196 into address_pipe and address_file. */
200 deliver_domain_parent = addr->parent->domain;
201 deliver_localpart_parent = !addr->parent->router
202 ? addr->parent->local_part
203 : addr->parent->router->caseful_local_part
204 ? addr->parent->cc_local_part
205 : addr->parent->lc_local_part;
207 /* File deliveries have their own flag because they need to be picked out
208 as special more often. */
210 if (testflag(addr, af_pfr))
212 if (testflag(addr, af_file)) address_file = addr->local_part;
213 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
214 deliver_localpart = addr->parent->local_part;
215 deliver_localpart_prefix = addr->parent->prefix;
216 deliver_localpart_suffix = addr->parent->suffix;
220 #ifdef EXPERIMENTAL_BRIGHTMAIL
221 /* Set expansion variables related to Brightmail AntiSpam */
222 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
223 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
224 /* get message delivery status (0 - don't deliver | 1 - deliver) */
225 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
226 /* if message is to be delivered, get eventual alternate location */
227 if (bmi_deliver == 1)
228 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
233 /* For multiple addresses, don't set local part, and leave the domain and
234 self_hostname set only if it is the same for all of them. It is possible to
235 have multiple pipe and file addresses, but only when all addresses have routed
236 to the same pipe or file. */
241 if (testflag(addr, af_pfr))
243 if (testflag(addr, af_file)) address_file = addr->local_part;
244 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
246 for (addr2 = addr->next; addr2; addr2 = addr2->next)
248 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
249 deliver_domain = NULL;
251 && ( !addr2->self_hostname
252 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
254 self_hostname = NULL;
255 if (!deliver_domain && !self_hostname) break;
263 /*************************************************
264 * Open a msglog file *
265 *************************************************/
267 /* This function is used both for normal message logs, and for files in the
268 msglog directory that are used to catch output from pipes. Try to create the
269 directory if it does not exist. From release 4.21, normal message logs should
270 be created when the message is received.
272 Called from deliver_message(), can be operating as root.
275 filename the file name
276 mode the mode required
277 error used for saying what failed
279 Returns: a file descriptor, or -1 (with errno set)
283 open_msglog_file(uschar *filename, int mode, uschar **error)
287 for (i = 2; i > 0; i--)
296 O_WRONLY|O_APPEND|O_CREAT, mode);
299 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
300 function is called as root). Double check the mode, because the group setting
301 doesn't always get set automatically. */
304 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
306 if (fchown(fd, exim_uid, exim_gid) < 0)
311 if (fchmod(fd, mode) < 0)
321 (void)directory_make(spool_directory,
322 spool_sname(US"msglog", message_subdir),
323 MSGLOG_DIRECTORY_MODE, TRUE);
333 /*************************************************
334 * Write to msglog if required *
335 *************************************************/
337 /* Write to the message log, if configured. This function may also be called
341 format a string format
347 deliver_msglog(const char *format, ...)
350 if (!message_logs) return;
351 va_start(ap, format);
352 vfprintf(message_log, format, ap);
360 /*************************************************
361 * Replicate status for batch *
362 *************************************************/
364 /* When a transport handles a batch of addresses, it may treat them
365 individually, or it may just put the status in the first one, and return FALSE,
366 requesting that the status be copied to all the others externally. This is the
367 replication function. As well as the status, it copies the transport pointer,
368 which may have changed if appendfile passed the addresses on to a different
371 Argument: pointer to the first address in a chain
376 replicate_status(address_item *addr)
379 for (addr2 = addr->next; addr2; addr2 = addr2->next)
381 addr2->transport = addr->transport;
382 addr2->transport_return = addr->transport_return;
383 addr2->basic_errno = addr->basic_errno;
384 addr2->more_errno = addr->more_errno;
385 addr2->delivery_usec = addr->delivery_usec;
386 addr2->special_action = addr->special_action;
387 addr2->message = addr->message;
388 addr2->user_message = addr->user_message;
394 /*************************************************
395 * Compare lists of hosts *
396 *************************************************/
398 /* This function is given two pointers to chains of host items, and it yields
399 TRUE if the lists refer to the same hosts in the same order, except that
401 (1) Multiple hosts with the same non-negative MX values are permitted to appear
402 in different orders. Round-robinning nameservers can cause this to happen.
404 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
405 permitted to appear in different orders. This is caused by randomizing
408 This enables Exim to use a single SMTP transaction for sending to two entirely
409 different domains that happen to end up pointing at the same hosts.
412 one points to the first host list
413 two points to the second host list
415 Returns: TRUE if the lists refer to the same host set
419 same_hosts(host_item *one, host_item *two)
423 if (Ustrcmp(one->name, two->name) != 0)
426 host_item *end_one = one;
427 host_item *end_two = two;
429 /* Batch up only if there was no MX and the list was not randomized */
431 if (mx == MX_NONE) return FALSE;
433 /* Find the ends of the shortest sequence of identical MX values */
435 while ( end_one->next && end_one->next->mx == mx
436 && end_two->next && end_two->next->mx == mx)
438 end_one = end_one->next;
439 end_two = end_two->next;
442 /* If there aren't any duplicates, there's no match. */
444 if (end_one == one) return FALSE;
446 /* For each host in the 'one' sequence, check that it appears in the 'two'
447 sequence, returning FALSE if not. */
452 for (hi = two; hi != end_two->next; hi = hi->next)
453 if (Ustrcmp(one->name, hi->name) == 0) break;
454 if (hi == end_two->next) return FALSE;
455 if (one == end_one) break;
459 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
460 Ensure both are pointing at the last host, and carry on as for equality. */
465 /* if the names matched but ports do not, mismatch */
466 else if (one->port != two->port)
475 /* True if both are NULL */
482 /*************************************************
483 * Compare header lines *
484 *************************************************/
486 /* This function is given two pointers to chains of header items, and it yields
487 TRUE if they are the same header texts in the same order.
490 one points to the first header list
491 two points to the second header list
493 Returns: TRUE if the lists refer to the same header set
497 same_headers(header_line *one, header_line *two)
499 for (;; one = one->next, two = two->next)
501 if (one == two) return TRUE; /* Includes the case where both NULL */
502 if (!one || !two) return FALSE;
503 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
509 /*************************************************
510 * Compare string settings *
511 *************************************************/
513 /* This function is given two pointers to strings, and it returns
514 TRUE if they are the same pointer, or if the two strings are the same.
517 one points to the first string
518 two points to the second string
520 Returns: TRUE or FALSE
524 same_strings(uschar *one, uschar *two)
526 if (one == two) return TRUE; /* Includes the case where both NULL */
527 if (!one || !two) return FALSE;
528 return (Ustrcmp(one, two) == 0);
533 /*************************************************
534 * Compare uid/gid for addresses *
535 *************************************************/
537 /* This function is given a transport and two addresses. It yields TRUE if the
538 uid/gid/initgroups settings for the two addresses are going to be the same when
543 addr1 the first address
544 addr2 the second address
546 Returns: TRUE or FALSE
550 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
552 if ( !tp->uid_set && !tp->expand_uid
553 && !tp->deliver_as_creator
554 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
555 || ( testflag(addr1, af_uid_set)
556 && ( addr1->uid != addr2->uid
557 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
561 if ( !tp->gid_set && !tp->expand_gid
562 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
563 || ( testflag(addr1, af_gid_set)
564 && addr1->gid != addr2->gid
574 /*************************************************
575 * Record that an address is complete *
576 *************************************************/
578 /* This function records that an address is complete. This is straightforward
579 for most addresses, where the unique address is just the full address with the
580 domain lower cased. For homonyms (addresses that are the same as one of their
581 ancestors) their are complications. Their unique addresses have \x\ prepended
582 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
585 Exim used to record the unique addresses of homonyms as "complete". This,
586 however, fails when the pattern of redirection varies over time (e.g. if taking
587 unseen copies at only some times of day) because the prepended numbers may vary
588 from one delivery run to the next. This problem is solved by never recording
589 prepended unique addresses as complete. Instead, when a homonymic address has
590 actually been delivered via a transport, we record its basic unique address
591 followed by the name of the transport. This is checked in subsequent delivery
592 runs whenever an address is routed to a transport.
594 If the completed address is a top-level one (has no parent, which means it
595 cannot be homonymic) we also add the original address to the non-recipients
596 tree, so that it gets recorded in the spool file and therefore appears as
597 "done" in any spool listings. The original address may differ from the unique
598 address in the case of the domain.
600 Finally, this function scans the list of duplicates, marks as done any that
601 match this address, and calls child_done() for their ancestors.
604 addr address item that has been completed
605 now current time as a string
611 address_done(address_item *addr, uschar *now)
615 update_spool = TRUE; /* Ensure spool gets updated */
617 /* Top-level address */
621 tree_add_nonrecipient(addr->unique);
622 tree_add_nonrecipient(addr->address);
625 /* Homonymous child address */
627 else if (testflag(addr, af_homonym))
630 tree_add_nonrecipient(
631 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
634 /* Non-homonymous child address */
636 else tree_add_nonrecipient(addr->unique);
638 /* Check the list of duplicate addresses and ensure they are now marked
641 for (dup = addr_duplicate; dup; dup = dup->next)
642 if (Ustrcmp(addr->unique, dup->unique) == 0)
644 tree_add_nonrecipient(dup->unique);
645 child_done(dup, now);
652 /*************************************************
653 * Decrease counts in parents and mark done *
654 *************************************************/
656 /* This function is called when an address is complete. If there is a parent
657 address, its count of children is decremented. If there are still other
658 children outstanding, the function exits. Otherwise, if the count has become
659 zero, address_done() is called to mark the parent and its duplicates complete.
660 Then loop for any earlier ancestors.
663 addr points to the completed address item
664 now the current time as a string, for writing to the message log
670 child_done(address_item *addr, uschar *now)
676 if (--addr->child_count > 0) return; /* Incomplete parent */
677 address_done(addr, now);
679 /* Log the completion of all descendents only when there is no ancestor with
680 the same original address. */
682 for (aa = addr->parent; aa; aa = aa->parent)
683 if (Ustrcmp(aa->address, addr->address) == 0) break;
686 deliver_msglog("%s %s: children all complete\n", now, addr->address);
687 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
693 /*************************************************
694 * Delivery logging support functions *
695 *************************************************/
697 /* The LOGGING() checks in d_log_interface() are complicated for backwards
698 compatibility. When outgoing interface logging was originally added, it was
699 conditional on just incoming_interface (which is off by default). The
700 outgoing_interface option is on by default to preserve this behaviour, but
701 you can enable incoming_interface and disable outgoing_interface to get I=
702 fields on incoming lines only.
705 s The log line buffer
706 sizep Pointer to the buffer size
707 ptrp Pointer to current index into buffer
708 addr The address to be logged
710 Returns: New value for s
714 d_log_interface(uschar *s, int *sizep, int *ptrp)
716 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
717 && sending_ip_address)
719 s = string_append(s, sizep, ptrp, 2, US" I=[", sending_ip_address);
720 s = LOGGING(outgoing_port)
721 ? string_append(s, sizep, ptrp, 2, US"]:",
722 string_sprintf("%d", sending_port))
723 : string_catn(s, sizep, ptrp, US"]", 1);
731 d_hostlog(uschar * s, int * sp, int * pp, address_item * addr)
733 host_item * h = addr->host_used;
735 s = string_append(s, sp, pp, 2, US" H=", h->name);
737 if (LOGGING(dnssec) && h->dnssec == DS_YES)
738 s = string_catn(s, sp, pp, US" DS", 3);
740 s = string_append(s, sp, pp, 3, US" [", h->address, US"]");
742 if (LOGGING(outgoing_port))
743 s = string_append(s, sp, pp, 2, US":", string_sprintf("%d", h->port));
746 if (LOGGING(proxy) && proxy_local_address)
748 s = string_append(s, sp, pp, 3, US" PRX=[", proxy_local_address, US"]");
749 if (LOGGING(outgoing_port))
750 s = string_append(s, sp, pp, 2, US":", string_sprintf("%d",
755 s = d_log_interface(s, sp, pp);
757 if (testflag(addr, af_tcp_fastopen))
758 s = string_catn(s, sp, pp, US" TFO", 4);
769 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
771 if (LOGGING(tls_cipher) && addr->cipher)
772 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
773 if (LOGGING(tls_certificate_verified) && addr->cipher)
774 s = string_append(s, sizep, ptrp, 2, US" CV=",
775 testflag(addr, af_cert_verified)
777 #ifdef EXPERIMENTAL_DANE
778 testflag(addr, af_dane_verified)
784 if (LOGGING(tls_peerdn) && addr->peerdn)
785 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
786 string_printing(addr->peerdn), US"\"");
794 #ifndef DISABLE_EVENT
796 event_raise(uschar * action, const uschar * event, uschar * ev_data)
802 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
804 action, deliver_host_address);
807 event_data = ev_data;
809 if (!(s = expand_string(action)) && *expand_string_message)
810 log_write(0, LOG_MAIN|LOG_PANIC,
811 "failed to expand event_action %s in %s: %s\n",
812 event, transport_name, expand_string_message);
814 event_name = event_data = NULL;
816 /* If the expansion returns anything but an empty string, flag for
817 the caller to modify his normal processing
822 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
830 msg_event_raise(const uschar * event, const address_item * addr)
832 const uschar * save_domain = deliver_domain;
833 uschar * save_local = deliver_localpart;
834 const uschar * save_host = deliver_host;
835 const uschar * save_address = deliver_host_address;
836 const int save_port = deliver_host_port;
838 if (!addr->transport)
841 router_name = addr->router ? addr->router->name : NULL;
842 transport_name = addr->transport->name;
843 deliver_domain = addr->domain;
844 deliver_localpart = addr->local_part;
845 deliver_host = addr->host_used ? addr->host_used->name : NULL;
847 (void) event_raise(addr->transport->event_action, event,
849 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
850 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
851 ? addr->message : NULL);
853 deliver_host_port = save_port;
854 deliver_host_address = save_address;
855 deliver_host = save_host;
856 deliver_localpart = save_local;
857 deliver_domain = save_domain;
858 router_name = transport_name = NULL;
860 #endif /*DISABLE_EVENT*/
864 /******************************************************************************/
867 /*************************************************
868 * Generate local prt for logging *
869 *************************************************/
871 /* This function is a subroutine for use in string_log_address() below.
874 addr the address being logged
875 yield the current dynamic buffer pointer
876 sizeptr points to current size
877 ptrptr points to current insert pointer
879 Returns: the new value of the buffer pointer
883 string_get_localpart(address_item *addr, uschar *yield, int *sizeptr,
889 if (testflag(addr, af_include_affixes) && s)
892 if (testflag(addr, af_utf8_downcvt))
893 s = string_localpart_utf8_to_alabel(s, NULL);
895 yield = string_cat(yield, sizeptr, ptrptr, s);
898 s = addr->local_part;
900 if (testflag(addr, af_utf8_downcvt))
901 s = string_localpart_utf8_to_alabel(s, NULL);
903 yield = string_cat(yield, sizeptr, ptrptr, s);
906 if (testflag(addr, af_include_affixes) && s)
909 if (testflag(addr, af_utf8_downcvt))
910 s = string_localpart_utf8_to_alabel(s, NULL);
912 yield = string_cat(yield, sizeptr, ptrptr, s);
919 /*************************************************
920 * Generate log address list *
921 *************************************************/
923 /* This function generates a list consisting of an address and its parents, for
924 use in logging lines. For saved onetime aliased addresses, the onetime parent
925 field is used. If the address was delivered by a transport with rcpt_include_
926 affixes set, the af_include_affixes bit will be set in the address. In that
927 case, we include the affixes here too.
930 str points to start of growing string, or NULL
931 size points to current allocation for string
932 ptr points to offset for append point; updated on exit
933 addr bottom (ultimate) address
934 all_parents if TRUE, include all parents
935 success TRUE for successful delivery
937 Returns: a growable string in dynamic store
941 string_log_address(uschar * str, int * size, int * ptr,
942 address_item *addr, BOOL all_parents, BOOL success)
944 BOOL add_topaddr = TRUE;
945 address_item *topaddr;
947 /* Find the ultimate parent */
949 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
951 /* We start with just the local part for pipe, file, and reply deliveries, and
952 for successful local deliveries from routers that have the log_as_local flag
953 set. File deliveries from filters can be specified as non-absolute paths in
954 cases where the transport is going to complete the path. If there is an error
955 before this happens (expansion failure) the local part will not be updated, and
956 so won't necessarily look like a path. Add extra text for this case. */
958 if ( testflag(addr, af_pfr)
960 && addr->router && addr->router->log_as_local
961 && addr->transport && addr->transport->info->local
964 if (testflag(addr, af_file) && addr->local_part[0] != '/')
965 str = string_catn(str, size, ptr, CUS"save ", 5);
966 str = string_get_localpart(addr, str, size, ptr);
969 /* Other deliveries start with the full address. It we have split it into local
970 part and domain, use those fields. Some early failures can happen before the
971 splitting is done; in those cases use the original field. */
975 uschar * cmp = str + *ptr;
977 if (addr->local_part)
980 str = string_get_localpart(addr, str, size, ptr);
981 str = string_catn(str, size, ptr, US"@", 1);
984 if (testflag(addr, af_utf8_downcvt))
985 s = string_localpart_utf8_to_alabel(s, NULL);
987 str = string_cat(str, size, ptr, s);
990 str = string_cat(str, size, ptr, addr->address);
992 /* If the address we are going to print is the same as the top address,
993 and all parents are not being included, don't add on the top address. First
994 of all, do a caseless comparison; if this succeeds, do a caseful comparison
995 on the local parts. */
998 if ( strcmpic(cmp, topaddr->address) == 0
999 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1000 && !addr->onetime_parent
1001 && (!all_parents || !addr->parent || addr->parent == topaddr)
1003 add_topaddr = FALSE;
1006 /* If all parents are requested, or this is a local pipe/file/reply, and
1007 there is at least one intermediate parent, show it in brackets, and continue
1008 with all of them if all are wanted. */
1010 if ( (all_parents || testflag(addr, af_pfr))
1012 && addr->parent != topaddr)
1015 address_item *addr2;
1016 for (addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1018 str = string_catn(str, size, ptr, s, 2);
1019 str = string_cat (str, size, ptr, addr2->address);
1020 if (!all_parents) break;
1023 str = string_catn(str, size, ptr, US")", 1);
1026 /* Add the top address if it is required */
1029 str = string_append(str, size, ptr, 3,
1031 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1040 timesince(struct timeval * diff, struct timeval * then)
1042 gettimeofday(diff, NULL);
1043 diff->tv_sec -= then->tv_sec;
1044 if ((diff->tv_usec -= then->tv_usec) < 0)
1047 diff->tv_usec += 1000*1000;
1054 string_timediff(struct timeval * diff)
1056 static uschar buf[sizeof("0.000s")];
1058 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1059 return readconf_printtime((int)diff->tv_sec);
1061 sprintf(CS buf, "%d.%03ds", (int)diff->tv_sec, (int)diff->tv_usec/1000);
1067 string_timesince(struct timeval * then)
1069 struct timeval diff;
1071 timesince(&diff, then);
1072 return string_timediff(&diff);
1075 /******************************************************************************/
1079 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1080 this is a nonstandard call; no two-character delivery flag is written
1081 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1084 flags passed to log_write()
1087 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1089 int size = 256; /* Used for a temporary, */
1090 int ptr = 0; /* expanding buffer, for */
1091 uschar * s; /* building log lines; */
1092 void * reset_point; /* released afterwards. */
1094 /* Log the delivery on the main log. We use an extensible string to build up
1095 the log line, and reset the store afterwards. Remote deliveries should always
1096 have a pointer to the host item that succeeded; local deliveries can have a
1097 pointer to a single host item in their host list, for use by the transport. */
1099 #ifndef DISABLE_EVENT
1100 /* presume no successful remote delivery */
1101 lookup_dnssec_authenticated = NULL;
1104 s = reset_point = store_get(size);
1107 s = string_append(s, &size, &ptr, 2, host_and_ident(TRUE), US" ");
1111 s = string_catn(s, &size, &ptr, US"> ", 2);
1113 s = string_log_address(s, &size, &ptr, addr, LOGGING(all_parents), TRUE);
1115 if (LOGGING(sender_on_delivery) || msg)
1116 s = string_append(s, &size, &ptr, 3, US" F=<",
1118 testflag(addr, af_utf8_downcvt)
1119 ? string_address_utf8_to_alabel(sender_address, NULL)
1126 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1128 #ifdef EXPERIMENTAL_SRS
1129 if(addr->prop.srs_sender)
1130 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
1133 /* You might think that the return path must always be set for a successful
1134 delivery; indeed, I did for some time, until this statement crashed. The case
1135 when it is not set is for a delivery to /dev/null which is optimised by not
1136 being run at all. */
1138 if (used_return_path && LOGGING(return_path_on_delivery))
1139 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1142 s = string_append(s, &size, &ptr, 2, US" ", msg);
1144 /* For a delivery from a system filter, there may not be a router */
1146 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1148 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1150 if (LOGGING(delivery_size))
1151 s = string_append(s, &size, &ptr, 2, US" S=",
1152 string_sprintf("%d", transport_count));
1154 /* Local delivery */
1156 if (addr->transport->info->local)
1158 if (addr->host_list)
1159 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
1160 s = d_log_interface(s, &size, &ptr);
1161 if (addr->shadow_message)
1162 s = string_cat(s, &size, &ptr, addr->shadow_message);
1165 /* Remote delivery */
1169 if (addr->host_used)
1171 s = d_hostlog(s, &size, &ptr, addr);
1172 if (continue_sequence > 1)
1173 s = string_catn(s, &size, &ptr, US"*", 1);
1175 #ifndef DISABLE_EVENT
1176 deliver_host_address = addr->host_used->address;
1177 deliver_host_port = addr->host_used->port;
1178 deliver_host = addr->host_used->name;
1180 /* DNS lookup status */
1181 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1182 : addr->host_used->dnssec==DS_NO ? US"no"
1188 s = d_tlslog(s, &size, &ptr, addr);
1191 if (addr->authenticator)
1193 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
1196 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
1197 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1198 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
1202 #ifndef DISABLE_PRDR
1203 if (testflag(addr, af_prdr_used))
1204 s = string_catn(s, &size, &ptr, US" PRDR", 5);
1207 if (testflag(addr, af_chunking_used))
1208 s = string_catn(s, &size, &ptr, US" K", 2);
1211 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1213 if ( LOGGING(smtp_confirmation)
1215 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1219 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1220 uschar *p = big_buffer;
1221 uschar *ss = addr->message;
1223 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1225 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1230 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
1233 /* Time on queue and actual time taken to deliver */
1235 if (LOGGING(queue_time))
1236 s = string_append(s, &size, &ptr, 2, US" QT=",
1237 string_timesince(&received_time));
1239 if (LOGGING(deliver_time))
1241 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1242 s = string_append(s, &size, &ptr, 2, US" DT=", string_timediff(&diff));
1245 /* string_cat() always leaves room for the terminator. Release the
1246 store we used to build the line after writing it. */
1249 log_write(0, flags, "%s", s);
1251 #ifndef DISABLE_EVENT
1252 if (!msg) msg_event_raise(US"msg:delivery", addr);
1255 store_reset(reset_point);
1262 deferral_log(address_item * addr, uschar * now,
1263 int logflags, uschar * driver_name, uschar * driver_kind)
1265 int size = 256; /* Used for a temporary, */
1266 int ptr = 0; /* expanding buffer, for */
1267 uschar * s; /* building log lines; */
1268 void * reset_point; /* released afterwards. */
1272 /* Build up the line that is used for both the message log and the main
1275 s = reset_point = store_get(size);
1277 /* Create the address string for logging. Must not do this earlier, because
1278 an OK result may be changed to FAIL when a pipe returns text. */
1280 s = string_log_address(s, &size, &ptr, addr, LOGGING(all_parents), FALSE);
1283 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1285 /* Either driver_name contains something and driver_kind contains
1286 " router" or " transport" (note the leading space), or driver_name is
1287 a null string and driver_kind contains "routing" without the leading
1288 space, if all routing has been deferred. When a domain has been held,
1289 so nothing has been done at all, both variables contain null strings. */
1293 if (driver_kind[1] == 't' && addr->router)
1294 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1296 ss[1] = toupper(driver_kind[1]);
1297 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1299 else if (driver_kind)
1300 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1302 /*XXX need an s+s+p sprintf */
1303 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1304 s = string_cat(s, &size, &ptr, ss);
1306 if (addr->basic_errno > 0)
1307 s = string_append(s, &size, &ptr, 2, US": ",
1308 US strerror(addr->basic_errno));
1310 if (addr->host_used)
1312 s = string_append(s, &size, &ptr, 5,
1313 US" H=", addr->host_used->name,
1314 US" [", addr->host_used->address, US"]");
1315 if (LOGGING(outgoing_port))
1317 int port = addr->host_used->port;
1318 s = string_append(s, &size, &ptr, 2,
1319 US":", port == PORT_NONE ? US"25" : string_sprintf("%d", port));
1324 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1328 /* Log the deferment in the message log, but don't clutter it
1329 up with retry-time defers after the first delivery attempt. */
1331 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1332 deliver_msglog("%s %s\n", now, s);
1334 /* Write the main log and reset the store.
1335 For errors of the type "retry time not reached" (also remotes skipped
1336 on queue run), logging is controlled by L_retry_defer. Note that this kind
1337 of error number is negative, and all the retry ones are less than any
1341 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1344 store_reset(reset_point);
1351 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1353 int size = 256; /* Used for a temporary, */
1354 int ptr = 0; /* expanding buffer, for */
1355 uschar * s; /* building log lines; */
1356 void * reset_point; /* released afterwards. */
1358 /* Build up the log line for the message and main logs */
1360 s = reset_point = store_get(size);
1362 /* Create the address string for logging. Must not do this earlier, because
1363 an OK result may be changed to FAIL when a pipe returns text. */
1365 s = string_log_address(s, &size, &ptr, addr, LOGGING(all_parents), FALSE);
1367 if (LOGGING(sender_on_delivery))
1368 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1371 s = string_append(s, &size, &ptr, 2, US" Q=", queue_name);
1373 /* Return path may not be set if no delivery actually happened */
1375 if (used_return_path && LOGGING(return_path_on_delivery))
1376 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1379 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1380 if (addr->transport)
1381 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1383 if (addr->host_used)
1384 s = d_hostlog(s, &size, &ptr, addr);
1387 s = d_tlslog(s, &size, &ptr, addr);
1390 if (addr->basic_errno > 0)
1391 s = string_append(s, &size, &ptr, 2, US": ", US strerror(addr->basic_errno));
1394 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1398 /* Do the logging. For the message log, "routing failed" for those cases,
1399 just to make it clearer. */
1402 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1404 deliver_msglog("%s %s\n", now, s);
1406 log_write(0, LOG_MAIN, "** %s", s);
1408 #ifndef DISABLE_EVENT
1409 msg_event_raise(US"msg:fail:delivery", addr);
1412 store_reset(reset_point);
1418 /*************************************************
1419 * Actions at the end of handling an address *
1420 *************************************************/
1422 /* This is a function for processing a single address when all that can be done
1423 with it has been done.
1426 addr points to the address block
1427 result the result of the delivery attempt
1428 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1429 driver_type indicates which type of driver (transport, or router) was last
1430 to process the address
1431 logchar '=' or '-' for use when logging deliveries with => or ->
1437 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1440 uschar *now = tod_stamp(tod_log);
1441 uschar *driver_kind = NULL;
1442 uschar *driver_name = NULL;
1444 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1446 /* Set up driver kind and name for logging. Disable logging if the router or
1447 transport has disabled it. */
1449 if (driver_type == EXIM_DTYPE_TRANSPORT)
1451 if (addr->transport)
1453 driver_name = addr->transport->name;
1454 driver_kind = US" transport";
1455 disable_logging = addr->transport->disable_logging;
1457 else driver_kind = US"transporting";
1459 else if (driver_type == EXIM_DTYPE_ROUTER)
1463 driver_name = addr->router->name;
1464 driver_kind = US" router";
1465 disable_logging = addr->router->disable_logging;
1467 else driver_kind = US"routing";
1470 /* If there's an error message set, ensure that it contains only printing
1471 characters - it should, but occasionally things slip in and this at least
1472 stops the log format from getting wrecked. We also scan the message for an LDAP
1473 expansion item that has a password setting, and flatten the password. This is a
1474 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1475 malformed, it won't ever have gone near LDAP.) */
1479 const uschar * s = string_printing(addr->message);
1481 /* deconst cast ok as string_printing known to have alloc'n'copied */
1482 addr->message = expand_hide_passwords(US s);
1485 /* If we used a transport that has one of the "return_output" options set, and
1486 if it did in fact generate some output, then for return_output we treat the
1487 message as failed if it was not already set that way, so that the output gets
1488 returned to the sender, provided there is a sender to send it to. For
1489 return_fail_output, do this only if the delivery failed. Otherwise we just
1490 unlink the file, and remove the name so that if the delivery failed, we don't
1491 try to send back an empty or unwanted file. The log_output options operate only
1492 on a non-empty file.
1494 In any case, we close the message file, because we cannot afford to leave a
1495 file-descriptor for one address while processing (maybe very many) others. */
1497 if (addr->return_file >= 0 && addr->return_filename)
1499 BOOL return_output = FALSE;
1500 struct stat statbuf;
1501 (void)EXIMfsync(addr->return_file);
1503 /* If there is no output, do nothing. */
1505 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1507 transport_instance *tb = addr->transport;
1509 /* Handle logging options */
1512 || result == FAIL && tb->log_fail_output
1513 || result == DEFER && tb->log_defer_output
1517 FILE *f = Ufopen(addr->return_filename, "rb");
1519 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1520 "from %s transport: %s", addr->return_filename, tb->name,
1523 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1525 uschar *p = big_buffer + Ustrlen(big_buffer);
1527 while (p > big_buffer && isspace(p[-1])) p--;
1529 sp = string_printing(big_buffer);
1530 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1531 addr->address, tb->name, sp);
1536 /* Handle returning options, but only if there is an address to return
1539 if (sender_address[0] != 0 || addr->prop.errors_address)
1540 if (tb->return_output)
1542 addr->transport_return = result = FAIL;
1543 if (addr->basic_errno == 0 && !addr->message)
1544 addr->message = US"return message generated";
1545 return_output = TRUE;
1548 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1551 /* Get rid of the file unless it might be returned, but close it in
1556 Uunlink(addr->return_filename);
1557 addr->return_filename = NULL;
1558 addr->return_file = -1;
1561 (void)close(addr->return_file);
1564 /* The success case happens only after delivery by a transport. */
1568 addr->next = addr_succeed;
1569 addr_succeed = addr;
1571 /* Call address_done() to ensure that we don't deliver to this address again,
1572 and write appropriate things to the message log. If it is a child address, we
1573 call child_done() to scan the ancestors and mark them complete if this is the
1574 last child to complete. */
1576 address_done(addr, now);
1577 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1580 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1581 driver_name, driver_kind);
1584 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1585 addr->parent->address, driver_name, driver_kind);
1586 child_done(addr, now);
1589 /* Certificates for logging (via events) */
1591 tls_out.ourcert = addr->ourcert;
1592 addr->ourcert = NULL;
1593 tls_out.peercert = addr->peercert;
1594 addr->peercert = NULL;
1596 tls_out.cipher = addr->cipher;
1597 tls_out.peerdn = addr->peerdn;
1598 tls_out.ocsp = addr->ocsp;
1599 # ifdef EXPERIMENTAL_DANE
1600 tls_out.dane_verified = testflag(addr, af_dane_verified);
1604 delivery_log(LOG_MAIN, addr, logchar, NULL);
1607 tls_free_cert(&tls_out.ourcert);
1608 tls_free_cert(&tls_out.peercert);
1609 tls_out.cipher = NULL;
1610 tls_out.peerdn = NULL;
1611 tls_out.ocsp = OCSP_NOT_REQ;
1612 # ifdef EXPERIMENTAL_DANE
1613 tls_out.dane_verified = FALSE;
1619 /* Soft failure, or local delivery process failed; freezing may be
1622 else if (result == DEFER || result == PANIC)
1624 if (result == PANIC) logflags |= LOG_PANIC;
1626 /* This puts them on the chain in reverse order. Do not change this, because
1627 the code for handling retries assumes that the one with the retry
1628 information is last. */
1630 addr->next = addr_defer;
1633 /* The only currently implemented special action is to freeze the
1634 message. Logging of this is done later, just before the -H file is
1637 if (addr->special_action == SPECIAL_FREEZE)
1639 deliver_freeze = TRUE;
1640 deliver_frozen_at = time(NULL);
1641 update_spool = TRUE;
1644 /* If doing a 2-stage queue run, we skip writing to either the message
1645 log or the main log for SMTP defers. */
1647 if (!queue_2stage || addr->basic_errno != 0)
1648 deferral_log(addr, now, logflags, driver_name, driver_kind);
1652 /* Hard failure. If there is an address to which an error message can be sent,
1653 put this address on the failed list. If not, put it on the deferred list and
1654 freeze the mail message for human attention. The latter action can also be
1655 explicitly requested by a router or transport. */
1659 /* If this is a delivery error, or a message for which no replies are
1660 wanted, and the message's age is greater than ignore_bounce_errors_after,
1661 force the af_ignore_error flag. This will cause the address to be discarded
1662 later (with a log entry). */
1664 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1665 addr->prop.ignore_error = TRUE;
1667 /* Freeze the message if requested, or if this is a bounce message (or other
1668 message with null sender) and this address does not have its own errors
1669 address. However, don't freeze if errors are being ignored. The actual code
1670 to ignore occurs later, instead of sending a message. Logging of freezing
1671 occurs later, just before writing the -H file. */
1673 if ( !addr->prop.ignore_error
1674 && ( addr->special_action == SPECIAL_FREEZE
1675 || (sender_address[0] == 0 && !addr->prop.errors_address)
1678 frozen_info = addr->special_action == SPECIAL_FREEZE
1680 : sender_local && !local_error_message
1681 ? US" (message created with -f <>)"
1682 : US" (delivery error message)";
1683 deliver_freeze = TRUE;
1684 deliver_frozen_at = time(NULL);
1685 update_spool = TRUE;
1687 /* The address is put on the defer rather than the failed queue, because
1688 the message is being retained. */
1690 addr->next = addr_defer;
1694 /* Don't put the address on the nonrecipients tree yet; wait until an
1695 error message has been successfully sent. */
1699 addr->next = addr_failed;
1703 failure_log(addr, driver_name ? NULL : driver_kind, now);
1706 /* Ensure logging is turned on again in all cases */
1708 disable_logging = FALSE;
1714 /*************************************************
1715 * Address-independent error *
1716 *************************************************/
1718 /* This function is called when there's an error that is not dependent on a
1719 particular address, such as an expansion string failure. It puts the error into
1720 all the addresses in a batch, logs the incident on the main and panic logs, and
1721 clears the expansions. It is mostly called from local_deliver(), but can be
1722 called for a remote delivery via findugid().
1725 logit TRUE if (MAIN+PANIC) logging required
1726 addr the first of the chain of addresses
1728 format format string for error message, or NULL if already set in addr
1729 ... arguments for the format
1735 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1737 address_item *addr2;
1738 addr->basic_errno = code;
1744 va_start(ap, format);
1745 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1746 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1747 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1749 addr->message = string_copy(buffer);
1752 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1754 addr2->basic_errno = code;
1755 addr2->message = addr->message;
1758 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1759 deliver_set_expansions(NULL);
1765 /*************************************************
1766 * Check a "never users" list *
1767 *************************************************/
1769 /* This function is called to check whether a uid is on one of the two "never
1773 uid the uid to be checked
1774 nusers the list to be scanned; the first item in the list is the count
1776 Returns: TRUE if the uid is on the list
1780 check_never_users(uid_t uid, uid_t *nusers)
1783 if (!nusers) return FALSE;
1784 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1790 /*************************************************
1791 * Find uid and gid for a transport *
1792 *************************************************/
1794 /* This function is called for both local and remote deliveries, to find the
1795 uid/gid under which to run the delivery. The values are taken preferentially
1796 from the transport (either explicit or deliver_as_creator), then from the
1797 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1798 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1799 panic error is logged, and the function fails (which normally leads to delivery
1803 addr the address (possibly a chain)
1805 uidp pointer to uid field
1806 gidp pointer to gid field
1807 igfp pointer to the use_initgroups field
1809 Returns: FALSE if failed - error has been set in address(es)
1813 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1817 BOOL gid_set = FALSE;
1819 /* Default initgroups flag comes from the transport */
1821 *igfp = tp->initgroups;
1823 /* First see if there's a gid on the transport, either fixed or expandable.
1824 The expanding function always logs failure itself. */
1831 else if (tp->expand_gid)
1833 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1836 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1842 /* If the transport did not set a group, see if the router did. */
1844 if (!gid_set && testflag(addr, af_gid_set))
1850 /* Pick up a uid from the transport if one is set. */
1852 if (tp->uid_set) *uidp = tp->uid;
1854 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1855 it does not provide a passwd value from which a gid can be taken. */
1857 else if (tp->expand_uid)
1860 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1861 uidp, &(addr->message)))
1863 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1873 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1875 else if (tp->deliver_as_creator)
1877 *uidp = originator_uid;
1880 *gidp = originator_gid;
1885 /* Otherwise see if the address specifies the uid and if so, take it and its
1888 else if (testflag(addr, af_uid_set))
1891 *igfp = testflag(addr, af_initgroups);
1894 /* Nothing has specified the uid - default to the Exim user, and group if the
1907 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1908 defaulting to the Exim uid. In other words, if the configuration has specified
1909 a uid, it must also provide a gid. */
1913 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1914 "%s transport", tp->name);
1918 /* Check that the uid is not on the lists of banned uids that may not be used
1919 for delivery processes. */
1921 nuname = check_never_users(*uidp, never_users)
1923 : check_never_users(*uidp, fixed_never_users)
1924 ? US"fixed_never_users"
1928 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1929 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1941 /*************************************************
1942 * Check the size of a message for a transport *
1943 *************************************************/
1945 /* Checks that the message isn't too big for the selected transport.
1946 This is called only when it is known that the limit is set.
1950 addr the (first) address being delivered
1953 DEFER expansion failed or did not yield an integer
1954 FAIL message too big
1958 check_message_size(transport_instance *tp, address_item *addr)
1963 deliver_set_expansions(addr);
1964 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1965 deliver_set_expansions(NULL);
1967 if (expand_string_message)
1970 addr->message = size_limit == -1
1971 ? string_sprintf("failed to expand message_size_limit "
1972 "in %s transport: %s", tp->name, expand_string_message)
1973 : string_sprintf("invalid message_size_limit "
1974 "in %s transport: %s", tp->name, expand_string_message);
1976 else if (size_limit > 0 && message_size > size_limit)
1980 string_sprintf("message is too big (transport limit = %d)",
1989 /*************************************************
1990 * Transport-time check for a previous delivery *
1991 *************************************************/
1993 /* Check that this base address hasn't previously been delivered to its routed
1994 transport. If it has been delivered, mark it done. The check is necessary at
1995 delivery time in order to handle homonymic addresses correctly in cases where
1996 the pattern of redirection changes between delivery attempts (so the unique
1997 fields change). Non-homonymic previous delivery is detected earlier, at routing
1998 time (which saves unnecessary routing).
2001 addr the address item
2002 testing TRUE if testing wanted only, without side effects
2004 Returns: TRUE if previously delivered by the transport
2008 previously_transported(address_item *addr, BOOL testing)
2010 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
2011 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2013 if (tree_search(tree_nonrecipients, big_buffer) != 0)
2015 DEBUG(D_deliver|D_route|D_transport)
2016 debug_printf("%s was previously delivered (%s transport): discarded\n",
2017 addr->address, addr->transport->name);
2018 if (!testing) child_done(addr, tod_stamp(tod_log));
2027 /******************************************************
2028 * Check for a given header in a header string *
2029 ******************************************************/
2031 /* This function is used when generating quota warnings. The configuration may
2032 specify any header lines it likes in quota_warn_message. If certain of them are
2033 missing, defaults are inserted, so we need to be able to test for the presence
2037 hdr the required header name
2038 hstring the header string
2040 Returns: TRUE the header is in the string
2041 FALSE the header is not in the string
2045 contains_header(uschar *hdr, uschar *hstring)
2047 int len = Ustrlen(hdr);
2048 uschar *p = hstring;
2051 if (strncmpic(p, hdr, len) == 0)
2054 while (*p == ' ' || *p == '\t') p++;
2055 if (*p == ':') return TRUE;
2057 while (*p != 0 && *p != '\n') p++;
2058 if (*p == '\n') p++;
2066 /*************************************************
2067 * Perform a local delivery *
2068 *************************************************/
2070 /* Each local delivery is performed in a separate process which sets its
2071 uid and gid as specified. This is a safer way than simply changing and
2072 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2073 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2074 all systems have seteuid().
2076 If the uid/gid are specified in the transport_instance, they are used; the
2077 transport initialization must ensure that either both or neither are set.
2078 Otherwise, the values associated with the address are used. If neither are set,
2079 it is a configuration error.
2081 The transport or the address may specify a home directory (transport over-
2082 rides), and if they do, this is set as $home. If neither have set a working
2083 directory, this value is used for that as well. Otherwise $home is left unset
2084 and the cwd is set to "/" - a directory that should be accessible to all users.
2086 Using a separate process makes it more complicated to get error information
2087 back. We use a pipe to pass the return code and also an error code and error
2088 text string back to the parent process.
2091 addr points to an address block for this delivery; for "normal" local
2092 deliveries this is the only address to be delivered, but for
2093 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2094 a number of addresses can be handled simultaneously, and in this
2095 case addr will point to a chain of addresses with the same
2098 shadowing TRUE if running a shadow transport; this causes output from pipes
2105 deliver_local(address_item *addr, BOOL shadowing)
2107 BOOL use_initgroups;
2110 int status, len, rc;
2113 uschar *working_directory;
2114 address_item *addr2;
2115 transport_instance *tp = addr->transport;
2117 /* Set up the return path from the errors or sender address. If the transport
2118 has its own return path setting, expand it and replace the existing value. */
2120 if(addr->prop.errors_address)
2121 return_path = addr->prop.errors_address;
2122 #ifdef EXPERIMENTAL_SRS
2123 else if (addr->prop.srs_sender)
2124 return_path = addr->prop.srs_sender;
2127 return_path = sender_address;
2129 if (tp->return_path)
2131 uschar *new_return_path = expand_string(tp->return_path);
2132 if (!new_return_path)
2134 if (!expand_string_forcedfail)
2136 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2137 US"Failed to expand return path \"%s\" in %s transport: %s",
2138 tp->return_path, tp->name, expand_string_message);
2142 else return_path = new_return_path;
2145 /* For local deliveries, one at a time, the value used for logging can just be
2146 set directly, once and for all. */
2148 used_return_path = return_path;
2150 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2151 gets put into the address(es), and the expansions are unset, so we can just
2154 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2156 /* See if either the transport or the address specifies a home directory. A
2157 home directory set in the address may already be expanded; a flag is set to
2158 indicate that. In other cases we must expand it. */
2160 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2161 || ( (deliver_home = addr->home_dir) /* Set in address and */
2162 && !testflag(addr, af_home_expanded) /* not expanded */
2165 uschar *rawhome = deliver_home;
2166 deliver_home = NULL; /* in case it contains $home */
2167 if (!(deliver_home = expand_string(rawhome)))
2169 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2170 "to expand for %s transport: %s", rawhome, tp->name,
2171 expand_string_message);
2174 if (*deliver_home != '/')
2176 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2177 "is not absolute for %s transport", deliver_home, tp->name);
2182 /* See if either the transport or the address specifies a current directory,
2183 and if so, expand it. If nothing is set, use the home directory, unless it is
2184 also unset in which case use "/", which is assumed to be a directory to which
2185 all users have access. It is necessary to be in a visible directory for some
2186 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2187 2.5) require this. */
2189 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2190 if (working_directory)
2192 uschar *raw = working_directory;
2193 if (!(working_directory = expand_string(raw)))
2195 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2196 "failed to expand for %s transport: %s", raw, tp->name,
2197 expand_string_message);
2200 if (*working_directory != '/')
2202 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2203 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2207 else working_directory = deliver_home ? deliver_home : US"/";
2209 /* If one of the return_output flags is set on the transport, create and open a
2210 file in the message log directory for the transport to write its output onto.
2211 This is mainly used by pipe transports. The file needs to be unique to the
2212 address. This feature is not available for shadow transports. */
2215 && ( tp->return_output || tp->return_fail_output
2216 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2221 addr->return_filename =
2222 spool_fname(US"msglog", message_subdir, message_id,
2223 string_sprintf("-%d-%d", getpid(), return_count++));
2225 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2227 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2228 "to return message: %s", error, tp->name, strerror(errno));
2233 /* Create the pipe for inter-process communication. */
2237 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2242 /* Now fork the process to do the real work in the subprocess, but first
2243 ensure that all cached resources are freed so that the subprocess starts with
2244 a clean slate and doesn't interfere with the parent process. */
2248 if ((pid = fork()) == 0)
2250 BOOL replicate = TRUE;
2252 /* Prevent core dumps, as we don't want them in users' home directories.
2253 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2254 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2255 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2256 complain if the error is "not supported".
2258 There are two scenarios where changing the max limit has an effect. In one,
2259 the user is using a .forward and invoking a command of their choice via pipe;
2260 for these, we do need the max limit to be 0 unless the admin chooses to
2261 permit an increased limit. In the other, the command is invoked directly by
2262 the transport and is under administrator control, thus being able to raise
2263 the limit aids in debugging. So there's no general always-right answer.
2265 Thus we inhibit core-dumps completely but let individual transports, while
2266 still root, re-raise the limits back up to aid debugging. We make the
2267 default be no core-dumps -- few enough people can use core dumps in
2268 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2275 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2277 # ifdef SETRLIMIT_NOT_SUPPORTED
2278 if (errno != ENOSYS && errno != ENOTSUP)
2280 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2285 /* Reset the random number generator, so different processes don't all
2286 have the same sequence. */
2290 /* If the transport has a setup entry, call this first, while still
2291 privileged. (Appendfile uses this to expand quota, for example, while
2292 able to read private files.) */
2294 if (addr->transport->setup)
2295 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2299 addr->transport_return = DEFER;
2303 addr->transport_return = PANIC;
2307 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2308 when the process becomes unprivileged, it won't be able to write to the
2309 process log. SIGHUP is ignored throughout exim, except when it is being
2312 signal(SIGINT, SIG_IGN);
2313 signal(SIGTERM, SIG_IGN);
2314 signal(SIGUSR1, SIG_IGN);
2316 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2317 half - for transports that exec things (e.g. pipe). Then set the required
2320 (void)close(pfd[pipe_read]);
2321 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2323 exim_setugid(uid, gid, use_initgroups,
2324 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2325 addr->address, addr->transport->name));
2329 address_item *batched;
2330 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2331 for (batched = addr->next; batched; batched = batched->next)
2332 debug_printf("additional batched address: %s\n", batched->address);
2335 /* Set an appropriate working directory. */
2337 if (Uchdir(working_directory) < 0)
2339 addr->transport_return = DEFER;
2340 addr->basic_errno = errno;
2341 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2344 /* If successful, call the transport */
2349 set_process_info("delivering %s to %s using %s", message_id,
2350 addr->local_part, addr->transport->name);
2352 /* Setting this global in the subprocess means we need never clear it */
2353 transport_name = addr->transport->name;
2355 /* If a transport filter has been specified, set up its argument list.
2356 Any errors will get put into the address, and FALSE yielded. */
2358 if (addr->transport->filter_command)
2360 ok = transport_set_up_command(&transport_filter_argv,
2361 addr->transport->filter_command,
2362 TRUE, PANIC, addr, US"transport filter", NULL);
2363 transport_filter_timeout = addr->transport->filter_timeout;
2365 else transport_filter_argv = NULL;
2369 debug_print_string(addr->transport->debug_string);
2370 replicate = !(addr->transport->info->code)(addr->transport, addr);
2374 /* Pass the results back down the pipe. If necessary, first replicate the
2375 status in the top address to the others in the batch. The label is the
2376 subject of a goto when a call to the transport's setup function fails. We
2377 pass the pointer to the transport back in case it got changed as a result of
2378 file_format in appendfile. */
2382 if (replicate) replicate_status(addr);
2383 for (addr2 = addr; addr2; addr2 = addr2->next)
2386 int local_part_length = Ustrlen(addr2->local_part);
2390 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2391 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2392 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2393 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2394 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2395 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2396 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2397 || (ret = write(pfd[pipe_write], &addr2->transport,
2398 sizeof(transport_instance *))) != sizeof(transport_instance *)
2400 /* For a file delivery, pass back the local part, in case the original
2401 was only part of the final delivery path. This gives more complete
2404 || (testflag(addr2, af_file)
2405 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2406 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2410 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2411 ret == -1 ? strerror(errno) : "short write");
2413 /* Now any messages */
2415 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2417 int message_length = s ? Ustrlen(s) + 1 : 0;
2418 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2419 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2421 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2422 ret == -1 ? strerror(errno) : "short write");
2426 /* OK, this process is now done. Free any cached resources that it opened,
2427 and close the pipe we were writing down before exiting. */
2429 (void)close(pfd[pipe_write]);
2434 /* Back in the main process: panic if the fork did not succeed. This seems
2435 better than returning an error - if forking is failing it is probably best
2436 not to try other deliveries for this message. */
2439 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2442 /* Read the pipe to get the delivery status codes and error messages. Our copy
2443 of the writing end must be closed first, as otherwise read() won't return zero
2444 on an empty pipe. We check that a status exists for each address before
2445 overwriting the address structure. If data is missing, the default DEFER status
2446 will remain. Afterwards, close the reading end. */
2448 (void)close(pfd[pipe_write]);
2450 for (addr2 = addr; addr2; addr2 = addr2->next)
2452 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2457 addr2->transport_return = status;
2458 len = read(pfd[pipe_read], &transport_count,
2459 sizeof(transport_count));
2460 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2461 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2462 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2463 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2464 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2465 len = read(pfd[pipe_read], &addr2->transport,
2466 sizeof(transport_instance *));
2468 if (testflag(addr2, af_file))
2471 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2472 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2475 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2476 " from delivery subprocess");
2479 /* sanity-checked llen so disable the Coverity error */
2480 /* coverity[tainted_data] */
2481 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2483 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2484 " from delivery subprocess");
2487 big_buffer[llen] = 0;
2488 addr2->local_part = string_copy(big_buffer);
2491 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2494 len = read(pfd[pipe_read], &message_length, sizeof(int));
2495 if (message_length > 0)
2497 len = read(pfd[pipe_read], big_buffer, message_length);
2498 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2499 if (len > 0) *sptr = string_copy(big_buffer);
2506 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2507 "from delivery subprocess", addr2->unique);
2512 (void)close(pfd[pipe_read]);
2514 /* Unless shadowing, write all successful addresses immediately to the journal
2515 file, to ensure they are recorded asap. For homonymic addresses, use the base
2516 address plus the transport name. Failure to write the journal is panic-worthy,
2517 but don't stop, as it may prove possible subsequently to update the spool file
2518 in order to record the delivery. */
2522 for (addr2 = addr; addr2; addr2 = addr2->next)
2523 if (addr2->transport_return == OK)
2525 if (testflag(addr2, af_homonym))
2526 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2528 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2530 /* In the test harness, wait just a bit to let the subprocess finish off
2531 any debug output etc first. */
2533 if (running_in_test_harness) millisleep(300);
2535 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2536 len = Ustrlen(big_buffer);
2537 if (write(journal_fd, big_buffer, len) != len)
2538 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2539 big_buffer, strerror(errno));
2542 /* Ensure the journal file is pushed out to disk. */
2544 if (EXIMfsync(journal_fd) < 0)
2545 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2549 /* Wait for the process to finish. If it terminates with a non-zero code,
2550 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2551 status values of all the addresses as they are. Take care to handle the case
2552 when the subprocess doesn't seem to exist. This has been seen on one system
2553 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2554 happens, wait() doesn't recognize the termination of child processes. Exim now
2555 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2557 while ((rc = wait(&status)) != pid)
2558 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2560 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2561 addr->transport->driver_name);
2566 if ((status & 0xffff) != 0)
2568 int msb = (status >> 8) & 255;
2569 int lsb = status & 255;
2570 int code = (msb == 0)? (lsb & 0x7f) : msb;
2571 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2572 addr->special_action = SPECIAL_FREEZE;
2573 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2574 "status 0x%04x: %s %d",
2575 addr->transport->driver_name,
2577 msb == 0 ? "terminated by signal" : "exit code",
2581 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2583 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2586 uschar *warn_message;
2589 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2591 if (!(warn_message = expand_string(addr->transport->warn_message)))
2592 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2593 "message for %s transport): %s", addr->transport->warn_message,
2594 addr->transport->name, expand_string_message);
2596 else if ((pid = child_open_exim(&fd)) > 0)
2598 FILE *f = fdopen(fd, "wb");
2599 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2600 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2601 fprintf(f, "Auto-Submitted: auto-replied\n");
2602 if (!contains_header(US"From", warn_message))
2604 fprintf(f, "%s", CS warn_message);
2606 /* Close and wait for child process to complete, without a timeout. */
2609 (void)child_close(pid, 0);
2612 addr->special_action = SPECIAL_NONE;
2619 /* Check transport for the given concurrency limit. Return TRUE if over
2620 the limit (or an expansion failure), else FALSE and if there was a limit,
2621 the key for the hints database used for the concurrency count. */
2624 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2626 unsigned max_parallel;
2628 if (!tp->max_parallel) return FALSE;
2630 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2631 if (expand_string_message)
2633 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2634 "in %s transport (%s): %s", tp->name, addr->address,
2635 expand_string_message);
2639 if (max_parallel > 0)
2641 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2642 if (!enq_start(serialize_key, max_parallel))
2644 address_item * next;
2646 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2647 tp->name, max_parallel);
2651 addr->message = US"concurrency limit reached for transport";
2652 addr->basic_errno = ERRNO_TRETRY;
2653 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2654 } while ((addr = next));
2657 *key = serialize_key;
2664 /*************************************************
2665 * Do local deliveries *
2666 *************************************************/
2668 /* This function processes the list of addresses in addr_local. True local
2669 deliveries are always done one address at a time. However, local deliveries can
2670 be batched up in some cases. Typically this is when writing batched SMTP output
2671 files for use by some external transport mechanism, or when running local
2672 deliveries over LMTP.
2679 do_local_deliveries(void)
2682 open_db *dbm_file = NULL;
2683 time_t now = time(NULL);
2685 /* Loop until we have exhausted the supply of local deliveries */
2689 struct timeval delivery_start;
2690 struct timeval deliver_time;
2691 address_item *addr2, *addr3, *nextaddr;
2692 int logflags = LOG_MAIN;
2693 int logchar = dont_deliver? '*' : '=';
2694 transport_instance *tp;
2695 uschar * serialize_key = NULL;
2697 /* Pick the first undelivered address off the chain */
2699 address_item *addr = addr_local;
2700 addr_local = addr->next;
2703 DEBUG(D_deliver|D_transport)
2704 debug_printf("--------> %s <--------\n", addr->address);
2706 /* An internal disaster if there is no transport. Should not occur! */
2708 if (!(tp = addr->transport))
2710 logflags |= LOG_PANIC;
2711 disable_logging = FALSE; /* Jic */
2712 addr->message = addr->router
2713 ? string_sprintf("No transport set by %s router", addr->router->name)
2714 : string_sprintf("No transport set by system filter");
2715 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2719 /* Check that this base address hasn't previously been delivered to this
2720 transport. The check is necessary at this point to handle homonymic addresses
2721 correctly in cases where the pattern of redirection changes between delivery
2722 attempts. Non-homonymic previous delivery is detected earlier, at routing
2725 if (previously_transported(addr, FALSE)) continue;
2727 /* There are weird cases where logging is disabled */
2729 disable_logging = tp->disable_logging;
2731 /* Check for batched addresses and possible amalgamation. Skip all the work
2732 if either batch_max <= 1 or there aren't any other addresses for local
2735 if (tp->batch_max > 1 && addr_local)
2737 int batch_count = 1;
2738 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2739 BOOL uses_lp = ( testflag(addr, af_pfr)
2740 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2742 || readconf_depends((driver_instance *)tp, US"local_part");
2743 uschar *batch_id = NULL;
2744 address_item **anchor = &addr_local;
2745 address_item *last = addr;
2748 /* Expand the batch_id string for comparison with other addresses.
2749 Expansion failure suppresses batching. */
2753 deliver_set_expansions(addr);
2754 batch_id = expand_string(tp->batch_id);
2755 deliver_set_expansions(NULL);
2758 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2759 "in %s transport (%s): %s", tp->name, addr->address,
2760 expand_string_message);
2761 batch_count = tp->batch_max;
2765 /* Until we reach the batch_max limit, pick off addresses which have the
2766 same characteristics. These are:
2769 not previously delivered (see comment about 50 lines above)
2770 same local part if the transport's configuration contains $local_part
2771 or if this is a file or pipe delivery from a redirection
2772 same domain if the transport's configuration contains $domain
2774 same additional headers
2775 same headers to be removed
2776 same uid/gid for running the transport
2777 same first host if a host list is set
2780 while ((next = *anchor) && batch_count < tp->batch_max)
2783 tp == next->transport
2784 && !previously_transported(next, TRUE)
2785 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2786 && testflag(addr, af_file) == testflag(next, af_file)
2787 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2788 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2789 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2790 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2791 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2792 && same_ugid(tp, addr, next)
2793 && ( !addr->host_list && !next->host_list
2796 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2799 /* If the transport has a batch_id setting, batch_id will be non-NULL
2800 from the expansion outside the loop. Expand for this address and compare.
2801 Expansion failure makes this address ineligible for batching. */
2806 address_item *save_nextnext = next->next;
2807 next->next = NULL; /* Expansion for a single address */
2808 deliver_set_expansions(next);
2809 next->next = save_nextnext;
2810 bid = expand_string(tp->batch_id);
2811 deliver_set_expansions(NULL);
2814 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2815 "in %s transport (%s): %s", tp->name, next->address,
2816 expand_string_message);
2819 else ok = (Ustrcmp(batch_id, bid) == 0);
2822 /* Take address into batch if OK. */
2826 *anchor = next->next; /* Include the address */
2832 else anchor = &next->next; /* Skip the address */
2836 /* We now have one or more addresses that can be delivered in a batch. Check
2837 whether the transport is prepared to accept a message of this size. If not,
2838 fail them all forthwith. If the expansion fails, or does not yield an
2839 integer, defer delivery. */
2841 if (tp->message_size_limit)
2843 int rc = check_message_size(tp, addr);
2846 replicate_status(addr);
2850 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2853 continue; /* With next batch of addresses */
2857 /* If we are not running the queue, or if forcing, all deliveries will be
2858 attempted. Otherwise, we must respect the retry times for each address. Even
2859 when not doing this, we need to set up the retry key string, and determine
2860 whether a retry record exists, because after a successful delivery, a delete
2861 retry item must be set up. Keep the retry database open only for the duration
2862 of these checks, rather than for all local deliveries, because some local
2863 deliveries (e.g. to pipes) can take a substantial time. */
2865 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2867 DEBUG(D_deliver|D_retry|D_hints_lookup)
2868 debug_printf("no retry data available\n");
2875 BOOL ok = TRUE; /* to deliver this address */
2878 /* Set up the retry key to include the domain or not, and change its
2879 leading character from "R" to "T". Must make a copy before doing this,
2880 because the old key may be pointed to from a "delete" retry item after
2883 retry_key = string_copy(
2884 tp->retry_use_local_part ? addr2->address_retry_key :
2885 addr2->domain_retry_key);
2888 /* Inspect the retry data. If there is no hints file, delivery happens. */
2892 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2894 /* If there is no retry record, delivery happens. If there is,
2895 remember it exists so it can be deleted after a successful delivery. */
2899 setflag(addr2, af_lt_retry_exists);
2901 /* A retry record exists for this address. If queue running and not
2902 forcing, inspect its contents. If the record is too old, or if its
2903 retry time has come, or if it has passed its cutoff time, delivery
2908 debug_printf("retry record exists: age=%s ",
2909 readconf_printtime(now - retry_record->time_stamp));
2910 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2911 debug_printf(" time to retry = %s expired = %d\n",
2912 readconf_printtime(retry_record->next_try - now),
2913 retry_record->expired);
2916 if (queue_running && !deliver_force)
2918 ok = (now - retry_record->time_stamp > retry_data_expire)
2919 || (now >= retry_record->next_try)
2920 || retry_record->expired;
2922 /* If we haven't reached the retry time, there is one more check
2923 to do, which is for the ultimate address timeout. */
2926 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2930 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2933 /* This address is to be delivered. Leave it on the chain. */
2938 addr2 = addr2->next;
2941 /* This address is to be deferred. Take it out of the chain, and
2942 post-process it as complete. Must take it out of the chain first,
2943 because post processing puts it on another chain. */
2947 address_item *this = addr2;
2948 this->message = US"Retry time not yet reached";
2949 this->basic_errno = ERRNO_LRETRY;
2950 addr2 = addr3 ? (addr3->next = addr2->next)
2951 : (addr = addr2->next);
2952 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2956 if (dbm_file) dbfn_close(dbm_file);
2958 /* If there are no addresses left on the chain, they all deferred. Loop
2959 for the next set of addresses. */
2961 if (!addr) continue;
2963 /* If the transport is limited for parallellism, enforce that here.
2964 We use a hints DB entry, incremented here and decremented after
2965 the transport (and any shadow transport) completes. */
2967 if (tpt_parallel_check(tp, addr, &serialize_key))
2969 if (expand_string_message)
2971 logflags |= LOG_PANIC;
2975 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2976 } while ((addr = addr2));
2978 continue; /* Loop for the next set of addresses. */
2982 /* So, finally, we do have some addresses that can be passed to the
2983 transport. Before doing so, set up variables that are relevant to a
2986 deliver_set_expansions(addr);
2988 gettimeofday(&delivery_start, NULL);
2989 deliver_local(addr, FALSE);
2990 timesince(&deliver_time, &delivery_start);
2992 /* If a shadow transport (which must perforce be another local transport), is
2993 defined, and its condition is met, we must pass the message to the shadow
2994 too, but only those addresses that succeeded. We do this by making a new
2995 chain of addresses - also to keep the original chain uncontaminated. We must
2996 use a chain rather than doing it one by one, because the shadow transport may
2999 NOTE: if the condition fails because of a lookup defer, there is nothing we
3003 && ( !tp->shadow_condition
3004 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3007 transport_instance *stp;
3008 address_item *shadow_addr = NULL;
3009 address_item **last = &shadow_addr;
3011 for (stp = transports; stp; stp = stp->next)
3012 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3015 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3018 /* Pick off the addresses that have succeeded, and make clones. Put into
3019 the shadow_message field a pointer to the shadow_message field of the real
3022 else for (addr2 = addr; addr2; addr2 = addr2->next)
3023 if (addr2->transport_return == OK)
3025 addr3 = store_get(sizeof(address_item));
3028 addr3->shadow_message = US &addr2->shadow_message;
3029 addr3->transport = stp;
3030 addr3->transport_return = DEFER;
3031 addr3->return_filename = NULL;
3032 addr3->return_file = -1;
3034 last = &addr3->next;
3037 /* If we found any addresses to shadow, run the delivery, and stick any
3038 message back into the shadow_message field in the original. */
3042 int save_count = transport_count;
3044 DEBUG(D_deliver|D_transport)
3045 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3046 deliver_local(shadow_addr, TRUE);
3048 for(; shadow_addr; shadow_addr = shadow_addr->next)
3050 int sresult = shadow_addr->transport_return;
3051 *(uschar **)shadow_addr->shadow_message =
3053 ? string_sprintf(" ST=%s", stp->name)
3054 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3055 shadow_addr->basic_errno <= 0
3057 : US strerror(shadow_addr->basic_errno),
3058 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3061 shadow_addr->message
3062 ? shadow_addr->message
3063 : shadow_addr->basic_errno <= 0
3067 DEBUG(D_deliver|D_transport)
3068 debug_printf("%s shadow transport returned %s for %s\n",
3070 sresult == OK ? "OK" :
3071 sresult == DEFER ? "DEFER" :
3072 sresult == FAIL ? "FAIL" :
3073 sresult == PANIC ? "PANIC" : "?",
3074 shadow_addr->address);
3077 DEBUG(D_deliver|D_transport)
3078 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3080 transport_count = save_count; /* Restore original transport count */
3084 /* Cancel the expansions that were set up for the delivery. */
3086 deliver_set_expansions(NULL);
3088 /* If the transport was parallelism-limited, decrement the hints DB record. */
3090 if (serialize_key) enq_end(serialize_key);
3092 /* Now we can process the results of the real transport. We must take each
3093 address off the chain first, because post_process_one() puts it on another
3096 for (addr2 = addr; addr2; addr2 = nextaddr)
3098 int result = addr2->transport_return;
3099 nextaddr = addr2->next;
3101 DEBUG(D_deliver|D_transport)
3102 debug_printf("%s transport returned %s for %s\n",
3104 result == OK ? "OK" :
3105 result == DEFER ? "DEFER" :
3106 result == FAIL ? "FAIL" :
3107 result == PANIC ? "PANIC" : "?",
3110 /* If there is a retry_record, or if delivery is deferred, build a retry
3111 item for setting a new retry time or deleting the old retry record from
3112 the database. These items are handled all together after all addresses
3113 have been handled (so the database is open just for a short time for
3116 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3118 int flags = result == DEFER ? 0 : rf_delete;
3119 uschar *retry_key = string_copy(tp->retry_use_local_part
3120 ? addr2->address_retry_key : addr2->domain_retry_key);
3122 retry_add_item(addr2, retry_key, flags);
3125 /* Done with this address */
3129 addr2->more_errno = deliver_time.tv_sec;
3130 addr2->delivery_usec = deliver_time.tv_usec;
3132 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3134 /* If a pipe delivery generated text to be sent back, the result may be
3135 changed to FAIL, and we must copy this for subsequent addresses in the
3138 if (addr2->transport_return != result)
3140 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3142 addr3->transport_return = addr2->transport_return;
3143 addr3->basic_errno = addr2->basic_errno;
3144 addr3->message = addr2->message;
3146 result = addr2->transport_return;
3149 /* Whether or not the result was changed to FAIL, we need to copy the
3150 return_file value from the first address into all the addresses of the
3151 batch, so they are all listed in the error message. */
3153 addr2->return_file = addr->return_file;
3155 /* Change log character for recording successful deliveries. */
3157 if (result == OK) logchar = '-';
3159 } /* Loop back for next batch of addresses */
3165 /*************************************************
3166 * Sort remote deliveries *
3167 *************************************************/
3169 /* This function is called if remote_sort_domains is set. It arranges that the
3170 chain of addresses for remote deliveries is ordered according to the strings
3171 specified. Try to make this shuffling reasonably efficient by handling
3172 sequences of addresses rather than just single ones.
3179 sort_remote_deliveries(void)
3182 address_item **aptr = &addr_remote;
3183 const uschar *listptr = remote_sort_domains;
3188 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3191 address_item *moved = NULL;
3192 address_item **bptr = &moved;
3196 address_item **next;
3197 deliver_domain = (*aptr)->domain; /* set $domain */
3198 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3199 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3201 aptr = &(*aptr)->next;
3205 next = &(*aptr)->next;
3207 && (deliver_domain = (*next)->domain, /* Set $domain */
3208 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3209 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3211 next = &(*next)->next;
3213 /* If the batch of non-matchers is at the end, add on any that were
3214 extracted further up the chain, and end this iteration. Otherwise,
3215 extract them from the chain and hang on the moved chain. */
3227 aptr = &(*aptr)->next;
3230 /* If the loop ended because the final address matched, *aptr will
3231 be NULL. Add on to the end any extracted non-matching addresses. If
3232 *aptr is not NULL, the loop ended via "break" when *next is null, that
3233 is, there was a string of non-matching addresses at the end. In this
3234 case the extracted addresses have already been added on the end. */
3236 if (!*aptr) *aptr = moved;
3242 debug_printf("remote addresses after sorting:\n");
3243 for (addr = addr_remote; addr; addr = addr->next)
3244 debug_printf(" %s\n", addr->address);
3250 /*************************************************
3251 * Read from pipe for remote delivery subprocess *
3252 *************************************************/
3254 /* This function is called when the subprocess is complete, but can also be
3255 called before it is complete, in order to empty a pipe that is full (to prevent
3256 deadlock). It must therefore keep track of its progress in the parlist data
3259 We read the pipe to get the delivery status codes and a possible error message
3260 for each address, optionally preceded by unusability data for the hosts and
3261 also by optional retry data.
3263 Read in large chunks into the big buffer and then scan through, interpreting
3264 the data therein. In most cases, only a single read will be necessary. No
3265 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3266 that we read the next chunk when there is less than 2500 bytes left in the
3267 non-final chunk, we can assume each item is complete in the buffer before
3268 handling it. Each item is written using a single write(), which is atomic for
3269 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3270 often bigger) so even if we are reading while the subprocess is still going, we
3271 should never have only a partial item in the buffer.
3273 hs12: This assumption is not true anymore, since we got quit large items (certificate
3274 information and such)
3277 poffset the offset of the parlist item
3278 eop TRUE if the process has completed
3280 Returns: TRUE if the terminating 'Z' item has been read,
3281 or there has been a disaster (i.e. no more data needed);
3286 par_read_pipe(int poffset, BOOL eop)
3289 pardata *p = parlist + poffset;
3290 address_item *addrlist = p->addrlist;
3291 address_item *addr = p->addr;
3295 uschar *msg = p->msg;
3296 BOOL done = p->done;
3298 /* Loop through all items, reading from the pipe when necessary. The pipe
3299 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3300 here, as the preceding select() tells us, if data is available for reading.
3302 A read() on a "selected" handle should never block, but(!) it may return
3303 less data then we expected. (The buffer size we pass to read() shouldn't be
3304 understood as a "request", but as a "limit".)
3306 Each separate item is written to the pipe in a timely manner. But, especially for
3307 larger items, the read(2) may already return partial data from the write(2).
3309 The write is atomic mostly (depending on the amount written), but atomic does
3310 not imply "all or noting", it just is "not intermixed" with other writes on the
3311 same channel (pipe).
3315 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3316 (int)p->pid, eop? "ended" : "not ended yet");
3320 retry_item *r, **rp;
3321 uschar pipeheader[PIPE_HEADER_SIZE+1];
3322 uschar *id = &pipeheader[0];
3323 uschar *subid = &pipeheader[1];
3324 uschar *ptr = big_buffer;
3325 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3328 DEBUG(D_deliver) debug_printf(
3329 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3331 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3332 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3333 If we get less, we can assume the subprocess do be done and do not expect any further
3334 information from it. */
3336 got = readn(fd, pipeheader, required);
3337 if (got != required)
3339 msg = string_sprintf("got %d of %d bytes (pipeheader) "
3340 "from transport process %d for transport %s",
3341 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3346 pipeheader[PIPE_HEADER_SIZE] = '\0';
3348 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3352 /* If we can't decode the pipeheader, the subprocess seems to have a
3353 problem, we do not expect any furher information from it. */
3355 required = Ustrtol(pipeheader+2, &endc, 10);
3358 msg = string_sprintf("failed to read pipe "
3359 "from transport process %d for transport %s: error decoding size from header",
3360 pid, addr->transport->driver_name);
3367 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3368 (u_long)required, pid);
3370 /* Same as above, the transport process will write the bytes announced
3371 in a timely manner, so we can just wait for the bytes, getting less than expected
3372 is considered a problem of the subprocess, we do not expect anything else from it. */
3373 got = readn(fd, big_buffer, required);
3374 if (got != required)
3376 msg = string_sprintf("got only %d of %d bytes (pipedata) "
3377 "from transport process %d for transport %s",
3378 got, required, pid, addr->transport->driver_name);
3383 /* Handle each possible type of item, assuming the complete item is
3384 available in store. */
3388 /* Host items exist only if any hosts were marked unusable. Match
3389 up by checking the IP address. */
3392 for (h = addrlist->host_list; h; h = h->next)
3394 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3402 /* Retry items are sent in a preceding R item for each address. This is
3403 kept separate to keep each message short enough to guarantee it won't
3404 be split in the pipe. Hopefully, in the majority of cases, there won't in
3405 fact be any retry items at all.
3407 The complete set of retry items might include an item to delete a
3408 routing retry if there was a previous routing delay. However, routing
3409 retries are also used when a remote transport identifies an address error.
3410 In that case, there may also be an "add" item for the same key. Arrange
3411 that a "delete" item is dropped in favour of an "add" item. */
3414 if (!addr) goto ADDR_MISMATCH;
3416 DEBUG(D_deliver|D_retry)
3417 debug_printf("reading retry information for %s from subprocess\n",
3420 /* Cut out any "delete" items on the list. */
3422 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3423 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3425 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3426 *rp = r->next; /* Excise a delete item */
3427 DEBUG(D_deliver|D_retry)
3428 debug_printf(" existing delete item dropped\n");
3431 /* We want to add a delete item only if there is no non-delete item;
3432 however we still have to step ptr through the data. */
3434 if (!r || !(*ptr & rf_delete))
3436 r = store_get(sizeof(retry_item));
3437 r->next = addr->retries;
3440 r->key = string_copy(ptr);
3442 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3443 ptr += sizeof(r->basic_errno);
3444 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3445 ptr += sizeof(r->more_errno);
3446 r->message = *ptr ? string_copy(ptr) : NULL;
3447 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3448 r->flags & rf_delete ? "delete" : "retry");
3453 DEBUG(D_deliver|D_retry)
3454 debug_printf(" delete item not added: non-delete item exists\n");
3457 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3463 /* Put the amount of data written into the parlist block */
3466 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3467 ptr += sizeof(transport_count);
3470 /* Address items are in the order of items on the address chain. We
3471 remember the current address value in case this function is called
3472 several times to empty the pipe in stages. Information about delivery
3473 over TLS is sent in a preceding X item for each address. We don't put
3474 it in with the other info, in order to keep each message short enough to
3475 guarantee it won't be split in the pipe. */
3479 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3483 addr->cipher = NULL;
3484 addr->peerdn = NULL;
3487 addr->cipher = string_copy(ptr);
3490 addr->peerdn = string_copy(ptr);
3495 (void) tls_import_cert(ptr, &addr->peercert);
3497 addr->peercert = NULL;
3502 (void) tls_import_cert(ptr, &addr->ourcert);
3504 addr->ourcert = NULL;
3507 # ifndef DISABLE_OCSP
3509 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3515 #endif /*SUPPORT_TLS*/
3517 case 'C': /* client authenticator information */
3520 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3521 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3522 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3527 #ifndef DISABLE_PRDR
3529 setflag(addr, af_prdr_used);
3534 setflag(addr, af_chunking_used);
3538 setflag(addr, af_tcp_fastopen_conn);
3539 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3543 if (!addr) goto ADDR_MISMATCH;
3544 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3545 ptr += sizeof(addr->dsn_aware);
3546 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3553 msg = string_sprintf("address count mismatch for data read from pipe "
3554 "for transport process %d for transport %s", pid,
3555 addrlist->transport->driver_name);
3562 #ifdef SUPPORT_SOCKS
3563 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3564 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3569 proxy_local_address = string_copy(ptr);
3571 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3572 ptr += sizeof(proxy_local_port);
3577 #ifdef EXPERIMENTAL_DSN_INFO
3578 case '1': /* must arrive before A0, and applies to that addr */
3579 /* Two strings: smtp_greeting and helo_response */
3580 addr->smtp_greeting = string_copy(ptr);
3582 addr->helo_response = string_copy(ptr);
3588 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3589 addr->transport_return = *ptr++;
3590 addr->special_action = *ptr++;
3591 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3592 ptr += sizeof(addr->basic_errno);
3593 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3594 ptr += sizeof(addr->more_errno);
3595 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3596 ptr += sizeof(addr->delivery_usec);
3597 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3598 ptr += sizeof(addr->flags);
3599 addr->message = *ptr ? string_copy(ptr) : NULL;
3601 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3604 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3608 h = store_get(sizeof(host_item));
3609 h->name = string_copy(ptr);
3611 h->address = string_copy(ptr);
3613 memcpy(&h->port, ptr, sizeof(h->port));
3614 ptr += sizeof(h->port);
3615 h->dnssec = *ptr == '2' ? DS_YES
3616 : *ptr == '1' ? DS_NO
3619 addr->host_used = h;
3623 /* Finished with this address */
3630 /* Local interface address/port */
3632 if (*ptr) sending_ip_address = string_copy(ptr);
3634 if (*ptr) sending_port = atoi(CS ptr);
3638 /* Z marks the logical end of the data. It is followed by '0' if
3639 continue_transport was NULL at the end of transporting, otherwise '1'.
3640 We need to know when it becomes NULL during a delivery down a passed SMTP
3641 channel so that we don't try to pass anything more down it. Of course, for
3642 most normal messages it will remain NULL all the time. */
3647 continue_transport = NULL;
3648 continue_hostname = NULL;
3651 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3654 /* Anything else is a disaster. */
3657 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3658 "process %d for transport %s", ptr[-1], pid,
3659 addr->transport->driver_name);
3665 /* The done flag is inspected externally, to determine whether or not to
3666 call the function again when the process finishes. */
3670 /* If the process hadn't finished, and we haven't seen the end of the data
3671 or if we suffered a disaster, update the rest of the state, and return FALSE to
3672 indicate "not finished". */
3681 /* Close our end of the pipe, to prevent deadlock if the far end is still
3682 pushing stuff into it. */
3687 /* If we have finished without error, but haven't had data for every address,
3688 something is wrong. */
3691 msg = string_sprintf("insufficient address data read from pipe "
3692 "for transport process %d for transport %s", pid,
3693 addr->transport->driver_name);
3695 /* If an error message is set, something has gone wrong in getting back
3696 the delivery data. Put the message into each address and freeze it. */
3699 for (addr = addrlist; addr; addr = addr->next)
3701 addr->transport_return = DEFER;
3702 addr->special_action = SPECIAL_FREEZE;
3703 addr->message = msg;
3704 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3707 /* Return TRUE to indicate we have got all we need from this process, even
3708 if it hasn't actually finished yet. */
3715 /*************************************************
3716 * Post-process a set of remote addresses *
3717 *************************************************/
3719 /* Do what has to be done immediately after a remote delivery for each set of
3720 addresses, then re-write the spool if necessary. Note that post_process_one
3721 puts the address on an appropriate queue; hence we must fish off the next
3722 one first. This function is also called if there is a problem with setting
3723 up a subprocess to do a remote delivery in parallel. In this case, the final
3724 argument contains a message, and the action must be forced to DEFER.
3727 addr pointer to chain of address items
3728 logflags flags for logging
3729 msg NULL for normal cases; -> error message for unexpected problems
3730 fallback TRUE if processing fallback hosts
3736 remote_post_process(address_item *addr, int logflags, uschar *msg,
3741 /* If any host addresses were found to be unusable, add them to the unusable
3742 tree so that subsequent deliveries don't try them. */
3744 for (h = addr->host_list; h; h = h->next)
3746 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3748 /* Now handle each address on the chain. The transport has placed '=' or '-'
3749 into the special_action field for each successful delivery. */
3753 address_item *next = addr->next;
3755 /* If msg == NULL (normal processing) and the result is DEFER and we are
3756 processing the main hosts and there are fallback hosts available, put the
3757 address on the list for fallback delivery. */
3759 if ( addr->transport_return == DEFER
3760 && addr->fallback_hosts
3765 addr->host_list = addr->fallback_hosts;
3766 addr->next = addr_fallback;
3767 addr_fallback = addr;
3768 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3771 /* If msg is set (=> unexpected problem), set it in the address before
3772 doing the ordinary post processing. */
3778 addr->message = msg;
3779 addr->transport_return = DEFER;
3781 (void)post_process_one(addr, addr->transport_return, logflags,
3782 EXIM_DTYPE_TRANSPORT, addr->special_action);
3790 /* If we have just delivered down a passed SMTP channel, and that was
3791 the last address, the channel will have been closed down. Now that
3792 we have logged that delivery, set continue_sequence to 1 so that
3793 any subsequent deliveries don't get "*" incorrectly logged. */
3795 if (!continue_transport) continue_sequence = 1;
3800 /*************************************************
3801 * Wait for one remote delivery subprocess *
3802 *************************************************/
3804 /* This function is called while doing remote deliveries when either the
3805 maximum number of processes exist and we need one to complete so that another
3806 can be created, or when waiting for the last ones to complete. It must wait for
3807 the completion of one subprocess, empty the control block slot, and return a
3808 pointer to the address chain.
3811 Returns: pointer to the chain of addresses handled by the process;
3812 NULL if no subprocess found - this is an unexpected error
3815 static address_item *
3818 int poffset, status;
3819 address_item *addr, *addrlist;
3822 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3823 "to finish", message_id);
3825 /* Loop until either a subprocess completes, or there are no subprocesses in
3826 existence - in which case give an error return. We cannot proceed just by
3827 waiting for a completion, because a subprocess may have filled up its pipe, and
3828 be waiting for it to be emptied. Therefore, if no processes have finished, we
3829 wait for one of the pipes to acquire some data by calling select(), with a
3830 timeout just in case.
3832 The simple approach is just to iterate after reading data from a ready pipe.
3833 This leads to non-ideal behaviour when the subprocess has written its final Z
3834 item, closed the pipe, and is in the process of exiting (the common case). A
3835 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3836 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3839 To avoid this, if all the data that is needed has been read from a subprocess
3840 after select(), an explicit wait() for it is done. We know that all it is doing
3841 is writing to the pipe and then exiting, so the wait should not be long.
3843 The non-blocking waitpid() is to some extent just insurance; if we could
3844 reliably detect end-of-file on the pipe, we could always know when to do a
3845 blocking wait() for a completed process. However, because some systems use
3846 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3847 use code that functions without the need to recognize EOF.
3849 There's a double loop here just in case we end up with a process that is not in
3850 the list of remote delivery processes. Something has obviously gone wrong if
3851 this is the case. (For example, a process that is incorrectly left over from
3852 routing or local deliveries might be found.) The damage can be minimized by
3853 looping back and looking for another process. If there aren't any, the error
3854 return will happen. */
3856 for (;;) /* Normally we do not repeat this loop */
3858 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3861 fd_set select_pipes;
3862 int maxpipe, readycount;
3864 /* A return value of -1 can mean several things. If errno != ECHILD, it
3865 either means invalid options (which we discount), or that this process was
3866 interrupted by a signal. Just loop to try the waitpid() again.
3868 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3869 in existence. This should never happen, and is an unexpected error.
3870 However, there is a nasty complication when running under Linux. If "strace
3871 -f" is being used under Linux to trace this process and its children,
3872 subprocesses are "stolen" from their parents and become the children of the
3873 tracing process. A general wait such as the one we've just obeyed returns
3874 as if there are no children while subprocesses are running. Once a
3875 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3876 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3879 This does not happen using "truss" on Solaris, nor (I think) with other
3880 tracing facilities on other OS. It seems to be specific to Linux.
3882 What we do to get round this is to use kill() to see if any of our
3883 subprocesses are still in existence. If kill() gives an OK return, we know
3884 it must be for one of our processes - it can't be for a re-use of the pid,
3885 because if our process had finished, waitpid() would have found it. If any
3886 of our subprocesses are in existence, we proceed to use select() as if
3887 waitpid() had returned zero. I think this is safe. */
3891 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3894 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3895 "for process existence\n");
3897 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3899 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3901 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3902 "stolen by strace\n", (int)pid);
3903 break; /* With poffset set */
3907 if (poffset >= remote_max_parallel)
3909 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3910 return NULL; /* This is the error return */
3914 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3915 been handled above. A return value of zero means that there is at least one
3916 subprocess, but there are no completed subprocesses. See if any pipes are
3917 ready with any data for reading. */
3919 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3922 FD_ZERO(&select_pipes);
3923 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3924 if (parlist[poffset].pid != 0)
3926 int fd = parlist[poffset].fd;
3927 FD_SET(fd, &select_pipes);
3928 if (fd > maxpipe) maxpipe = fd;
3931 /* Stick in a 60-second timeout, just in case. */
3936 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3939 /* Scan through the pipes and read any that are ready; use the count
3940 returned by select() to stop when there are no more. Select() can return
3941 with no processes (e.g. if interrupted). This shouldn't matter.
3943 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3944 read, or there was a disaster. In either case, we are finished with this
3945 process. Do an explicit wait() for the process and break the main loop if
3948 It turns out that we have to deal with the case of an interrupted system
3949 call, which can happen on some operating systems if the signal handling is
3950 set up to do that by default. */
3953 readycount > 0 && poffset < remote_max_parallel;
3956 if ( (pid = parlist[poffset].pid) != 0
3957 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3961 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3962 for (;;) /* Loop for signals */
3964 pid_t endedpid = waitpid(pid, &status, 0);
3965 if (endedpid == pid) goto PROCESS_DONE;
3966 if (endedpid != (pid_t)(-1) || errno != EINTR)
3967 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3968 "%d (errno = %d) from waitpid() for process %d",
3969 (int)endedpid, errno, (int)pid);
3974 /* Now go back and look for a completed subprocess again. */
3977 /* A completed process was detected by the non-blocking waitpid(). Find the
3978 data block that corresponds to this subprocess. */
3980 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3981 if (pid == parlist[poffset].pid) break;
3983 /* Found the data block; this is a known remote delivery process. We don't
3984 need to repeat the outer loop. This should be what normally happens. */
3986 if (poffset < remote_max_parallel) break;
3988 /* This situation is an error, but it's probably better to carry on looking
3989 for another process than to give up (as we used to do). */
3991 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
3992 "transport process list", pid);
3993 } /* End of the "for" loop */
3995 /* Come here when all the data was completely read after a select(), and
3996 the process in pid has been wait()ed for. */
4003 debug_printf("remote delivery process %d ended\n", (int)pid);
4005 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4009 set_process_info("delivering %s", message_id);
4011 /* Get the chain of processed addresses */
4013 addrlist = parlist[poffset].addrlist;
4015 /* If the process did not finish cleanly, record an error and freeze (except
4016 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4017 in case the delivery did actually happen. */
4019 if ((status & 0xffff) != 0)
4022 int msb = (status >> 8) & 255;
4023 int lsb = status & 255;
4024 int code = (msb == 0)? (lsb & 0x7f) : msb;
4026 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4028 addrlist->transport->driver_name,
4030 (msb == 0)? "terminated by signal" : "exit code",
4033 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4034 addrlist->special_action = SPECIAL_FREEZE;
4036 for (addr = addrlist; addr; addr = addr->next)
4038 addr->transport_return = DEFER;
4039 addr->message = msg;
4042 remove_journal = FALSE;
4045 /* Else complete reading the pipe to get the result of the delivery, if all
4046 the data has not yet been obtained. */
4048 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4050 /* Put the data count and return path into globals, mark the data slot unused,
4051 decrement the count of subprocesses, and return the address chain. */
4053 transport_count = parlist[poffset].transport_count;
4054 used_return_path = parlist[poffset].return_path;
4055 parlist[poffset].pid = 0;
4062 /*************************************************
4063 * Wait for subprocesses and post-process *
4064 *************************************************/
4066 /* This function waits for subprocesses until the number that are still running
4067 is below a given threshold. For each complete subprocess, the addresses are
4068 post-processed. If we can't find a running process, there is some shambles.
4069 Better not bomb out, as that might lead to multiple copies of the message. Just
4070 log and proceed as if all done.
4073 max maximum number of subprocesses to leave running
4074 fallback TRUE if processing fallback hosts
4080 par_reduce(int max, BOOL fallback)
4082 while (parcount > max)
4084 address_item *doneaddr = par_wait();
4087 log_write(0, LOG_MAIN|LOG_PANIC,
4088 "remote delivery process count got out of step");
4093 transport_instance * tp = doneaddr->transport;
4094 if (tp->max_parallel)
4095 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4097 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4103 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4105 uschar pipe_header[PIPE_HEADER_SIZE+1];
4106 size_t total_len = PIPE_HEADER_SIZE + size;
4108 struct iovec iov[2] = {
4109 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4110 { buf, size } /* *the* data */
4115 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4116 /* complain to log if someone tries with buffer sizes we can't handle*/
4118 if (size > BIG_BUFFER_SIZE-1)
4120 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4121 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4123 size = BIG_BUFFER_SIZE;
4126 /* Should we check that we do not write more than PIPE_BUF? What would
4129 /* convert size to human readable string prepended by id and subid */
4130 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4131 id, subid, (long)size))
4132 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4134 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4135 id, subid, (long)size, pipe_header);
4137 if ((ret = writev(fd, iov, 2)) != total_len)
4138 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4139 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4140 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4143 /*************************************************
4144 * Do remote deliveries *
4145 *************************************************/
4147 /* This function is called to process the addresses in addr_remote. We must
4148 pick off the queue all addresses that have the same transport, remote
4149 destination, and errors address, and hand them to the transport in one go,
4150 subject to some configured limitations. If this is a run to continue delivering
4151 to an existing delivery channel, skip all but those addresses that can go to
4152 that channel. The skipped addresses just get deferred.
4154 If mua_wrapper is set, all addresses must be able to be sent in a single
4155 transaction. If not, this function yields FALSE.
4157 In Exim 4, remote deliveries are always done in separate processes, even
4158 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4159 is so that the base process can retain privilege. This makes the
4160 implementation of fallback transports feasible (though not initially done.)
4162 We create up to the configured number of subprocesses, each of which passes
4163 back the delivery state via a pipe. (However, when sending down an existing
4164 connection, remote_max_parallel is forced to 1.)
4167 fallback TRUE if processing fallback hosts
4169 Returns: TRUE normally
4170 FALSE if mua_wrapper is set and the addresses cannot all be sent
4175 do_remote_deliveries(BOOL fallback)
4181 parcount = 0; /* Number of executing subprocesses */
4183 /* When sending down an existing channel, only do one delivery at a time.
4184 We use a local variable (parmax) to hold the maximum number of processes;
4185 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4187 if (continue_transport) remote_max_parallel = 1;
4188 parmax = remote_max_parallel;
4190 /* If the data for keeping a list of processes hasn't yet been
4195 parlist = store_get(remote_max_parallel * sizeof(pardata));
4196 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4197 parlist[poffset].pid = 0;
4200 /* Now loop for each remote delivery */
4202 for (delivery_count = 0; addr_remote; delivery_count++)
4208 int address_count = 1;
4209 int address_count_max;
4211 BOOL use_initgroups;
4212 BOOL pipe_done = FALSE;
4213 transport_instance *tp;
4214 address_item **anchor = &addr_remote;
4215 address_item *addr = addr_remote;
4216 address_item *last = addr;
4219 uschar * serialize_key = NULL;
4221 /* Pull the first address right off the list. */
4223 addr_remote = addr->next;
4226 DEBUG(D_deliver|D_transport)
4227 debug_printf("--------> %s <--------\n", addr->address);
4229 /* If no transport has been set, there has been a big screw-up somewhere. */
4231 if (!(tp = addr->transport))
4233 disable_logging = FALSE; /* Jic */
4234 panicmsg = US"No transport set by router";
4235 goto panic_continue;
4238 /* Check that this base address hasn't previously been delivered to this
4239 transport. The check is necessary at this point to handle homonymic addresses
4240 correctly in cases where the pattern of redirection changes between delivery
4241 attempts. Non-homonymic previous delivery is detected earlier, at routing
4244 if (previously_transported(addr, FALSE)) continue;
4246 /* Force failure if the message is too big. */
4248 if (tp->message_size_limit)
4250 int rc = check_message_size(tp, addr);
4253 addr->transport_return = rc;
4254 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4259 /* Get the flag which specifies whether the transport can handle different
4260 domains that nevertheless resolve to the same set of hosts. If it needs
4261 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4262 $host, $host_address, $host_port. */
4263 if (tp->expand_multi_domain)
4264 deliver_set_expansions(addr);
4266 if (exp_bool(addr, US"transport", tp->name, D_transport,
4267 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4268 &multi_domain) != OK)
4270 deliver_set_expansions(NULL);
4271 panicmsg = addr->message;
4272 goto panic_continue;
4275 /* Get the maximum it can handle in one envelope, with zero meaning
4276 unlimited, which is forced for the MUA wrapper case. */
4278 address_count_max = tp->max_addresses;
4279 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4282 /************************************************************************/
4283 /***** This is slightly experimental code, but should be safe. *****/
4285 /* The address_count_max value is the maximum number of addresses that the
4286 transport can send in one envelope. However, the transport must be capable of
4287 dealing with any number of addresses. If the number it gets exceeds its
4288 envelope limitation, it must send multiple copies of the message. This can be
4289 done over a single connection for SMTP, so uses less resources than making
4290 multiple connections. On the other hand, if remote_max_parallel is greater
4291 than one, it is perhaps a good idea to use parallel processing to move the
4292 message faster, even if that results in multiple simultaneous connections to
4295 How can we come to some compromise between these two ideals? What we do is to
4296 limit the number of addresses passed to a single instance of a transport to
4297 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4298 number of addresses routed to remote transports divided by
4299 remote_max_parallel. For example, if the message has 100 remote recipients,
4300 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4301 once. But if rcpt_max is 100, we could send up to 100.
4303 Of course, not all the remotely addresses in a message are going to go to the
4304 same set of hosts (except in smarthost configurations), so this is just a
4305 heuristic way of dividing up the work.
4307 Furthermore (1), because this may not be wanted in some cases, and also to
4308 cope with really pathological cases, there is also a limit to the number of
4309 messages that are sent over one connection. This is the same limit that is
4310 used when sending several different messages over the same connection.
4311 Continue_sequence is set when in this situation, to the number sent so
4312 far, including this message.
4314 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4315 is probably because they are using VERP, in which case they want to pass only
4316 one address at a time to the transport, in order to be able to use
4317 $local_part and $domain in constructing a new return path. We could test for
4318 the use of these variables, but as it is so likely they will be used when the
4319 maximum is 1, we don't bother. Just leave the value alone. */
4321 if ( address_count_max != 1
4322 && address_count_max < remote_delivery_count/remote_max_parallel
4325 int new_max = remote_delivery_count/remote_max_parallel;
4326 int message_max = tp->connection_max_messages;
4327 if (connection_max_messages >= 0) message_max = connection_max_messages;
4328 message_max -= continue_sequence - 1;
4329 if (message_max > 0 && new_max > address_count_max * message_max)
4330 new_max = address_count_max * message_max;
4331 address_count_max = new_max;
4334 /************************************************************************/
4337 /* Pick off all addresses which have the same transport, errors address,
4338 destination, and extra headers. In some cases they point to the same host
4339 list, but we also need to check for identical host lists generated from
4340 entirely different domains. The host list pointers can be NULL in the case
4341 where the hosts are defined in the transport. There is also a configured
4342 maximum limit of addresses that can be handled at once (see comments above
4343 for how it is computed).
4344 If the transport does not handle multiple domains, enforce that also,
4345 and if it might need a per-address check for this, re-evaluate it.
4348 while ((next = *anchor) && address_count < address_count_max)
4351 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4352 && tp == next->transport
4353 && same_hosts(next->host_list, addr->host_list)
4354 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4355 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4356 && same_ugid(tp, next, addr)
4357 && ( next->prop.remove_headers == addr->prop.remove_headers
4358 || ( next->prop.remove_headers
4359 && addr->prop.remove_headers
4360 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4364 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4366 US"transport", next->transport->name, D_transport,
4367 US"multi_domain", next->transport->multi_domain,
4368 next->transport->expand_multi_domain, &md) == OK
4373 *anchor = next->next;
4375 next->first = addr; /* remember top one (for retry processing) */
4380 else anchor = &(next->next);
4381 deliver_set_expansions(NULL);
4384 /* If we are acting as an MUA wrapper, all addresses must go in a single
4385 transaction. If not, put them back on the chain and yield FALSE. */
4387 if (mua_wrapper && addr_remote)
4389 last->next = addr_remote;
4394 /* If the transport is limited for parallellism, enforce that here.
4395 The hints DB entry is decremented in par_reduce(), when we reap the
4396 transport process. */
4398 if (tpt_parallel_check(tp, addr, &serialize_key))
4399 if ((panicmsg = expand_string_message))
4400 goto panic_continue;
4402 continue; /* Loop for the next set of addresses. */
4404 /* Set up the expansion variables for this set of addresses */
4406 deliver_set_expansions(addr);
4408 /* Ensure any transport-set auth info is fresh */
4409 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4411 /* Compute the return path, expanding a new one if required. The old one
4412 must be set first, as it might be referred to in the expansion. */
4414 if(addr->prop.errors_address)
4415 return_path = addr->prop.errors_address;
4416 #ifdef EXPERIMENTAL_SRS
4417 else if(addr->prop.srs_sender)
4418 return_path = addr->prop.srs_sender;
4421 return_path = sender_address;
4423 if (tp->return_path)
4425 uschar *new_return_path = expand_string(tp->return_path);
4426 if (new_return_path)
4427 return_path = new_return_path;
4428 else if (!expand_string_forcedfail)
4430 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4431 tp->return_path, expand_string_message);
4436 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4437 logs and sets up error messages, so we just post-process and continue with
4438 the next address. */
4440 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4446 /* If this transport has a setup function, call it now so that it gets
4447 run in this process and not in any subprocess. That way, the results of
4448 any setup that are retained by the transport can be reusable. One of the
4449 things the setup does is to set the fallback host lists in the addresses.
4450 That is why it is called at this point, before the continue delivery
4451 processing, because that might use the fallback hosts. */
4454 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4456 /* If we have a connection still open from a verify stage (lazy-close)
4457 treat it as if it is a continued connection (apart from the counter used
4458 for the log line mark). */
4460 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
4463 debug_printf("lazy-callout-close: have conn still open from verification\n");
4464 continue_transport = cutthrough.transport;
4465 continue_hostname = string_copy(cutthrough.host.name);
4466 continue_host_address = string_copy(cutthrough.host.address);
4467 continue_sequence = 1;
4468 sending_ip_address = cutthrough.snd_ip;
4469 sending_port = cutthrough.snd_port;
4470 smtp_peer_options = cutthrough.peer_options;
4473 /* If this is a run to continue delivery down an already-established
4474 channel, check that this set of addresses matches the transport and
4475 the channel. If it does not, defer the addresses. If a host list exists,
4476 we must check that the continue host is on the list. Otherwise, the
4477 host is set in the transport. */
4479 continue_more = FALSE; /* In case got set for the last lot */
4480 if (continue_transport)
4482 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4484 /* If the transport is about to override the host list do not check
4485 it here but take the cost of running the transport process to discover
4486 if the continued_hostname connection is suitable. This is a layering
4487 violation which is unfortunate as it requires we haul in the smtp
4492 smtp_transport_options_block * ob;
4494 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4495 && (ob = (smtp_transport_options_block *)tp->options_block)
4496 && ob->hosts_override && ob->hosts
4503 for (h = addr->host_list; h; h = h->next)
4504 if (Ustrcmp(h->name, continue_hostname) == 0)
4505 /*XXX should also check port here */
4506 { ok = TRUE; break; }
4510 /* Addresses not suitable; defer or queue for fallback hosts (which
4511 might be the continue host) and skip to next address. */
4515 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4516 Ustrcmp(continue_transport, tp->name) != 0
4517 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4518 : string_sprintf("no host matching %s", continue_hostname));
4519 if (serialize_key) enq_end(serialize_key);
4521 if (addr->fallback_hosts && !fallback)
4523 for (next = addr; ; next = next->next)
4525 next->host_list = next->fallback_hosts;
4526 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4527 if (!next->next) break;
4529 next->next = addr_fallback;
4530 addr_fallback = addr;
4535 for (next = addr; ; next = next->next)
4537 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4538 if (!next->next) break;
4540 next->next = addr_defer;
4547 /* Set a flag indicating whether there are further addresses that list
4548 the continued host. This tells the transport to leave the channel open,
4549 but not to pass it to another delivery process. We'd like to do that
4550 for non-continue_transport cases too but the knowlege of which host is
4551 connected to is too hard to manage. Perhaps we need a finer-grain
4552 interface to the transport. */
4554 for (next = addr_remote; next && !continue_more; next = next->next)
4557 for (h = next->host_list; h; h = h->next)
4558 if (Ustrcmp(h->name, continue_hostname) == 0)
4559 { continue_more = TRUE; break; }
4563 /* The transports set up the process info themselves as they may connect
4564 to more than one remote machine. They also have to set up the filter
4565 arguments, if required, so that the host name and address are available
4568 transport_filter_argv = NULL;
4570 /* Create the pipe for inter-process communication. If pipe creation
4571 fails, it is probably because the value of remote_max_parallel is so
4572 large that too many file descriptors for pipes have been created. Arrange
4573 to wait for a process to finish, and then try again. If we still can't
4574 create a pipe when all processes have finished, break the retry loop. */
4578 if (pipe(pfd) == 0) pipe_done = TRUE;
4579 else if (parcount > 0) parmax = parcount;
4582 /* We need to make the reading end of the pipe non-blocking. There are
4583 two different options for this. Exim is cunningly (I hope!) coded so
4584 that it can use either of them, though it prefers O_NONBLOCK, which
4585 distinguishes between EOF and no-more-data. */
4587 /* The data appears in a timely manner and we already did a select on
4588 all pipes, so I do not see a reason to use non-blocking IO here
4591 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4593 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4597 /* If the maximum number of subprocesses already exist, wait for a process
4598 to finish. If we ran out of file descriptors, parmax will have been reduced
4599 from its initial value of remote_max_parallel. */
4601 par_reduce(parmax - 1, fallback);
4604 /* If we failed to create a pipe and there were no processes to wait
4605 for, we have to give up on this one. Do this outside the above loop
4606 so that we can continue the main loop. */
4610 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4614 /* Find a free slot in the pardata list. Must do this after the possible
4615 waiting for processes to finish, because a terminating process will free
4618 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4619 if (parlist[poffset].pid == 0)
4622 /* If there isn't one, there has been a horrible disaster. */
4624 if (poffset >= remote_max_parallel)
4626 (void)close(pfd[pipe_write]);
4627 (void)close(pfd[pipe_read]);
4628 panicmsg = US"Unexpectedly no free subprocess slot";
4632 /* Now fork a subprocess to do the remote delivery, but before doing so,
4633 ensure that any cached resources are released so as not to interfere with
4634 what happens in the subprocess. */
4639 if ((pid = fork()) == 0)
4641 int fd = pfd[pipe_write];
4643 DEBUG(D_deliver) debug_selector |= D_pid; // hs12
4645 /* Setting this global in the subprocess means we need never clear it */
4646 transport_name = tp->name;
4648 /* There are weird circumstances in which logging is disabled */
4649 disable_logging = tp->disable_logging;
4651 /* Show pids on debug output if parallelism possible */
4653 if (parmax > 1 && (parcount > 0 || addr_remote))
4655 DEBUG(D_any|D_v) debug_selector |= D_pid;
4656 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4659 /* Reset the random number generator, so different processes don't all
4660 have the same sequence. In the test harness we want different, but
4661 predictable settings for each delivery process, so do something explicit
4662 here rather they rely on the fixed reset in the random number function. */
4664 random_seed = running_in_test_harness ? 42 + 2*delivery_count : 0;
4666 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4667 a new process that may be forked to do another delivery down the same
4670 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4672 /* Close open file descriptors for the pipes of other processes
4673 that are running in parallel. */
4675 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4676 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4678 /* This process has inherited a copy of the file descriptor
4679 for the data file, but its file pointer is shared with all the
4680 other processes running in parallel. Therefore, we have to re-open
4681 the file in order to get a new file descriptor with its own
4682 file pointer. We don't need to lock it, as the lock is held by
4683 the parent process. There doesn't seem to be any way of doing
4684 a dup-with-new-file-pointer. */
4686 (void)close(deliver_datafile);
4688 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4690 if ((deliver_datafile = Uopen(fname,
4694 O_RDWR | O_APPEND, 0)) < 0)
4695 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4696 "parallel delivery: %s", fname, strerror(errno));
4699 /* Set the close-on-exec flag */
4701 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4705 /* Set the uid/gid of this process; bombs out on failure. */
4707 exim_setugid(uid, gid, use_initgroups,
4708 string_sprintf("remote delivery to %s with transport=%s",
4709 addr->address, tp->name));
4711 /* Close the unwanted half of this process' pipe, set the process state,
4712 and run the transport. Afterwards, transport_count will contain the number
4713 of bytes written. */
4715 (void)close(pfd[pipe_read]);
4716 set_process_info("delivering %s using %s", message_id, tp->name);
4717 debug_print_string(tp->debug_string);
4718 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4720 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4721 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4723 /* Ensure any cached resources that we used are now released */
4727 /* Pass the result back down the pipe. This is a lot more information
4728 than is needed for a local delivery. We have to send back the error
4729 status for each address, the usability status for each host that is
4730 flagged as unusable, and all the retry items. When TLS is in use, we
4731 send also the cipher and peerdn information. Each type of information
4732 is flagged by an identifying byte, and is then in a fixed format (with
4733 strings terminated by zeros), and there is a final terminator at the
4734 end. The host information and retry information is all attached to
4735 the first address, so that gets sent at the start. */
4737 /* Host unusability information: for most success cases this will
4740 for (h = addr->host_list; h; h = h->next)
4742 if (!h->address || h->status < hstatus_unusable) continue;
4743 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4744 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4747 /* The number of bytes written. This is the same for each address. Even
4748 if we sent several copies of the message down the same connection, the
4749 size of each one is the same, and it's that value we have got because
4750 transport_count gets reset before calling transport_write_message(). */
4752 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4753 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4755 /* Information about what happened to each address. Four item types are
4756 used: an optional 'X' item first, for TLS information, then an optional "C"
4757 item for any client-auth info followed by 'R' items for any retry settings,
4758 and finally an 'A' item for the remaining data. */
4760 for(; addr; addr = addr->next)
4765 /* The certificate verification status goes into the flags */
4766 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4767 #ifdef EXPERIMENTAL_DANE
4768 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4771 /* Use an X item only if there's something to send */
4775 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4779 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4781 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4783 else if (continue_proxy_cipher)
4785 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4787 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4793 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4797 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4802 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4806 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4808 # ifndef DISABLE_OCSP
4809 if (addr->ocsp > OCSP_NOT_REQ)
4811 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4812 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4815 #endif /*SUPPORT_TLS*/
4817 if (client_authenticator)
4819 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4820 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4822 if (client_authenticated_id)
4824 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4825 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4827 if (client_authenticated_sender)
4829 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4830 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4833 #ifndef DISABLE_PRDR
4834 if (testflag(addr, af_prdr_used))
4835 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4838 if (testflag(addr, af_chunking_used))
4839 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4841 if (testflag(addr, af_tcp_fastopen_conn))
4842 rmt_dlv_checked_write(fd, 'T',
4843 testflag(addr, af_tcp_fastopen) ? '1' : '0', NULL, 0);
4845 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4846 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4848 /* Retry information: for most success cases this will be null. */
4850 for (r = addr->retries; r; r = r->next)
4852 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4853 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4854 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4855 ptr += sizeof(r->basic_errno);
4856 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4857 ptr += sizeof(r->more_errno);
4858 if (!r->message) *ptr++ = 0; else
4860 sprintf(CS ptr, "%.512s", r->message);
4863 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4866 #ifdef SUPPORT_SOCKS
4867 if (LOGGING(proxy) && proxy_session)
4870 if (proxy_local_address)
4872 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4873 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4874 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4875 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4876 ptr += sizeof(proxy_local_port);
4880 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4884 #ifdef EXPERIMENTAL_DSN_INFO
4885 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4886 if (addr->smtp_greeting)
4888 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4889 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4890 if (addr->helo_response)
4892 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4893 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4897 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4901 /* The rest of the information goes in an 'A0' item. */
4903 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4904 ptr = big_buffer + 2;
4905 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4906 ptr += sizeof(addr->basic_errno);
4907 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4908 ptr += sizeof(addr->more_errno);
4909 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4910 ptr += sizeof(addr->delivery_usec);
4911 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4912 ptr += sizeof(addr->flags);
4914 if (!addr->message) *ptr++ = 0; else
4915 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4917 if (!addr->user_message) *ptr++ = 0; else
4918 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4920 if (!addr->host_used) *ptr++ = 0; else
4922 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4923 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4924 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4925 ptr += sizeof(addr->host_used->port);
4927 /* DNS lookup status */
4928 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4929 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4932 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4935 /* Local interface address/port */
4936 #ifdef EXPERIMENTAL_DSN_INFO
4937 if (sending_ip_address)
4939 if (LOGGING(incoming_interface) && sending_ip_address)
4943 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4944 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4945 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4948 /* Add termination flag, close the pipe, and that's it. The character
4949 after 'Z' indicates whether continue_transport is now NULL or not.
4950 A change from non-NULL to NULL indicates a problem with a continuing
4953 big_buffer[0] = continue_transport ? '1' : '0';
4954 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4959 /* Back in the mainline: close the unwanted half of the pipe. */
4961 (void)close(pfd[pipe_write]);
4963 /* If we have a connection still open from a verify stage (lazy-close)
4964 release its TLS library context (if any) as responsibility was passed to
4965 the delivery child process. */
4967 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
4970 tls_close(FALSE, FALSE);
4972 (void) close(cutthrough.fd);
4973 release_cutthrough_connection(US"passed to transport proc");
4976 /* Fork failed; defer with error message */
4980 (void)close(pfd[pipe_read]);
4981 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
4982 addr->domain, strerror(errno));
4986 /* Fork succeeded; increment the count, and remember relevant data for
4987 when the process finishes. */
4990 parlist[poffset].addrlist = parlist[poffset].addr = addr;
4991 parlist[poffset].pid = pid;
4992 parlist[poffset].fd = pfd[pipe_read];
4993 parlist[poffset].done = FALSE;
4994 parlist[poffset].msg = NULL;
4995 parlist[poffset].return_path = return_path;
4997 /* If the process we've just started is sending a message down an existing
4998 channel, wait for it now. This ensures that only one such process runs at
4999 once, whatever the value of remote_max parallel. Otherwise, we might try to
5000 send two or more messages simultaneously down the same channel. This could
5001 happen if there are different domains that include the same host in otherwise
5002 different host lists.
5004 Also, if the transport closes down the channel, this information gets back
5005 (continue_transport gets set to NULL) before we consider any other addresses
5008 if (continue_transport) par_reduce(0, fallback);
5010 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5011 newly created process get going before we create another process. This should
5012 ensure repeatability in the tests. We only need to wait a tad. */
5014 else if (running_in_test_harness) millisleep(500);
5019 if (serialize_key) enq_end(serialize_key);
5021 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5025 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5026 are still running and post-process their addresses. */
5028 par_reduce(0, fallback);
5035 /*************************************************
5036 * Split an address into local part and domain *
5037 *************************************************/
5039 /* This function initializes an address for routing by splitting it up into a
5040 local part and a domain. The local part is set up twice - once in its original
5041 casing, and once in lower case, and it is dequoted. We also do the "percent
5042 hack" for configured domains. This may lead to a DEFER result if a lookup
5043 defers. When a percent-hacking takes place, we insert a copy of the original
5044 address as a new parent of this address, as if we have had a redirection.
5047 addr points to an addr_item block containing the address
5050 DEFER - could not determine if domain is %-hackable
5054 deliver_split_address(address_item * addr)
5056 uschar * address = addr->address;
5061 if (!(domain = Ustrrchr(address, '@')))
5062 return DEFER; /* should always have a domain, but just in case... */
5064 len = domain - address;
5065 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5067 /* The implication in the RFCs (though I can't say I've seen it spelled out
5068 explicitly) is that quoting should be removed from local parts at the point
5069 where they are locally interpreted. [The new draft "821" is more explicit on
5070 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5071 removing quoting backslashes and any unquoted doublequotes. */
5073 t = addr->cc_local_part = store_get(len+1);
5077 if (c == '\"') continue;
5087 /* We do the percent hack only for those domains that are listed in
5088 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5090 if (percent_hack_domains)
5093 uschar *new_address = NULL;
5094 uschar *local_part = addr->cc_local_part;
5096 deliver_domain = addr->domain; /* set $domain */
5098 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5099 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5101 && (t = Ustrrchr(local_part, '%')) != NULL
5104 new_address = string_copy(local_part);
5105 new_address[t - local_part] = '@';
5106 deliver_domain = string_copylc(t+1);
5107 local_part = string_copyn(local_part, t - local_part);
5110 if (rc == DEFER) return DEFER; /* lookup deferred */
5112 /* If hackery happened, set up new parent and alter the current address. */
5116 address_item *new_parent = store_get(sizeof(address_item));
5117 *new_parent = *addr;
5118 addr->parent = new_parent;
5119 new_parent->child_count = 1;
5120 addr->address = new_address;
5121 addr->unique = string_copy(new_address);
5122 addr->domain = deliver_domain;
5123 addr->cc_local_part = local_part;
5124 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5129 /* Create the lowercased version of the final local part, and make that the
5130 default one to be used. */
5132 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5139 /*************************************************
5140 * Get next error message text *
5141 *************************************************/
5143 /* If f is not NULL, read the next "paragraph", from a customized error message
5144 text file, terminated by a line containing ****, and expand it.
5147 f NULL or a file to read from
5148 which string indicating which string (for errors)
5150 Returns: NULL or an expanded string
5154 next_emf(FILE *f, uschar *which)
5158 uschar *para, *yield;
5161 if (!f) return NULL;
5163 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5166 para = store_get(size);
5169 para = string_cat(para, &size, &ptr, buffer);
5170 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5175 if ((yield = expand_string(para)))
5178 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5179 "bounce_message_file or warn_message_file (%s): %s", which,
5180 expand_string_message);
5187 /*************************************************
5188 * Close down a passed transport channel *
5189 *************************************************/
5191 /* This function is called when a passed transport channel cannot be used.
5192 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5193 so that the function call can be the argument of a "return" statement.
5196 Returns: DELIVER_NOT_ATTEMPTED
5200 continue_closedown(void)
5202 if (continue_transport)
5204 transport_instance *t;
5205 for (t = transports; t; t = t->next)
5206 if (Ustrcmp(t->name, continue_transport) == 0)
5208 if (t->info->closedown) (t->info->closedown)(t);
5212 return DELIVER_NOT_ATTEMPTED;
5218 /*************************************************
5219 * Print address information *
5220 *************************************************/
5222 /* This function is called to output an address, or information about an
5223 address, for bounce or defer messages. If the hide_child flag is set, all we
5224 output is the original ancestor address.
5227 addr points to the address
5228 f the FILE to print to
5229 si an initial string
5230 sc a continuation string for before "generated"
5233 Returns: TRUE if the address is not hidden
5237 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5241 uschar *printed = US"";
5242 address_item *ancestor = addr;
5243 while (ancestor->parent) ancestor = ancestor->parent;
5245 fprintf(f, "%s", CS si);
5247 if (addr->parent && testflag(addr, af_hide_child))
5249 printed = US"an undisclosed address";
5252 else if (!testflag(addr, af_pfr) || !addr->parent)
5253 printed = addr->address;
5257 uschar *s = addr->address;
5260 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5261 else if (addr->address[0] == '|') ss = US"pipe";
5264 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5265 printed = addr->parent->address;
5268 fprintf(f, "%s", CS string_printing(printed));
5270 if (ancestor != addr)
5272 uschar *original = ancestor->onetime_parent;
5273 if (!original) original= ancestor->address;
5274 if (strcmpic(original, printed) != 0)
5275 fprintf(f, "%s(%sgenerated from %s)", sc,
5276 ancestor != addr->parent ? "ultimately " : "",
5277 string_printing(original));
5280 if (addr->host_used)
5281 fprintf(f, "\n host %s [%s]",
5282 addr->host_used->name, addr->host_used->address);
5284 fprintf(f, "%s", CS se);
5292 /*************************************************
5293 * Print error for an address *
5294 *************************************************/
5296 /* This function is called to print the error information out of an address for
5297 a bounce or a warning message. It tries to format the message reasonably by
5298 introducing newlines. All lines are indented by 4; the initial printing
5299 position must be set before calling.
5301 This function used always to print the error. Nowadays we want to restrict it
5302 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5303 and filter "fail". We no longer pass other information willy-nilly in bounce
5304 and warning messages. Text in user_message is always output; text in message
5305 only if the af_pass_message flag is set.
5309 f the FILE to print on
5316 print_address_error(address_item *addr, FILE *f, uschar *t)
5318 int count = Ustrlen(t);
5319 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
5321 if (!s && !(s = addr->user_message))
5324 fprintf(f, "\n %s", t);
5327 if (*s == '\\' && s[1] == 'n')
5337 if (*s++ == ':' && isspace(*s) && count > 45)
5339 fprintf(f, "\n "); /* sic (because space follows) */
5346 /***********************************************************
5347 * Print Diagnostic-Code for an address *
5348 ************************************************************/
5350 /* This function is called to print the error information out of an address for
5351 a bounce or a warning message. It tries to format the message reasonably as
5352 required by RFC 3461 by adding a space after each newline
5354 it uses the same logic as print_address_error() above. if af_pass_message is true
5355 and addr->message is set it uses the remote host answer. if not addr->user_message
5356 is used instead if available.
5360 f the FILE to print on
5366 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5368 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5370 /* af_pass_message and addr->message set ? print remote host answer */
5374 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5376 /* search first ": ". we assume to find the remote-MTA answer there */
5377 if (!(s = Ustrstr(addr->message, ": ")))
5378 return; /* not found, bail out */
5379 s += 2; /* skip ": " */
5380 fprintf(f, "Diagnostic-Code: smtp; ");
5382 /* no message available. do nothing */
5386 if (*s == '\\' && s[1] == 'n')
5388 fputs("\n ", f); /* as defined in RFC 3461 */
5398 /*************************************************
5399 * Check list of addresses for duplication *
5400 *************************************************/
5402 /* This function was introduced when the test for duplicate addresses that are
5403 not pipes, files, or autoreplies was moved from the middle of routing to when
5404 routing was complete. That was to fix obscure cases when the routing history
5405 affects the subsequent routing of identical addresses. This function is called
5406 after routing, to check that the final routed addresses are not duplicates.
5408 If we detect a duplicate, we remember what it is a duplicate of. Note that
5409 pipe, file, and autoreply de-duplication is handled during routing, so we must
5410 leave such "addresses" alone here, as otherwise they will incorrectly be
5413 Argument: address of list anchor
5418 do_duplicate_check(address_item **anchor)
5421 while ((addr = *anchor))
5424 if (testflag(addr, af_pfr))
5426 anchor = &(addr->next);
5428 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5430 DEBUG(D_deliver|D_route)
5431 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5432 *anchor = addr->next;
5433 addr->dupof = tnode->data.ptr;
5434 addr->next = addr_duplicate;
5435 addr_duplicate = addr;
5439 tree_add_duplicate(addr->unique, addr);
5440 anchor = &(addr->next);
5448 /*************************************************
5449 * Deliver one message *
5450 *************************************************/
5452 /* This is the function which is called when a message is to be delivered. It
5453 is passed the id of the message. It is possible that the message no longer
5454 exists, if some other process has delivered it, and it is also possible that
5455 the message is being worked on by another process, in which case the data file
5458 If no delivery is attempted for any of the above reasons, the function returns
5459 DELIVER_NOT_ATTEMPTED.
5461 If the give_up flag is set true, do not attempt any deliveries, but instead
5462 fail all outstanding addresses and return the message to the sender (or
5465 A delivery operation has a process all to itself; we never deliver more than
5466 one message in the same process. Therefore we needn't worry too much about
5469 Liable to be called as root.
5472 id the id of the message to be delivered
5473 forced TRUE if delivery was forced by an administrator; this overrides
5474 retry delays and causes a delivery to be tried regardless
5475 give_up TRUE if an administrator has requested that delivery attempts
5478 Returns: When the global variable mua_wrapper is FALSE:
5479 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5480 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5481 When the global variable mua_wrapper is TRUE:
5482 DELIVER_MUA_SUCCEEDED if delivery succeeded
5483 DELIVER_MUA_FAILED if delivery failed
5484 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5488 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5491 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5492 time_t now = time(NULL);
5493 address_item *addr_last = NULL;
5494 uschar *filter_message = NULL;
5495 int process_recipients = RECIP_ACCEPT;
5498 extern int acl_where;
5500 uschar *info = queue_run_pid == (pid_t)0
5501 ? string_sprintf("delivering %s", id)
5502 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5504 /* If the D_process_info bit is on, set_process_info() will output debugging
5505 information. If not, we want to show this initial information if D_deliver or
5506 D_queue_run is set or in verbose mode. */
5508 set_process_info("%s", info);
5510 if ( !(debug_selector & D_process_info)
5511 && (debug_selector & (D_deliver|D_queue_run|D_v))
5513 debug_printf("%s\n", info);
5515 /* Ensure that we catch any subprocesses that are created. Although Exim
5516 sets SIG_DFL as its initial default, some routes through the code end up
5517 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5518 has been forked, but no re-exec has been done. We use sigaction rather than
5519 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5520 sure it is turned off. (There was a problem on AIX with this.) */
5524 struct sigaction act;
5525 act.sa_handler = SIG_DFL;
5526 sigemptyset(&(act.sa_mask));
5528 sigaction(SIGCHLD, &act, NULL);
5531 signal(SIGCHLD, SIG_DFL);
5534 /* Make the forcing flag available for routers and transports, set up the
5535 global message id field, and initialize the count for returned files and the
5536 message size. This use of strcpy() is OK because the length id is checked when
5537 it is obtained from a command line (the -M or -q options), and otherwise it is
5538 known to be a valid message id. */
5540 Ustrcpy(message_id, id);
5541 deliver_force = forced;
5545 /* Initialize some flags */
5547 update_spool = FALSE;
5548 remove_journal = TRUE;
5550 /* Set a known context for any ACLs we call via expansions */
5551 acl_where = ACL_WHERE_DELIVERY;
5553 /* Reset the random number generator, so that if several delivery processes are
5554 started from a queue runner that has already used random numbers (for sorting),
5555 they don't all get the same sequence. */
5559 /* Open and lock the message's data file. Exim locks on this one because the
5560 header file may get replaced as it is re-written during the delivery process.
5561 Any failures cause messages to be written to the log, except for missing files
5562 while queue running - another process probably completed delivery. As part of
5563 opening the data file, message_subdir gets set. */
5565 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5566 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5568 /* The value of message_size at this point has been set to the data length,
5569 plus one for the blank line that notionally precedes the data. */
5571 /* Now read the contents of the header file, which will set up the headers in
5572 store, and also the list of recipients and the tree of non-recipients and
5573 assorted flags. It updates message_size. If there is a reading or format error,
5574 give up; if the message has been around for sufficiently long, remove it. */
5577 uschar * spoolname = string_sprintf("%s-H", id);
5578 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5580 if (errno == ERRNO_SPOOLFORMAT)
5582 struct stat statbuf;
5583 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5585 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5586 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5588 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5591 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5594 /* If we managed to read the envelope data, received_time contains the
5595 time the message was received. Otherwise, we can calculate it from the
5598 if (rc != spool_read_hdrerror)
5600 received_time.tv_sec = received_time.tv_usec = 0;
5601 /*XXX subsec precision?*/
5602 for (i = 0; i < 6; i++)
5603 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5606 /* If we've had this malformed message too long, sling it. */
5608 if (now - received_time.tv_sec > keep_malformed)
5610 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5611 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5612 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5613 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5614 log_write(0, LOG_MAIN, "Message removed because older than %s",
5615 readconf_printtime(keep_malformed));
5618 (void)close(deliver_datafile);
5619 deliver_datafile = -1;
5620 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5624 /* The spool header file has been read. Look to see if there is an existing
5625 journal file for this message. If there is, it means that a previous delivery
5626 attempt crashed (program or host) before it could update the spool header file.
5627 Read the list of delivered addresses from the journal and add them to the
5628 nonrecipients tree. Then update the spool file. We can leave the journal in
5629 existence, as it will get further successful deliveries added to it in this
5630 run, and it will be deleted if this function gets to its end successfully.
5631 Otherwise it might be needed again. */
5634 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5637 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5645 && lseek(journal_fd, 0, SEEK_SET) == 0
5646 && (jread = fdopen(journal_fd, "rb"))
5649 while (Ufgets(big_buffer, big_buffer_size, jread))
5651 int n = Ustrlen(big_buffer);
5652 big_buffer[n-1] = 0;
5653 tree_add_nonrecipient(big_buffer);
5654 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5655 "journal file\n", big_buffer);
5658 if ((journal_fd = dup(fileno(jread))) < 0)
5659 journal_fd = fileno(jread);
5661 (void) fclose(jread); /* Try to not leak the FILE resource */
5663 /* Panic-dies on error */
5664 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5666 else if (errno != ENOENT)
5668 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5669 "%s", strerror(errno));
5670 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5673 /* A null recipients list indicates some kind of disaster. */
5675 if (!recipients_list)
5677 (void)close(deliver_datafile);
5678 deliver_datafile = -1;
5679 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5680 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5685 /* Handle a message that is frozen. There are a number of different things that
5686 can happen, but in the default situation, unless forced, no delivery is
5691 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5692 /* Moving to another directory removes the message from Exim's view. Other
5693 tools must be used to deal with it. Logging of this action happens in
5694 spool_move_message() and its subfunctions. */
5696 if ( move_frozen_messages
5697 && spool_move_message(id, message_subdir, US"", US"F")
5699 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5702 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5703 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5704 flag causing all recipients to be failed. The time is the age of the
5705 message, not the time since freezing. */
5707 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5709 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5710 process_recipients = RECIP_FAIL_TIMEOUT;
5713 /* For bounce messages (and others with no sender), thaw if the error message
5714 ignore timer is exceeded. The message will be discarded if this delivery
5717 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5718 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5720 /* If this is a bounce message, or there's no auto thaw, or we haven't
5721 reached the auto thaw time yet, and this delivery is not forced by an admin
5722 user, do not attempt delivery of this message. Note that forced is set for
5723 continuing messages down the same channel, in order to skip load checking and
5724 ignore hold domains, but we don't want unfreezing in that case. */
5728 if ( ( sender_address[0] == 0
5730 || now <= deliver_frozen_at + auto_thaw
5732 && ( !forced || !deliver_force_thaw
5733 || !admin_user || continue_hostname
5736 (void)close(deliver_datafile);
5737 deliver_datafile = -1;
5738 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5739 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5742 /* If delivery was forced (by an admin user), assume a manual thaw.
5743 Otherwise it's an auto thaw. */
5747 deliver_manual_thaw = TRUE;
5748 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5750 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5753 /* We get here if any of the rules for unfreezing have triggered. */
5755 deliver_freeze = FALSE;
5756 update_spool = TRUE;
5760 /* Open the message log file if we are using them. This records details of
5761 deliveries, deferments, and failures for the benefit of the mail administrator.
5762 The log is not used by exim itself to track the progress of a message; that is
5763 done by rewriting the header spool file. */
5767 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5771 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5773 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5774 fname, strerror(errno));
5775 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5778 /* Make a C stream out of it. */
5780 if (!(message_log = fdopen(fd, "a")))
5782 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5783 fname, strerror(errno));
5784 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5789 /* If asked to give up on a message, log who did it, and set the action for all
5794 struct passwd *pw = getpwuid(real_uid);
5795 log_write(0, LOG_MAIN, "cancelled by %s",
5796 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5797 process_recipients = RECIP_FAIL;
5800 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5802 else if (received_count > received_headers_max)
5803 process_recipients = RECIP_FAIL_LOOP;
5805 /* Otherwise, if a system-wide, address-independent message filter is
5806 specified, run it now, except in the case when we are failing all recipients as
5807 a result of timeout_frozen_after. If the system filter yields "delivered", then
5808 ignore the true recipients of the message. Failure of the filter file is
5809 logged, and the delivery attempt fails. */
5811 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5816 redirect_block redirect;
5818 if (system_filter_uid_set)
5820 ugid.uid = system_filter_uid;
5821 ugid.gid = system_filter_gid;
5822 ugid.uid_set = ugid.gid_set = TRUE;
5826 ugid.uid_set = ugid.gid_set = FALSE;
5829 return_path = sender_address;
5830 enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5831 system_filtering = TRUE;
5833 /* Any error in the filter file causes a delivery to be abandoned. */
5835 redirect.string = system_filter;
5836 redirect.isfile = TRUE;
5837 redirect.check_owner = redirect.check_group = FALSE;
5838 redirect.owners = NULL;
5839 redirect.owngroups = NULL;
5841 redirect.modemask = 0;
5843 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5846 &redirect, /* Where the data is */
5847 RDO_DEFER | /* Turn on all the enabling options */
5848 RDO_FAIL | /* Leave off all the disabling options */
5853 NULL, /* No :include: restriction (not used in filter) */
5854 NULL, /* No sieve vacation directory (not sieve!) */
5855 NULL, /* No sieve enotify mailto owner (not sieve!) */
5856 NULL, /* No sieve user address (not sieve!) */
5857 NULL, /* No sieve subaddress (not sieve!) */
5858 &ugid, /* uid/gid data */
5859 &addr_new, /* Where to hang generated addresses */
5860 &filter_message, /* Where to put error message */
5861 NULL, /* Don't skip syntax errors */
5862 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5863 US"system filter"); /* For error messages */
5865 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5867 if (rc == FF_ERROR || rc == FF_NONEXIST)
5869 (void)close(deliver_datafile);
5870 deliver_datafile = -1;
5871 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5872 string_printing(filter_message));
5873 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5876 /* Reset things. If the filter message is an empty string, which can happen
5877 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5879 system_filtering = FALSE;
5880 enable_dollar_recipients = FALSE;
5881 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5883 /* Save the values of the system filter variables so that user filters
5886 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5888 /* The filter can request that delivery of the original addresses be
5893 process_recipients = RECIP_DEFER;
5894 deliver_msglog("Delivery deferred by system filter\n");
5895 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5898 /* The filter can request that a message be frozen, but this does not
5899 take place if the message has been manually thawed. In that case, we must
5900 unset "delivered", which is forced by the "freeze" command to make -bF
5903 else if (rc == FF_FREEZE && !deliver_manual_thaw)
5905 deliver_freeze = TRUE;
5906 deliver_frozen_at = time(NULL);
5907 process_recipients = RECIP_DEFER;
5908 frozen_info = string_sprintf(" by the system filter%s%s",
5909 filter_message ? US": " : US"",
5910 filter_message ? filter_message : US"");
5913 /* The filter can request that a message be failed. The error message may be
5914 quite long - it is sent back to the sender in the bounce - but we don't want
5915 to fill up the log with repetitions of it. If it starts with << then the text
5916 between << and >> is written to the log, with the rest left for the bounce
5919 else if (rc == FF_FAIL)
5921 uschar *colon = US"";
5922 uschar *logmsg = US"";
5925 process_recipients = RECIP_FAIL_FILTER;
5931 if ( filter_message[0] == '<'
5932 && filter_message[1] == '<'
5933 && (logend = Ustrstr(filter_message, ">>"))
5936 logmsg = filter_message + 2;
5937 loglen = logend - logmsg;
5938 filter_message = logend + 2;
5939 if (filter_message[0] == 0) filter_message = NULL;
5943 logmsg = filter_message;
5944 loglen = Ustrlen(filter_message);
5948 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5952 /* Delivery can be restricted only to those recipients (if any) that the
5953 filter specified. */
5955 else if (rc == FF_DELIVERED)
5957 process_recipients = RECIP_IGNORE;
5959 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
5961 log_write(0, LOG_MAIN, "=> discarded (system filter)");
5964 /* If any new addresses were created by the filter, fake up a "parent"
5965 for them. This is necessary for pipes, etc., which are expected to have
5966 parents, and it also gives some sensible logging for others. Allow
5967 pipes, files, and autoreplies, and run them as the filter uid if set,
5968 otherwise as the current uid. */
5972 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
5973 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
5975 /* The text "system-filter" is tested in transport_set_up_command() and in
5976 set_up_shell_command() in the pipe transport, to enable them to permit
5977 $recipients, so don't change it here without also changing it there. */
5979 address_item *p = addr_new;
5980 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
5982 parent->domain = string_copylc(qualify_domain_recipient);
5983 parent->local_part = US"system-filter";
5985 /* As part of this loop, we arrange for addr_last to end up pointing
5986 at the final address. This is used if we go on to add addresses for the
5987 original recipients. */
5991 if (parent->child_count == USHRT_MAX)
5992 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
5993 "than %d delivery addresses", USHRT_MAX);
5994 parent->child_count++;
5997 if (testflag(p, af_pfr))
6003 setflag(p, af_uid_set);
6004 setflag(p, af_gid_set);
6005 setflag(p, af_allow_file);
6006 setflag(p, af_allow_pipe);
6007 setflag(p, af_allow_reply);
6009 /* Find the name of the system filter's appropriate pfr transport */
6011 if (p->address[0] == '|')
6014 tpname = system_filter_pipe_transport;
6015 address_pipe = p->address;
6017 else if (p->address[0] == '>')
6020 tpname = system_filter_reply_transport;
6024 if (p->address[Ustrlen(p->address)-1] == '/')
6026 type = US"directory";
6027 tpname = system_filter_directory_transport;
6032 tpname = system_filter_file_transport;
6034 address_file = p->address;
6037 /* Now find the actual transport, first expanding the name. We have
6038 set address_file or address_pipe above. */
6042 uschar *tmp = expand_string(tpname);
6043 address_file = address_pipe = NULL;
6045 p->message = string_sprintf("failed to expand \"%s\" as a "
6046 "system filter transport name", tpname);
6050 p->message = string_sprintf("system_filter_%s_transport is unset",
6055 transport_instance *tp;
6056 for (tp = transports; tp; tp = tp->next)
6057 if (Ustrcmp(tp->name, tpname) == 0)
6063 p->message = string_sprintf("failed to find \"%s\" transport "
6064 "for system filter delivery", tpname);
6067 /* If we couldn't set up a transport, defer the delivery, putting the
6068 error on the panic log as well as the main log. */
6072 address_item *badp = p;
6074 if (!addr_last) addr_new = p; else addr_last->next = p;
6075 badp->local_part = badp->address; /* Needed for log line */
6076 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6079 } /* End of pfr handling */
6081 /* Either a non-pfr delivery, or we found a transport */
6083 DEBUG(D_deliver|D_filter)
6084 debug_printf("system filter added %s\n", p->address);
6088 } /* Loop through all addr_new addresses */
6093 /* Scan the recipients list, and for every one that is not in the non-
6094 recipients tree, add an addr item to the chain of new addresses. If the pno
6095 value is non-negative, we must set the onetime parent from it. This which
6096 points to the relevant entry in the recipients list.
6098 This processing can be altered by the setting of the process_recipients
6099 variable, which is changed if recipients are to be ignored, failed, or
6100 deferred. This can happen as a result of system filter activity, or if the -Mg
6101 option is used to fail all of them.
6103 Duplicate addresses are handled later by a different tree structure; we can't
6104 just extend the non-recipients tree, because that will be re-written to the
6105 spool if the message is deferred, and in any case there are casing
6106 complications for local addresses. */
6108 if (process_recipients != RECIP_IGNORE)
6109 for (i = 0; i < recipients_count; i++)
6110 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6112 recipient_item *r = recipients_list + i;
6113 address_item *new = deliver_make_addr(r->address, FALSE);
6114 new->prop.errors_address = r->errors_to;
6116 if ((new->prop.utf8_msg = message_smtputf8))
6118 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6119 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6120 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6121 new->prop.utf8_downcvt ? "yes"
6122 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6128 new->onetime_parent = recipients_list[r->pno].address;
6130 /* If DSN support is enabled, set the dsn flags and the original receipt
6131 to be passed on to other DSN enabled MTAs */
6132 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6133 new->dsn_orcpt = r->orcpt;
6134 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6135 new->dsn_orcpt, new->dsn_flags);
6137 switch (process_recipients)
6139 /* RECIP_DEFER is set when a system filter freezes a message. */
6142 new->next = addr_defer;
6147 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6150 case RECIP_FAIL_FILTER:
6152 filter_message ? filter_message : US"delivery cancelled";
6153 setflag(new, af_pass_message);
6154 goto RECIP_QUEUE_FAILED; /* below */
6157 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6158 than the value in timeout_frozen_after. Treat non-bounce messages
6159 similarly to -Mg; for bounce messages we just want to discard, so
6160 don't put the address on the failed list. The timeout has already
6163 case RECIP_FAIL_TIMEOUT:
6164 new->message = US"delivery cancelled; message timed out";
6165 goto RECIP_QUEUE_FAILED; /* below */
6168 /* RECIP_FAIL is set when -Mg has been used. */
6171 new->message = US"delivery cancelled by administrator";
6174 /* Common code for the failure cases above. If this is not a bounce
6175 message, put the address on the failed list so that it is used to
6176 create a bounce. Otherwise do nothing - this just discards the address.
6177 The incident has already been logged. */
6180 if (sender_address[0] != 0)
6182 new->next = addr_failed;
6188 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6189 in the message. Process each address as a routing failure; if this
6190 is a bounce message, it will get frozen. */
6192 case RECIP_FAIL_LOOP:
6193 new->message = US"Too many \"Received\" headers - suspected mail loop";
6194 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6198 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6201 if (!addr_new) addr_new = new; else addr_last->next = new;
6206 #ifndef DISABLE_EVENT
6207 if (process_recipients != RECIP_ACCEPT)
6209 uschar * save_local = deliver_localpart;
6210 const uschar * save_domain = deliver_domain;
6212 deliver_localpart = expand_string(
6213 string_sprintf("${local_part:%s}", new->address));
6214 deliver_domain = expand_string(
6215 string_sprintf("${domain:%s}", new->address));
6217 (void) event_raise(event_action,
6218 US"msg:fail:internal", new->message);
6220 deliver_localpart = save_local;
6221 deliver_domain = save_domain;
6229 debug_printf("Delivery address list:\n");
6230 for (p = addr_new; p; p = p->next)
6231 debug_printf(" %s %s\n", p->address,
6232 p->onetime_parent ? p->onetime_parent : US"");
6235 /* Set up the buffers used for copying over the file when delivering. */
6237 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6238 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6242 /* Until there are no more new addresses, handle each one as follows:
6244 . If this is a generated address (indicated by the presence of a parent
6245 pointer) then check to see whether it is a pipe, file, or autoreply, and
6246 if so, handle it directly here. The router that produced the address will
6247 have set the allow flags into the address, and also set the uid/gid required.
6248 Having the routers generate new addresses and then checking them here at
6249 the outer level is tidier than making each router do the checking, and
6250 means that routers don't need access to the failed address queue.
6252 . Break up the address into local part and domain, and make lowercased
6253 versions of these strings. We also make unquoted versions of the local part.
6255 . Handle the percent hack for those domains for which it is valid.
6257 . For child addresses, determine if any of the parents have the same address.
6258 If so, generate a different string for previous delivery checking. Without
6259 this code, if the address spqr generates spqr via a forward or alias file,
6260 delivery of the generated spqr stops further attempts at the top level spqr,
6261 which is not what is wanted - it may have generated other addresses.
6263 . Check on the retry database to see if routing was previously deferred, but
6264 only if in a queue run. Addresses that are to be routed are put on the
6265 addr_route chain. Addresses that are to be deferred are put on the
6266 addr_defer chain. We do all the checking first, so as not to keep the
6267 retry database open any longer than necessary.
6269 . Now we run the addresses through the routers. A router may put the address
6270 on either the addr_local or the addr_remote chain for local or remote
6271 delivery, respectively, or put it on the addr_failed chain if it is
6272 undeliveable, or it may generate child addresses and put them on the
6273 addr_new chain, or it may defer an address. All the chain anchors are
6274 passed as arguments so that the routers can be called for verification
6277 . If new addresses have been generated by the routers, da capo.
6280 header_rewritten = FALSE; /* No headers rewritten yet */
6281 while (addr_new) /* Loop until all addresses dealt with */
6283 address_item *addr, *parent;
6285 /* Failure to open the retry database is treated the same as if it does
6286 not exist. In both cases, dbm_file is NULL. */
6288 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6289 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6290 debug_printf("no retry data available\n");
6292 /* Scan the current batch of new addresses, to handle pipes, files and
6293 autoreplies, and determine which others are ready for routing. */
6300 dbdata_retry *domain_retry_record;
6301 dbdata_retry *address_retry_record;
6304 addr_new = addr->next;
6306 DEBUG(D_deliver|D_retry|D_route)
6308 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6309 debug_printf("Considering: %s\n", addr->address);
6312 /* Handle generated address that is a pipe or a file or an autoreply. */
6314 if (testflag(addr, af_pfr))
6316 /* If an autoreply in a filter could not generate a syntactically valid
6317 address, give up forthwith. Set af_ignore_error so that we don't try to
6318 generate a bounce. */
6320 if (testflag(addr, af_bad_reply))
6322 addr->basic_errno = ERRNO_BADADDRESS2;
6323 addr->local_part = addr->address;
6325 US"filter autoreply generated syntactically invalid recipient";
6326 addr->prop.ignore_error = TRUE;
6327 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6328 continue; /* with the next new address */
6331 /* If two different users specify delivery to the same pipe or file or
6332 autoreply, there should be two different deliveries, so build a unique
6333 string that incorporates the original address, and use this for
6334 duplicate testing and recording delivery, and also for retrying. */
6337 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6338 (testflag(addr->parent, af_homonym)? 3:0));
6340 addr->address_retry_key = addr->domain_retry_key =
6341 string_sprintf("T:%s", addr->unique);
6343 /* If a filter file specifies two deliveries to the same pipe or file,
6344 we want to de-duplicate, but this is probably not wanted for two mail
6345 commands to the same address, where probably both should be delivered.
6346 So, we have to invent a different unique string in that case. Just
6347 keep piling '>' characters on the front. */
6349 if (addr->address[0] == '>')
6351 while (tree_search(tree_duplicates, addr->unique))
6352 addr->unique = string_sprintf(">%s", addr->unique);
6355 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6357 DEBUG(D_deliver|D_route)
6358 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6359 addr->dupof = tnode->data.ptr;
6360 addr->next = addr_duplicate;
6361 addr_duplicate = addr;
6365 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6367 /* Check for previous delivery */
6369 if (tree_search(tree_nonrecipients, addr->unique))
6371 DEBUG(D_deliver|D_route)
6372 debug_printf("%s was previously delivered: discarded\n", addr->address);
6373 child_done(addr, tod_stamp(tod_log));
6377 /* Save for checking future duplicates */
6379 tree_add_duplicate(addr->unique, addr);
6381 /* Set local part and domain */
6383 addr->local_part = addr->address;
6384 addr->domain = addr->parent->domain;
6386 /* Ensure that the delivery is permitted. */
6388 if (testflag(addr, af_file))
6390 if (!testflag(addr, af_allow_file))
6392 addr->basic_errno = ERRNO_FORBIDFILE;
6393 addr->message = US"delivery to file forbidden";
6394 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6395 continue; /* with the next new address */
6398 else if (addr->address[0] == '|')
6400 if (!testflag(addr, af_allow_pipe))
6402 addr->basic_errno = ERRNO_FORBIDPIPE;
6403 addr->message = US"delivery to pipe forbidden";
6404 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6405 continue; /* with the next new address */
6408 else if (!testflag(addr, af_allow_reply))
6410 addr->basic_errno = ERRNO_FORBIDREPLY;
6411 addr->message = US"autoreply forbidden";
6412 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6413 continue; /* with the next new address */
6416 /* If the errno field is already set to BADTRANSPORT, it indicates
6417 failure to expand a transport string, or find the associated transport,
6418 or an unset transport when one is required. Leave this test till now so
6419 that the forbid errors are given in preference. */
6421 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6423 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6427 /* Treat /dev/null as a special case and abandon the delivery. This
6428 avoids having to specify a uid on the transport just for this case.
6429 Arrange for the transport name to be logged as "**bypassed**". */
6431 if (Ustrcmp(addr->address, "/dev/null") == 0)
6433 uschar *save = addr->transport->name;
6434 addr->transport->name = US"**bypassed**";
6435 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6436 addr->transport->name = save;
6437 continue; /* with the next new address */
6440 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6443 DEBUG(D_deliver|D_route)
6444 debug_printf("queued for %s transport\n", addr->transport->name);
6445 addr->next = addr_local;
6447 continue; /* with the next new address */
6450 /* Handle normal addresses. First, split up into local part and domain,
6451 handling the %-hack if necessary. There is the possibility of a defer from
6452 a lookup in percent_hack_domains. */
6454 if ((rc = deliver_split_address(addr)) == DEFER)
6456 addr->message = US"cannot check percent_hack_domains";
6457 addr->basic_errno = ERRNO_LISTDEFER;
6458 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6462 /* Check to see if the domain is held. If so, proceed only if the
6463 delivery was forced by hand. */
6465 deliver_domain = addr->domain; /* set $domain */
6466 if ( !forced && hold_domains
6467 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6468 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6474 addr->message = US"hold_domains lookup deferred";
6475 addr->basic_errno = ERRNO_LISTDEFER;
6479 addr->message = US"domain is held";
6480 addr->basic_errno = ERRNO_HELD;
6482 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6486 /* Now we can check for duplicates and previously delivered addresses. In
6487 order to do this, we have to generate a "unique" value for each address,
6488 because there may be identical actual addresses in a line of descendents.
6489 The "unique" field is initialized to the same value as the "address" field,
6490 but gets changed here to cope with identically-named descendents. */
6492 for (parent = addr->parent; parent; parent = parent->parent)
6493 if (strcmpic(addr->address, parent->address) == 0) break;
6495 /* If there's an ancestor with the same name, set the homonym flag. This
6496 influences how deliveries are recorded. Then add a prefix on the front of
6497 the unique address. We use \n\ where n starts at 0 and increases each time.
6498 It is unlikely to pass 9, but if it does, it may look odd but will still
6499 work. This means that siblings or cousins with the same names are treated
6500 as duplicates, which is what we want. */
6504 setflag(addr, af_homonym);
6505 if (parent->unique[0] != '\\')
6506 addr->unique = string_sprintf("\\0\\%s", addr->address);
6508 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6512 /* Ensure that the domain in the unique field is lower cased, because
6513 domains are always handled caselessly. */
6515 p = Ustrrchr(addr->unique, '@');
6516 while (*p != 0) { *p = tolower(*p); p++; }
6518 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6520 if (tree_search(tree_nonrecipients, addr->unique))
6522 DEBUG(D_deliver|D_route)
6523 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6524 child_done(addr, tod_stamp(tod_log));
6528 /* Get the routing retry status, saving the two retry keys (with and
6529 without the local part) for subsequent use. If there is no retry record for
6530 the standard address routing retry key, we look for the same key with the
6531 sender attached, because this form is used by the smtp transport after a
6532 4xx response to RCPT when address_retry_include_sender is true. */
6534 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6535 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6540 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6541 if ( domain_retry_record
6542 && now - domain_retry_record->time_stamp > retry_data_expire
6544 domain_retry_record = NULL; /* Ignore if too old */
6546 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6547 if ( address_retry_record
6548 && now - address_retry_record->time_stamp > retry_data_expire
6550 address_retry_record = NULL; /* Ignore if too old */
6552 if (!address_retry_record)
6554 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6556 address_retry_record = dbfn_read(dbm_file, altkey);
6557 if ( address_retry_record
6558 && now - address_retry_record->time_stamp > retry_data_expire)
6559 address_retry_record = NULL; /* Ignore if too old */
6563 domain_retry_record = address_retry_record = NULL;
6565 DEBUG(D_deliver|D_retry)
6567 if (!domain_retry_record)
6568 debug_printf("no domain retry record\n");
6569 if (!address_retry_record)
6570 debug_printf("no address retry record\n");
6573 /* If we are sending a message down an existing SMTP connection, we must
6574 assume that the message which created the connection managed to route
6575 an address to that connection. We do not want to run the risk of taking
6576 a long time over routing here, because if we do, the server at the other
6577 end of the connection may time it out. This is especially true for messages
6578 with lots of addresses. For this kind of delivery, queue_running is not
6579 set, so we would normally route all addresses. We take a pragmatic approach
6580 and defer routing any addresses that have any kind of domain retry record.
6581 That is, we don't even look at their retry times. It doesn't matter if this
6582 doesn't work occasionally. This is all just an optimization, after all.
6584 The reason for not doing the same for address retries is that they normally
6585 arise from 4xx responses, not DNS timeouts. */
6587 if (continue_hostname && domain_retry_record)
6589 addr->message = US"reusing SMTP connection skips previous routing defer";
6590 addr->basic_errno = ERRNO_RRETRY;
6591 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6594 /* If we are in a queue run, defer routing unless there is no retry data or
6595 we've passed the next retry time, or this message is forced. In other
6596 words, ignore retry data when not in a queue run.
6598 However, if the domain retry time has expired, always allow the routing
6599 attempt. If it fails again, the address will be failed. This ensures that
6600 each address is routed at least once, even after long-term routing
6603 If there is an address retry, check that too; just wait for the next
6604 retry time. This helps with the case when the temporary error on the
6605 address was really message-specific rather than address specific, since
6606 it allows other messages through.
6608 We also wait for the next retry time if this is a message sent down an
6609 existing SMTP connection (even though that will be forced). Otherwise there
6610 will be far too many attempts for an address that gets a 4xx error. In
6611 fact, after such an error, we should not get here because, the host should
6612 not be remembered as one this message needs. However, there was a bug that
6613 used to cause this to happen, so it is best to be on the safe side.
6615 Even if we haven't reached the retry time in the hints, there is one more
6616 check to do, which is for the ultimate address timeout. We only do this
6617 check if there is an address retry record and there is not a domain retry
6618 record; this implies that previous attempts to handle the address had the
6619 retry_use_local_parts option turned on. We use this as an approximation
6620 for the destination being like a local delivery, for example delivery over
6621 LMTP to an IMAP message store. In this situation users are liable to bump
6622 into their quota and thereby have intermittently successful deliveries,
6623 which keep the retry record fresh, which can lead to us perpetually
6624 deferring messages. */
6626 else if ( ( queue_running && !deliver_force
6627 || continue_hostname
6629 && ( ( domain_retry_record
6630 && now < domain_retry_record->next_try
6631 && !domain_retry_record->expired
6633 || ( address_retry_record
6634 && now < address_retry_record->next_try
6636 && ( domain_retry_record
6637 || !address_retry_record
6638 || !retry_ultimate_address_timeout(addr->address_retry_key,
6639 addr->domain, address_retry_record, now)
6642 addr->message = US"retry time not reached";
6643 addr->basic_errno = ERRNO_RRETRY;
6644 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6647 /* The domain is OK for routing. Remember if retry data exists so it
6648 can be cleaned up after a successful delivery. */
6652 if (domain_retry_record || address_retry_record)
6653 setflag(addr, af_dr_retry_exists);
6654 addr->next = addr_route;
6656 DEBUG(D_deliver|D_route)
6657 debug_printf("%s: queued for routing\n", addr->address);
6661 /* The database is closed while routing is actually happening. Requests to
6662 update it are put on a chain and all processed together at the end. */
6664 if (dbm_file) dbfn_close(dbm_file);
6666 /* If queue_domains is set, we don't even want to try routing addresses in
6667 those domains. During queue runs, queue_domains is forced to be unset.
6668 Optimize by skipping this pass through the addresses if nothing is set. */
6670 if (!deliver_force && queue_domains)
6672 address_item *okaddr = NULL;
6675 address_item *addr = addr_route;
6676 addr_route = addr->next;
6678 deliver_domain = addr->domain; /* set $domain */
6679 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6680 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6684 addr->basic_errno = ERRNO_LISTDEFER;
6685 addr->message = US"queue_domains lookup deferred";
6686 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6690 addr->next = okaddr;
6695 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6696 addr->message = US"domain is in queue_domains";
6697 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6701 addr_route = okaddr;
6704 /* Now route those addresses that are not deferred. */
6709 address_item *addr = addr_route;
6710 const uschar *old_domain = addr->domain;
6711 uschar *old_unique = addr->unique;
6712 addr_route = addr->next;
6715 /* Just in case some router parameter refers to it. */
6717 if (!(return_path = addr->prop.errors_address))
6718 return_path = sender_address;
6720 /* If a router defers an address, add a retry item. Whether or not to
6721 use the local part in the key is a property of the router. */
6723 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6724 &addr_succeed, v_none)) == DEFER)
6725 retry_add_item(addr,
6726 addr->router->retry_use_local_part
6727 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6728 : string_sprintf("R:%s", addr->domain),
6731 /* Otherwise, if there is an existing retry record in the database, add
6732 retry items to delete both forms. We must also allow for the possibility
6733 of a routing retry that includes the sender address. Since the domain might
6734 have been rewritten (expanded to fully qualified) as a result of routing,
6735 ensure that the rewritten form is also deleted. */
6737 else if (testflag(addr, af_dr_retry_exists))
6739 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6741 retry_add_item(addr, altkey, rf_delete);
6742 retry_add_item(addr, addr->address_retry_key, rf_delete);
6743 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6744 if (Ustrcmp(addr->domain, old_domain) != 0)
6745 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6748 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6749 logged, but we need to ensure the address (and maybe parents) is marked
6754 address_done(addr, tod_stamp(tod_log));
6755 continue; /* route next address */
6758 /* The address is finished with (failed or deferred). */
6762 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6763 continue; /* route next address */
6766 /* The address has been routed. If the router changed the domain, it will
6767 also have changed the unique address. We have to test whether this address
6768 has already been delivered, because it's the unique address that finally
6771 if ( addr->unique != old_unique
6772 && tree_search(tree_nonrecipients, addr->unique) != 0
6775 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6776 "discarded\n", addr->address);
6777 if (addr_remote == addr) addr_remote = addr->next;
6778 else if (addr_local == addr) addr_local = addr->next;
6781 /* If the router has same_domain_copy_routing set, we are permitted to copy
6782 the routing for any other addresses with the same domain. This is an
6783 optimisation to save repeated DNS lookups for "standard" remote domain
6784 routing. The option is settable only on routers that generate host lists.
6785 We play it very safe, and do the optimization only if the address is routed
6786 to a remote transport, there are no header changes, and the domain was not
6787 modified by the router. */
6789 if ( addr_remote == addr
6790 && addr->router->same_domain_copy_routing
6791 && !addr->prop.extra_headers
6792 && !addr->prop.remove_headers
6793 && old_domain == addr->domain
6796 address_item **chain = &addr_route;
6799 address_item *addr2 = *chain;
6800 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6802 chain = &(addr2->next);
6806 /* Found a suitable address; take it off the routing list and add it to
6807 the remote delivery list. */
6809 *chain = addr2->next;
6810 addr2->next = addr_remote;
6811 addr_remote = addr2;
6813 /* Copy the routing data */
6815 addr2->domain = addr->domain;
6816 addr2->router = addr->router;
6817 addr2->transport = addr->transport;
6818 addr2->host_list = addr->host_list;
6819 addr2->fallback_hosts = addr->fallback_hosts;
6820 addr2->prop.errors_address = addr->prop.errors_address;
6821 copyflag(addr2, addr, af_hide_child);
6822 copyflag(addr2, addr, af_local_host_removed);
6824 DEBUG(D_deliver|D_route)
6825 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6827 "Routing for %s copied from %s\n",
6828 addr2->address, addr2->address, addr->address);
6831 } /* Continue with routing the next address. */
6832 } /* Loop to process any child addresses that the routers created, and
6833 any rerouted addresses that got put back on the new chain. */
6836 /* Debugging: show the results of the routing */
6838 DEBUG(D_deliver|D_retry|D_route)
6841 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6842 debug_printf("After routing:\n Local deliveries:\n");
6843 for (p = addr_local; p; p = p->next)
6844 debug_printf(" %s\n", p->address);
6846 debug_printf(" Remote deliveries:\n");
6847 for (p = addr_remote; p; p = p->next)
6848 debug_printf(" %s\n", p->address);
6850 debug_printf(" Failed addresses:\n");
6851 for (p = addr_failed; p; p = p->next)
6852 debug_printf(" %s\n", p->address);
6854 debug_printf(" Deferred addresses:\n");
6855 for (p = addr_defer; p; p = p->next)
6856 debug_printf(" %s\n", p->address);
6859 /* Free any resources that were cached during routing. */
6864 /* These two variables are set only during routing, after check_local_user.
6865 Ensure they are not set in transports. */
6867 local_user_gid = (gid_t)(-1);
6868 local_user_uid = (uid_t)(-1);
6870 /* Check for any duplicate addresses. This check is delayed until after
6871 routing, because the flexibility of the routing configuration means that
6872 identical addresses with different parentage may end up being redirected to
6873 different addresses. Checking for duplicates too early (as we previously used
6874 to) makes this kind of thing not work. */
6876 do_duplicate_check(&addr_local);
6877 do_duplicate_check(&addr_remote);
6879 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6880 remote transport. The check that they all end up in one transaction happens in
6881 the do_remote_deliveries() function. */
6884 && (addr_local || addr_failed || addr_defer)
6888 uschar *which, *colon, *msg;
6895 else if (addr_defer)
6898 which = US"deferred";
6906 while (addr->parent) addr = addr->parent;
6911 msg = addr->message;
6913 else colon = msg = US"";
6915 /* We don't need to log here for a forced failure as it will already
6916 have been logged. Defer will also have been logged, but as a defer, so we do
6917 need to do the failure logging. */
6919 if (addr != addr_failed)
6920 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6921 addr->address, which);
6923 /* Always write an error to the caller */
6925 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
6928 final_yield = DELIVER_MUA_FAILED;
6929 addr_failed = addr_defer = NULL; /* So that we remove the message */
6930 goto DELIVERY_TIDYUP;
6934 /* If this is a run to continue deliveries to an external channel that is
6935 already set up, defer any local deliveries. */
6937 if (continue_transport)
6941 address_item *addr = addr_defer;
6942 while (addr->next) addr = addr->next;
6943 addr->next = addr_local;
6946 addr_defer = addr_local;
6951 /* Because address rewriting can happen in the routers, we should not really do
6952 ANY deliveries until all addresses have been routed, so that all recipients of
6953 the message get the same headers. However, this is in practice not always
6954 possible, since sometimes remote addresses give DNS timeouts for days on end.
6955 The pragmatic approach is to deliver what we can now, saving any rewritten
6956 headers so that at least the next lot of recipients benefit from the rewriting
6957 that has already been done.
6959 If any headers have been rewritten during routing, update the spool file to
6960 remember them for all subsequent deliveries. This can be delayed till later if
6961 there is only address to be delivered - if it succeeds the spool write need not
6964 if ( header_rewritten
6965 && ( addr_local && (addr_local->next || addr_remote)
6966 || addr_remote && addr_remote->next
6969 /* Panic-dies on error */
6970 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6971 header_rewritten = FALSE;
6975 /* If there are any deliveries to be and we do not already have the journal
6976 file, create it. This is used to record successful deliveries as soon as
6977 possible after each delivery is known to be complete. A file opened with
6978 O_APPEND is used so that several processes can run simultaneously.
6980 The journal is just insurance against crashes. When the spool file is
6981 ultimately updated at the end of processing, the journal is deleted. If a
6982 journal is found to exist at the start of delivery, the addresses listed
6983 therein are added to the non-recipients. */
6985 if (addr_local || addr_remote)
6989 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6991 if ((journal_fd = Uopen(fname,
6995 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
6997 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
6998 fname, strerror(errno));
6999 return DELIVER_NOT_ATTEMPTED;
7002 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7003 that the mode is correct - the group setting doesn't always seem to get
7004 set automatically. */
7006 if( fchown(journal_fd, exim_uid, exim_gid)
7007 || fchmod(journal_fd, SPOOL_MODE)
7009 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7013 int ret = Uunlink(fname);
7014 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7015 fname, strerror(errno));
7016 if(ret && errno != ENOENT)
7017 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7018 fname, strerror(errno));
7019 return DELIVER_NOT_ATTEMPTED;
7023 else if (journal_fd >= 0)
7031 /* Now we can get down to the business of actually doing deliveries. Local
7032 deliveries are done first, then remote ones. If ever the problems of how to
7033 handle fallback transports are figured out, this section can be put into a loop
7034 for handling fallbacks, though the uid switching will have to be revised. */
7036 /* Precompile a regex that is used to recognize a parameter in response
7037 to an LHLO command, if is isn't already compiled. This may be used on both
7038 local and remote LMTP deliveries. */
7040 if (!regex_IGNOREQUOTA)
7042 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7044 /* Handle local deliveries */
7048 DEBUG(D_deliver|D_transport)
7049 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7050 do_local_deliveries();
7051 disable_logging = FALSE;
7054 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7055 so just queue them all. */
7057 if (queue_run_local)
7060 address_item *addr = addr_remote;
7061 addr_remote = addr->next;
7063 addr->basic_errno = ERRNO_LOCAL_ONLY;
7064 addr->message = US"remote deliveries suppressed";
7065 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7068 /* Handle remote deliveries */
7072 DEBUG(D_deliver|D_transport)
7073 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7075 /* Precompile some regex that are used to recognize parameters in response
7076 to an EHLO command, if they aren't already compiled. */
7080 /* Now sort the addresses if required, and do the deliveries. The yield of
7081 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7082 cannot be delivered in one transaction. */
7084 if (remote_sort_domains) sort_remote_deliveries();
7085 if (!do_remote_deliveries(FALSE))
7087 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7088 "be delivered in one transaction");
7089 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7091 final_yield = DELIVER_MUA_FAILED;
7092 addr_failed = addr_defer = NULL; /* So that we remove the message */
7093 goto DELIVERY_TIDYUP;
7096 /* See if any of the addresses that failed got put on the queue for delivery
7097 to their fallback hosts. We do it this way because often the same fallback
7098 host is used for many domains, so all can be sent in a single transaction
7099 (if appropriately configured). */
7101 if (addr_fallback && !mua_wrapper)
7103 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7104 addr_remote = addr_fallback;
7105 addr_fallback = NULL;
7106 if (remote_sort_domains) sort_remote_deliveries();
7107 do_remote_deliveries(TRUE);
7109 disable_logging = FALSE;
7113 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7114 phase, to minimize cases of half-done things. */
7117 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7118 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7120 /* Root privilege is no longer needed */
7122 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7124 set_process_info("tidying up after delivering %s", message_id);
7125 signal(SIGTERM, SIG_IGN);
7127 /* When we are acting as an MUA wrapper, the smtp transport will either have
7128 succeeded for all addresses, or failed them all in normal cases. However, there
7129 are some setup situations (e.g. when a named port does not exist) that cause an
7130 immediate exit with deferral of all addresses. Convert those into failures. We
7131 do not ever want to retry, nor do we want to send a bounce message. */
7137 address_item *addr, *nextaddr;
7138 for (addr = addr_defer; addr; addr = nextaddr)
7140 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7141 "delivery", addr->address);
7142 nextaddr = addr->next;
7143 addr->next = addr_failed;
7149 /* Now all should either have succeeded or failed. */
7152 final_yield = DELIVER_MUA_SUCCEEDED;
7156 uschar *s = addr_failed->user_message;
7158 if (!s) s = addr_failed->message;
7160 fprintf(stderr, "Delivery failed: ");
7161 if (addr_failed->basic_errno > 0)
7163 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7164 if (s) fprintf(stderr, ": ");
7166 if ((host = addr_failed->host_used))
7167 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7169 fprintf(stderr, "%s", CS s);
7170 else if (addr_failed->basic_errno <= 0)
7171 fprintf(stderr, "unknown error");
7172 fprintf(stderr, "\n");
7174 final_yield = DELIVER_MUA_FAILED;
7179 /* In a normal configuration, we now update the retry database. This is done in
7180 one fell swoop at the end in order not to keep opening and closing (and
7181 locking) the database. The code for handling retries is hived off into a
7182 separate module for convenience. We pass it the addresses of the various
7183 chains, because deferred addresses can get moved onto the failed chain if the
7184 retry cutoff time has expired for all alternative destinations. Bypass the
7185 updating of the database if the -N flag is set, which is a debugging thing that
7186 prevents actual delivery. */
7188 else if (!dont_deliver)
7189 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7191 /* Send DSN for successful messages if requested */
7192 addr_senddsn = NULL;
7194 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7196 /* af_ignore_error not honored here. it's not an error */
7197 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7198 "DSN: processing successful delivery address: %s\n"
7199 "DSN: Sender_address: %s\n"
7200 "DSN: orcpt: %s flags: %d\n"
7201 "DSN: envid: %s ret: %d\n"
7202 "DSN: Final recipient: %s\n"
7203 "DSN: Remote SMTP server supports DSN: %d\n",
7204 addr_dsntmp->router->name,
7205 addr_dsntmp->address,
7207 addr_dsntmp->dsn_orcpt, addr_dsntmp->dsn_flags,
7209 addr_dsntmp->address,
7210 addr_dsntmp->dsn_aware
7213 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7214 and a report was requested */
7215 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7216 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7218 && addr_dsntmp->dsn_flags & rf_dsnflags
7219 && addr_dsntmp->dsn_flags & rf_notify_success
7222 /* copy and relink address_item and send report with all of them at once later */
7223 address_item * addr_next = addr_senddsn;
7224 addr_senddsn = store_get(sizeof(address_item));
7225 *addr_senddsn = *addr_dsntmp;
7226 addr_senddsn->next = addr_next;
7229 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7237 /* create exim process to send message */
7238 pid = child_open_exim(&fd);
7240 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7242 if (pid < 0) /* Creation of child failed */
7244 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7245 "create child process to send failure message: %s", getpid(),
7246 getppid(), strerror(errno));
7248 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7250 else /* Creation of child succeeded */
7252 FILE *f = fdopen(fd, "wb");
7253 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7255 transport_ctx tctx = {{0}};
7258 debug_printf("sending error message to: %s\n", sender_address);
7260 /* build unique id for MIME boundary */
7261 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7262 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7264 if (errors_reply_to)
7265 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7267 fprintf(f, "Auto-Submitted: auto-generated\n"
7268 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7270 "Subject: Delivery Status Notification\n"
7271 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7272 "MIME-Version: 1.0\n\n"
7275 "Content-type: text/plain; charset=us-ascii\n\n"
7277 "This message was created automatically by mail delivery software.\n"
7278 " ----- The following addresses had successful delivery notifications -----\n",
7279 qualify_domain_sender, sender_address, bound, bound);
7281 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7282 addr_dsntmp = addr_dsntmp->next)
7283 fprintf(f, "<%s> (relayed %s)\n\n",
7284 addr_dsntmp->address,
7285 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1
7286 ? "via non DSN router"
7287 : addr_dsntmp->dsn_aware == dsn_support_no
7288 ? "to non-DSN-aware mailer"
7289 : "via non \"Remote SMTP\" router"
7293 "Content-type: message/delivery-status\n\n"
7294 "Reporting-MTA: dns; %s\n",
7295 bound, smtp_active_hostname);
7298 { /* must be decoded from xtext: see RFC 3461:6.3a */
7300 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7301 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7303 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7307 for (addr_dsntmp = addr_senddsn;
7309 addr_dsntmp = addr_dsntmp->next)
7311 if (addr_dsntmp->dsn_orcpt)
7312 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7314 fprintf(f, "Action: delivered\n"
7315 "Final-Recipient: rfc822;%s\n"
7317 addr_dsntmp->address);
7319 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7320 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7321 addr_dsntmp->host_used->name);
7323 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7324 (addr_dsntmp->dsn_flags & rf_dsnlasthop) == 1 ? "DSN" : "SMTP");
7327 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7330 transport_filter_argv = NULL; /* Just in case */
7331 return_path = sender_address; /* In case not previously set */
7333 /* Write the original email out */
7335 tctx.u.fd = fileno(f);
7336 tctx.options = topt_add_return_path | topt_no_body;
7337 transport_write_message(&tctx, 0);
7340 fprintf(f,"\n--%s--\n", bound);
7344 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7348 /* If any addresses failed, we must send a message to somebody, unless
7349 af_ignore_error is set, in which case no action is taken. It is possible for
7350 several messages to get sent if there are addresses with different
7357 uschar *logtod = tod_stamp(tod_log);
7359 address_item *handled_addr = NULL;
7360 address_item **paddr;
7361 address_item *msgchain = NULL;
7362 address_item **pmsgchain = &msgchain;
7364 /* There are weird cases when logging is disabled in the transport. However,
7365 there may not be a transport (address failed by a router). */
7367 disable_logging = FALSE;
7368 if (addr_failed->transport)
7369 disable_logging = addr_failed->transport->disable_logging;
7372 debug_printf("processing failed address %s\n", addr_failed->address);
7374 /* There are only two ways an address in a bounce message can get here:
7376 (1) When delivery was initially deferred, but has now timed out (in the call
7377 to retry_update() above). We can detect this by testing for
7378 af_retry_timedout. If the address does not have its own errors address,
7379 we arrange to ignore the error.
7381 (2) If delivery failures for bounce messages are being ignored. We can detect
7382 this by testing for af_ignore_error. This will also be set if a bounce
7383 message has been autothawed and the ignore_bounce_errors_after time has
7384 passed. It might also be set if a router was explicitly configured to
7385 ignore errors (errors_to = "").
7387 If neither of these cases obtains, something has gone wrong. Log the
7388 incident, but then ignore the error. */
7390 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7392 if ( !testflag(addr_failed, af_retry_timedout)
7393 && !addr_failed->prop.ignore_error)
7394 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7395 "failure is neither frozen nor ignored (it's been ignored)");
7397 addr_failed->prop.ignore_error = TRUE;
7400 /* If the first address on the list has af_ignore_error set, just remove
7401 it from the list, throw away any saved message file, log it, and
7402 mark the recipient done. */
7404 if ( addr_failed->prop.ignore_error
7405 || ( addr_failed->dsn_flags & rf_dsnflags
7406 && (addr_failed->dsn_flags & rf_notify_failure) != rf_notify_failure
7410 addr_failed = addr->next;
7411 if (addr->return_filename) Uunlink(addr->return_filename);
7413 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7415 !addr->parent ? US"" : US" <",
7416 !addr->parent ? US"" : addr->parent->address,
7417 !addr->parent ? US"" : US">");
7419 address_done(addr, logtod);
7420 child_done(addr, logtod);
7421 /* Panic-dies on error */
7422 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7425 /* Otherwise, handle the sending of a message. Find the error address for
7426 the first address, then send a message that includes all failed addresses
7427 that have the same error address. Note the bounce_recipient is a global so
7428 that it can be accessed by $bounce_recipient while creating a customized
7433 if (!(bounce_recipient = addr_failed->prop.errors_address))
7434 bounce_recipient = sender_address;
7436 /* Make a subprocess to send a message */
7438 if ((pid = child_open_exim(&fd)) < 0)
7439 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7440 "create child process to send failure message: %s", getpid(),
7441 getppid(), strerror(errno));
7443 /* Creation of child succeeded */
7450 uschar *bcc, *emf_text;
7451 FILE *f = fdopen(fd, "wb");
7453 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7454 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7455 DELIVER_IN_BUFFER_SIZE;
7457 uschar *dsnlimitmsg;
7458 uschar *dsnnotifyhdr;
7462 debug_printf("sending error message to: %s\n", bounce_recipient);
7464 /* Scan the addresses for all that have the same errors address, removing
7465 them from the addr_failed chain, and putting them on msgchain. */
7467 paddr = &addr_failed;
7468 for (addr = addr_failed; addr; addr = *paddr)
7469 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7470 ? addr->prop.errors_address : sender_address) == 0)
7471 { /* The same - dechain */
7472 *paddr = addr->next;
7475 pmsgchain = &(addr->next);
7478 paddr = &addr->next; /* Not the same; skip */
7480 /* Include X-Failed-Recipients: for automatic interpretation, but do
7481 not let any one header line get too long. We do this by starting a
7482 new header every 50 recipients. Omit any addresses for which the
7483 "hide_child" flag is set. */
7485 for (addr = msgchain; addr; addr = addr->next)
7487 if (testflag(addr, af_hide_child)) continue;
7495 ? "X-Failed-Recipients: "
7497 testflag(addr, af_pfr) && addr->parent
7498 ? string_printing(addr->parent->address)
7499 : string_printing(addr->address));
7501 if (rcount > 0) fprintf(f, "\n");
7503 /* Output the standard headers */
7505 if (errors_reply_to)
7506 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7507 fprintf(f, "Auto-Submitted: auto-replied\n");
7509 fprintf(f, "To: %s\n", bounce_recipient);
7511 /* generate boundary string and output MIME-Headers */
7512 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7514 fprintf(f, "Content-Type: multipart/report;"
7515 " report-type=delivery-status; boundary=%s\n"
7516 "MIME-Version: 1.0\n",
7519 /* Open a template file if one is provided. Log failure to open, but
7520 carry on - default texts will be used. */
7522 if (bounce_message_file)
7523 if (!(emf = Ufopen(bounce_message_file, "rb")))
7524 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7525 "message texts: %s", bounce_message_file, strerror(errno));
7527 /* Quietly copy to configured additional addresses if required. */
7529 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7530 fprintf(f, "Bcc: %s\n", bcc);
7532 /* The texts for the message can be read from a template file; if there
7533 isn't one, or if it is too short, built-in texts are used. The first
7534 emf text is a Subject: and any other headers. */
7536 if ((emf_text = next_emf(emf, US"header")))
7537 fprintf(f, "%s\n", emf_text);
7539 fprintf(f, "Subject: Mail delivery failed%s\n\n",
7540 to_sender? ": returning message to sender" : "");
7542 /* output human readable part as text/plain section */
7544 "Content-type: text/plain; charset=us-ascii\n\n",
7547 if ((emf_text = next_emf(emf, US"intro")))
7548 fprintf(f, "%s", CS emf_text);
7552 /* This message has been reworded several times. It seems to be confusing to
7553 somebody, however it is worded. I have retreated to the original, simple
7555 "This message was created automatically by mail delivery software.\n");
7557 if (bounce_message_text)
7558 fprintf(f, "%s", CS bounce_message_text);
7561 "\nA message that you sent could not be delivered to one or more of its\n"
7562 "recipients. This is a permanent error. The following address(es) failed:\n");
7565 "\nA message sent by\n\n <%s>\n\n"
7566 "could not be delivered to one or more of its recipients. The following\n"
7567 "address(es) failed:\n", sender_address);
7571 /* Process the addresses, leaving them on the msgchain if they have a
7572 file name for a return message. (There has already been a check in
7573 post_process_one() for the existence of data in the message file.) A TRUE
7574 return from print_address_information() means that the address is not
7578 for (addr = msgchain; addr; addr = *paddr)
7580 if (print_address_information(addr, f, US" ", US"\n ", US""))
7581 print_address_error(addr, f, US"");
7583 /* End the final line for the address */
7587 /* Leave on msgchain if there's a return file. */
7589 if (addr->return_file >= 0)
7591 paddr = &(addr->next);
7595 /* Else save so that we can tick off the recipient when the
7600 *paddr = addr->next;
7601 addr->next = handled_addr;
7602 handled_addr = addr;
7608 /* Get the next text, whether we need it or not, so as to be
7609 positioned for the one after. */
7611 emf_text = next_emf(emf, US"generated text");
7613 /* If there were any file messages passed by the local transports,
7614 include them in the message. Then put the address on the handled chain.
7615 In the case of a batch of addresses that were all sent to the same
7616 transport, the return_file field in all of them will contain the same
7617 fd, and the return_filename field in the *last* one will be set (to the
7618 name of the file). */
7622 address_item *nextaddr;
7625 fprintf(f, "%s", CS emf_text);
7628 "The following text was generated during the delivery "
7629 "attempt%s:\n", (filecount > 1)? "s" : "");
7631 for (addr = msgchain; addr; addr = nextaddr)
7634 address_item *topaddr = addr;
7636 /* List all the addresses that relate to this file */
7639 while(addr) /* Insurance */
7641 print_address_information(addr, f, US"------ ", US"\n ",
7643 if (addr->return_filename) break;
7648 /* Now copy the file */
7650 if (!(fm = Ufopen(addr->return_filename, "rb")))
7651 fprintf(f, " +++ Exim error... failed to open text file: %s\n",
7655 while ((ch = fgetc(fm)) != EOF) fputc(ch, f);
7658 Uunlink(addr->return_filename);
7660 /* Can now add to handled chain, first fishing off the next
7661 address on the msgchain. */
7663 nextaddr = addr->next;
7664 addr->next = handled_addr;
7665 handled_addr = topaddr;
7670 /* output machine readable part */
7672 if (message_smtputf8)
7674 "Content-type: message/global-delivery-status\n\n"
7675 "Reporting-MTA: dns; %s\n",
7676 bound, smtp_active_hostname);
7680 "Content-type: message/delivery-status\n\n"
7681 "Reporting-MTA: dns; %s\n",
7682 bound, smtp_active_hostname);
7686 /* must be decoded from xtext: see RFC 3461:6.3a */
7688 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7689 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7691 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7695 for (addr = handled_addr; addr; addr = addr->next)
7698 fprintf(f, "Action: failed\n"
7699 "Final-Recipient: rfc822;%s\n"
7702 if ((hu = addr->host_used) && hu->name)
7705 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
7706 #ifdef EXPERIMENTAL_DSN_INFO
7709 uschar * p = hu->port == 25
7710 ? US"" : string_sprintf(":%d", hu->port);
7711 fprintf(f, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7713 if ((s = addr->smtp_greeting) && *s)
7714 fprintf(f, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7715 if ((s = addr->helo_response) && *s)
7716 fprintf(f, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7717 if ((s = addr->message) && *s)
7718 fprintf(f, "X-Exim-Diagnostic: X-str; %s\n", s);
7720 print_dsn_diagnostic_code(addr, f);
7725 /* Now copy the message, trying to give an intelligible comment if
7726 it is too long for it all to be copied. The limit isn't strictly
7727 applied because of the buffering. There is, however, an option
7728 to suppress copying altogether. */
7730 emf_text = next_emf(emf, US"copy");
7733 we ignore the intro text from template and add
7734 the text for bounce_return_size_limit at the end.
7736 bounce_return_message is ignored
7737 in case RET= is defined we honor these values
7738 otherwise bounce_return_body is honored.
7740 bounce_return_size_limit is always honored.
7743 fprintf(f, "--%s\n", bound);
7745 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7746 dsnnotifyhdr = NULL;
7747 topt = topt_add_return_path;
7749 /* RET=HDRS? top priority */
7750 if (dsn_ret == dsn_ret_hdrs)
7751 topt |= topt_no_body;
7754 struct stat statbuf;
7756 /* no full body return at all? */
7757 if (!bounce_return_body)
7759 topt |= topt_no_body;
7760 /* add header if we overrule RET=FULL */
7761 if (dsn_ret == dsn_ret_full)
7762 dsnnotifyhdr = dsnlimitmsg;
7764 /* line length limited... return headers only if oversize */
7765 /* size limited ... return headers only if limit reached */
7766 else if ( max_received_linelength > bounce_return_linesize_limit
7767 || ( bounce_return_size_limit > 0
7768 && fstat(deliver_datafile, &statbuf) == 0
7769 && statbuf.st_size > max
7772 topt |= topt_no_body;
7773 dsnnotifyhdr = dsnlimitmsg;
7778 if (message_smtputf8)
7779 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7780 : "Content-type: message/global\n\n",
7784 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7785 : "Content-type: message/rfc822\n\n",
7789 transport_filter_argv = NULL; /* Just in case */
7790 return_path = sender_address; /* In case not previously set */
7791 { /* Dummy transport for headers add */
7792 transport_ctx tctx = {{0}};
7793 transport_instance tb = {0};
7795 tctx.u.fd = fileno(f);
7797 tctx.options = topt;
7798 tb.add_headers = dsnnotifyhdr;
7800 transport_write_message(&tctx, 0);
7804 /* we never add the final text. close the file */
7808 fprintf(f, "\n--%s--\n", bound);
7810 /* Close the file, which should send an EOF to the child process
7811 that is receiving the message. Wait for it to finish. */
7814 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7816 /* In the test harness, let the child do it's thing first. */
7818 if (running_in_test_harness) millisleep(500);
7820 /* If the process failed, there was some disaster in setting up the
7821 error message. Unless the message is very old, ensure that addr_defer
7822 is non-null, which will have the effect of leaving the message on the
7823 spool. The failed addresses will get tried again next time. However, we
7824 don't really want this to happen too often, so freeze the message unless
7825 there are some genuine deferred addresses to try. To do this we have
7826 to call spool_write_header() here, because with no genuine deferred
7827 addresses the normal code below doesn't get run. */
7832 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7834 addr_defer = (address_item *)(+1);
7835 deliver_freeze = TRUE;
7836 deliver_frozen_at = time(NULL);
7837 /* Panic-dies on error */
7838 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7841 deliver_msglog("Process failed (%d) when writing error message "
7842 "to %s%s", rc, bounce_recipient, s);
7843 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7844 "to %s%s", rc, bounce_recipient, s);
7847 /* The message succeeded. Ensure that the recipients that failed are
7848 now marked finished with on the spool and their parents updated. */
7852 for (addr = handled_addr; addr; addr = addr->next)
7854 address_done(addr, logtod);
7855 child_done(addr, logtod);
7857 /* Panic-dies on error */
7858 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7864 disable_logging = FALSE; /* In case left set */
7866 /* Come here from the mua_wrapper case if routing goes wrong */
7870 /* If there are now no deferred addresses, we are done. Preserve the
7871 message log if so configured, and we are using them. Otherwise, sling it.
7872 Then delete the message itself. */
7880 fname = spool_fname(US"msglog", message_subdir, id, US"");
7881 if (preserve_message_logs)
7884 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7886 if ((rc = Urename(fname, moname)) < 0)
7888 (void)directory_make(spool_directory,
7889 spool_sname(US"msglog.OLD", US""),
7890 MSGLOG_DIRECTORY_MODE, TRUE);
7891 rc = Urename(fname, moname);
7894 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7895 "msglog.OLD directory", fname);
7898 if (Uunlink(fname) < 0)
7899 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7900 fname, strerror(errno));
7903 /* Remove the two message files. */
7905 fname = spool_fname(US"input", message_subdir, id, US"-D");
7906 if (Uunlink(fname) < 0)
7907 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7908 fname, strerror(errno));
7909 fname = spool_fname(US"input", message_subdir, id, US"-H");
7910 if (Uunlink(fname) < 0)
7911 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7912 fname, strerror(errno));
7914 /* Log the end of this message, with queue time if requested. */
7916 if (LOGGING(queue_time_overall))
7917 log_write(0, LOG_MAIN, "Completed QT=%s",
7918 string_timesince(&received_time));
7920 log_write(0, LOG_MAIN, "Completed");
7922 /* Unset deliver_freeze so that we won't try to move the spool files further down */
7923 deliver_freeze = FALSE;
7925 #ifndef DISABLE_EVENT
7926 (void) event_raise(event_action, US"msg:complete", NULL);
7930 /* If there are deferred addresses, we are keeping this message because it is
7931 not yet completed. Lose any temporary files that were catching output from
7932 pipes for any of the deferred addresses, handle one-time aliases, and see if
7933 the message has been on the queue for so long that it is time to send a warning
7934 message to the sender, unless it is a mailer-daemon. If all deferred addresses
7935 have the same domain, we can set deliver_domain for the expansion of
7936 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
7937 the parent's domain.
7939 If all the deferred addresses have an error number that indicates "retry time
7940 not reached", skip sending the warning message, because it won't contain the
7941 reason for the delay. It will get sent at the next real delivery attempt.
7942 However, if at least one address has tried, we'd better include all of them in
7945 If we can't make a process to send the message, don't worry.
7947 For mailing list expansions we want to send the warning message to the
7948 mailing list manager. We can't do a perfect job here, as some addresses may
7949 have different errors addresses, but if we take the errors address from
7950 each deferred address it will probably be right in most cases.
7952 If addr_defer == +1, it means there was a problem sending an error message
7953 for failed addresses, and there were no "real" deferred addresses. The value
7954 was set just to keep the message on the spool, so there is nothing to do here.
7957 else if (addr_defer != (address_item *)(+1))
7960 uschar *recipients = US"";
7961 BOOL delivery_attempted = FALSE;
7963 deliver_domain = testflag(addr_defer, af_pfr)
7964 ? addr_defer->parent->domain : addr_defer->domain;
7966 for (addr = addr_defer; addr; addr = addr->next)
7968 address_item *otaddr;
7970 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
7974 const uschar *d = testflag(addr, af_pfr)
7975 ? addr->parent->domain : addr->domain;
7977 /* The domain may be unset for an address that has never been routed
7978 because the system filter froze the message. */
7980 if (!d || Ustrcmp(d, deliver_domain) != 0)
7981 deliver_domain = NULL;
7984 if (addr->return_filename) Uunlink(addr->return_filename);
7986 /* Handle the case of one-time aliases. If any address in the ancestry
7987 of this one is flagged, ensure it is in the recipients list, suitably
7988 flagged, and that its parent is marked delivered. */
7990 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
7991 if (otaddr->onetime_parent) break;
7996 int t = recipients_count;
7998 for (i = 0; i < recipients_count; i++)
8000 uschar *r = recipients_list[i].address;
8001 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8002 if (Ustrcmp(otaddr->address, r) == 0) break;
8005 /* Didn't find the address already in the list, and did find the
8006 ultimate parent's address in the list, and they really are different
8007 (i.e. not from an identity-redirect). After adding the recipient,
8008 update the errors address in the recipients list. */
8010 if ( i >= recipients_count && t < recipients_count
8011 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8013 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8014 otaddr->address, otaddr->parent->address);
8015 receive_add_recipient(otaddr->address, t);
8016 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8017 tree_add_nonrecipient(otaddr->parent->address);
8018 update_spool = TRUE;
8022 /* Except for error messages, ensure that either the errors address for
8023 this deferred address or, if there is none, the sender address, is on the
8024 list of recipients for a warning message. */
8026 if (sender_address[0])
8028 uschar * s = addr->prop.errors_address;
8029 if (!s) s = sender_address;
8030 if (Ustrstr(recipients, s) == NULL)
8031 recipients = string_sprintf("%s%s%s", recipients,
8032 recipients[0] ? "," : "", s);
8036 /* Send a warning message if the conditions are right. If the condition check
8037 fails because of a lookup defer, there is nothing we can do. The warning
8038 is not sent. Another attempt will be made at the next delivery attempt (if
8042 && delivery_attempted
8043 && ( ((addr_defer->dsn_flags & rf_dsnflags) == 0)
8044 || (addr_defer->dsn_flags & rf_notify_delay) == rf_notify_delay
8046 && delay_warning[1] > 0
8047 && sender_address[0] != 0
8048 && ( !delay_warning_condition
8049 || expand_check_condition(delay_warning_condition,
8050 US"delay_warning", US"option")
8056 int queue_time = time(NULL) - received_time.tv_sec;
8058 /* When running in the test harness, there's an option that allows us to
8059 fudge this time so as to get repeatability of the tests. Take the first
8060 time off the list. In queue runs, the list pointer gets updated in the
8063 if (running_in_test_harness && fudged_queue_times[0] != 0)
8065 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8068 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8069 fudged_queue_times);
8074 /* See how many warnings we should have sent by now */
8076 for (count = 0; count < delay_warning[1]; count++)
8077 if (queue_time < delay_warning[count+2]) break;
8079 show_time = delay_warning[count+1];
8081 if (count >= delay_warning[1])
8084 int last_gap = show_time;
8085 if (count > 1) last_gap -= delay_warning[count];
8086 extra = (queue_time - delay_warning[count+1])/last_gap;
8087 show_time += last_gap * extra;
8093 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
8094 debug_printf("warning counts: required %d done %d\n", count,
8098 /* We have computed the number of warnings there should have been by now.
8099 If there haven't been enough, send one, and up the count to what it should
8102 if (warning_count < count)
8106 pid_t pid = child_open_exim(&fd);
8112 FILE *f = fdopen(fd, "wb");
8114 transport_ctx tctx = {{0}};
8116 if (warn_message_file)
8117 if (!(wmf = Ufopen(warn_message_file, "rb")))
8118 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8119 "message texts: %s", warn_message_file, strerror(errno));
8121 warnmsg_recipients = recipients;
8122 warnmsg_delay = queue_time < 120*60
8123 ? string_sprintf("%d minutes", show_time/60)
8124 : string_sprintf("%d hours", show_time/3600);
8126 if (errors_reply_to)
8127 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8128 fprintf(f, "Auto-Submitted: auto-replied\n");
8130 fprintf(f, "To: %s\n", recipients);
8132 /* generated boundary string and output MIME-Headers */
8133 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8135 fprintf(f, "Content-Type: multipart/report;"
8136 " report-type=delivery-status; boundary=%s\n"
8137 "MIME-Version: 1.0\n",
8140 if ((wmf_text = next_emf(wmf, US"header")))
8141 fprintf(f, "%s\n", wmf_text);
8143 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8144 message_id, warnmsg_delay);
8146 /* output human readable part as text/plain section */
8148 "Content-type: text/plain; charset=us-ascii\n\n",
8151 if ((wmf_text = next_emf(wmf, US"intro")))
8152 fprintf(f, "%s", CS wmf_text);
8156 "This message was created automatically by mail delivery software.\n");
8158 if (Ustrcmp(recipients, sender_address) == 0)
8160 "A message that you sent has not yet been delivered to one or more of its\n"
8161 "recipients after more than ");
8165 "A message sent by\n\n <%s>\n\n"
8166 "has not yet been delivered to one or more of its recipients after more than \n",
8169 fprintf(f, "%s on the queue on %s.\n\n"
8170 "The message identifier is: %s\n",
8171 warnmsg_delay, primary_hostname, message_id);
8173 for (h = header_list; h; h = h->next)
8174 if (strncmpic(h->text, US"Subject:", 8) == 0)
8175 fprintf(f, "The subject of the message is: %s", h->text + 9);
8176 else if (strncmpic(h->text, US"Date:", 5) == 0)
8177 fprintf(f, "The date of the message is: %s", h->text + 6);
8180 fprintf(f, "The address%s to which the message has not yet been "
8182 !addr_defer->next ? "" : "es",
8183 !addr_defer->next ? "is": "are");
8186 /* List the addresses, with error information if allowed */
8188 /* store addr_defer for machine readable part */
8189 address_item *addr_dsndefer = addr_defer;
8193 address_item *addr = addr_defer;
8194 addr_defer = addr->next;
8195 if (print_address_information(addr, f, US" ", US"\n ", US""))
8196 print_address_error(addr, f, US"Delay reason: ");
8205 if ((wmf_text = next_emf(wmf, US"final")))
8206 fprintf(f, "%s", CS wmf_text);
8212 "No action is required on your part. Delivery attempts will continue for\n"
8213 "some time, and this warning may be repeated at intervals if the message\n"
8214 "remains undelivered. Eventually the mail delivery software will give up,\n"
8215 "and when that happens, the message will be returned to you.\n");
8218 /* output machine readable part */
8219 fprintf(f, "\n--%s\n"
8220 "Content-type: message/delivery-status\n\n"
8221 "Reporting-MTA: dns; %s\n",
8223 smtp_active_hostname);
8228 /* must be decoded from xtext: see RFC 3461:6.3a */
8230 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8231 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8233 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8237 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8239 if (addr_dsndefer->dsn_orcpt)
8240 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8242 fprintf(f, "Action: delayed\n"
8243 "Final-Recipient: rfc822;%s\n"
8245 addr_dsndefer->address);
8246 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8248 fprintf(f, "Remote-MTA: dns; %s\n",
8249 addr_dsndefer->host_used->name);
8250 print_dsn_diagnostic_code(addr_dsndefer, f);
8256 "Content-type: text/rfc822-headers\n\n",
8260 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8261 tctx.u.fd = fileno(f);
8262 tctx.options = topt_add_return_path | topt_no_body;
8263 transport_filter_argv = NULL; /* Just in case */
8264 return_path = sender_address; /* In case not previously set */
8266 /* Write the original email out */
8267 transport_write_message(&tctx, 0);
8270 fprintf(f,"\n--%s--\n", bound);
8274 /* Close and wait for child process to complete, without a timeout.
8275 If there's an error, don't update the count. */
8278 if (child_close(pid, 0) == 0)
8280 warning_count = count;
8281 update_spool = TRUE; /* Ensure spool rewritten */
8287 /* Clear deliver_domain */
8289 deliver_domain = NULL;
8291 /* If this was a first delivery attempt, unset the first time flag, and
8292 ensure that the spool gets updated. */
8294 if (deliver_firsttime)
8296 deliver_firsttime = FALSE;
8297 update_spool = TRUE;
8300 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8301 message, unless the message is a local error message (to avoid loops). Then
8302 log the freezing. If the text in "frozen_info" came from a system filter,
8303 it has been escaped into printing characters so as not to mess up log lines.
8304 For the "tell" message, we turn \n back into newline. Also, insert a newline
8305 near the start instead of the ": " string. */
8309 if (freeze_tell && freeze_tell[0] != 0 && !local_error_message)
8311 uschar *s = string_copy(frozen_info);
8312 uschar *ss = Ustrstr(s, " by the system filter: ");
8323 if (*ss == '\\' && ss[1] == 'n')
8330 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8331 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8335 /* Log freezing just before we update the -H file, to minimize the chance
8336 of a race problem. */
8338 deliver_msglog("*** Frozen%s\n", frozen_info);
8339 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8342 /* If there have been any updates to the non-recipients list, or other things
8343 that get written to the spool, we must now update the spool header file so
8344 that it has the right information for the next delivery attempt. If there
8345 was more than one address being delivered, the header_change update is done
8346 earlier, in case one succeeds and then something crashes. */
8349 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8350 update_spool, header_rewritten);
8352 if (update_spool || header_rewritten)
8353 /* Panic-dies on error */
8354 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8357 /* Finished with the message log. If the message is complete, it will have
8358 been unlinked or renamed above. */
8360 if (message_logs) (void)fclose(message_log);
8362 /* Now we can close and remove the journal file. Its only purpose is to record
8363 successfully completed deliveries asap so that this information doesn't get
8364 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8365 not serious, as trying it again is not harmful. The journal might not be open
8366 if all addresses were deferred at routing or directing. Nevertheless, we must
8367 remove it if it exists (may have been lying around from a crash during the
8368 previous delivery attempt). We don't remove the journal if a delivery
8369 subprocess failed to pass back delivery information; this is controlled by
8370 the remove_journal flag. When the journal is left, we also don't move the
8371 message off the main spool if frozen and the option is set. It should get moved
8372 at the next attempt, after the journal has been inspected. */
8374 if (journal_fd >= 0) (void)close(journal_fd);
8378 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8380 if (Uunlink(fname) < 0 && errno != ENOENT)
8381 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8384 /* Move the message off the spool if requested */
8386 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8387 if (deliver_freeze && move_frozen_messages)
8388 (void)spool_move_message(id, message_subdir, US"", US"F");
8392 /* Closing the data file frees the lock; if the file has been unlinked it
8393 will go away. Otherwise the message becomes available for another process
8396 (void)close(deliver_datafile);
8397 deliver_datafile = -1;
8398 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8400 /* It is unlikely that there will be any cached resources, since they are
8401 released after routing, and in the delivery subprocesses. However, it's
8402 possible for an expansion for something afterwards (for example,
8403 expand_check_condition) to do a lookup. We must therefore be sure everything is
8407 acl_where = ACL_WHERE_UNKNOWN;
8416 #ifdef EXIM_TFO_PROBE
8419 tcp_fastopen_ok = TRUE;
8423 if (!regex_PIPELINING) regex_PIPELINING =
8424 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8426 if (!regex_SIZE) regex_SIZE =
8427 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8429 if (!regex_AUTH) regex_AUTH =
8430 regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
8434 if (!regex_STARTTLS) regex_STARTTLS =
8435 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8438 if (!regex_CHUNKING) regex_CHUNKING =
8439 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8441 #ifndef DISABLE_PRDR
8442 if (!regex_PRDR) regex_PRDR =
8443 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8447 if (!regex_UTF8) regex_UTF8 =
8448 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8451 if (!regex_DSN) regex_DSN =
8452 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8454 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8455 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8460 deliver_get_sender_address (uschar * id)
8463 uschar * new_sender_address,
8464 * save_sender_address;
8465 BOOL save_qr = queue_running;
8468 /* make spool_open_datafile non-noisy on fail */
8470 queue_running = TRUE;
8472 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8474 deliver_datafile = spool_open_datafile(id);
8475 queue_running = save_qr;
8476 if (deliver_datafile < 0)
8479 /* Save and restore the global sender_address. I'm not sure if we should
8480 not save/restore all the other global variables too, because
8481 spool_read_header() may change all of them. But OTOH, when this
8482 deliver_get_sender_address() gets called, the current message is done
8483 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8485 spoolname = string_sprintf("%s-H", id);
8486 save_sender_address = sender_address;
8488 rc = spool_read_header(spoolname, TRUE, TRUE);
8490 new_sender_address = sender_address;
8491 sender_address = save_sender_address;
8493 if (rc != spool_read_OK)
8496 assert(new_sender_address);
8498 (void)close(deliver_datafile);
8499 deliver_datafile = -1;
8501 return new_sender_address;
8507 delivery_re_exec(int exec_type)
8511 if (cutthrough.fd >= 0 && cutthrough.callout_hold_only)
8513 int pfd[2], channel_fd = cutthrough.fd, pid;
8515 smtp_peer_options = cutthrough.peer_options;
8516 continue_sequence = 0;
8519 if (cutthrough.is_tls)
8521 smtp_peer_options |= OPTION_TLS;
8522 sending_ip_address = cutthrough.snd_ip;
8523 sending_port = cutthrough.snd_port;
8525 where = US"socketpair";
8526 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8530 if ((pid = fork()) < 0)
8533 else if (pid == 0) /* child: fork again to totally disconnect */
8537 _exit(pid ? EXIT_FAILURE : EXIT_SUCCESS);
8538 smtp_proxy_tls(big_buffer, big_buffer_size, pfd[0], 5*60);
8543 waitpid(pid, NULL, 0);
8544 (void) close(channel_fd); /* release the client socket */
8545 channel_fd = pfd[1];
8549 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8550 cutthrough.host.address, message_id, channel_fd);
8554 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8555 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8557 return; /* compiler quietening; control does not reach here. */
8561 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8562 "delivery re-exec %s failed: %s", where, strerror(errno));
8564 /* Get here if exec_type == CEE_EXEC_EXIT.
8565 Note: this must be _exit(), not exit(). */
8567 _exit(EX_EXECFAILED);
8572 /* End of deliver.c */