1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_dsntmp = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static int return_count;
78 static uschar *frozen_info = US"";
79 static uschar *used_return_path = NULL;
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
87 /* The syscall read(2) doesn't always returns as much as we want. For
88 several reasons it might get less. (Not talking about signals, as syscalls
89 are restartable). When reading from a network or pipe connection the sender
90 might send in smaller chunks, with delays between these chunks. The read(2)
91 may return such a chunk.
93 The more the writer writes and the smaller the pipe between write and read is,
94 the more we get the chance of reading leass than requested. (See bug 2130)
96 This function read(2)s until we got all the data we *requested*.
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
106 Returns: the amount of bytes read
109 readn(int fd, void * buffer, size_t len)
111 void * next = buffer;
112 void * end = buffer + len;
116 ssize_t got = read(fd, next, end - next);
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got == -1 && errno == EINTR) continue;
121 if (got <= 0) return next - buffer;
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
133 /* This function gets the store and initializes with default values. The
134 transport_return value defaults to DEFER, so that any unexpected failure to
135 deliver does not wipe out the message. The default unique string is set to a
136 copy of the address, so that its domain can be lowercased.
139 address the RFC822 address string
140 copy force a copy of the address
142 Returns: a pointer to an initialized address_item
146 deliver_make_addr(uschar *address, BOOL copy)
148 address_item *addr = store_get(sizeof(address_item));
149 *addr = address_defaults;
150 if (copy) address = string_copy(address);
151 addr->address = address;
152 addr->unique = string_copy(address);
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
163 /* Certain expansion variables are valid only when handling an address or
164 address list. This function sets them up or clears the values, according to its
168 addr the address in question, or NULL to clear values
173 deliver_set_expansions(address_item *addr)
177 const uschar ***p = address_expansions;
178 while (*p) **p++ = NULL;
182 /* Exactly what gets set depends on whether there is one or more addresses, and
183 what they contain. These first ones are always set, taking their values from
184 the first address. */
186 if (!addr->host_list)
188 deliver_host = deliver_host_address = US"";
189 deliver_host_port = 0;
193 deliver_host = addr->host_list->name;
194 deliver_host_address = addr->host_list->address;
195 deliver_host_port = addr->host_list->port;
198 deliver_recipients = addr;
199 deliver_address_data = addr->prop.address_data;
200 deliver_domain_data = addr->prop.domain_data;
201 deliver_localpart_data = addr->prop.localpart_data;
203 /* These may be unset for multiple addresses */
205 deliver_domain = addr->domain;
206 self_hostname = addr->self_hostname;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver = 1; /* deliver by default */
210 bmi_alt_location = NULL;
211 bmi_base64_verdict = NULL;
212 bmi_base64_tracker_verdict = NULL;
215 /* If there's only one address we can set everything. */
219 address_item *addr_orig;
221 deliver_localpart = addr->local_part;
222 deliver_localpart_prefix = addr->prefix;
223 deliver_localpart_suffix = addr->suffix;
225 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
226 deliver_domain_orig = addr_orig->domain;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig = !addr_orig->router
235 ? addr_orig->local_part
236 : addr_orig->router->caseful_local_part
237 ? addr_orig->cc_local_part
238 : addr_orig->lc_local_part;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent = addr->parent->domain;
248 deliver_localpart_parent = !addr->parent->router
249 ? addr->parent->local_part
250 : addr->parent->router->caseful_local_part
251 ? addr->parent->cc_local_part
252 : addr->parent->lc_local_part;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr, af_pfr))
259 if (testflag(addr, af_file)) address_file = addr->local_part;
260 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
261 deliver_localpart = addr->parent->local_part;
262 deliver_localpart_prefix = addr->parent->prefix;
263 deliver_localpart_suffix = addr->parent->suffix;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
270 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver == 1)
275 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
288 if (testflag(addr, af_pfr))
290 if (testflag(addr, af_file)) address_file = addr->local_part;
291 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
293 for (addr2 = addr->next; addr2; addr2 = addr2->next)
295 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
296 deliver_domain = NULL;
298 && ( !addr2->self_hostname
299 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
301 self_hostname = NULL;
302 if (!deliver_domain && !self_hostname) break;
310 /*************************************************
311 * Open a msglog file *
312 *************************************************/
314 /* This function is used both for normal message logs, and for files in the
315 msglog directory that are used to catch output from pipes. Try to create the
316 directory if it does not exist. From release 4.21, normal message logs should
317 be created when the message is received.
319 Called from deliver_message(), can be operating as root.
322 filename the file name
323 mode the mode required
324 error used for saying what failed
326 Returns: a file descriptor, or -1 (with errno set)
330 open_msglog_file(uschar *filename, int mode, uschar **error)
334 for (i = 2; i > 0; i--)
343 O_WRONLY|O_APPEND|O_CREAT, mode);
346 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
347 function is called as root). Double check the mode, because the group setting
348 doesn't always get set automatically. */
351 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
353 if (fchown(fd, exim_uid, exim_gid) < 0)
358 if (fchmod(fd, mode) < 0)
368 (void)directory_make(spool_directory,
369 spool_sname(US"msglog", message_subdir),
370 MSGLOG_DIRECTORY_MODE, TRUE);
380 /*************************************************
381 * Write to msglog if required *
382 *************************************************/
384 /* Write to the message log, if configured. This function may also be called
388 format a string format
394 deliver_msglog(const char *format, ...)
397 if (!message_logs) return;
398 va_start(ap, format);
399 vfprintf(message_log, format, ap);
407 /*************************************************
408 * Replicate status for batch *
409 *************************************************/
411 /* When a transport handles a batch of addresses, it may treat them
412 individually, or it may just put the status in the first one, and return FALSE,
413 requesting that the status be copied to all the others externally. This is the
414 replication function. As well as the status, it copies the transport pointer,
415 which may have changed if appendfile passed the addresses on to a different
418 Argument: pointer to the first address in a chain
423 replicate_status(address_item *addr)
426 for (addr2 = addr->next; addr2; addr2 = addr2->next)
428 addr2->transport = addr->transport;
429 addr2->transport_return = addr->transport_return;
430 addr2->basic_errno = addr->basic_errno;
431 addr2->more_errno = addr->more_errno;
432 addr2->delivery_usec = addr->delivery_usec;
433 addr2->special_action = addr->special_action;
434 addr2->message = addr->message;
435 addr2->user_message = addr->user_message;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
459 one points to the first host list
460 two points to the second host list
462 Returns: TRUE if the lists refer to the same host set
466 same_hosts(host_item *one, host_item *two)
470 if (Ustrcmp(one->name, two->name) != 0)
473 host_item *end_one = one;
474 host_item *end_two = two;
476 /* Batch up only if there was no MX and the list was not randomized */
478 if (mx == MX_NONE) return FALSE;
480 /* Find the ends of the shortest sequence of identical MX values */
482 while ( end_one->next && end_one->next->mx == mx
483 && end_two->next && end_two->next->mx == mx)
485 end_one = end_one->next;
486 end_two = end_two->next;
489 /* If there aren't any duplicates, there's no match. */
491 if (end_one == one) return FALSE;
493 /* For each host in the 'one' sequence, check that it appears in the 'two'
494 sequence, returning FALSE if not. */
499 for (hi = two; hi != end_two->next; hi = hi->next)
500 if (Ustrcmp(one->name, hi->name) == 0) break;
501 if (hi == end_two->next) return FALSE;
502 if (one == end_one) break;
506 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
507 Ensure both are pointing at the last host, and carry on as for equality. */
512 /* if the names matched but ports do not, mismatch */
513 else if (one->port != two->port)
522 /* True if both are NULL */
529 /*************************************************
530 * Compare header lines *
531 *************************************************/
533 /* This function is given two pointers to chains of header items, and it yields
534 TRUE if they are the same header texts in the same order.
537 one points to the first header list
538 two points to the second header list
540 Returns: TRUE if the lists refer to the same header set
544 same_headers(header_line *one, header_line *two)
546 for (;; one = one->next, two = two->next)
548 if (one == two) return TRUE; /* Includes the case where both NULL */
549 if (!one || !two) return FALSE;
550 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
556 /*************************************************
557 * Compare string settings *
558 *************************************************/
560 /* This function is given two pointers to strings, and it returns
561 TRUE if they are the same pointer, or if the two strings are the same.
564 one points to the first string
565 two points to the second string
567 Returns: TRUE or FALSE
571 same_strings(uschar *one, uschar *two)
573 if (one == two) return TRUE; /* Includes the case where both NULL */
574 if (!one || !two) return FALSE;
575 return (Ustrcmp(one, two) == 0);
580 /*************************************************
581 * Compare uid/gid for addresses *
582 *************************************************/
584 /* This function is given a transport and two addresses. It yields TRUE if the
585 uid/gid/initgroups settings for the two addresses are going to be the same when
590 addr1 the first address
591 addr2 the second address
593 Returns: TRUE or FALSE
597 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
599 if ( !tp->uid_set && !tp->expand_uid
600 && !tp->deliver_as_creator
601 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
602 || ( testflag(addr1, af_uid_set)
603 && ( addr1->uid != addr2->uid
604 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
608 if ( !tp->gid_set && !tp->expand_gid
609 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
610 || ( testflag(addr1, af_gid_set)
611 && addr1->gid != addr2->gid
621 /*************************************************
622 * Record that an address is complete *
623 *************************************************/
625 /* This function records that an address is complete. This is straightforward
626 for most addresses, where the unique address is just the full address with the
627 domain lower cased. For homonyms (addresses that are the same as one of their
628 ancestors) their are complications. Their unique addresses have \x\ prepended
629 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
632 Exim used to record the unique addresses of homonyms as "complete". This,
633 however, fails when the pattern of redirection varies over time (e.g. if taking
634 unseen copies at only some times of day) because the prepended numbers may vary
635 from one delivery run to the next. This problem is solved by never recording
636 prepended unique addresses as complete. Instead, when a homonymic address has
637 actually been delivered via a transport, we record its basic unique address
638 followed by the name of the transport. This is checked in subsequent delivery
639 runs whenever an address is routed to a transport.
641 If the completed address is a top-level one (has no parent, which means it
642 cannot be homonymic) we also add the original address to the non-recipients
643 tree, so that it gets recorded in the spool file and therefore appears as
644 "done" in any spool listings. The original address may differ from the unique
645 address in the case of the domain.
647 Finally, this function scans the list of duplicates, marks as done any that
648 match this address, and calls child_done() for their ancestors.
651 addr address item that has been completed
652 now current time as a string
658 address_done(address_item *addr, uschar *now)
662 update_spool = TRUE; /* Ensure spool gets updated */
664 /* Top-level address */
668 tree_add_nonrecipient(addr->unique);
669 tree_add_nonrecipient(addr->address);
672 /* Homonymous child address */
674 else if (testflag(addr, af_homonym))
677 tree_add_nonrecipient(
678 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
681 /* Non-homonymous child address */
683 else tree_add_nonrecipient(addr->unique);
685 /* Check the list of duplicate addresses and ensure they are now marked
688 for (dup = addr_duplicate; dup; dup = dup->next)
689 if (Ustrcmp(addr->unique, dup->unique) == 0)
691 tree_add_nonrecipient(dup->unique);
692 child_done(dup, now);
699 /*************************************************
700 * Decrease counts in parents and mark done *
701 *************************************************/
703 /* This function is called when an address is complete. If there is a parent
704 address, its count of children is decremented. If there are still other
705 children outstanding, the function exits. Otherwise, if the count has become
706 zero, address_done() is called to mark the parent and its duplicates complete.
707 Then loop for any earlier ancestors.
710 addr points to the completed address item
711 now the current time as a string, for writing to the message log
717 child_done(address_item *addr, uschar *now)
723 if (--addr->child_count > 0) return; /* Incomplete parent */
724 address_done(addr, now);
726 /* Log the completion of all descendents only when there is no ancestor with
727 the same original address. */
729 for (aa = addr->parent; aa; aa = aa->parent)
730 if (Ustrcmp(aa->address, addr->address) == 0) break;
733 deliver_msglog("%s %s: children all complete\n", now, addr->address);
734 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
740 /*************************************************
741 * Delivery logging support functions *
742 *************************************************/
744 /* The LOGGING() checks in d_log_interface() are complicated for backwards
745 compatibility. When outgoing interface logging was originally added, it was
746 conditional on just incoming_interface (which is off by default). The
747 outgoing_interface option is on by default to preserve this behaviour, but
748 you can enable incoming_interface and disable outgoing_interface to get I=
749 fields on incoming lines only.
753 addr The address to be logged
755 Returns: New value for s
759 d_log_interface(gstring * g)
761 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
762 && sending_ip_address)
764 g = string_append(g, 2, US" I=[", sending_ip_address);
765 g = LOGGING(outgoing_port)
766 ? string_append(g, 2, US"]:", string_sprintf("%d", sending_port))
767 : string_catn(g, US"]", 1);
775 d_hostlog(gstring * g, address_item * addr)
777 host_item * h = addr->host_used;
779 g = string_append(g, 2, US" H=", h->name);
781 if (LOGGING(dnssec) && h->dnssec == DS_YES)
782 g = string_catn(g, US" DS", 3);
784 g = string_append(g, 3, US" [", h->address, US"]");
786 if (LOGGING(outgoing_port))
787 g = string_append(g, 2, US":", string_sprintf("%d", h->port));
790 if (LOGGING(proxy) && proxy_local_address)
792 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
793 if (LOGGING(outgoing_port))
794 g = string_append(g, 2, US":", string_sprintf("%d", proxy_local_port));
798 g = d_log_interface(g);
800 if (testflag(addr, af_tcp_fastopen))
801 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
812 d_tlslog(gstring * s, address_item * addr)
814 if (LOGGING(tls_cipher) && addr->cipher)
815 s = string_append(s, 2, US" X=", addr->cipher);
816 if (LOGGING(tls_certificate_verified) && addr->cipher)
817 s = string_append(s, 2, US" CV=",
818 testflag(addr, af_cert_verified)
821 testflag(addr, af_dane_verified)
827 if (LOGGING(tls_peerdn) && addr->peerdn)
828 s = string_append(s, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
836 #ifndef DISABLE_EVENT
838 event_raise(uschar * action, const uschar * event, uschar * ev_data)
844 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
846 action, deliver_host_address);
849 event_data = ev_data;
851 if (!(s = expand_string(action)) && *expand_string_message)
852 log_write(0, LOG_MAIN|LOG_PANIC,
853 "failed to expand event_action %s in %s: %s\n",
854 event, transport_name ? transport_name : US"main", expand_string_message);
856 event_name = event_data = NULL;
858 /* If the expansion returns anything but an empty string, flag for
859 the caller to modify his normal processing
864 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
872 msg_event_raise(const uschar * event, const address_item * addr)
874 const uschar * save_domain = deliver_domain;
875 uschar * save_local = deliver_localpart;
876 const uschar * save_host = deliver_host;
877 const uschar * save_address = deliver_host_address;
878 const int save_port = deliver_host_port;
880 router_name = addr->router ? addr->router->name : NULL;
881 deliver_domain = addr->domain;
882 deliver_localpart = addr->local_part;
883 deliver_host = addr->host_used ? addr->host_used->name : NULL;
885 if (!addr->transport)
887 if (Ustrcmp(event, "msg:fail:delivery") == 0)
889 /* An address failed with no transport involved. This happens when
890 a filter was used which triggered a fail command (in such a case
891 a transport isn't needed). Convert it to an internal fail event. */
893 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
898 transport_name = addr->transport->name;
900 (void) event_raise(addr->transport->event_action, event,
902 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
903 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
904 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
905 ? addr->message : NULL);
908 deliver_host_port = save_port;
909 deliver_host_address = save_address;
910 deliver_host = save_host;
911 deliver_localpart = save_local;
912 deliver_domain = save_domain;
913 router_name = transport_name = NULL;
915 #endif /*DISABLE_EVENT*/
919 /******************************************************************************/
922 /*************************************************
923 * Generate local prt for logging *
924 *************************************************/
926 /* This function is a subroutine for use in string_log_address() below.
929 addr the address being logged
930 yield the current dynamic buffer pointer
932 Returns: the new value of the buffer pointer
936 string_get_localpart(address_item * addr, gstring * yield)
941 if (testflag(addr, af_include_affixes) && s)
944 if (testflag(addr, af_utf8_downcvt))
945 s = string_localpart_utf8_to_alabel(s, NULL);
947 yield = string_cat(yield, s);
950 s = addr->local_part;
952 if (testflag(addr, af_utf8_downcvt))
953 s = string_localpart_utf8_to_alabel(s, NULL);
955 yield = string_cat(yield, s);
958 if (testflag(addr, af_include_affixes) && s)
961 if (testflag(addr, af_utf8_downcvt))
962 s = string_localpart_utf8_to_alabel(s, NULL);
964 yield = string_cat(yield, s);
971 /*************************************************
972 * Generate log address list *
973 *************************************************/
975 /* This function generates a list consisting of an address and its parents, for
976 use in logging lines. For saved onetime aliased addresses, the onetime parent
977 field is used. If the address was delivered by a transport with rcpt_include_
978 affixes set, the af_include_affixes bit will be set in the address. In that
979 case, we include the affixes here too.
982 g points to growing-string struct
983 addr bottom (ultimate) address
984 all_parents if TRUE, include all parents
985 success TRUE for successful delivery
987 Returns: a growable string in dynamic store
991 string_log_address(gstring * g,
992 address_item *addr, BOOL all_parents, BOOL success)
994 BOOL add_topaddr = TRUE;
995 address_item *topaddr;
997 /* Find the ultimate parent */
999 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1001 /* We start with just the local part for pipe, file, and reply deliveries, and
1002 for successful local deliveries from routers that have the log_as_local flag
1003 set. File deliveries from filters can be specified as non-absolute paths in
1004 cases where the transport is going to complete the path. If there is an error
1005 before this happens (expansion failure) the local part will not be updated, and
1006 so won't necessarily look like a path. Add extra text for this case. */
1008 if ( testflag(addr, af_pfr)
1010 && addr->router && addr->router->log_as_local
1011 && addr->transport && addr->transport->info->local
1014 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1015 g = string_catn(g, CUS"save ", 5);
1016 g = string_get_localpart(addr, g);
1019 /* Other deliveries start with the full address. It we have split it into local
1020 part and domain, use those fields. Some early failures can happen before the
1021 splitting is done; in those cases use the original field. */
1025 uschar * cmp = g->s + g->ptr;
1027 if (addr->local_part)
1030 g = string_get_localpart(addr, g);
1031 g = string_catn(g, US"@", 1);
1034 if (testflag(addr, af_utf8_downcvt))
1035 s = string_localpart_utf8_to_alabel(s, NULL);
1037 g = string_cat(g, s);
1040 g = string_cat(g, addr->address);
1042 /* If the address we are going to print is the same as the top address,
1043 and all parents are not being included, don't add on the top address. First
1044 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1045 on the local parts. */
1047 string_from_gstring(g); /* ensure nul-terminated */
1048 if ( strcmpic(cmp, topaddr->address) == 0
1049 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1050 && !addr->onetime_parent
1051 && (!all_parents || !addr->parent || addr->parent == topaddr)
1053 add_topaddr = FALSE;
1056 /* If all parents are requested, or this is a local pipe/file/reply, and
1057 there is at least one intermediate parent, show it in brackets, and continue
1058 with all of them if all are wanted. */
1060 if ( (all_parents || testflag(addr, af_pfr))
1062 && addr->parent != topaddr)
1065 address_item *addr2;
1066 for (addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1068 g = string_catn(g, s, 2);
1069 g = string_cat (g, addr2->address);
1070 if (!all_parents) break;
1073 g = string_catn(g, US")", 1);
1076 /* Add the top address if it is required */
1079 g = string_append(g, 3,
1081 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1090 timesince(struct timeval * diff, struct timeval * then)
1092 gettimeofday(diff, NULL);
1093 diff->tv_sec -= then->tv_sec;
1094 if ((diff->tv_usec -= then->tv_usec) < 0)
1097 diff->tv_usec += 1000*1000;
1104 string_timediff(struct timeval * diff)
1106 static uschar buf[sizeof("0.000s")];
1108 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1109 return readconf_printtime((int)diff->tv_sec);
1111 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1117 string_timesince(struct timeval * then)
1119 struct timeval diff;
1121 timesince(&diff, then);
1122 return string_timediff(&diff);
1125 /******************************************************************************/
1129 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1130 this is a nonstandard call; no two-character delivery flag is written
1131 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1134 flags passed to log_write()
1137 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1139 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1140 void * reset_point; /* released afterwards. */
1142 /* Log the delivery on the main log. We use an extensible string to build up
1143 the log line, and reset the store afterwards. Remote deliveries should always
1144 have a pointer to the host item that succeeded; local deliveries can have a
1145 pointer to a single host item in their host list, for use by the transport. */
1147 #ifndef DISABLE_EVENT
1148 /* presume no successful remote delivery */
1149 lookup_dnssec_authenticated = NULL;
1152 g = reset_point = string_get(256);
1155 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1158 g->s[0] = logchar; g->ptr = 1;
1159 g = string_catn(g, US"> ", 2);
1161 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1163 if (LOGGING(sender_on_delivery) || msg)
1164 g = string_append(g, 3, US" F=<",
1166 testflag(addr, af_utf8_downcvt)
1167 ? string_address_utf8_to_alabel(sender_address, NULL)
1174 g = string_append(g, 2, US" Q=", queue_name);
1176 #ifdef EXPERIMENTAL_SRS
1177 if(addr->prop.srs_sender)
1178 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1181 /* You might think that the return path must always be set for a successful
1182 delivery; indeed, I did for some time, until this statement crashed. The case
1183 when it is not set is for a delivery to /dev/null which is optimised by not
1184 being run at all. */
1186 if (used_return_path && LOGGING(return_path_on_delivery))
1187 g = string_append(g, 3, US" P=<", used_return_path, US">");
1190 g = string_append(g, 2, US" ", msg);
1192 /* For a delivery from a system filter, there may not be a router */
1194 g = string_append(g, 2, US" R=", addr->router->name);
1196 g = string_append(g, 2, US" T=", addr->transport->name);
1198 if (LOGGING(delivery_size))
1199 g = string_append(g, 2, US" S=",
1200 string_sprintf("%d", transport_count));
1202 /* Local delivery */
1204 if (addr->transport->info->local)
1206 if (addr->host_list)
1207 g = string_append(g, 2, US" H=", addr->host_list->name);
1208 g = d_log_interface(g);
1209 if (addr->shadow_message)
1210 g = string_cat(g, addr->shadow_message);
1213 /* Remote delivery */
1217 if (addr->host_used)
1219 g = d_hostlog(g, addr);
1220 if (continue_sequence > 1)
1221 g = string_catn(g, US"*", 1);
1223 #ifndef DISABLE_EVENT
1224 deliver_host_address = addr->host_used->address;
1225 deliver_host_port = addr->host_used->port;
1226 deliver_host = addr->host_used->name;
1228 /* DNS lookup status */
1229 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1230 : addr->host_used->dnssec==DS_NO ? US"no"
1236 g = d_tlslog(g, addr);
1239 if (addr->authenticator)
1241 g = string_append(g, 2, US" A=", addr->authenticator);
1244 g = string_append(g, 2, US":", addr->auth_id);
1245 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1246 g = string_append(g, 2, US":", addr->auth_sndr);
1250 if (LOGGING(pipelining))
1252 if (testflag(addr, af_pipelining))
1253 g = string_catn(g, US" L", 2);
1254 #ifdef EXPERIMENTAL_PIPE_CONNECT
1255 if (testflag(addr, af_early_pipe))
1256 g = string_catn(g, US"*", 1);
1260 #ifndef DISABLE_PRDR
1261 if (testflag(addr, af_prdr_used))
1262 g = string_catn(g, US" PRDR", 5);
1265 if (testflag(addr, af_chunking_used))
1266 g = string_catn(g, US" K", 2);
1269 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1271 if ( LOGGING(smtp_confirmation)
1273 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1277 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1278 uschar *p = big_buffer;
1279 uschar *ss = addr->message;
1281 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1283 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1288 g = string_append(g, 2, US" C=", big_buffer);
1291 /* Time on queue and actual time taken to deliver */
1293 if (LOGGING(queue_time))
1294 g = string_append(g, 2, US" QT=",
1295 string_timesince(&received_time));
1297 if (LOGGING(deliver_time))
1299 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1300 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1303 /* string_cat() always leaves room for the terminator. Release the
1304 store we used to build the line after writing it. */
1306 log_write(0, flags, "%s", string_from_gstring(g));
1308 #ifndef DISABLE_EVENT
1309 if (!msg) msg_event_raise(US"msg:delivery", addr);
1312 store_reset(reset_point);
1319 deferral_log(address_item * addr, uschar * now,
1320 int logflags, uschar * driver_name, uschar * driver_kind)
1325 /* Build up the line that is used for both the message log and the main
1328 g = reset_point = string_get(256);
1330 /* Create the address string for logging. Must not do this earlier, because
1331 an OK result may be changed to FAIL when a pipe returns text. */
1333 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1336 g = string_append(g, 2, US" Q=", queue_name);
1338 /* Either driver_name contains something and driver_kind contains
1339 " router" or " transport" (note the leading space), or driver_name is
1340 a null string and driver_kind contains "routing" without the leading
1341 space, if all routing has been deferred. When a domain has been held,
1342 so nothing has been done at all, both variables contain null strings. */
1346 if (driver_kind[1] == 't' && addr->router)
1347 g = string_append(g, 2, US" R=", addr->router->name);
1348 g = string_cat(g, string_sprintf(" %c=%s", toupper(driver_kind[1]), driver_name));
1350 else if (driver_kind)
1351 g = string_append(g, 2, US" ", driver_kind);
1353 /*XXX need an s+s+p sprintf */
1354 g = string_cat(g, string_sprintf(" defer (%d)", addr->basic_errno));
1356 if (addr->basic_errno > 0)
1357 g = string_append(g, 2, US": ",
1358 US strerror(addr->basic_errno));
1360 if (addr->host_used)
1362 g = string_append(g, 5,
1363 US" H=", addr->host_used->name,
1364 US" [", addr->host_used->address, US"]");
1365 if (LOGGING(outgoing_port))
1367 int port = addr->host_used->port;
1368 g = string_append(g, 2,
1369 US":", port == PORT_NONE ? US"25" : string_sprintf("%d", port));
1374 g = string_append(g, 2, US": ", addr->message);
1376 (void) string_from_gstring(g);
1378 /* Log the deferment in the message log, but don't clutter it
1379 up with retry-time defers after the first delivery attempt. */
1381 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1382 deliver_msglog("%s %s\n", now, g->s);
1384 /* Write the main log and reset the store.
1385 For errors of the type "retry time not reached" (also remotes skipped
1386 on queue run), logging is controlled by L_retry_defer. Note that this kind
1387 of error number is negative, and all the retry ones are less than any
1391 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1394 store_reset(reset_point);
1401 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1404 gstring * g = reset_point = string_get(256);
1406 #ifndef DISABLE_EVENT
1407 /* Message failures for which we will send a DSN get their event raised
1408 later so avoid doing it here. */
1410 if ( !addr->prop.ignore_error
1411 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1413 msg_event_raise(US"msg:fail:delivery", addr);
1416 /* Build up the log line for the message and main logs */
1418 /* Create the address string for logging. Must not do this earlier, because
1419 an OK result may be changed to FAIL when a pipe returns text. */
1421 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1423 if (LOGGING(sender_on_delivery))
1424 g = string_append(g, 3, US" F=<", sender_address, US">");
1427 g = string_append(g, 2, US" Q=", queue_name);
1429 /* Return path may not be set if no delivery actually happened */
1431 if (used_return_path && LOGGING(return_path_on_delivery))
1432 g = string_append(g, 3, US" P=<", used_return_path, US">");
1435 g = string_append(g, 2, US" R=", addr->router->name);
1436 if (addr->transport)
1437 g = string_append(g, 2, US" T=", addr->transport->name);
1439 if (addr->host_used)
1440 g = d_hostlog(g, addr);
1443 g = d_tlslog(g, addr);
1446 if (addr->basic_errno > 0)
1447 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1450 g = string_append(g, 2, US": ", addr->message);
1452 (void) string_from_gstring(g);
1454 /* Do the logging. For the message log, "routing failed" for those cases,
1455 just to make it clearer. */
1458 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1460 deliver_msglog("%s %s\n", now, g->s);
1462 log_write(0, LOG_MAIN, "** %s", g->s);
1464 store_reset(reset_point);
1470 /*************************************************
1471 * Actions at the end of handling an address *
1472 *************************************************/
1474 /* This is a function for processing a single address when all that can be done
1475 with it has been done.
1478 addr points to the address block
1479 result the result of the delivery attempt
1480 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1481 driver_type indicates which type of driver (transport, or router) was last
1482 to process the address
1483 logchar '=' or '-' for use when logging deliveries with => or ->
1489 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1492 uschar *now = tod_stamp(tod_log);
1493 uschar *driver_kind = NULL;
1494 uschar *driver_name = NULL;
1496 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1498 /* Set up driver kind and name for logging. Disable logging if the router or
1499 transport has disabled it. */
1501 if (driver_type == EXIM_DTYPE_TRANSPORT)
1503 if (addr->transport)
1505 driver_name = addr->transport->name;
1506 driver_kind = US" transport";
1507 f.disable_logging = addr->transport->disable_logging;
1509 else driver_kind = US"transporting";
1511 else if (driver_type == EXIM_DTYPE_ROUTER)
1515 driver_name = addr->router->name;
1516 driver_kind = US" router";
1517 f.disable_logging = addr->router->disable_logging;
1519 else driver_kind = US"routing";
1522 /* If there's an error message set, ensure that it contains only printing
1523 characters - it should, but occasionally things slip in and this at least
1524 stops the log format from getting wrecked. We also scan the message for an LDAP
1525 expansion item that has a password setting, and flatten the password. This is a
1526 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1527 malformed, it won't ever have gone near LDAP.) */
1531 const uschar * s = string_printing(addr->message);
1533 /* deconst cast ok as string_printing known to have alloc'n'copied */
1534 addr->message = expand_hide_passwords(US s);
1537 /* If we used a transport that has one of the "return_output" options set, and
1538 if it did in fact generate some output, then for return_output we treat the
1539 message as failed if it was not already set that way, so that the output gets
1540 returned to the sender, provided there is a sender to send it to. For
1541 return_fail_output, do this only if the delivery failed. Otherwise we just
1542 unlink the file, and remove the name so that if the delivery failed, we don't
1543 try to send back an empty or unwanted file. The log_output options operate only
1544 on a non-empty file.
1546 In any case, we close the message file, because we cannot afford to leave a
1547 file-descriptor for one address while processing (maybe very many) others. */
1549 if (addr->return_file >= 0 && addr->return_filename)
1551 BOOL return_output = FALSE;
1552 struct stat statbuf;
1553 (void)EXIMfsync(addr->return_file);
1555 /* If there is no output, do nothing. */
1557 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1559 transport_instance *tb = addr->transport;
1561 /* Handle logging options */
1564 || result == FAIL && tb->log_fail_output
1565 || result == DEFER && tb->log_defer_output
1569 FILE *f = Ufopen(addr->return_filename, "rb");
1571 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1572 "from %s transport: %s", addr->return_filename, tb->name,
1575 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1577 uschar *p = big_buffer + Ustrlen(big_buffer);
1579 while (p > big_buffer && isspace(p[-1])) p--;
1581 sp = string_printing(big_buffer);
1582 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1583 addr->address, tb->name, sp);
1588 /* Handle returning options, but only if there is an address to return
1591 if (sender_address[0] != 0 || addr->prop.errors_address)
1592 if (tb->return_output)
1594 addr->transport_return = result = FAIL;
1595 if (addr->basic_errno == 0 && !addr->message)
1596 addr->message = US"return message generated";
1597 return_output = TRUE;
1600 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1603 /* Get rid of the file unless it might be returned, but close it in
1608 Uunlink(addr->return_filename);
1609 addr->return_filename = NULL;
1610 addr->return_file = -1;
1613 (void)close(addr->return_file);
1616 /* The success case happens only after delivery by a transport. */
1620 addr->next = addr_succeed;
1621 addr_succeed = addr;
1623 /* Call address_done() to ensure that we don't deliver to this address again,
1624 and write appropriate things to the message log. If it is a child address, we
1625 call child_done() to scan the ancestors and mark them complete if this is the
1626 last child to complete. */
1628 address_done(addr, now);
1629 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1632 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1633 driver_name, driver_kind);
1636 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1637 addr->parent->address, driver_name, driver_kind);
1638 child_done(addr, now);
1641 /* Certificates for logging (via events) */
1643 tls_out.ourcert = addr->ourcert;
1644 addr->ourcert = NULL;
1645 tls_out.peercert = addr->peercert;
1646 addr->peercert = NULL;
1648 tls_out.cipher = addr->cipher;
1649 tls_out.peerdn = addr->peerdn;
1650 tls_out.ocsp = addr->ocsp;
1651 # ifdef SUPPORT_DANE
1652 tls_out.dane_verified = testflag(addr, af_dane_verified);
1656 delivery_log(LOG_MAIN, addr, logchar, NULL);
1659 tls_free_cert(&tls_out.ourcert);
1660 tls_free_cert(&tls_out.peercert);
1661 tls_out.cipher = NULL;
1662 tls_out.peerdn = NULL;
1663 tls_out.ocsp = OCSP_NOT_REQ;
1664 # ifdef SUPPORT_DANE
1665 tls_out.dane_verified = FALSE;
1671 /* Soft failure, or local delivery process failed; freezing may be
1674 else if (result == DEFER || result == PANIC)
1676 if (result == PANIC) logflags |= LOG_PANIC;
1678 /* This puts them on the chain in reverse order. Do not change this, because
1679 the code for handling retries assumes that the one with the retry
1680 information is last. */
1682 addr->next = addr_defer;
1685 /* The only currently implemented special action is to freeze the
1686 message. Logging of this is done later, just before the -H file is
1689 if (addr->special_action == SPECIAL_FREEZE)
1691 f.deliver_freeze = TRUE;
1692 deliver_frozen_at = time(NULL);
1693 update_spool = TRUE;
1696 /* If doing a 2-stage queue run, we skip writing to either the message
1697 log or the main log for SMTP defers. */
1699 if (!f.queue_2stage || addr->basic_errno != 0)
1700 deferral_log(addr, now, logflags, driver_name, driver_kind);
1704 /* Hard failure. If there is an address to which an error message can be sent,
1705 put this address on the failed list. If not, put it on the deferred list and
1706 freeze the mail message for human attention. The latter action can also be
1707 explicitly requested by a router or transport. */
1711 /* If this is a delivery error, or a message for which no replies are
1712 wanted, and the message's age is greater than ignore_bounce_errors_after,
1713 force the af_ignore_error flag. This will cause the address to be discarded
1714 later (with a log entry). */
1716 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1717 addr->prop.ignore_error = TRUE;
1719 /* Freeze the message if requested, or if this is a bounce message (or other
1720 message with null sender) and this address does not have its own errors
1721 address. However, don't freeze if errors are being ignored. The actual code
1722 to ignore occurs later, instead of sending a message. Logging of freezing
1723 occurs later, just before writing the -H file. */
1725 if ( !addr->prop.ignore_error
1726 && ( addr->special_action == SPECIAL_FREEZE
1727 || (sender_address[0] == 0 && !addr->prop.errors_address)
1730 frozen_info = addr->special_action == SPECIAL_FREEZE
1732 : f.sender_local && !f.local_error_message
1733 ? US" (message created with -f <>)"
1734 : US" (delivery error message)";
1735 f.deliver_freeze = TRUE;
1736 deliver_frozen_at = time(NULL);
1737 update_spool = TRUE;
1739 /* The address is put on the defer rather than the failed queue, because
1740 the message is being retained. */
1742 addr->next = addr_defer;
1746 /* Don't put the address on the nonrecipients tree yet; wait until an
1747 error message has been successfully sent. */
1751 addr->next = addr_failed;
1755 failure_log(addr, driver_name ? NULL : driver_kind, now);
1758 /* Ensure logging is turned on again in all cases */
1760 f.disable_logging = FALSE;
1766 /*************************************************
1767 * Address-independent error *
1768 *************************************************/
1770 /* This function is called when there's an error that is not dependent on a
1771 particular address, such as an expansion string failure. It puts the error into
1772 all the addresses in a batch, logs the incident on the main and panic logs, and
1773 clears the expansions. It is mostly called from local_deliver(), but can be
1774 called for a remote delivery via findugid().
1777 logit TRUE if (MAIN+PANIC) logging required
1778 addr the first of the chain of addresses
1780 format format string for error message, or NULL if already set in addr
1781 ... arguments for the format
1787 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1789 address_item *addr2;
1790 addr->basic_errno = code;
1796 va_start(ap, format);
1797 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1798 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1799 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1801 addr->message = string_copy(buffer);
1804 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1806 addr2->basic_errno = code;
1807 addr2->message = addr->message;
1810 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1811 deliver_set_expansions(NULL);
1817 /*************************************************
1818 * Check a "never users" list *
1819 *************************************************/
1821 /* This function is called to check whether a uid is on one of the two "never
1825 uid the uid to be checked
1826 nusers the list to be scanned; the first item in the list is the count
1828 Returns: TRUE if the uid is on the list
1832 check_never_users(uid_t uid, uid_t *nusers)
1835 if (!nusers) return FALSE;
1836 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1842 /*************************************************
1843 * Find uid and gid for a transport *
1844 *************************************************/
1846 /* This function is called for both local and remote deliveries, to find the
1847 uid/gid under which to run the delivery. The values are taken preferentially
1848 from the transport (either explicit or deliver_as_creator), then from the
1849 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1850 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1851 panic error is logged, and the function fails (which normally leads to delivery
1855 addr the address (possibly a chain)
1857 uidp pointer to uid field
1858 gidp pointer to gid field
1859 igfp pointer to the use_initgroups field
1861 Returns: FALSE if failed - error has been set in address(es)
1865 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1869 BOOL gid_set = FALSE;
1871 /* Default initgroups flag comes from the transport */
1873 *igfp = tp->initgroups;
1875 /* First see if there's a gid on the transport, either fixed or expandable.
1876 The expanding function always logs failure itself. */
1883 else if (tp->expand_gid)
1885 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1888 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1894 /* If the transport did not set a group, see if the router did. */
1896 if (!gid_set && testflag(addr, af_gid_set))
1902 /* Pick up a uid from the transport if one is set. */
1904 if (tp->uid_set) *uidp = tp->uid;
1906 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1907 it does not provide a passwd value from which a gid can be taken. */
1909 else if (tp->expand_uid)
1912 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1913 uidp, &(addr->message)))
1915 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1925 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1927 else if (tp->deliver_as_creator)
1929 *uidp = originator_uid;
1932 *gidp = originator_gid;
1937 /* Otherwise see if the address specifies the uid and if so, take it and its
1940 else if (testflag(addr, af_uid_set))
1943 *igfp = testflag(addr, af_initgroups);
1946 /* Nothing has specified the uid - default to the Exim user, and group if the
1959 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1960 defaulting to the Exim uid. In other words, if the configuration has specified
1961 a uid, it must also provide a gid. */
1965 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1966 "%s transport", tp->name);
1970 /* Check that the uid is not on the lists of banned uids that may not be used
1971 for delivery processes. */
1973 nuname = check_never_users(*uidp, never_users)
1975 : check_never_users(*uidp, fixed_never_users)
1976 ? US"fixed_never_users"
1980 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1981 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1993 /*************************************************
1994 * Check the size of a message for a transport *
1995 *************************************************/
1997 /* Checks that the message isn't too big for the selected transport.
1998 This is called only when it is known that the limit is set.
2002 addr the (first) address being delivered
2005 DEFER expansion failed or did not yield an integer
2006 FAIL message too big
2010 check_message_size(transport_instance *tp, address_item *addr)
2015 deliver_set_expansions(addr);
2016 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2017 deliver_set_expansions(NULL);
2019 if (expand_string_message)
2022 addr->message = size_limit == -1
2023 ? string_sprintf("failed to expand message_size_limit "
2024 "in %s transport: %s", tp->name, expand_string_message)
2025 : string_sprintf("invalid message_size_limit "
2026 "in %s transport: %s", tp->name, expand_string_message);
2028 else if (size_limit > 0 && message_size > size_limit)
2032 string_sprintf("message is too big (transport limit = %d)",
2041 /*************************************************
2042 * Transport-time check for a previous delivery *
2043 *************************************************/
2045 /* Check that this base address hasn't previously been delivered to its routed
2046 transport. If it has been delivered, mark it done. The check is necessary at
2047 delivery time in order to handle homonymic addresses correctly in cases where
2048 the pattern of redirection changes between delivery attempts (so the unique
2049 fields change). Non-homonymic previous delivery is detected earlier, at routing
2050 time (which saves unnecessary routing).
2053 addr the address item
2054 testing TRUE if testing wanted only, without side effects
2056 Returns: TRUE if previously delivered by the transport
2060 previously_transported(address_item *addr, BOOL testing)
2062 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
2063 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2065 if (tree_search(tree_nonrecipients, big_buffer) != 0)
2067 DEBUG(D_deliver|D_route|D_transport)
2068 debug_printf("%s was previously delivered (%s transport): discarded\n",
2069 addr->address, addr->transport->name);
2070 if (!testing) child_done(addr, tod_stamp(tod_log));
2079 /******************************************************
2080 * Check for a given header in a header string *
2081 ******************************************************/
2083 /* This function is used when generating quota warnings. The configuration may
2084 specify any header lines it likes in quota_warn_message. If certain of them are
2085 missing, defaults are inserted, so we need to be able to test for the presence
2089 hdr the required header name
2090 hstring the header string
2092 Returns: TRUE the header is in the string
2093 FALSE the header is not in the string
2097 contains_header(uschar *hdr, uschar *hstring)
2099 int len = Ustrlen(hdr);
2100 uschar *p = hstring;
2103 if (strncmpic(p, hdr, len) == 0)
2106 while (*p == ' ' || *p == '\t') p++;
2107 if (*p == ':') return TRUE;
2109 while (*p != 0 && *p != '\n') p++;
2110 if (*p == '\n') p++;
2118 /*************************************************
2119 * Perform a local delivery *
2120 *************************************************/
2122 /* Each local delivery is performed in a separate process which sets its
2123 uid and gid as specified. This is a safer way than simply changing and
2124 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2125 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2126 all systems have seteuid().
2128 If the uid/gid are specified in the transport_instance, they are used; the
2129 transport initialization must ensure that either both or neither are set.
2130 Otherwise, the values associated with the address are used. If neither are set,
2131 it is a configuration error.
2133 The transport or the address may specify a home directory (transport over-
2134 rides), and if they do, this is set as $home. If neither have set a working
2135 directory, this value is used for that as well. Otherwise $home is left unset
2136 and the cwd is set to "/" - a directory that should be accessible to all users.
2138 Using a separate process makes it more complicated to get error information
2139 back. We use a pipe to pass the return code and also an error code and error
2140 text string back to the parent process.
2143 addr points to an address block for this delivery; for "normal" local
2144 deliveries this is the only address to be delivered, but for
2145 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2146 a number of addresses can be handled simultaneously, and in this
2147 case addr will point to a chain of addresses with the same
2150 shadowing TRUE if running a shadow transport; this causes output from pipes
2157 deliver_local(address_item *addr, BOOL shadowing)
2159 BOOL use_initgroups;
2162 int status, len, rc;
2165 uschar *working_directory;
2166 address_item *addr2;
2167 transport_instance *tp = addr->transport;
2169 /* Set up the return path from the errors or sender address. If the transport
2170 has its own return path setting, expand it and replace the existing value. */
2172 if(addr->prop.errors_address)
2173 return_path = addr->prop.errors_address;
2174 #ifdef EXPERIMENTAL_SRS
2175 else if (addr->prop.srs_sender)
2176 return_path = addr->prop.srs_sender;
2179 return_path = sender_address;
2181 if (tp->return_path)
2183 uschar *new_return_path = expand_string(tp->return_path);
2184 if (!new_return_path)
2186 if (!f.expand_string_forcedfail)
2188 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2189 US"Failed to expand return path \"%s\" in %s transport: %s",
2190 tp->return_path, tp->name, expand_string_message);
2194 else return_path = new_return_path;
2197 /* For local deliveries, one at a time, the value used for logging can just be
2198 set directly, once and for all. */
2200 used_return_path = return_path;
2202 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2203 gets put into the address(es), and the expansions are unset, so we can just
2206 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2208 /* See if either the transport or the address specifies a home directory. A
2209 home directory set in the address may already be expanded; a flag is set to
2210 indicate that. In other cases we must expand it. */
2212 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2213 || ( (deliver_home = addr->home_dir) /* Set in address and */
2214 && !testflag(addr, af_home_expanded) /* not expanded */
2217 uschar *rawhome = deliver_home;
2218 deliver_home = NULL; /* in case it contains $home */
2219 if (!(deliver_home = expand_string(rawhome)))
2221 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2222 "to expand for %s transport: %s", rawhome, tp->name,
2223 expand_string_message);
2226 if (*deliver_home != '/')
2228 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2229 "is not absolute for %s transport", deliver_home, tp->name);
2234 /* See if either the transport or the address specifies a current directory,
2235 and if so, expand it. If nothing is set, use the home directory, unless it is
2236 also unset in which case use "/", which is assumed to be a directory to which
2237 all users have access. It is necessary to be in a visible directory for some
2238 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2239 2.5) require this. */
2241 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2242 if (working_directory)
2244 uschar *raw = working_directory;
2245 if (!(working_directory = expand_string(raw)))
2247 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2248 "failed to expand for %s transport: %s", raw, tp->name,
2249 expand_string_message);
2252 if (*working_directory != '/')
2254 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2255 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2259 else working_directory = deliver_home ? deliver_home : US"/";
2261 /* If one of the return_output flags is set on the transport, create and open a
2262 file in the message log directory for the transport to write its output onto.
2263 This is mainly used by pipe transports. The file needs to be unique to the
2264 address. This feature is not available for shadow transports. */
2267 && ( tp->return_output || tp->return_fail_output
2268 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2273 addr->return_filename =
2274 spool_fname(US"msglog", message_subdir, message_id,
2275 string_sprintf("-%d-%d", getpid(), return_count++));
2277 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2279 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2280 "to return message: %s", error, tp->name, strerror(errno));
2285 /* Create the pipe for inter-process communication. */
2289 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2294 /* Now fork the process to do the real work in the subprocess, but first
2295 ensure that all cached resources are freed so that the subprocess starts with
2296 a clean slate and doesn't interfere with the parent process. */
2300 if ((pid = fork()) == 0)
2302 BOOL replicate = TRUE;
2304 /* Prevent core dumps, as we don't want them in users' home directories.
2305 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2306 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2307 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2308 complain if the error is "not supported".
2310 There are two scenarios where changing the max limit has an effect. In one,
2311 the user is using a .forward and invoking a command of their choice via pipe;
2312 for these, we do need the max limit to be 0 unless the admin chooses to
2313 permit an increased limit. In the other, the command is invoked directly by
2314 the transport and is under administrator control, thus being able to raise
2315 the limit aids in debugging. So there's no general always-right answer.
2317 Thus we inhibit core-dumps completely but let individual transports, while
2318 still root, re-raise the limits back up to aid debugging. We make the
2319 default be no core-dumps -- few enough people can use core dumps in
2320 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2327 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2329 # ifdef SETRLIMIT_NOT_SUPPORTED
2330 if (errno != ENOSYS && errno != ENOTSUP)
2332 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2337 /* Reset the random number generator, so different processes don't all
2338 have the same sequence. */
2342 /* If the transport has a setup entry, call this first, while still
2343 privileged. (Appendfile uses this to expand quota, for example, while
2344 able to read private files.) */
2346 if (addr->transport->setup)
2347 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2351 addr->transport_return = DEFER;
2355 addr->transport_return = PANIC;
2359 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2360 when the process becomes unprivileged, it won't be able to write to the
2361 process log. SIGHUP is ignored throughout exim, except when it is being
2364 signal(SIGINT, SIG_IGN);
2365 signal(SIGTERM, SIG_IGN);
2366 signal(SIGUSR1, SIG_IGN);
2368 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2369 half - for transports that exec things (e.g. pipe). Then set the required
2372 (void)close(pfd[pipe_read]);
2373 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2375 exim_setugid(uid, gid, use_initgroups,
2376 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2377 addr->address, addr->transport->name));
2381 address_item *batched;
2382 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2383 for (batched = addr->next; batched; batched = batched->next)
2384 debug_printf("additional batched address: %s\n", batched->address);
2387 /* Set an appropriate working directory. */
2389 if (Uchdir(working_directory) < 0)
2391 addr->transport_return = DEFER;
2392 addr->basic_errno = errno;
2393 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2396 /* If successful, call the transport */
2401 set_process_info("delivering %s to %s using %s", message_id,
2402 addr->local_part, addr->transport->name);
2404 /* Setting this global in the subprocess means we need never clear it */
2405 transport_name = addr->transport->name;
2407 /* If a transport filter has been specified, set up its argument list.
2408 Any errors will get put into the address, and FALSE yielded. */
2410 if (addr->transport->filter_command)
2412 ok = transport_set_up_command(&transport_filter_argv,
2413 addr->transport->filter_command,
2414 TRUE, PANIC, addr, US"transport filter", NULL);
2415 transport_filter_timeout = addr->transport->filter_timeout;
2417 else transport_filter_argv = NULL;
2421 debug_print_string(addr->transport->debug_string);
2422 replicate = !(addr->transport->info->code)(addr->transport, addr);
2426 /* Pass the results back down the pipe. If necessary, first replicate the
2427 status in the top address to the others in the batch. The label is the
2428 subject of a goto when a call to the transport's setup function fails. We
2429 pass the pointer to the transport back in case it got changed as a result of
2430 file_format in appendfile. */
2434 if (replicate) replicate_status(addr);
2435 for (addr2 = addr; addr2; addr2 = addr2->next)
2438 int local_part_length = Ustrlen(addr2->local_part);
2442 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2443 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2444 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2445 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2446 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2447 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2448 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2449 || (ret = write(pfd[pipe_write], &addr2->transport,
2450 sizeof(transport_instance *))) != sizeof(transport_instance *)
2452 /* For a file delivery, pass back the local part, in case the original
2453 was only part of the final delivery path. This gives more complete
2456 || (testflag(addr2, af_file)
2457 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2458 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2462 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2463 ret == -1 ? strerror(errno) : "short write");
2465 /* Now any messages */
2467 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2469 int message_length = s ? Ustrlen(s) + 1 : 0;
2470 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2471 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2473 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2474 ret == -1 ? strerror(errno) : "short write");
2478 /* OK, this process is now done. Free any cached resources that it opened,
2479 and close the pipe we were writing down before exiting. */
2481 (void)close(pfd[pipe_write]);
2486 /* Back in the main process: panic if the fork did not succeed. This seems
2487 better than returning an error - if forking is failing it is probably best
2488 not to try other deliveries for this message. */
2491 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2494 /* Read the pipe to get the delivery status codes and error messages. Our copy
2495 of the writing end must be closed first, as otherwise read() won't return zero
2496 on an empty pipe. We check that a status exists for each address before
2497 overwriting the address structure. If data is missing, the default DEFER status
2498 will remain. Afterwards, close the reading end. */
2500 (void)close(pfd[pipe_write]);
2502 for (addr2 = addr; addr2; addr2 = addr2->next)
2504 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2509 addr2->transport_return = status;
2510 len = read(pfd[pipe_read], &transport_count,
2511 sizeof(transport_count));
2512 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2513 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2514 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2515 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2516 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2517 len = read(pfd[pipe_read], &addr2->transport,
2518 sizeof(transport_instance *));
2520 if (testflag(addr2, af_file))
2523 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2524 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2527 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2528 " from delivery subprocess");
2531 /* sanity-checked llen so disable the Coverity error */
2532 /* coverity[tainted_data] */
2533 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2535 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2536 " from delivery subprocess");
2539 big_buffer[llen] = 0;
2540 addr2->local_part = string_copy(big_buffer);
2543 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2546 len = read(pfd[pipe_read], &message_length, sizeof(int));
2547 if (message_length > 0)
2549 len = read(pfd[pipe_read], big_buffer, message_length);
2550 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2551 if (len > 0) *sptr = string_copy(big_buffer);
2558 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2559 "from delivery subprocess", addr2->unique);
2564 (void)close(pfd[pipe_read]);
2566 /* Unless shadowing, write all successful addresses immediately to the journal
2567 file, to ensure they are recorded asap. For homonymic addresses, use the base
2568 address plus the transport name. Failure to write the journal is panic-worthy,
2569 but don't stop, as it may prove possible subsequently to update the spool file
2570 in order to record the delivery. */
2574 for (addr2 = addr; addr2; addr2 = addr2->next)
2575 if (addr2->transport_return == OK)
2577 if (testflag(addr2, af_homonym))
2578 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2580 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2582 /* In the test harness, wait just a bit to let the subprocess finish off
2583 any debug output etc first. */
2585 if (f.running_in_test_harness) millisleep(300);
2587 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2588 len = Ustrlen(big_buffer);
2589 if (write(journal_fd, big_buffer, len) != len)
2590 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2591 big_buffer, strerror(errno));
2594 /* Ensure the journal file is pushed out to disk. */
2596 if (EXIMfsync(journal_fd) < 0)
2597 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2601 /* Wait for the process to finish. If it terminates with a non-zero code,
2602 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2603 status values of all the addresses as they are. Take care to handle the case
2604 when the subprocess doesn't seem to exist. This has been seen on one system
2605 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2606 happens, wait() doesn't recognize the termination of child processes. Exim now
2607 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2609 while ((rc = wait(&status)) != pid)
2610 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2612 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2613 addr->transport->driver_name);
2618 if ((status & 0xffff) != 0)
2620 int msb = (status >> 8) & 255;
2621 int lsb = status & 255;
2622 int code = (msb == 0)? (lsb & 0x7f) : msb;
2623 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2624 addr->special_action = SPECIAL_FREEZE;
2625 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2626 "status 0x%04x: %s %d",
2627 addr->transport->driver_name,
2629 msb == 0 ? "terminated by signal" : "exit code",
2633 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2635 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2638 uschar *warn_message;
2641 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2643 if (!(warn_message = expand_string(addr->transport->warn_message)))
2644 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2645 "message for %s transport): %s", addr->transport->warn_message,
2646 addr->transport->name, expand_string_message);
2648 else if ((pid = child_open_exim(&fd)) > 0)
2650 FILE *f = fdopen(fd, "wb");
2651 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2652 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2653 fprintf(f, "Auto-Submitted: auto-replied\n");
2654 if (!contains_header(US"From", warn_message))
2656 fprintf(f, "%s", CS warn_message);
2658 /* Close and wait for child process to complete, without a timeout. */
2661 (void)child_close(pid, 0);
2664 addr->special_action = SPECIAL_NONE;
2671 /* Check transport for the given concurrency limit. Return TRUE if over
2672 the limit (or an expansion failure), else FALSE and if there was a limit,
2673 the key for the hints database used for the concurrency count. */
2676 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2678 unsigned max_parallel;
2680 if (!tp->max_parallel) return FALSE;
2682 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2683 if (expand_string_message)
2685 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2686 "in %s transport (%s): %s", tp->name, addr->address,
2687 expand_string_message);
2691 if (max_parallel > 0)
2693 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2694 if (!enq_start(serialize_key, max_parallel))
2696 address_item * next;
2698 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2699 tp->name, max_parallel);
2703 addr->message = US"concurrency limit reached for transport";
2704 addr->basic_errno = ERRNO_TRETRY;
2705 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2706 } while ((addr = next));
2709 *key = serialize_key;
2716 /*************************************************
2717 * Do local deliveries *
2718 *************************************************/
2720 /* This function processes the list of addresses in addr_local. True local
2721 deliveries are always done one address at a time. However, local deliveries can
2722 be batched up in some cases. Typically this is when writing batched SMTP output
2723 files for use by some external transport mechanism, or when running local
2724 deliveries over LMTP.
2731 do_local_deliveries(void)
2734 open_db *dbm_file = NULL;
2735 time_t now = time(NULL);
2737 /* Loop until we have exhausted the supply of local deliveries */
2741 struct timeval delivery_start;
2742 struct timeval deliver_time;
2743 address_item *addr2, *addr3, *nextaddr;
2744 int logflags = LOG_MAIN;
2745 int logchar = f.dont_deliver? '*' : '=';
2746 transport_instance *tp;
2747 uschar * serialize_key = NULL;
2749 /* Pick the first undelivered address off the chain */
2751 address_item *addr = addr_local;
2752 addr_local = addr->next;
2755 DEBUG(D_deliver|D_transport)
2756 debug_printf("--------> %s <--------\n", addr->address);
2758 /* An internal disaster if there is no transport. Should not occur! */
2760 if (!(tp = addr->transport))
2762 logflags |= LOG_PANIC;
2763 f.disable_logging = FALSE; /* Jic */
2764 addr->message = addr->router
2765 ? string_sprintf("No transport set by %s router", addr->router->name)
2766 : string_sprintf("No transport set by system filter");
2767 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2771 /* Check that this base address hasn't previously been delivered to this
2772 transport. The check is necessary at this point to handle homonymic addresses
2773 correctly in cases where the pattern of redirection changes between delivery
2774 attempts. Non-homonymic previous delivery is detected earlier, at routing
2777 if (previously_transported(addr, FALSE)) continue;
2779 /* There are weird cases where logging is disabled */
2781 f.disable_logging = tp->disable_logging;
2783 /* Check for batched addresses and possible amalgamation. Skip all the work
2784 if either batch_max <= 1 or there aren't any other addresses for local
2787 if (tp->batch_max > 1 && addr_local)
2789 int batch_count = 1;
2790 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2791 BOOL uses_lp = ( testflag(addr, af_pfr)
2792 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2794 || readconf_depends((driver_instance *)tp, US"local_part");
2795 uschar *batch_id = NULL;
2796 address_item **anchor = &addr_local;
2797 address_item *last = addr;
2800 /* Expand the batch_id string for comparison with other addresses.
2801 Expansion failure suppresses batching. */
2805 deliver_set_expansions(addr);
2806 batch_id = expand_string(tp->batch_id);
2807 deliver_set_expansions(NULL);
2810 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2811 "in %s transport (%s): %s", tp->name, addr->address,
2812 expand_string_message);
2813 batch_count = tp->batch_max;
2817 /* Until we reach the batch_max limit, pick off addresses which have the
2818 same characteristics. These are:
2821 not previously delivered (see comment about 50 lines above)
2822 same local part if the transport's configuration contains $local_part
2823 or if this is a file or pipe delivery from a redirection
2824 same domain if the transport's configuration contains $domain
2826 same additional headers
2827 same headers to be removed
2828 same uid/gid for running the transport
2829 same first host if a host list is set
2832 while ((next = *anchor) && batch_count < tp->batch_max)
2835 tp == next->transport
2836 && !previously_transported(next, TRUE)
2837 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2838 && testflag(addr, af_file) == testflag(next, af_file)
2839 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2840 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2841 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2842 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2843 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2844 && same_ugid(tp, addr, next)
2845 && ( !addr->host_list && !next->host_list
2848 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2851 /* If the transport has a batch_id setting, batch_id will be non-NULL
2852 from the expansion outside the loop. Expand for this address and compare.
2853 Expansion failure makes this address ineligible for batching. */
2858 address_item *save_nextnext = next->next;
2859 next->next = NULL; /* Expansion for a single address */
2860 deliver_set_expansions(next);
2861 next->next = save_nextnext;
2862 bid = expand_string(tp->batch_id);
2863 deliver_set_expansions(NULL);
2866 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2867 "in %s transport (%s): %s", tp->name, next->address,
2868 expand_string_message);
2871 else ok = (Ustrcmp(batch_id, bid) == 0);
2874 /* Take address into batch if OK. */
2878 *anchor = next->next; /* Include the address */
2884 else anchor = &next->next; /* Skip the address */
2888 /* We now have one or more addresses that can be delivered in a batch. Check
2889 whether the transport is prepared to accept a message of this size. If not,
2890 fail them all forthwith. If the expansion fails, or does not yield an
2891 integer, defer delivery. */
2893 if (tp->message_size_limit)
2895 int rc = check_message_size(tp, addr);
2898 replicate_status(addr);
2902 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2905 continue; /* With next batch of addresses */
2909 /* If we are not running the queue, or if forcing, all deliveries will be
2910 attempted. Otherwise, we must respect the retry times for each address. Even
2911 when not doing this, we need to set up the retry key string, and determine
2912 whether a retry record exists, because after a successful delivery, a delete
2913 retry item must be set up. Keep the retry database open only for the duration
2914 of these checks, rather than for all local deliveries, because some local
2915 deliveries (e.g. to pipes) can take a substantial time. */
2917 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2919 DEBUG(D_deliver|D_retry|D_hints_lookup)
2920 debug_printf("no retry data available\n");
2927 BOOL ok = TRUE; /* to deliver this address */
2930 /* Set up the retry key to include the domain or not, and change its
2931 leading character from "R" to "T". Must make a copy before doing this,
2932 because the old key may be pointed to from a "delete" retry item after
2935 retry_key = string_copy(
2936 tp->retry_use_local_part ? addr2->address_retry_key :
2937 addr2->domain_retry_key);
2940 /* Inspect the retry data. If there is no hints file, delivery happens. */
2944 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2946 /* If there is no retry record, delivery happens. If there is,
2947 remember it exists so it can be deleted after a successful delivery. */
2951 setflag(addr2, af_lt_retry_exists);
2953 /* A retry record exists for this address. If queue running and not
2954 forcing, inspect its contents. If the record is too old, or if its
2955 retry time has come, or if it has passed its cutoff time, delivery
2960 debug_printf("retry record exists: age=%s ",
2961 readconf_printtime(now - retry_record->time_stamp));
2962 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2963 debug_printf(" time to retry = %s expired = %d\n",
2964 readconf_printtime(retry_record->next_try - now),
2965 retry_record->expired);
2968 if (f.queue_running && !f.deliver_force)
2970 ok = (now - retry_record->time_stamp > retry_data_expire)
2971 || (now >= retry_record->next_try)
2972 || retry_record->expired;
2974 /* If we haven't reached the retry time, there is one more check
2975 to do, which is for the ultimate address timeout. */
2978 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2982 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2985 /* This address is to be delivered. Leave it on the chain. */
2990 addr2 = addr2->next;
2993 /* This address is to be deferred. Take it out of the chain, and
2994 post-process it as complete. Must take it out of the chain first,
2995 because post processing puts it on another chain. */
2999 address_item *this = addr2;
3000 this->message = US"Retry time not yet reached";
3001 this->basic_errno = ERRNO_LRETRY;
3002 addr2 = addr3 ? (addr3->next = addr2->next)
3003 : (addr = addr2->next);
3004 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3008 if (dbm_file) dbfn_close(dbm_file);
3010 /* If there are no addresses left on the chain, they all deferred. Loop
3011 for the next set of addresses. */
3013 if (!addr) continue;
3015 /* If the transport is limited for parallellism, enforce that here.
3016 We use a hints DB entry, incremented here and decremented after
3017 the transport (and any shadow transport) completes. */
3019 if (tpt_parallel_check(tp, addr, &serialize_key))
3021 if (expand_string_message)
3023 logflags |= LOG_PANIC;
3027 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3028 } while ((addr = addr2));
3030 continue; /* Loop for the next set of addresses. */
3034 /* So, finally, we do have some addresses that can be passed to the
3035 transport. Before doing so, set up variables that are relevant to a
3038 deliver_set_expansions(addr);
3040 gettimeofday(&delivery_start, NULL);
3041 deliver_local(addr, FALSE);
3042 timesince(&deliver_time, &delivery_start);
3044 /* If a shadow transport (which must perforce be another local transport), is
3045 defined, and its condition is met, we must pass the message to the shadow
3046 too, but only those addresses that succeeded. We do this by making a new
3047 chain of addresses - also to keep the original chain uncontaminated. We must
3048 use a chain rather than doing it one by one, because the shadow transport may
3051 NOTE: if the condition fails because of a lookup defer, there is nothing we
3055 && ( !tp->shadow_condition
3056 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3059 transport_instance *stp;
3060 address_item *shadow_addr = NULL;
3061 address_item **last = &shadow_addr;
3063 for (stp = transports; stp; stp = stp->next)
3064 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3067 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3070 /* Pick off the addresses that have succeeded, and make clones. Put into
3071 the shadow_message field a pointer to the shadow_message field of the real
3074 else for (addr2 = addr; addr2; addr2 = addr2->next)
3075 if (addr2->transport_return == OK)
3077 addr3 = store_get(sizeof(address_item));
3080 addr3->shadow_message = US &addr2->shadow_message;
3081 addr3->transport = stp;
3082 addr3->transport_return = DEFER;
3083 addr3->return_filename = NULL;
3084 addr3->return_file = -1;
3086 last = &addr3->next;
3089 /* If we found any addresses to shadow, run the delivery, and stick any
3090 message back into the shadow_message field in the original. */
3094 int save_count = transport_count;
3096 DEBUG(D_deliver|D_transport)
3097 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3098 deliver_local(shadow_addr, TRUE);
3100 for(; shadow_addr; shadow_addr = shadow_addr->next)
3102 int sresult = shadow_addr->transport_return;
3103 *(uschar **)shadow_addr->shadow_message =
3105 ? string_sprintf(" ST=%s", stp->name)
3106 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3107 shadow_addr->basic_errno <= 0
3109 : US strerror(shadow_addr->basic_errno),
3110 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3113 shadow_addr->message
3114 ? shadow_addr->message
3115 : shadow_addr->basic_errno <= 0
3119 DEBUG(D_deliver|D_transport)
3120 debug_printf("%s shadow transport returned %s for %s\n",
3122 sresult == OK ? "OK" :
3123 sresult == DEFER ? "DEFER" :
3124 sresult == FAIL ? "FAIL" :
3125 sresult == PANIC ? "PANIC" : "?",
3126 shadow_addr->address);
3129 DEBUG(D_deliver|D_transport)
3130 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3132 transport_count = save_count; /* Restore original transport count */
3136 /* Cancel the expansions that were set up for the delivery. */
3138 deliver_set_expansions(NULL);
3140 /* If the transport was parallelism-limited, decrement the hints DB record. */
3142 if (serialize_key) enq_end(serialize_key);
3144 /* Now we can process the results of the real transport. We must take each
3145 address off the chain first, because post_process_one() puts it on another
3148 for (addr2 = addr; addr2; addr2 = nextaddr)
3150 int result = addr2->transport_return;
3151 nextaddr = addr2->next;
3153 DEBUG(D_deliver|D_transport)
3154 debug_printf("%s transport returned %s for %s\n",
3156 result == OK ? "OK" :
3157 result == DEFER ? "DEFER" :
3158 result == FAIL ? "FAIL" :
3159 result == PANIC ? "PANIC" : "?",
3162 /* If there is a retry_record, or if delivery is deferred, build a retry
3163 item for setting a new retry time or deleting the old retry record from
3164 the database. These items are handled all together after all addresses
3165 have been handled (so the database is open just for a short time for
3168 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3170 int flags = result == DEFER ? 0 : rf_delete;
3171 uschar *retry_key = string_copy(tp->retry_use_local_part
3172 ? addr2->address_retry_key : addr2->domain_retry_key);
3174 retry_add_item(addr2, retry_key, flags);
3177 /* Done with this address */
3181 addr2->more_errno = deliver_time.tv_sec;
3182 addr2->delivery_usec = deliver_time.tv_usec;
3184 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3186 /* If a pipe delivery generated text to be sent back, the result may be
3187 changed to FAIL, and we must copy this for subsequent addresses in the
3190 if (addr2->transport_return != result)
3192 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3194 addr3->transport_return = addr2->transport_return;
3195 addr3->basic_errno = addr2->basic_errno;
3196 addr3->message = addr2->message;
3198 result = addr2->transport_return;
3201 /* Whether or not the result was changed to FAIL, we need to copy the
3202 return_file value from the first address into all the addresses of the
3203 batch, so they are all listed in the error message. */
3205 addr2->return_file = addr->return_file;
3207 /* Change log character for recording successful deliveries. */
3209 if (result == OK) logchar = '-';
3211 } /* Loop back for next batch of addresses */
3217 /*************************************************
3218 * Sort remote deliveries *
3219 *************************************************/
3221 /* This function is called if remote_sort_domains is set. It arranges that the
3222 chain of addresses for remote deliveries is ordered according to the strings
3223 specified. Try to make this shuffling reasonably efficient by handling
3224 sequences of addresses rather than just single ones.
3231 sort_remote_deliveries(void)
3234 address_item **aptr = &addr_remote;
3235 const uschar *listptr = remote_sort_domains;
3240 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3243 address_item *moved = NULL;
3244 address_item **bptr = &moved;
3248 address_item **next;
3249 deliver_domain = (*aptr)->domain; /* set $domain */
3250 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3251 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3253 aptr = &(*aptr)->next;
3257 next = &(*aptr)->next;
3259 && (deliver_domain = (*next)->domain, /* Set $domain */
3260 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3261 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3263 next = &(*next)->next;
3265 /* If the batch of non-matchers is at the end, add on any that were
3266 extracted further up the chain, and end this iteration. Otherwise,
3267 extract them from the chain and hang on the moved chain. */
3279 aptr = &(*aptr)->next;
3282 /* If the loop ended because the final address matched, *aptr will
3283 be NULL. Add on to the end any extracted non-matching addresses. If
3284 *aptr is not NULL, the loop ended via "break" when *next is null, that
3285 is, there was a string of non-matching addresses at the end. In this
3286 case the extracted addresses have already been added on the end. */
3288 if (!*aptr) *aptr = moved;
3294 debug_printf("remote addresses after sorting:\n");
3295 for (addr = addr_remote; addr; addr = addr->next)
3296 debug_printf(" %s\n", addr->address);
3302 /*************************************************
3303 * Read from pipe for remote delivery subprocess *
3304 *************************************************/
3306 /* This function is called when the subprocess is complete, but can also be
3307 called before it is complete, in order to empty a pipe that is full (to prevent
3308 deadlock). It must therefore keep track of its progress in the parlist data
3311 We read the pipe to get the delivery status codes and a possible error message
3312 for each address, optionally preceded by unusability data for the hosts and
3313 also by optional retry data.
3315 Read in large chunks into the big buffer and then scan through, interpreting
3316 the data therein. In most cases, only a single read will be necessary. No
3317 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3318 that we read the next chunk when there is less than 2500 bytes left in the
3319 non-final chunk, we can assume each item is complete in the buffer before
3320 handling it. Each item is written using a single write(), which is atomic for
3321 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3322 often bigger) so even if we are reading while the subprocess is still going, we
3323 should never have only a partial item in the buffer.
3325 hs12: This assumption is not true anymore, since we get quite large items (certificate
3326 information and such).
3329 poffset the offset of the parlist item
3330 eop TRUE if the process has completed
3332 Returns: TRUE if the terminating 'Z' item has been read,
3333 or there has been a disaster (i.e. no more data needed);
3338 par_read_pipe(int poffset, BOOL eop)
3341 pardata *p = parlist + poffset;
3342 address_item *addrlist = p->addrlist;
3343 address_item *addr = p->addr;
3347 uschar *msg = p->msg;
3348 BOOL done = p->done;
3350 /* Loop through all items, reading from the pipe when necessary. The pipe
3351 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3352 here, as the preceding select() tells us, if data is available for reading.
3354 A read() on a "selected" handle should never block, but(!) it may return
3355 less data then we expected. (The buffer size we pass to read() shouldn't be
3356 understood as a "request", but as a "limit".)
3358 Each separate item is written to the pipe in a timely manner. But, especially for
3359 larger items, the read(2) may already return partial data from the write(2).
3361 The write is atomic mostly (depending on the amount written), but atomic does
3362 not imply "all or noting", it just is "not intermixed" with other writes on the
3363 same channel (pipe).
3367 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3368 (int)p->pid, eop? "ended" : "not ended yet");
3372 retry_item *r, **rp;
3373 uschar pipeheader[PIPE_HEADER_SIZE+1];
3374 uschar *id = &pipeheader[0];
3375 uschar *subid = &pipeheader[1];
3376 uschar *ptr = big_buffer;
3377 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3380 DEBUG(D_deliver) debug_printf(
3381 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3383 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3384 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3385 If we get less, we can assume the subprocess do be done and do not expect any further
3386 information from it. */
3388 if ((got = readn(fd, pipeheader, required)) != required)
3390 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3391 "from transport process %d for transport %s",
3392 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3397 pipeheader[PIPE_HEADER_SIZE] = '\0';
3399 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3403 /* If we can't decode the pipeheader, the subprocess seems to have a
3404 problem, we do not expect any furher information from it. */
3406 required = Ustrtol(pipeheader+2, &endc, 10);
3409 msg = string_sprintf("failed to read pipe "
3410 "from transport process %d for transport %s: error decoding size from header",
3411 pid, addr->transport->driver_name);
3418 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3419 (u_long)required, pid);
3421 /* Same as above, the transport process will write the bytes announced
3422 in a timely manner, so we can just wait for the bytes, getting less than expected
3423 is considered a problem of the subprocess, we do not expect anything else from it. */
3424 if ((got = readn(fd, big_buffer, required)) != required)
3426 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3427 " bytes (pipedata) from transport process %d for transport %s",
3428 got, required, pid, addr->transport->driver_name);
3433 /* Handle each possible type of item, assuming the complete item is
3434 available in store. */
3438 /* Host items exist only if any hosts were marked unusable. Match
3439 up by checking the IP address. */
3442 for (h = addrlist->host_list; h; h = h->next)
3444 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3452 /* Retry items are sent in a preceding R item for each address. This is
3453 kept separate to keep each message short enough to guarantee it won't
3454 be split in the pipe. Hopefully, in the majority of cases, there won't in
3455 fact be any retry items at all.
3457 The complete set of retry items might include an item to delete a
3458 routing retry if there was a previous routing delay. However, routing
3459 retries are also used when a remote transport identifies an address error.
3460 In that case, there may also be an "add" item for the same key. Arrange
3461 that a "delete" item is dropped in favour of an "add" item. */
3464 if (!addr) goto ADDR_MISMATCH;
3466 DEBUG(D_deliver|D_retry)
3467 debug_printf("reading retry information for %s from subprocess\n",
3470 /* Cut out any "delete" items on the list. */
3472 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3473 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3475 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3476 *rp = r->next; /* Excise a delete item */
3477 DEBUG(D_deliver|D_retry)
3478 debug_printf(" existing delete item dropped\n");
3481 /* We want to add a delete item only if there is no non-delete item;
3482 however we still have to step ptr through the data. */
3484 if (!r || !(*ptr & rf_delete))
3486 r = store_get(sizeof(retry_item));
3487 r->next = addr->retries;
3490 r->key = string_copy(ptr);
3492 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3493 ptr += sizeof(r->basic_errno);
3494 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3495 ptr += sizeof(r->more_errno);
3496 r->message = *ptr ? string_copy(ptr) : NULL;
3497 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3498 r->flags & rf_delete ? "delete" : "retry");
3503 DEBUG(D_deliver|D_retry)
3504 debug_printf(" delete item not added: non-delete item exists\n");
3507 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3513 /* Put the amount of data written into the parlist block */
3516 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3517 ptr += sizeof(transport_count);
3520 /* Address items are in the order of items on the address chain. We
3521 remember the current address value in case this function is called
3522 several times to empty the pipe in stages. Information about delivery
3523 over TLS is sent in a preceding X item for each address. We don't put
3524 it in with the other info, in order to keep each message short enough to
3525 guarantee it won't be split in the pipe. */
3529 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3533 addr->cipher = NULL;
3534 addr->peerdn = NULL;
3537 addr->cipher = string_copy(ptr);
3540 addr->peerdn = string_copy(ptr);
3545 (void) tls_import_cert(ptr, &addr->peercert);
3547 addr->peercert = NULL;
3552 (void) tls_import_cert(ptr, &addr->ourcert);
3554 addr->ourcert = NULL;
3557 # ifndef DISABLE_OCSP
3559 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3565 #endif /*SUPPORT_TLS*/
3567 case 'C': /* client authenticator information */
3570 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3571 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3572 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3577 #ifndef DISABLE_PRDR
3579 setflag(addr, af_prdr_used);
3586 #ifdef EXPERIMENTAL_PIPE_CONNECT
3587 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3589 case 1: setflag(addr, af_pipelining); break;
3594 setflag(addr, af_chunking_used);
3598 setflag(addr, af_tcp_fastopen_conn);
3599 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3600 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3604 if (!addr) goto ADDR_MISMATCH;
3605 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3606 ptr += sizeof(addr->dsn_aware);
3607 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3614 msg = string_sprintf("address count mismatch for data read from pipe "
3615 "for transport process %d for transport %s", pid,
3616 addrlist->transport->driver_name);
3623 #ifdef SUPPORT_SOCKS
3624 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3625 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3630 proxy_local_address = string_copy(ptr);
3632 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3633 ptr += sizeof(proxy_local_port);
3638 #ifdef EXPERIMENTAL_DSN_INFO
3639 case '1': /* must arrive before A0, and applies to that addr */
3640 /* Two strings: smtp_greeting and helo_response */
3641 addr->smtp_greeting = string_copy(ptr);
3643 addr->helo_response = string_copy(ptr);
3649 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3650 addr->transport_return = *ptr++;
3651 addr->special_action = *ptr++;
3652 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3653 ptr += sizeof(addr->basic_errno);
3654 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3655 ptr += sizeof(addr->more_errno);
3656 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3657 ptr += sizeof(addr->delivery_usec);
3658 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3659 ptr += sizeof(addr->flags);
3660 addr->message = *ptr ? string_copy(ptr) : NULL;
3662 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3665 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3669 h = store_get(sizeof(host_item));
3670 h->name = string_copy(ptr);
3672 h->address = string_copy(ptr);
3674 memcpy(&h->port, ptr, sizeof(h->port));
3675 ptr += sizeof(h->port);
3676 h->dnssec = *ptr == '2' ? DS_YES
3677 : *ptr == '1' ? DS_NO
3680 addr->host_used = h;
3684 /* Finished with this address */
3691 /* Local interface address/port */
3693 if (*ptr) sending_ip_address = string_copy(ptr);
3695 if (*ptr) sending_port = atoi(CS ptr);
3699 /* Z marks the logical end of the data. It is followed by '0' if
3700 continue_transport was NULL at the end of transporting, otherwise '1'.
3701 We need to know when it becomes NULL during a delivery down a passed SMTP
3702 channel so that we don't try to pass anything more down it. Of course, for
3703 most normal messages it will remain NULL all the time. */
3708 continue_transport = NULL;
3709 continue_hostname = NULL;
3712 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3715 /* Anything else is a disaster. */
3718 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3719 "process %d for transport %s", ptr[-1], pid,
3720 addr->transport->driver_name);
3726 /* The done flag is inspected externally, to determine whether or not to
3727 call the function again when the process finishes. */
3731 /* If the process hadn't finished, and we haven't seen the end of the data
3732 or if we suffered a disaster, update the rest of the state, and return FALSE to
3733 indicate "not finished". */
3742 /* Close our end of the pipe, to prevent deadlock if the far end is still
3743 pushing stuff into it. */
3748 /* If we have finished without error, but haven't had data for every address,
3749 something is wrong. */
3752 msg = string_sprintf("insufficient address data read from pipe "
3753 "for transport process %d for transport %s", pid,
3754 addr->transport->driver_name);
3756 /* If an error message is set, something has gone wrong in getting back
3757 the delivery data. Put the message into each address and freeze it. */
3760 for (addr = addrlist; addr; addr = addr->next)
3762 addr->transport_return = DEFER;
3763 addr->special_action = SPECIAL_FREEZE;
3764 addr->message = msg;
3765 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3768 /* Return TRUE to indicate we have got all we need from this process, even
3769 if it hasn't actually finished yet. */
3776 /*************************************************
3777 * Post-process a set of remote addresses *
3778 *************************************************/
3780 /* Do what has to be done immediately after a remote delivery for each set of
3781 addresses, then re-write the spool if necessary. Note that post_process_one
3782 puts the address on an appropriate queue; hence we must fish off the next
3783 one first. This function is also called if there is a problem with setting
3784 up a subprocess to do a remote delivery in parallel. In this case, the final
3785 argument contains a message, and the action must be forced to DEFER.
3788 addr pointer to chain of address items
3789 logflags flags for logging
3790 msg NULL for normal cases; -> error message for unexpected problems
3791 fallback TRUE if processing fallback hosts
3797 remote_post_process(address_item *addr, int logflags, uschar *msg,
3802 /* If any host addresses were found to be unusable, add them to the unusable
3803 tree so that subsequent deliveries don't try them. */
3805 for (h = addr->host_list; h; h = h->next)
3807 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3809 /* Now handle each address on the chain. The transport has placed '=' or '-'
3810 into the special_action field for each successful delivery. */
3814 address_item *next = addr->next;
3816 /* If msg == NULL (normal processing) and the result is DEFER and we are
3817 processing the main hosts and there are fallback hosts available, put the
3818 address on the list for fallback delivery. */
3820 if ( addr->transport_return == DEFER
3821 && addr->fallback_hosts
3826 addr->host_list = addr->fallback_hosts;
3827 addr->next = addr_fallback;
3828 addr_fallback = addr;
3829 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3832 /* If msg is set (=> unexpected problem), set it in the address before
3833 doing the ordinary post processing. */
3839 addr->message = msg;
3840 addr->transport_return = DEFER;
3842 (void)post_process_one(addr, addr->transport_return, logflags,
3843 EXIM_DTYPE_TRANSPORT, addr->special_action);
3851 /* If we have just delivered down a passed SMTP channel, and that was
3852 the last address, the channel will have been closed down. Now that
3853 we have logged that delivery, set continue_sequence to 1 so that
3854 any subsequent deliveries don't get "*" incorrectly logged. */
3856 if (!continue_transport) continue_sequence = 1;
3861 /*************************************************
3862 * Wait for one remote delivery subprocess *
3863 *************************************************/
3865 /* This function is called while doing remote deliveries when either the
3866 maximum number of processes exist and we need one to complete so that another
3867 can be created, or when waiting for the last ones to complete. It must wait for
3868 the completion of one subprocess, empty the control block slot, and return a
3869 pointer to the address chain.
3872 Returns: pointer to the chain of addresses handled by the process;
3873 NULL if no subprocess found - this is an unexpected error
3876 static address_item *
3879 int poffset, status;
3880 address_item *addr, *addrlist;
3883 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3884 "to finish", message_id);
3886 /* Loop until either a subprocess completes, or there are no subprocesses in
3887 existence - in which case give an error return. We cannot proceed just by
3888 waiting for a completion, because a subprocess may have filled up its pipe, and
3889 be waiting for it to be emptied. Therefore, if no processes have finished, we
3890 wait for one of the pipes to acquire some data by calling select(), with a
3891 timeout just in case.
3893 The simple approach is just to iterate after reading data from a ready pipe.
3894 This leads to non-ideal behaviour when the subprocess has written its final Z
3895 item, closed the pipe, and is in the process of exiting (the common case). A
3896 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3897 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3900 To avoid this, if all the data that is needed has been read from a subprocess
3901 after select(), an explicit wait() for it is done. We know that all it is doing
3902 is writing to the pipe and then exiting, so the wait should not be long.
3904 The non-blocking waitpid() is to some extent just insurance; if we could
3905 reliably detect end-of-file on the pipe, we could always know when to do a
3906 blocking wait() for a completed process. However, because some systems use
3907 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3908 use code that functions without the need to recognize EOF.
3910 There's a double loop here just in case we end up with a process that is not in
3911 the list of remote delivery processes. Something has obviously gone wrong if
3912 this is the case. (For example, a process that is incorrectly left over from
3913 routing or local deliveries might be found.) The damage can be minimized by
3914 looping back and looking for another process. If there aren't any, the error
3915 return will happen. */
3917 for (;;) /* Normally we do not repeat this loop */
3919 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3922 fd_set select_pipes;
3923 int maxpipe, readycount;
3925 /* A return value of -1 can mean several things. If errno != ECHILD, it
3926 either means invalid options (which we discount), or that this process was
3927 interrupted by a signal. Just loop to try the waitpid() again.
3929 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3930 in existence. This should never happen, and is an unexpected error.
3931 However, there is a nasty complication when running under Linux. If "strace
3932 -f" is being used under Linux to trace this process and its children,
3933 subprocesses are "stolen" from their parents and become the children of the
3934 tracing process. A general wait such as the one we've just obeyed returns
3935 as if there are no children while subprocesses are running. Once a
3936 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3937 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3940 This does not happen using "truss" on Solaris, nor (I think) with other
3941 tracing facilities on other OS. It seems to be specific to Linux.
3943 What we do to get round this is to use kill() to see if any of our
3944 subprocesses are still in existence. If kill() gives an OK return, we know
3945 it must be for one of our processes - it can't be for a re-use of the pid,
3946 because if our process had finished, waitpid() would have found it. If any
3947 of our subprocesses are in existence, we proceed to use select() as if
3948 waitpid() had returned zero. I think this is safe. */
3952 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3955 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3956 "for process existence\n");
3958 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3960 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3962 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3963 "stolen by strace\n", (int)pid);
3964 break; /* With poffset set */
3968 if (poffset >= remote_max_parallel)
3970 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3971 return NULL; /* This is the error return */
3975 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3976 been handled above. A return value of zero means that there is at least one
3977 subprocess, but there are no completed subprocesses. See if any pipes are
3978 ready with any data for reading. */
3980 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3983 FD_ZERO(&select_pipes);
3984 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3985 if (parlist[poffset].pid != 0)
3987 int fd = parlist[poffset].fd;
3988 FD_SET(fd, &select_pipes);
3989 if (fd > maxpipe) maxpipe = fd;
3992 /* Stick in a 60-second timeout, just in case. */
3997 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
4000 /* Scan through the pipes and read any that are ready; use the count
4001 returned by select() to stop when there are no more. Select() can return
4002 with no processes (e.g. if interrupted). This shouldn't matter.
4004 If par_read_pipe() returns TRUE, it means that either the terminating Z was
4005 read, or there was a disaster. In either case, we are finished with this
4006 process. Do an explicit wait() for the process and break the main loop if
4009 It turns out that we have to deal with the case of an interrupted system
4010 call, which can happen on some operating systems if the signal handling is
4011 set up to do that by default. */
4014 readycount > 0 && poffset < remote_max_parallel;
4017 if ( (pid = parlist[poffset].pid) != 0
4018 && FD_ISSET(parlist[poffset].fd, &select_pipes)
4022 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4023 for (;;) /* Loop for signals */
4025 pid_t endedpid = waitpid(pid, &status, 0);
4026 if (endedpid == pid) goto PROCESS_DONE;
4027 if (endedpid != (pid_t)(-1) || errno != EINTR)
4028 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4029 "%d (errno = %d) from waitpid() for process %d",
4030 (int)endedpid, errno, (int)pid);
4035 /* Now go back and look for a completed subprocess again. */
4038 /* A completed process was detected by the non-blocking waitpid(). Find the
4039 data block that corresponds to this subprocess. */
4041 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4042 if (pid == parlist[poffset].pid) break;
4044 /* Found the data block; this is a known remote delivery process. We don't
4045 need to repeat the outer loop. This should be what normally happens. */
4047 if (poffset < remote_max_parallel) break;
4049 /* This situation is an error, but it's probably better to carry on looking
4050 for another process than to give up (as we used to do). */
4052 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4053 "transport process list", pid);
4054 } /* End of the "for" loop */
4056 /* Come here when all the data was completely read after a select(), and
4057 the process in pid has been wait()ed for. */
4064 debug_printf("remote delivery process %d ended\n", (int)pid);
4066 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4070 set_process_info("delivering %s", message_id);
4072 /* Get the chain of processed addresses */
4074 addrlist = parlist[poffset].addrlist;
4076 /* If the process did not finish cleanly, record an error and freeze (except
4077 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4078 in case the delivery did actually happen. */
4080 if ((status & 0xffff) != 0)
4083 int msb = (status >> 8) & 255;
4084 int lsb = status & 255;
4085 int code = (msb == 0)? (lsb & 0x7f) : msb;
4087 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4089 addrlist->transport->driver_name,
4091 (msb == 0)? "terminated by signal" : "exit code",
4094 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4095 addrlist->special_action = SPECIAL_FREEZE;
4097 for (addr = addrlist; addr; addr = addr->next)
4099 addr->transport_return = DEFER;
4100 addr->message = msg;
4103 remove_journal = FALSE;
4106 /* Else complete reading the pipe to get the result of the delivery, if all
4107 the data has not yet been obtained. */
4109 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4111 /* Put the data count and return path into globals, mark the data slot unused,
4112 decrement the count of subprocesses, and return the address chain. */
4114 transport_count = parlist[poffset].transport_count;
4115 used_return_path = parlist[poffset].return_path;
4116 parlist[poffset].pid = 0;
4123 /*************************************************
4124 * Wait for subprocesses and post-process *
4125 *************************************************/
4127 /* This function waits for subprocesses until the number that are still running
4128 is below a given threshold. For each complete subprocess, the addresses are
4129 post-processed. If we can't find a running process, there is some shambles.
4130 Better not bomb out, as that might lead to multiple copies of the message. Just
4131 log and proceed as if all done.
4134 max maximum number of subprocesses to leave running
4135 fallback TRUE if processing fallback hosts
4141 par_reduce(int max, BOOL fallback)
4143 while (parcount > max)
4145 address_item *doneaddr = par_wait();
4148 log_write(0, LOG_MAIN|LOG_PANIC,
4149 "remote delivery process count got out of step");
4154 transport_instance * tp = doneaddr->transport;
4155 if (tp->max_parallel)
4156 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4158 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4164 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4166 uschar pipe_header[PIPE_HEADER_SIZE+1];
4167 size_t total_len = PIPE_HEADER_SIZE + size;
4169 struct iovec iov[2] = {
4170 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4171 { buf, size } /* *the* data */
4176 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4177 /* complain to log if someone tries with buffer sizes we can't handle*/
4179 if (size > BIG_BUFFER_SIZE-1)
4181 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4182 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4184 size = BIG_BUFFER_SIZE;
4187 /* Should we check that we do not write more than PIPE_BUF? What would
4190 /* convert size to human readable string prepended by id and subid */
4191 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4192 id, subid, (long)size))
4193 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4195 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4196 id, subid, (long)size, pipe_header);
4198 if ((ret = writev(fd, iov, 2)) != total_len)
4199 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4200 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4201 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4204 /*************************************************
4205 * Do remote deliveries *
4206 *************************************************/
4208 /* This function is called to process the addresses in addr_remote. We must
4209 pick off the queue all addresses that have the same transport, remote
4210 destination, and errors address, and hand them to the transport in one go,
4211 subject to some configured limitations. If this is a run to continue delivering
4212 to an existing delivery channel, skip all but those addresses that can go to
4213 that channel. The skipped addresses just get deferred.
4215 If mua_wrapper is set, all addresses must be able to be sent in a single
4216 transaction. If not, this function yields FALSE.
4218 In Exim 4, remote deliveries are always done in separate processes, even
4219 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4220 is so that the base process can retain privilege. This makes the
4221 implementation of fallback transports feasible (though not initially done.)
4223 We create up to the configured number of subprocesses, each of which passes
4224 back the delivery state via a pipe. (However, when sending down an existing
4225 connection, remote_max_parallel is forced to 1.)
4228 fallback TRUE if processing fallback hosts
4230 Returns: TRUE normally
4231 FALSE if mua_wrapper is set and the addresses cannot all be sent
4236 do_remote_deliveries(BOOL fallback)
4242 parcount = 0; /* Number of executing subprocesses */
4244 /* When sending down an existing channel, only do one delivery at a time.
4245 We use a local variable (parmax) to hold the maximum number of processes;
4246 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4248 if (continue_transport) remote_max_parallel = 1;
4249 parmax = remote_max_parallel;
4251 /* If the data for keeping a list of processes hasn't yet been
4256 parlist = store_get(remote_max_parallel * sizeof(pardata));
4257 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4258 parlist[poffset].pid = 0;
4261 /* Now loop for each remote delivery */
4263 for (delivery_count = 0; addr_remote; delivery_count++)
4269 int address_count = 1;
4270 int address_count_max;
4272 BOOL use_initgroups;
4273 BOOL pipe_done = FALSE;
4274 transport_instance *tp;
4275 address_item **anchor = &addr_remote;
4276 address_item *addr = addr_remote;
4277 address_item *last = addr;
4280 uschar * serialize_key = NULL;
4282 /* Pull the first address right off the list. */
4284 addr_remote = addr->next;
4287 DEBUG(D_deliver|D_transport)
4288 debug_printf("--------> %s <--------\n", addr->address);
4290 /* If no transport has been set, there has been a big screw-up somewhere. */
4292 if (!(tp = addr->transport))
4294 f.disable_logging = FALSE; /* Jic */
4295 panicmsg = US"No transport set by router";
4296 goto panic_continue;
4299 /* Check that this base address hasn't previously been delivered to this
4300 transport. The check is necessary at this point to handle homonymic addresses
4301 correctly in cases where the pattern of redirection changes between delivery
4302 attempts. Non-homonymic previous delivery is detected earlier, at routing
4305 if (previously_transported(addr, FALSE)) continue;
4307 /* Force failure if the message is too big. */
4309 if (tp->message_size_limit)
4311 int rc = check_message_size(tp, addr);
4314 addr->transport_return = rc;
4315 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4320 /* Get the flag which specifies whether the transport can handle different
4321 domains that nevertheless resolve to the same set of hosts. If it needs
4322 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4323 $host, $host_address, $host_port. */
4324 if (tp->expand_multi_domain)
4325 deliver_set_expansions(addr);
4327 if (exp_bool(addr, US"transport", tp->name, D_transport,
4328 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4329 &multi_domain) != OK)
4331 deliver_set_expansions(NULL);
4332 panicmsg = addr->message;
4333 goto panic_continue;
4336 /* Get the maximum it can handle in one envelope, with zero meaning
4337 unlimited, which is forced for the MUA wrapper case. */
4339 address_count_max = tp->max_addresses;
4340 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4343 /************************************************************************/
4344 /***** This is slightly experimental code, but should be safe. *****/
4346 /* The address_count_max value is the maximum number of addresses that the
4347 transport can send in one envelope. However, the transport must be capable of
4348 dealing with any number of addresses. If the number it gets exceeds its
4349 envelope limitation, it must send multiple copies of the message. This can be
4350 done over a single connection for SMTP, so uses less resources than making
4351 multiple connections. On the other hand, if remote_max_parallel is greater
4352 than one, it is perhaps a good idea to use parallel processing to move the
4353 message faster, even if that results in multiple simultaneous connections to
4356 How can we come to some compromise between these two ideals? What we do is to
4357 limit the number of addresses passed to a single instance of a transport to
4358 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4359 number of addresses routed to remote transports divided by
4360 remote_max_parallel. For example, if the message has 100 remote recipients,
4361 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4362 once. But if rcpt_max is 100, we could send up to 100.
4364 Of course, not all the remotely addresses in a message are going to go to the
4365 same set of hosts (except in smarthost configurations), so this is just a
4366 heuristic way of dividing up the work.
4368 Furthermore (1), because this may not be wanted in some cases, and also to
4369 cope with really pathological cases, there is also a limit to the number of
4370 messages that are sent over one connection. This is the same limit that is
4371 used when sending several different messages over the same connection.
4372 Continue_sequence is set when in this situation, to the number sent so
4373 far, including this message.
4375 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4376 is probably because they are using VERP, in which case they want to pass only
4377 one address at a time to the transport, in order to be able to use
4378 $local_part and $domain in constructing a new return path. We could test for
4379 the use of these variables, but as it is so likely they will be used when the
4380 maximum is 1, we don't bother. Just leave the value alone. */
4382 if ( address_count_max != 1
4383 && address_count_max < remote_delivery_count/remote_max_parallel
4386 int new_max = remote_delivery_count/remote_max_parallel;
4387 int message_max = tp->connection_max_messages;
4388 if (connection_max_messages >= 0) message_max = connection_max_messages;
4389 message_max -= continue_sequence - 1;
4390 if (message_max > 0 && new_max > address_count_max * message_max)
4391 new_max = address_count_max * message_max;
4392 address_count_max = new_max;
4395 /************************************************************************/
4398 /* Pick off all addresses which have the same transport, errors address,
4399 destination, and extra headers. In some cases they point to the same host
4400 list, but we also need to check for identical host lists generated from
4401 entirely different domains. The host list pointers can be NULL in the case
4402 where the hosts are defined in the transport. There is also a configured
4403 maximum limit of addresses that can be handled at once (see comments above
4404 for how it is computed).
4405 If the transport does not handle multiple domains, enforce that also,
4406 and if it might need a per-address check for this, re-evaluate it.
4409 while ((next = *anchor) && address_count < address_count_max)
4412 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4413 && tp == next->transport
4414 && same_hosts(next->host_list, addr->host_list)
4415 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4416 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4417 && same_ugid(tp, next, addr)
4418 && ( next->prop.remove_headers == addr->prop.remove_headers
4419 || ( next->prop.remove_headers
4420 && addr->prop.remove_headers
4421 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4425 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4427 US"transport", next->transport->name, D_transport,
4428 US"multi_domain", next->transport->multi_domain,
4429 next->transport->expand_multi_domain, &md) == OK
4434 *anchor = next->next;
4436 next->first = addr; /* remember top one (for retry processing) */
4441 else anchor = &(next->next);
4442 deliver_set_expansions(NULL);
4445 /* If we are acting as an MUA wrapper, all addresses must go in a single
4446 transaction. If not, put them back on the chain and yield FALSE. */
4448 if (mua_wrapper && addr_remote)
4450 last->next = addr_remote;
4455 /* If the transport is limited for parallellism, enforce that here.
4456 The hints DB entry is decremented in par_reduce(), when we reap the
4457 transport process. */
4459 if (tpt_parallel_check(tp, addr, &serialize_key))
4460 if ((panicmsg = expand_string_message))
4461 goto panic_continue;
4463 continue; /* Loop for the next set of addresses. */
4465 /* Set up the expansion variables for this set of addresses */
4467 deliver_set_expansions(addr);
4469 /* Ensure any transport-set auth info is fresh */
4470 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4472 /* Compute the return path, expanding a new one if required. The old one
4473 must be set first, as it might be referred to in the expansion. */
4475 if(addr->prop.errors_address)
4476 return_path = addr->prop.errors_address;
4477 #ifdef EXPERIMENTAL_SRS
4478 else if(addr->prop.srs_sender)
4479 return_path = addr->prop.srs_sender;
4482 return_path = sender_address;
4484 if (tp->return_path)
4486 uschar *new_return_path = expand_string(tp->return_path);
4487 if (new_return_path)
4488 return_path = new_return_path;
4489 else if (!f.expand_string_forcedfail)
4491 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4492 tp->return_path, expand_string_message);
4497 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4498 logs and sets up error messages, so we just post-process and continue with
4499 the next address. */
4501 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4507 /* If this transport has a setup function, call it now so that it gets
4508 run in this process and not in any subprocess. That way, the results of
4509 any setup that are retained by the transport can be reusable. One of the
4510 things the setup does is to set the fallback host lists in the addresses.
4511 That is why it is called at this point, before the continue delivery
4512 processing, because that might use the fallback hosts. */
4515 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4517 /* If we have a connection still open from a verify stage (lazy-close)
4518 treat it as if it is a continued connection (apart from the counter used
4519 for the log line mark). */
4521 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4524 debug_printf("lazy-callout-close: have conn still open from verification\n");
4525 continue_transport = cutthrough.transport;
4526 continue_hostname = string_copy(cutthrough.host.name);
4527 continue_host_address = string_copy(cutthrough.host.address);
4528 continue_sequence = 1;
4529 sending_ip_address = cutthrough.snd_ip;
4530 sending_port = cutthrough.snd_port;
4531 smtp_peer_options = cutthrough.peer_options;
4534 /* If this is a run to continue delivery down an already-established
4535 channel, check that this set of addresses matches the transport and
4536 the channel. If it does not, defer the addresses. If a host list exists,
4537 we must check that the continue host is on the list. Otherwise, the
4538 host is set in the transport. */
4540 f.continue_more = FALSE; /* In case got set for the last lot */
4541 if (continue_transport)
4543 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4545 /* If the transport is about to override the host list do not check
4546 it here but take the cost of running the transport process to discover
4547 if the continued_hostname connection is suitable. This is a layering
4548 violation which is unfortunate as it requires we haul in the smtp
4553 smtp_transport_options_block * ob;
4555 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4556 && (ob = (smtp_transport_options_block *)tp->options_block)
4557 && ob->hosts_override && ob->hosts
4564 for (h = addr->host_list; h; h = h->next)
4565 if (Ustrcmp(h->name, continue_hostname) == 0)
4566 /*XXX should also check port here */
4567 { ok = TRUE; break; }
4571 /* Addresses not suitable; defer or queue for fallback hosts (which
4572 might be the continue host) and skip to next address. */
4576 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4577 Ustrcmp(continue_transport, tp->name) != 0
4578 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4579 : string_sprintf("no host matching %s", continue_hostname));
4580 if (serialize_key) enq_end(serialize_key);
4582 if (addr->fallback_hosts && !fallback)
4584 for (next = addr; ; next = next->next)
4586 next->host_list = next->fallback_hosts;
4587 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4588 if (!next->next) break;
4590 next->next = addr_fallback;
4591 addr_fallback = addr;
4596 for (next = addr; ; next = next->next)
4598 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4599 if (!next->next) break;
4601 next->next = addr_defer;
4608 /* Set a flag indicating whether there are further addresses that list
4609 the continued host. This tells the transport to leave the channel open,
4610 but not to pass it to another delivery process. We'd like to do that
4611 for non-continue_transport cases too but the knowlege of which host is
4612 connected to is too hard to manage. Perhaps we need a finer-grain
4613 interface to the transport. */
4615 for (next = addr_remote; next && !f.continue_more; next = next->next)
4618 for (h = next->host_list; h; h = h->next)
4619 if (Ustrcmp(h->name, continue_hostname) == 0)
4620 { f.continue_more = TRUE; break; }
4624 /* The transports set up the process info themselves as they may connect
4625 to more than one remote machine. They also have to set up the filter
4626 arguments, if required, so that the host name and address are available
4629 transport_filter_argv = NULL;
4631 /* Create the pipe for inter-process communication. If pipe creation
4632 fails, it is probably because the value of remote_max_parallel is so
4633 large that too many file descriptors for pipes have been created. Arrange
4634 to wait for a process to finish, and then try again. If we still can't
4635 create a pipe when all processes have finished, break the retry loop. */
4639 if (pipe(pfd) == 0) pipe_done = TRUE;
4640 else if (parcount > 0) parmax = parcount;
4643 /* We need to make the reading end of the pipe non-blocking. There are
4644 two different options for this. Exim is cunningly (I hope!) coded so
4645 that it can use either of them, though it prefers O_NONBLOCK, which
4646 distinguishes between EOF and no-more-data. */
4648 /* The data appears in a timely manner and we already did a select on
4649 all pipes, so I do not see a reason to use non-blocking IO here
4652 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4654 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4658 /* If the maximum number of subprocesses already exist, wait for a process
4659 to finish. If we ran out of file descriptors, parmax will have been reduced
4660 from its initial value of remote_max_parallel. */
4662 par_reduce(parmax - 1, fallback);
4665 /* If we failed to create a pipe and there were no processes to wait
4666 for, we have to give up on this one. Do this outside the above loop
4667 so that we can continue the main loop. */
4671 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4675 /* Find a free slot in the pardata list. Must do this after the possible
4676 waiting for processes to finish, because a terminating process will free
4679 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4680 if (parlist[poffset].pid == 0)
4683 /* If there isn't one, there has been a horrible disaster. */
4685 if (poffset >= remote_max_parallel)
4687 (void)close(pfd[pipe_write]);
4688 (void)close(pfd[pipe_read]);
4689 panicmsg = US"Unexpectedly no free subprocess slot";
4693 /* Now fork a subprocess to do the remote delivery, but before doing so,
4694 ensure that any cached resources are released so as not to interfere with
4695 what happens in the subprocess. */
4699 if ((pid = fork()) == 0)
4701 int fd = pfd[pipe_write];
4704 /* Setting this global in the subprocess means we need never clear it */
4705 transport_name = tp->name;
4707 /* There are weird circumstances in which logging is disabled */
4708 f.disable_logging = tp->disable_logging;
4710 /* Show pids on debug output if parallelism possible */
4712 if (parmax > 1 && (parcount > 0 || addr_remote))
4714 DEBUG(D_any|D_v) debug_selector |= D_pid;
4715 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4718 /* Reset the random number generator, so different processes don't all
4719 have the same sequence. In the test harness we want different, but
4720 predictable settings for each delivery process, so do something explicit
4721 here rather they rely on the fixed reset in the random number function. */
4723 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4725 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4726 a new process that may be forked to do another delivery down the same
4729 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4731 /* Close open file descriptors for the pipes of other processes
4732 that are running in parallel. */
4734 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4735 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4737 /* This process has inherited a copy of the file descriptor
4738 for the data file, but its file pointer is shared with all the
4739 other processes running in parallel. Therefore, we have to re-open
4740 the file in order to get a new file descriptor with its own
4741 file pointer. We don't need to lock it, as the lock is held by
4742 the parent process. There doesn't seem to be any way of doing
4743 a dup-with-new-file-pointer. */
4745 (void)close(deliver_datafile);
4747 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4749 if ((deliver_datafile = Uopen(fname,
4753 O_RDWR | O_APPEND, 0)) < 0)
4754 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4755 "parallel delivery: %s", fname, strerror(errno));
4758 /* Set the close-on-exec flag */
4760 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4764 /* Set the uid/gid of this process; bombs out on failure. */
4766 exim_setugid(uid, gid, use_initgroups,
4767 string_sprintf("remote delivery to %s with transport=%s",
4768 addr->address, tp->name));
4770 /* Close the unwanted half of this process' pipe, set the process state,
4771 and run the transport. Afterwards, transport_count will contain the number
4772 of bytes written. */
4774 (void)close(pfd[pipe_read]);
4775 set_process_info("delivering %s using %s", message_id, tp->name);
4776 debug_print_string(tp->debug_string);
4777 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4779 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4780 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4782 /* Ensure any cached resources that we used are now released */
4786 /* Pass the result back down the pipe. This is a lot more information
4787 than is needed for a local delivery. We have to send back the error
4788 status for each address, the usability status for each host that is
4789 flagged as unusable, and all the retry items. When TLS is in use, we
4790 send also the cipher and peerdn information. Each type of information
4791 is flagged by an identifying byte, and is then in a fixed format (with
4792 strings terminated by zeros), and there is a final terminator at the
4793 end. The host information and retry information is all attached to
4794 the first address, so that gets sent at the start. */
4796 /* Host unusability information: for most success cases this will
4799 for (h = addr->host_list; h; h = h->next)
4801 if (!h->address || h->status < hstatus_unusable) continue;
4802 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4803 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4806 /* The number of bytes written. This is the same for each address. Even
4807 if we sent several copies of the message down the same connection, the
4808 size of each one is the same, and it's that value we have got because
4809 transport_count gets reset before calling transport_write_message(). */
4811 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4812 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4814 /* Information about what happened to each address. Four item types are
4815 used: an optional 'X' item first, for TLS information, then an optional "C"
4816 item for any client-auth info followed by 'R' items for any retry settings,
4817 and finally an 'A' item for the remaining data. */
4819 for(; addr; addr = addr->next)
4824 /* The certificate verification status goes into the flags */
4825 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4827 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4830 /* Use an X item only if there's something to send */
4834 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4838 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4840 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4842 else if (continue_proxy_cipher)
4844 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4846 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4852 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4856 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4861 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4865 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4867 # ifndef DISABLE_OCSP
4868 if (addr->ocsp > OCSP_NOT_REQ)
4870 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4871 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4874 #endif /*SUPPORT_TLS*/
4876 if (client_authenticator)
4878 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4879 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4881 if (client_authenticated_id)
4883 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4884 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4886 if (client_authenticated_sender)
4888 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4889 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4892 #ifndef DISABLE_PRDR
4893 if (testflag(addr, af_prdr_used))
4894 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4897 if (testflag(addr, af_pipelining))
4898 #ifdef EXPERIMENTAL_PIPE_CONNECT
4899 if (testflag(addr, af_early_pipe))
4900 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4903 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4905 if (testflag(addr, af_chunking_used))
4906 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4908 if (testflag(addr, af_tcp_fastopen_conn))
4909 rmt_dlv_checked_write(fd, 'T',
4910 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4914 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4915 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4917 /* Retry information: for most success cases this will be null. */
4919 for (r = addr->retries; r; r = r->next)
4921 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4922 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4923 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4924 ptr += sizeof(r->basic_errno);
4925 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4926 ptr += sizeof(r->more_errno);
4927 if (!r->message) *ptr++ = 0; else
4929 sprintf(CS ptr, "%.512s", r->message);
4932 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4935 #ifdef SUPPORT_SOCKS
4936 if (LOGGING(proxy) && proxy_session)
4939 if (proxy_local_address)
4941 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4942 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4943 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4944 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4945 ptr += sizeof(proxy_local_port);
4949 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4953 #ifdef EXPERIMENTAL_DSN_INFO
4954 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4955 if (addr->smtp_greeting)
4957 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4958 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4959 if (addr->helo_response)
4961 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4962 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4966 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4970 /* The rest of the information goes in an 'A0' item. */
4972 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4973 ptr = big_buffer + 2;
4974 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4975 ptr += sizeof(addr->basic_errno);
4976 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4977 ptr += sizeof(addr->more_errno);
4978 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4979 ptr += sizeof(addr->delivery_usec);
4980 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4981 ptr += sizeof(addr->flags);
4983 if (!addr->message) *ptr++ = 0; else
4984 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4986 if (!addr->user_message) *ptr++ = 0; else
4987 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4989 if (!addr->host_used) *ptr++ = 0; else
4991 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4992 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4993 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4994 ptr += sizeof(addr->host_used->port);
4996 /* DNS lookup status */
4997 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4998 : addr->host_used->dnssec==DS_NO ? '1' : '0';
5001 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
5004 /* Local interface address/port */
5005 #ifdef EXPERIMENTAL_DSN_INFO
5006 if (sending_ip_address)
5008 if (LOGGING(incoming_interface) && sending_ip_address)
5012 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
5013 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
5014 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
5017 /* Add termination flag, close the pipe, and that's it. The character
5018 after 'Z' indicates whether continue_transport is now NULL or not.
5019 A change from non-NULL to NULL indicates a problem with a continuing
5022 big_buffer[0] = continue_transport ? '1' : '0';
5023 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5028 /* Back in the mainline: close the unwanted half of the pipe. */
5030 (void)close(pfd[pipe_write]);
5032 /* If we have a connection still open from a verify stage (lazy-close)
5033 release its TLS library context (if any) as responsibility was passed to
5034 the delivery child process. */
5036 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5039 if (cutthrough.is_tls)
5040 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5042 (void) close(cutthrough.cctx.sock);
5043 release_cutthrough_connection(US"passed to transport proc");
5046 /* Fork failed; defer with error message */
5050 (void)close(pfd[pipe_read]);
5051 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5052 addr->domain, strerror(errno));
5056 /* Fork succeeded; increment the count, and remember relevant data for
5057 when the process finishes. */
5060 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5061 parlist[poffset].pid = pid;
5062 parlist[poffset].fd = pfd[pipe_read];
5063 parlist[poffset].done = FALSE;
5064 parlist[poffset].msg = NULL;
5065 parlist[poffset].return_path = return_path;
5067 /* If the process we've just started is sending a message down an existing
5068 channel, wait for it now. This ensures that only one such process runs at
5069 once, whatever the value of remote_max parallel. Otherwise, we might try to
5070 send two or more messages simultaneously down the same channel. This could
5071 happen if there are different domains that include the same host in otherwise
5072 different host lists.
5074 Also, if the transport closes down the channel, this information gets back
5075 (continue_transport gets set to NULL) before we consider any other addresses
5078 if (continue_transport) par_reduce(0, fallback);
5080 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5081 newly created process get going before we create another process. This should
5082 ensure repeatability in the tests. We only need to wait a tad. */
5084 else if (f.running_in_test_harness) millisleep(500);
5089 if (serialize_key) enq_end(serialize_key);
5091 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5095 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5096 are still running and post-process their addresses. */
5098 par_reduce(0, fallback);
5105 /*************************************************
5106 * Split an address into local part and domain *
5107 *************************************************/
5109 /* This function initializes an address for routing by splitting it up into a
5110 local part and a domain. The local part is set up twice - once in its original
5111 casing, and once in lower case, and it is dequoted. We also do the "percent
5112 hack" for configured domains. This may lead to a DEFER result if a lookup
5113 defers. When a percent-hacking takes place, we insert a copy of the original
5114 address as a new parent of this address, as if we have had a redirection.
5117 addr points to an addr_item block containing the address
5120 DEFER - could not determine if domain is %-hackable
5124 deliver_split_address(address_item * addr)
5126 uschar * address = addr->address;
5131 if (!(domain = Ustrrchr(address, '@')))
5132 return DEFER; /* should always have a domain, but just in case... */
5134 len = domain - address;
5135 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5137 /* The implication in the RFCs (though I can't say I've seen it spelled out
5138 explicitly) is that quoting should be removed from local parts at the point
5139 where they are locally interpreted. [The new draft "821" is more explicit on
5140 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5141 removing quoting backslashes and any unquoted doublequotes. */
5143 t = addr->cc_local_part = store_get(len+1);
5147 if (c == '\"') continue;
5157 /* We do the percent hack only for those domains that are listed in
5158 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5160 if (percent_hack_domains)
5163 uschar *new_address = NULL;
5164 uschar *local_part = addr->cc_local_part;
5166 deliver_domain = addr->domain; /* set $domain */
5168 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5169 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5171 && (t = Ustrrchr(local_part, '%')) != NULL
5174 new_address = string_copy(local_part);
5175 new_address[t - local_part] = '@';
5176 deliver_domain = string_copylc(t+1);
5177 local_part = string_copyn(local_part, t - local_part);
5180 if (rc == DEFER) return DEFER; /* lookup deferred */
5182 /* If hackery happened, set up new parent and alter the current address. */
5186 address_item *new_parent = store_get(sizeof(address_item));
5187 *new_parent = *addr;
5188 addr->parent = new_parent;
5189 new_parent->child_count = 1;
5190 addr->address = new_address;
5191 addr->unique = string_copy(new_address);
5192 addr->domain = deliver_domain;
5193 addr->cc_local_part = local_part;
5194 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5199 /* Create the lowercased version of the final local part, and make that the
5200 default one to be used. */
5202 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5209 /*************************************************
5210 * Get next error message text *
5211 *************************************************/
5213 /* If f is not NULL, read the next "paragraph", from a customized error message
5214 text file, terminated by a line containing ****, and expand it.
5217 f NULL or a file to read from
5218 which string indicating which string (for errors)
5220 Returns: NULL or an expanded string
5224 next_emf(FILE *f, uschar *which)
5230 if (!f) return NULL;
5232 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5235 para = string_get(256);
5238 para = string_cat(para, buffer);
5239 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5242 if ((yield = expand_string(string_from_gstring(para))))
5245 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5246 "bounce_message_file or warn_message_file (%s): %s", which,
5247 expand_string_message);
5254 /*************************************************
5255 * Close down a passed transport channel *
5256 *************************************************/
5258 /* This function is called when a passed transport channel cannot be used.
5259 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5260 so that the function call can be the argument of a "return" statement.
5263 Returns: DELIVER_NOT_ATTEMPTED
5267 continue_closedown(void)
5269 if (continue_transport)
5271 transport_instance *t;
5272 for (t = transports; t; t = t->next)
5273 if (Ustrcmp(t->name, continue_transport) == 0)
5275 if (t->info->closedown) (t->info->closedown)(t);
5279 return DELIVER_NOT_ATTEMPTED;
5285 /*************************************************
5286 * Print address information *
5287 *************************************************/
5289 /* This function is called to output an address, or information about an
5290 address, for bounce or defer messages. If the hide_child flag is set, all we
5291 output is the original ancestor address.
5294 addr points to the address
5295 f the FILE to print to
5296 si an initial string
5297 sc a continuation string for before "generated"
5300 Returns: TRUE if the address is not hidden
5304 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5308 uschar *printed = US"";
5309 address_item *ancestor = addr;
5310 while (ancestor->parent) ancestor = ancestor->parent;
5312 fprintf(f, "%s", CS si);
5314 if (addr->parent && testflag(addr, af_hide_child))
5316 printed = US"an undisclosed address";
5319 else if (!testflag(addr, af_pfr) || !addr->parent)
5320 printed = addr->address;
5324 uschar *s = addr->address;
5327 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5328 else if (addr->address[0] == '|') ss = US"pipe";
5331 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5332 printed = addr->parent->address;
5335 fprintf(f, "%s", CS string_printing(printed));
5337 if (ancestor != addr)
5339 uschar *original = ancestor->onetime_parent;
5340 if (!original) original= ancestor->address;
5341 if (strcmpic(original, printed) != 0)
5342 fprintf(f, "%s(%sgenerated from %s)", sc,
5343 ancestor != addr->parent ? "ultimately " : "",
5344 string_printing(original));
5347 if (addr->host_used)
5348 fprintf(f, "\n host %s [%s]",
5349 addr->host_used->name, addr->host_used->address);
5351 fprintf(f, "%s", CS se);
5359 /*************************************************
5360 * Print error for an address *
5361 *************************************************/
5363 /* This function is called to print the error information out of an address for
5364 a bounce or a warning message. It tries to format the message reasonably by
5365 introducing newlines. All lines are indented by 4; the initial printing
5366 position must be set before calling.
5368 This function used always to print the error. Nowadays we want to restrict it
5369 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5370 and filter "fail". We no longer pass other information willy-nilly in bounce
5371 and warning messages. Text in user_message is always output; text in message
5372 only if the af_pass_message flag is set.
5376 f the FILE to print on
5383 print_address_error(address_item *addr, FILE *f, uschar *t)
5385 int count = Ustrlen(t);
5386 uschar *s = testflag(addr, af_pass_message)? addr->message : NULL;
5388 if (!s && !(s = addr->user_message))
5391 fprintf(f, "\n %s", t);
5394 if (*s == '\\' && s[1] == 'n')
5404 if (*s++ == ':' && isspace(*s) && count > 45)
5406 fprintf(f, "\n "); /* sic (because space follows) */
5413 /***********************************************************
5414 * Print Diagnostic-Code for an address *
5415 ************************************************************/
5417 /* This function is called to print the error information out of an address for
5418 a bounce or a warning message. It tries to format the message reasonably as
5419 required by RFC 3461 by adding a space after each newline
5421 it uses the same logic as print_address_error() above. if af_pass_message is true
5422 and addr->message is set it uses the remote host answer. if not addr->user_message
5423 is used instead if available.
5427 f the FILE to print on
5433 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5435 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5437 /* af_pass_message and addr->message set ? print remote host answer */
5441 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5443 /* search first ": ". we assume to find the remote-MTA answer there */
5444 if (!(s = Ustrstr(addr->message, ": ")))
5445 return; /* not found, bail out */
5446 s += 2; /* skip ": " */
5447 fprintf(f, "Diagnostic-Code: smtp; ");
5449 /* no message available. do nothing */
5453 if (*s == '\\' && s[1] == 'n')
5455 fputs("\n ", f); /* as defined in RFC 3461 */
5465 /*************************************************
5466 * Check list of addresses for duplication *
5467 *************************************************/
5469 /* This function was introduced when the test for duplicate addresses that are
5470 not pipes, files, or autoreplies was moved from the middle of routing to when
5471 routing was complete. That was to fix obscure cases when the routing history
5472 affects the subsequent routing of identical addresses. This function is called
5473 after routing, to check that the final routed addresses are not duplicates.
5475 If we detect a duplicate, we remember what it is a duplicate of. Note that
5476 pipe, file, and autoreply de-duplication is handled during routing, so we must
5477 leave such "addresses" alone here, as otherwise they will incorrectly be
5480 Argument: address of list anchor
5485 do_duplicate_check(address_item **anchor)
5488 while ((addr = *anchor))
5491 if (testflag(addr, af_pfr))
5493 anchor = &(addr->next);
5495 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5497 DEBUG(D_deliver|D_route)
5498 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5499 *anchor = addr->next;
5500 addr->dupof = tnode->data.ptr;
5501 addr->next = addr_duplicate;
5502 addr_duplicate = addr;
5506 tree_add_duplicate(addr->unique, addr);
5507 anchor = &(addr->next);
5515 /*************************************************
5516 * Deliver one message *
5517 *************************************************/
5519 /* This is the function which is called when a message is to be delivered. It
5520 is passed the id of the message. It is possible that the message no longer
5521 exists, if some other process has delivered it, and it is also possible that
5522 the message is being worked on by another process, in which case the data file
5525 If no delivery is attempted for any of the above reasons, the function returns
5526 DELIVER_NOT_ATTEMPTED.
5528 If the give_up flag is set true, do not attempt any deliveries, but instead
5529 fail all outstanding addresses and return the message to the sender (or
5532 A delivery operation has a process all to itself; we never deliver more than
5533 one message in the same process. Therefore we needn't worry too much about
5536 Liable to be called as root.
5539 id the id of the message to be delivered
5540 forced TRUE if delivery was forced by an administrator; this overrides
5541 retry delays and causes a delivery to be tried regardless
5542 give_up TRUE if an administrator has requested that delivery attempts
5545 Returns: When the global variable mua_wrapper is FALSE:
5546 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5547 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5548 When the global variable mua_wrapper is TRUE:
5549 DELIVER_MUA_SUCCEEDED if delivery succeeded
5550 DELIVER_MUA_FAILED if delivery failed
5551 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5555 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5558 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5559 time_t now = time(NULL);
5560 address_item *addr_last = NULL;
5561 uschar *filter_message = NULL;
5562 int process_recipients = RECIP_ACCEPT;
5565 extern int acl_where;
5567 uschar *info = queue_run_pid == (pid_t)0
5568 ? string_sprintf("delivering %s", id)
5569 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5571 /* If the D_process_info bit is on, set_process_info() will output debugging
5572 information. If not, we want to show this initial information if D_deliver or
5573 D_queue_run is set or in verbose mode. */
5575 set_process_info("%s", info);
5577 if ( !(debug_selector & D_process_info)
5578 && (debug_selector & (D_deliver|D_queue_run|D_v))
5580 debug_printf("%s\n", info);
5582 /* Ensure that we catch any subprocesses that are created. Although Exim
5583 sets SIG_DFL as its initial default, some routes through the code end up
5584 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5585 has been forked, but no re-exec has been done. We use sigaction rather than
5586 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5587 sure it is turned off. (There was a problem on AIX with this.) */
5591 struct sigaction act;
5592 act.sa_handler = SIG_DFL;
5593 sigemptyset(&(act.sa_mask));
5595 sigaction(SIGCHLD, &act, NULL);
5598 signal(SIGCHLD, SIG_DFL);
5601 /* Make the forcing flag available for routers and transports, set up the
5602 global message id field, and initialize the count for returned files and the
5603 message size. This use of strcpy() is OK because the length id is checked when
5604 it is obtained from a command line (the -M or -q options), and otherwise it is
5605 known to be a valid message id. */
5607 if (id != message_id)
5608 Ustrcpy(message_id, id);
5609 f.deliver_force = forced;
5613 /* Initialize some flags */
5615 update_spool = FALSE;
5616 remove_journal = TRUE;
5618 /* Set a known context for any ACLs we call via expansions */
5619 acl_where = ACL_WHERE_DELIVERY;
5621 /* Reset the random number generator, so that if several delivery processes are
5622 started from a queue runner that has already used random numbers (for sorting),
5623 they don't all get the same sequence. */
5627 /* Open and lock the message's data file. Exim locks on this one because the
5628 header file may get replaced as it is re-written during the delivery process.
5629 Any failures cause messages to be written to the log, except for missing files
5630 while queue running - another process probably completed delivery. As part of
5631 opening the data file, message_subdir gets set. */
5633 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5634 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5636 /* The value of message_size at this point has been set to the data length,
5637 plus one for the blank line that notionally precedes the data. */
5639 /* Now read the contents of the header file, which will set up the headers in
5640 store, and also the list of recipients and the tree of non-recipients and
5641 assorted flags. It updates message_size. If there is a reading or format error,
5642 give up; if the message has been around for sufficiently long, remove it. */
5645 uschar * spoolname = string_sprintf("%s-H", id);
5646 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5648 if (errno == ERRNO_SPOOLFORMAT)
5650 struct stat statbuf;
5651 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5653 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5654 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5656 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5659 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5662 /* If we managed to read the envelope data, received_time contains the
5663 time the message was received. Otherwise, we can calculate it from the
5666 if (rc != spool_read_hdrerror)
5668 received_time.tv_sec = received_time.tv_usec = 0;
5669 /*XXX subsec precision?*/
5670 for (i = 0; i < 6; i++)
5671 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5674 /* If we've had this malformed message too long, sling it. */
5676 if (now - received_time.tv_sec > keep_malformed)
5678 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5679 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5680 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5681 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5682 log_write(0, LOG_MAIN, "Message removed because older than %s",
5683 readconf_printtime(keep_malformed));
5686 (void)close(deliver_datafile);
5687 deliver_datafile = -1;
5688 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5692 /* The spool header file has been read. Look to see if there is an existing
5693 journal file for this message. If there is, it means that a previous delivery
5694 attempt crashed (program or host) before it could update the spool header file.
5695 Read the list of delivered addresses from the journal and add them to the
5696 nonrecipients tree. Then update the spool file. We can leave the journal in
5697 existence, as it will get further successful deliveries added to it in this
5698 run, and it will be deleted if this function gets to its end successfully.
5699 Otherwise it might be needed again. */
5702 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5705 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5713 && lseek(journal_fd, 0, SEEK_SET) == 0
5714 && (jread = fdopen(journal_fd, "rb"))
5717 while (Ufgets(big_buffer, big_buffer_size, jread))
5719 int n = Ustrlen(big_buffer);
5720 big_buffer[n-1] = 0;
5721 tree_add_nonrecipient(big_buffer);
5722 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5723 "journal file\n", big_buffer);
5726 if ((journal_fd = dup(fileno(jread))) < 0)
5727 journal_fd = fileno(jread);
5729 (void) fclose(jread); /* Try to not leak the FILE resource */
5731 /* Panic-dies on error */
5732 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5734 else if (errno != ENOENT)
5736 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5737 "%s", strerror(errno));
5738 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5741 /* A null recipients list indicates some kind of disaster. */
5743 if (!recipients_list)
5745 (void)close(deliver_datafile);
5746 deliver_datafile = -1;
5747 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5748 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5753 /* Handle a message that is frozen. There are a number of different things that
5754 can happen, but in the default situation, unless forced, no delivery is
5757 if (f.deliver_freeze)
5759 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5760 /* Moving to another directory removes the message from Exim's view. Other
5761 tools must be used to deal with it. Logging of this action happens in
5762 spool_move_message() and its subfunctions. */
5764 if ( move_frozen_messages
5765 && spool_move_message(id, message_subdir, US"", US"F")
5767 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5770 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5771 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5772 flag causing all recipients to be failed. The time is the age of the
5773 message, not the time since freezing. */
5775 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5777 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5778 process_recipients = RECIP_FAIL_TIMEOUT;
5781 /* For bounce messages (and others with no sender), thaw if the error message
5782 ignore timer is exceeded. The message will be discarded if this delivery
5785 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5786 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5788 /* If this is a bounce message, or there's no auto thaw, or we haven't
5789 reached the auto thaw time yet, and this delivery is not forced by an admin
5790 user, do not attempt delivery of this message. Note that forced is set for
5791 continuing messages down the same channel, in order to skip load checking and
5792 ignore hold domains, but we don't want unfreezing in that case. */
5796 if ( ( sender_address[0] == 0
5798 || now <= deliver_frozen_at + auto_thaw
5800 && ( !forced || !f.deliver_force_thaw
5801 || !f.admin_user || continue_hostname
5804 (void)close(deliver_datafile);
5805 deliver_datafile = -1;
5806 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5807 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5810 /* If delivery was forced (by an admin user), assume a manual thaw.
5811 Otherwise it's an auto thaw. */
5815 f.deliver_manual_thaw = TRUE;
5816 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5818 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5821 /* We get here if any of the rules for unfreezing have triggered. */
5823 f.deliver_freeze = FALSE;
5824 update_spool = TRUE;
5828 /* Open the message log file if we are using them. This records details of
5829 deliveries, deferments, and failures for the benefit of the mail administrator.
5830 The log is not used by exim itself to track the progress of a message; that is
5831 done by rewriting the header spool file. */
5835 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5839 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5841 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5842 fname, strerror(errno));
5843 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5846 /* Make a C stream out of it. */
5848 if (!(message_log = fdopen(fd, "a")))
5850 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5851 fname, strerror(errno));
5852 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5857 /* If asked to give up on a message, log who did it, and set the action for all
5862 struct passwd *pw = getpwuid(real_uid);
5863 log_write(0, LOG_MAIN, "cancelled by %s",
5864 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5865 process_recipients = RECIP_FAIL;
5868 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5870 else if (received_count > received_headers_max)
5871 process_recipients = RECIP_FAIL_LOOP;
5873 /* Otherwise, if a system-wide, address-independent message filter is
5874 specified, run it now, except in the case when we are failing all recipients as
5875 a result of timeout_frozen_after. If the system filter yields "delivered", then
5876 ignore the true recipients of the message. Failure of the filter file is
5877 logged, and the delivery attempt fails. */
5879 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5884 redirect_block redirect;
5886 if (system_filter_uid_set)
5888 ugid.uid = system_filter_uid;
5889 ugid.gid = system_filter_gid;
5890 ugid.uid_set = ugid.gid_set = TRUE;
5894 ugid.uid_set = ugid.gid_set = FALSE;
5897 return_path = sender_address;
5898 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5899 f.system_filtering = TRUE;
5901 /* Any error in the filter file causes a delivery to be abandoned. */
5903 redirect.string = system_filter;
5904 redirect.isfile = TRUE;
5905 redirect.check_owner = redirect.check_group = FALSE;
5906 redirect.owners = NULL;
5907 redirect.owngroups = NULL;
5909 redirect.modemask = 0;
5911 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5914 &redirect, /* Where the data is */
5915 RDO_DEFER | /* Turn on all the enabling options */
5916 RDO_FAIL | /* Leave off all the disabling options */
5921 NULL, /* No :include: restriction (not used in filter) */
5922 NULL, /* No sieve vacation directory (not sieve!) */
5923 NULL, /* No sieve enotify mailto owner (not sieve!) */
5924 NULL, /* No sieve user address (not sieve!) */
5925 NULL, /* No sieve subaddress (not sieve!) */
5926 &ugid, /* uid/gid data */
5927 &addr_new, /* Where to hang generated addresses */
5928 &filter_message, /* Where to put error message */
5929 NULL, /* Don't skip syntax errors */
5930 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5931 US"system filter"); /* For error messages */
5933 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5935 if (rc == FF_ERROR || rc == FF_NONEXIST)
5937 (void)close(deliver_datafile);
5938 deliver_datafile = -1;
5939 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5940 string_printing(filter_message));
5941 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5944 /* Reset things. If the filter message is an empty string, which can happen
5945 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5947 f.system_filtering = FALSE;
5948 f.enable_dollar_recipients = FALSE;
5949 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5951 /* Save the values of the system filter variables so that user filters
5954 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5956 /* The filter can request that delivery of the original addresses be
5961 process_recipients = RECIP_DEFER;
5962 deliver_msglog("Delivery deferred by system filter\n");
5963 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5966 /* The filter can request that a message be frozen, but this does not
5967 take place if the message has been manually thawed. In that case, we must
5968 unset "delivered", which is forced by the "freeze" command to make -bF
5971 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5973 f.deliver_freeze = TRUE;
5974 deliver_frozen_at = time(NULL);
5975 process_recipients = RECIP_DEFER;
5976 frozen_info = string_sprintf(" by the system filter%s%s",
5977 filter_message ? US": " : US"",
5978 filter_message ? filter_message : US"");
5981 /* The filter can request that a message be failed. The error message may be
5982 quite long - it is sent back to the sender in the bounce - but we don't want
5983 to fill up the log with repetitions of it. If it starts with << then the text
5984 between << and >> is written to the log, with the rest left for the bounce
5987 else if (rc == FF_FAIL)
5989 uschar *colon = US"";
5990 uschar *logmsg = US"";
5993 process_recipients = RECIP_FAIL_FILTER;
5999 if ( filter_message[0] == '<'
6000 && filter_message[1] == '<'
6001 && (logend = Ustrstr(filter_message, ">>"))
6004 logmsg = filter_message + 2;
6005 loglen = logend - logmsg;
6006 filter_message = logend + 2;
6007 if (filter_message[0] == 0) filter_message = NULL;
6011 logmsg = filter_message;
6012 loglen = Ustrlen(filter_message);
6016 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6020 /* Delivery can be restricted only to those recipients (if any) that the
6021 filter specified. */
6023 else if (rc == FF_DELIVERED)
6025 process_recipients = RECIP_IGNORE;
6027 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6029 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6032 /* If any new addresses were created by the filter, fake up a "parent"
6033 for them. This is necessary for pipes, etc., which are expected to have
6034 parents, and it also gives some sensible logging for others. Allow
6035 pipes, files, and autoreplies, and run them as the filter uid if set,
6036 otherwise as the current uid. */
6040 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
6041 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
6043 /* The text "system-filter" is tested in transport_set_up_command() and in
6044 set_up_shell_command() in the pipe transport, to enable them to permit
6045 $recipients, so don't change it here without also changing it there. */
6047 address_item *p = addr_new;
6048 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6050 parent->domain = string_copylc(qualify_domain_recipient);
6051 parent->local_part = US"system-filter";
6053 /* As part of this loop, we arrange for addr_last to end up pointing
6054 at the final address. This is used if we go on to add addresses for the
6055 original recipients. */
6059 if (parent->child_count == USHRT_MAX)
6060 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6061 "than %d delivery addresses", USHRT_MAX);
6062 parent->child_count++;
6065 if (testflag(p, af_pfr))
6071 setflag(p, af_uid_set);
6072 setflag(p, af_gid_set);
6073 setflag(p, af_allow_file);
6074 setflag(p, af_allow_pipe);
6075 setflag(p, af_allow_reply);
6077 /* Find the name of the system filter's appropriate pfr transport */
6079 if (p->address[0] == '|')
6082 tpname = system_filter_pipe_transport;
6083 address_pipe = p->address;
6085 else if (p->address[0] == '>')
6088 tpname = system_filter_reply_transport;
6092 if (p->address[Ustrlen(p->address)-1] == '/')
6094 type = US"directory";
6095 tpname = system_filter_directory_transport;
6100 tpname = system_filter_file_transport;
6102 address_file = p->address;
6105 /* Now find the actual transport, first expanding the name. We have
6106 set address_file or address_pipe above. */
6110 uschar *tmp = expand_string(tpname);
6111 address_file = address_pipe = NULL;
6113 p->message = string_sprintf("failed to expand \"%s\" as a "
6114 "system filter transport name", tpname);
6118 p->message = string_sprintf("system_filter_%s_transport is unset",
6123 transport_instance *tp;
6124 for (tp = transports; tp; tp = tp->next)
6125 if (Ustrcmp(tp->name, tpname) == 0)
6131 p->message = string_sprintf("failed to find \"%s\" transport "
6132 "for system filter delivery", tpname);
6135 /* If we couldn't set up a transport, defer the delivery, putting the
6136 error on the panic log as well as the main log. */
6140 address_item *badp = p;
6142 if (!addr_last) addr_new = p; else addr_last->next = p;
6143 badp->local_part = badp->address; /* Needed for log line */
6144 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6147 } /* End of pfr handling */
6149 /* Either a non-pfr delivery, or we found a transport */
6151 DEBUG(D_deliver|D_filter)
6152 debug_printf("system filter added %s\n", p->address);
6156 } /* Loop through all addr_new addresses */
6161 /* Scan the recipients list, and for every one that is not in the non-
6162 recipients tree, add an addr item to the chain of new addresses. If the pno
6163 value is non-negative, we must set the onetime parent from it. This which
6164 points to the relevant entry in the recipients list.
6166 This processing can be altered by the setting of the process_recipients
6167 variable, which is changed if recipients are to be ignored, failed, or
6168 deferred. This can happen as a result of system filter activity, or if the -Mg
6169 option is used to fail all of them.
6171 Duplicate addresses are handled later by a different tree structure; we can't
6172 just extend the non-recipients tree, because that will be re-written to the
6173 spool if the message is deferred, and in any case there are casing
6174 complications for local addresses. */
6176 if (process_recipients != RECIP_IGNORE)
6177 for (i = 0; i < recipients_count; i++)
6178 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6180 recipient_item *r = recipients_list + i;
6181 address_item *new = deliver_make_addr(r->address, FALSE);
6182 new->prop.errors_address = r->errors_to;
6184 if ((new->prop.utf8_msg = message_smtputf8))
6186 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6187 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6188 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6189 new->prop.utf8_downcvt ? "yes"
6190 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6196 new->onetime_parent = recipients_list[r->pno].address;
6198 /* If DSN support is enabled, set the dsn flags and the original receipt
6199 to be passed on to other DSN enabled MTAs */
6200 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6201 new->dsn_orcpt = r->orcpt;
6202 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6203 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6205 switch (process_recipients)
6207 /* RECIP_DEFER is set when a system filter freezes a message. */
6210 new->next = addr_defer;
6215 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6218 case RECIP_FAIL_FILTER:
6220 filter_message ? filter_message : US"delivery cancelled";
6221 setflag(new, af_pass_message);
6222 goto RECIP_QUEUE_FAILED; /* below */
6225 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6226 than the value in timeout_frozen_after. Treat non-bounce messages
6227 similarly to -Mg; for bounce messages we just want to discard, so
6228 don't put the address on the failed list. The timeout has already
6231 case RECIP_FAIL_TIMEOUT:
6232 new->message = US"delivery cancelled; message timed out";
6233 goto RECIP_QUEUE_FAILED; /* below */
6236 /* RECIP_FAIL is set when -Mg has been used. */
6239 new->message = US"delivery cancelled by administrator";
6242 /* Common code for the failure cases above. If this is not a bounce
6243 message, put the address on the failed list so that it is used to
6244 create a bounce. Otherwise do nothing - this just discards the address.
6245 The incident has already been logged. */
6248 if (sender_address[0])
6250 new->next = addr_failed;
6256 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6257 in the message. Process each address as a routing failure; if this
6258 is a bounce message, it will get frozen. */
6260 case RECIP_FAIL_LOOP:
6261 new->message = US"Too many \"Received\" headers - suspected mail loop";
6262 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6266 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6269 if (!addr_new) addr_new = new; else addr_last->next = new;
6274 #ifndef DISABLE_EVENT
6275 if (process_recipients != RECIP_ACCEPT)
6277 uschar * save_local = deliver_localpart;
6278 const uschar * save_domain = deliver_domain;
6279 uschar * addr = new->address, * errmsg = NULL;
6280 int start, end, dom;
6282 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6283 log_write(0, LOG_MAIN|LOG_PANIC,
6284 "failed to parse address '%.100s': %s\n", addr, errmsg);
6288 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6289 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6291 event_raise(event_action, US"msg:fail:internal", new->message);
6293 deliver_localpart = save_local;
6294 deliver_domain = save_domain;
6303 debug_printf("Delivery address list:\n");
6304 for (p = addr_new; p; p = p->next)
6305 debug_printf(" %s %s\n", p->address,
6306 p->onetime_parent ? p->onetime_parent : US"");
6309 /* Set up the buffers used for copying over the file when delivering. */
6311 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6312 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6316 /* Until there are no more new addresses, handle each one as follows:
6318 . If this is a generated address (indicated by the presence of a parent
6319 pointer) then check to see whether it is a pipe, file, or autoreply, and
6320 if so, handle it directly here. The router that produced the address will
6321 have set the allow flags into the address, and also set the uid/gid required.
6322 Having the routers generate new addresses and then checking them here at
6323 the outer level is tidier than making each router do the checking, and
6324 means that routers don't need access to the failed address queue.
6326 . Break up the address into local part and domain, and make lowercased
6327 versions of these strings. We also make unquoted versions of the local part.
6329 . Handle the percent hack for those domains for which it is valid.
6331 . For child addresses, determine if any of the parents have the same address.
6332 If so, generate a different string for previous delivery checking. Without
6333 this code, if the address spqr generates spqr via a forward or alias file,
6334 delivery of the generated spqr stops further attempts at the top level spqr,
6335 which is not what is wanted - it may have generated other addresses.
6337 . Check on the retry database to see if routing was previously deferred, but
6338 only if in a queue run. Addresses that are to be routed are put on the
6339 addr_route chain. Addresses that are to be deferred are put on the
6340 addr_defer chain. We do all the checking first, so as not to keep the
6341 retry database open any longer than necessary.
6343 . Now we run the addresses through the routers. A router may put the address
6344 on either the addr_local or the addr_remote chain for local or remote
6345 delivery, respectively, or put it on the addr_failed chain if it is
6346 undeliveable, or it may generate child addresses and put them on the
6347 addr_new chain, or it may defer an address. All the chain anchors are
6348 passed as arguments so that the routers can be called for verification
6351 . If new addresses have been generated by the routers, da capo.
6354 f.header_rewritten = FALSE; /* No headers rewritten yet */
6355 while (addr_new) /* Loop until all addresses dealt with */
6357 address_item *addr, *parent;
6359 /* Failure to open the retry database is treated the same as if it does
6360 not exist. In both cases, dbm_file is NULL. */
6362 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6363 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6364 debug_printf("no retry data available\n");
6366 /* Scan the current batch of new addresses, to handle pipes, files and
6367 autoreplies, and determine which others are ready for routing. */
6374 dbdata_retry *domain_retry_record;
6375 dbdata_retry *address_retry_record;
6378 addr_new = addr->next;
6380 DEBUG(D_deliver|D_retry|D_route)
6382 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6383 debug_printf("Considering: %s\n", addr->address);
6386 /* Handle generated address that is a pipe or a file or an autoreply. */
6388 if (testflag(addr, af_pfr))
6390 /* If an autoreply in a filter could not generate a syntactically valid
6391 address, give up forthwith. Set af_ignore_error so that we don't try to
6392 generate a bounce. */
6394 if (testflag(addr, af_bad_reply))
6396 addr->basic_errno = ERRNO_BADADDRESS2;
6397 addr->local_part = addr->address;
6399 US"filter autoreply generated syntactically invalid recipient";
6400 addr->prop.ignore_error = TRUE;
6401 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6402 continue; /* with the next new address */
6405 /* If two different users specify delivery to the same pipe or file or
6406 autoreply, there should be two different deliveries, so build a unique
6407 string that incorporates the original address, and use this for
6408 duplicate testing and recording delivery, and also for retrying. */
6411 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6412 (testflag(addr->parent, af_homonym)? 3:0));
6414 addr->address_retry_key = addr->domain_retry_key =
6415 string_sprintf("T:%s", addr->unique);
6417 /* If a filter file specifies two deliveries to the same pipe or file,
6418 we want to de-duplicate, but this is probably not wanted for two mail
6419 commands to the same address, where probably both should be delivered.
6420 So, we have to invent a different unique string in that case. Just
6421 keep piling '>' characters on the front. */
6423 if (addr->address[0] == '>')
6425 while (tree_search(tree_duplicates, addr->unique))
6426 addr->unique = string_sprintf(">%s", addr->unique);
6429 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6431 DEBUG(D_deliver|D_route)
6432 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6433 addr->dupof = tnode->data.ptr;
6434 addr->next = addr_duplicate;
6435 addr_duplicate = addr;
6439 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6441 /* Check for previous delivery */
6443 if (tree_search(tree_nonrecipients, addr->unique))
6445 DEBUG(D_deliver|D_route)
6446 debug_printf("%s was previously delivered: discarded\n", addr->address);
6447 child_done(addr, tod_stamp(tod_log));
6451 /* Save for checking future duplicates */
6453 tree_add_duplicate(addr->unique, addr);
6455 /* Set local part and domain */
6457 addr->local_part = addr->address;
6458 addr->domain = addr->parent->domain;
6460 /* Ensure that the delivery is permitted. */
6462 if (testflag(addr, af_file))
6464 if (!testflag(addr, af_allow_file))
6466 addr->basic_errno = ERRNO_FORBIDFILE;
6467 addr->message = US"delivery to file forbidden";
6468 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6469 continue; /* with the next new address */
6472 else if (addr->address[0] == '|')
6474 if (!testflag(addr, af_allow_pipe))
6476 addr->basic_errno = ERRNO_FORBIDPIPE;
6477 addr->message = US"delivery to pipe forbidden";
6478 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6479 continue; /* with the next new address */
6482 else if (!testflag(addr, af_allow_reply))
6484 addr->basic_errno = ERRNO_FORBIDREPLY;
6485 addr->message = US"autoreply forbidden";
6486 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6487 continue; /* with the next new address */
6490 /* If the errno field is already set to BADTRANSPORT, it indicates
6491 failure to expand a transport string, or find the associated transport,
6492 or an unset transport when one is required. Leave this test till now so
6493 that the forbid errors are given in preference. */
6495 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6497 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6501 /* Treat /dev/null as a special case and abandon the delivery. This
6502 avoids having to specify a uid on the transport just for this case.
6503 Arrange for the transport name to be logged as "**bypassed**". */
6505 if (Ustrcmp(addr->address, "/dev/null") == 0)
6507 uschar *save = addr->transport->name;
6508 addr->transport->name = US"**bypassed**";
6509 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6510 addr->transport->name = save;
6511 continue; /* with the next new address */
6514 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6517 DEBUG(D_deliver|D_route)
6518 debug_printf("queued for %s transport\n", addr->transport->name);
6519 addr->next = addr_local;
6521 continue; /* with the next new address */
6524 /* Handle normal addresses. First, split up into local part and domain,
6525 handling the %-hack if necessary. There is the possibility of a defer from
6526 a lookup in percent_hack_domains. */
6528 if ((rc = deliver_split_address(addr)) == DEFER)
6530 addr->message = US"cannot check percent_hack_domains";
6531 addr->basic_errno = ERRNO_LISTDEFER;
6532 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6536 /* Check to see if the domain is held. If so, proceed only if the
6537 delivery was forced by hand. */
6539 deliver_domain = addr->domain; /* set $domain */
6540 if ( !forced && hold_domains
6541 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6542 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6548 addr->message = US"hold_domains lookup deferred";
6549 addr->basic_errno = ERRNO_LISTDEFER;
6553 addr->message = US"domain is held";
6554 addr->basic_errno = ERRNO_HELD;
6556 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6560 /* Now we can check for duplicates and previously delivered addresses. In
6561 order to do this, we have to generate a "unique" value for each address,
6562 because there may be identical actual addresses in a line of descendents.
6563 The "unique" field is initialized to the same value as the "address" field,
6564 but gets changed here to cope with identically-named descendents. */
6566 for (parent = addr->parent; parent; parent = parent->parent)
6567 if (strcmpic(addr->address, parent->address) == 0) break;
6569 /* If there's an ancestor with the same name, set the homonym flag. This
6570 influences how deliveries are recorded. Then add a prefix on the front of
6571 the unique address. We use \n\ where n starts at 0 and increases each time.
6572 It is unlikely to pass 9, but if it does, it may look odd but will still
6573 work. This means that siblings or cousins with the same names are treated
6574 as duplicates, which is what we want. */
6578 setflag(addr, af_homonym);
6579 if (parent->unique[0] != '\\')
6580 addr->unique = string_sprintf("\\0\\%s", addr->address);
6582 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6586 /* Ensure that the domain in the unique field is lower cased, because
6587 domains are always handled caselessly. */
6589 p = Ustrrchr(addr->unique, '@');
6590 while (*p != 0) { *p = tolower(*p); p++; }
6592 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6594 if (tree_search(tree_nonrecipients, addr->unique))
6596 DEBUG(D_deliver|D_route)
6597 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6598 child_done(addr, tod_stamp(tod_log));
6602 /* Get the routing retry status, saving the two retry keys (with and
6603 without the local part) for subsequent use. If there is no retry record for
6604 the standard address routing retry key, we look for the same key with the
6605 sender attached, because this form is used by the smtp transport after a
6606 4xx response to RCPT when address_retry_include_sender is true. */
6608 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6609 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6614 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6615 if ( domain_retry_record
6616 && now - domain_retry_record->time_stamp > retry_data_expire
6618 domain_retry_record = NULL; /* Ignore if too old */
6620 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6621 if ( address_retry_record
6622 && now - address_retry_record->time_stamp > retry_data_expire
6624 address_retry_record = NULL; /* Ignore if too old */
6626 if (!address_retry_record)
6628 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6630 address_retry_record = dbfn_read(dbm_file, altkey);
6631 if ( address_retry_record
6632 && now - address_retry_record->time_stamp > retry_data_expire)
6633 address_retry_record = NULL; /* Ignore if too old */
6637 domain_retry_record = address_retry_record = NULL;
6639 DEBUG(D_deliver|D_retry)
6641 if (!domain_retry_record)
6642 debug_printf("no domain retry record\n");
6643 if (!address_retry_record)
6644 debug_printf("no address retry record\n");
6647 /* If we are sending a message down an existing SMTP connection, we must
6648 assume that the message which created the connection managed to route
6649 an address to that connection. We do not want to run the risk of taking
6650 a long time over routing here, because if we do, the server at the other
6651 end of the connection may time it out. This is especially true for messages
6652 with lots of addresses. For this kind of delivery, queue_running is not
6653 set, so we would normally route all addresses. We take a pragmatic approach
6654 and defer routing any addresses that have any kind of domain retry record.
6655 That is, we don't even look at their retry times. It doesn't matter if this
6656 doesn't work occasionally. This is all just an optimization, after all.
6658 The reason for not doing the same for address retries is that they normally
6659 arise from 4xx responses, not DNS timeouts. */
6661 if (continue_hostname && domain_retry_record)
6663 addr->message = US"reusing SMTP connection skips previous routing defer";
6664 addr->basic_errno = ERRNO_RRETRY;
6665 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6668 /* If we are in a queue run, defer routing unless there is no retry data or
6669 we've passed the next retry time, or this message is forced. In other
6670 words, ignore retry data when not in a queue run.
6672 However, if the domain retry time has expired, always allow the routing
6673 attempt. If it fails again, the address will be failed. This ensures that
6674 each address is routed at least once, even after long-term routing
6677 If there is an address retry, check that too; just wait for the next
6678 retry time. This helps with the case when the temporary error on the
6679 address was really message-specific rather than address specific, since
6680 it allows other messages through.
6682 We also wait for the next retry time if this is a message sent down an
6683 existing SMTP connection (even though that will be forced). Otherwise there
6684 will be far too many attempts for an address that gets a 4xx error. In
6685 fact, after such an error, we should not get here because, the host should
6686 not be remembered as one this message needs. However, there was a bug that
6687 used to cause this to happen, so it is best to be on the safe side.
6689 Even if we haven't reached the retry time in the hints, there is one more
6690 check to do, which is for the ultimate address timeout. We only do this
6691 check if there is an address retry record and there is not a domain retry
6692 record; this implies that previous attempts to handle the address had the
6693 retry_use_local_parts option turned on. We use this as an approximation
6694 for the destination being like a local delivery, for example delivery over
6695 LMTP to an IMAP message store. In this situation users are liable to bump
6696 into their quota and thereby have intermittently successful deliveries,
6697 which keep the retry record fresh, which can lead to us perpetually
6698 deferring messages. */
6700 else if ( ( f.queue_running && !f.deliver_force
6701 || continue_hostname
6703 && ( ( domain_retry_record
6704 && now < domain_retry_record->next_try
6705 && !domain_retry_record->expired
6707 || ( address_retry_record
6708 && now < address_retry_record->next_try
6710 && ( domain_retry_record
6711 || !address_retry_record
6712 || !retry_ultimate_address_timeout(addr->address_retry_key,
6713 addr->domain, address_retry_record, now)
6716 addr->message = US"retry time not reached";
6717 addr->basic_errno = ERRNO_RRETRY;
6718 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6721 /* The domain is OK for routing. Remember if retry data exists so it
6722 can be cleaned up after a successful delivery. */
6726 if (domain_retry_record || address_retry_record)
6727 setflag(addr, af_dr_retry_exists);
6728 addr->next = addr_route;
6730 DEBUG(D_deliver|D_route)
6731 debug_printf("%s: queued for routing\n", addr->address);
6735 /* The database is closed while routing is actually happening. Requests to
6736 update it are put on a chain and all processed together at the end. */
6738 if (dbm_file) dbfn_close(dbm_file);
6740 /* If queue_domains is set, we don't even want to try routing addresses in
6741 those domains. During queue runs, queue_domains is forced to be unset.
6742 Optimize by skipping this pass through the addresses if nothing is set. */
6744 if (!f.deliver_force && queue_domains)
6746 address_item *okaddr = NULL;
6749 address_item *addr = addr_route;
6750 addr_route = addr->next;
6752 deliver_domain = addr->domain; /* set $domain */
6753 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6754 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6758 addr->basic_errno = ERRNO_LISTDEFER;
6759 addr->message = US"queue_domains lookup deferred";
6760 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6764 addr->next = okaddr;
6769 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6770 addr->message = US"domain is in queue_domains";
6771 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6775 addr_route = okaddr;
6778 /* Now route those addresses that are not deferred. */
6783 address_item *addr = addr_route;
6784 const uschar *old_domain = addr->domain;
6785 uschar *old_unique = addr->unique;
6786 addr_route = addr->next;
6789 /* Just in case some router parameter refers to it. */
6791 if (!(return_path = addr->prop.errors_address))
6792 return_path = sender_address;
6794 /* If a router defers an address, add a retry item. Whether or not to
6795 use the local part in the key is a property of the router. */
6797 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6798 &addr_succeed, v_none)) == DEFER)
6799 retry_add_item(addr,
6800 addr->router->retry_use_local_part
6801 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6802 : string_sprintf("R:%s", addr->domain),
6805 /* Otherwise, if there is an existing retry record in the database, add
6806 retry items to delete both forms. We must also allow for the possibility
6807 of a routing retry that includes the sender address. Since the domain might
6808 have been rewritten (expanded to fully qualified) as a result of routing,
6809 ensure that the rewritten form is also deleted. */
6811 else if (testflag(addr, af_dr_retry_exists))
6813 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6815 retry_add_item(addr, altkey, rf_delete);
6816 retry_add_item(addr, addr->address_retry_key, rf_delete);
6817 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6818 if (Ustrcmp(addr->domain, old_domain) != 0)
6819 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6822 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6823 logged, but we need to ensure the address (and maybe parents) is marked
6828 address_done(addr, tod_stamp(tod_log));
6829 continue; /* route next address */
6832 /* The address is finished with (failed or deferred). */
6836 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6837 continue; /* route next address */
6840 /* The address has been routed. If the router changed the domain, it will
6841 also have changed the unique address. We have to test whether this address
6842 has already been delivered, because it's the unique address that finally
6845 if ( addr->unique != old_unique
6846 && tree_search(tree_nonrecipients, addr->unique) != 0
6849 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6850 "discarded\n", addr->address);
6851 if (addr_remote == addr) addr_remote = addr->next;
6852 else if (addr_local == addr) addr_local = addr->next;
6855 /* If the router has same_domain_copy_routing set, we are permitted to copy
6856 the routing for any other addresses with the same domain. This is an
6857 optimisation to save repeated DNS lookups for "standard" remote domain
6858 routing. The option is settable only on routers that generate host lists.
6859 We play it very safe, and do the optimization only if the address is routed
6860 to a remote transport, there are no header changes, and the domain was not
6861 modified by the router. */
6863 if ( addr_remote == addr
6864 && addr->router->same_domain_copy_routing
6865 && !addr->prop.extra_headers
6866 && !addr->prop.remove_headers
6867 && old_domain == addr->domain
6870 address_item **chain = &addr_route;
6873 address_item *addr2 = *chain;
6874 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6876 chain = &(addr2->next);
6880 /* Found a suitable address; take it off the routing list and add it to
6881 the remote delivery list. */
6883 *chain = addr2->next;
6884 addr2->next = addr_remote;
6885 addr_remote = addr2;
6887 /* Copy the routing data */
6889 addr2->domain = addr->domain;
6890 addr2->router = addr->router;
6891 addr2->transport = addr->transport;
6892 addr2->host_list = addr->host_list;
6893 addr2->fallback_hosts = addr->fallback_hosts;
6894 addr2->prop.errors_address = addr->prop.errors_address;
6895 copyflag(addr2, addr, af_hide_child);
6896 copyflag(addr2, addr, af_local_host_removed);
6898 DEBUG(D_deliver|D_route)
6899 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6901 "Routing for %s copied from %s\n",
6902 addr2->address, addr2->address, addr->address);
6905 } /* Continue with routing the next address. */
6906 } /* Loop to process any child addresses that the routers created, and
6907 any rerouted addresses that got put back on the new chain. */
6910 /* Debugging: show the results of the routing */
6912 DEBUG(D_deliver|D_retry|D_route)
6915 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6916 debug_printf("After routing:\n Local deliveries:\n");
6917 for (p = addr_local; p; p = p->next)
6918 debug_printf(" %s\n", p->address);
6920 debug_printf(" Remote deliveries:\n");
6921 for (p = addr_remote; p; p = p->next)
6922 debug_printf(" %s\n", p->address);
6924 debug_printf(" Failed addresses:\n");
6925 for (p = addr_failed; p; p = p->next)
6926 debug_printf(" %s\n", p->address);
6928 debug_printf(" Deferred addresses:\n");
6929 for (p = addr_defer; p; p = p->next)
6930 debug_printf(" %s\n", p->address);
6933 /* Free any resources that were cached during routing. */
6938 /* These two variables are set only during routing, after check_local_user.
6939 Ensure they are not set in transports. */
6941 local_user_gid = (gid_t)(-1);
6942 local_user_uid = (uid_t)(-1);
6944 /* Check for any duplicate addresses. This check is delayed until after
6945 routing, because the flexibility of the routing configuration means that
6946 identical addresses with different parentage may end up being redirected to
6947 different addresses. Checking for duplicates too early (as we previously used
6948 to) makes this kind of thing not work. */
6950 do_duplicate_check(&addr_local);
6951 do_duplicate_check(&addr_remote);
6953 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6954 remote transport. The check that they all end up in one transaction happens in
6955 the do_remote_deliveries() function. */
6958 && (addr_local || addr_failed || addr_defer)
6962 uschar *which, *colon, *msg;
6969 else if (addr_defer)
6972 which = US"deferred";
6980 while (addr->parent) addr = addr->parent;
6985 msg = addr->message;
6987 else colon = msg = US"";
6989 /* We don't need to log here for a forced failure as it will already
6990 have been logged. Defer will also have been logged, but as a defer, so we do
6991 need to do the failure logging. */
6993 if (addr != addr_failed)
6994 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6995 addr->address, which);
6997 /* Always write an error to the caller */
6999 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7002 final_yield = DELIVER_MUA_FAILED;
7003 addr_failed = addr_defer = NULL; /* So that we remove the message */
7004 goto DELIVERY_TIDYUP;
7008 /* If this is a run to continue deliveries to an external channel that is
7009 already set up, defer any local deliveries. */
7011 if (continue_transport)
7015 address_item *addr = addr_defer;
7016 while (addr->next) addr = addr->next;
7017 addr->next = addr_local;
7020 addr_defer = addr_local;
7025 /* Because address rewriting can happen in the routers, we should not really do
7026 ANY deliveries until all addresses have been routed, so that all recipients of
7027 the message get the same headers. However, this is in practice not always
7028 possible, since sometimes remote addresses give DNS timeouts for days on end.
7029 The pragmatic approach is to deliver what we can now, saving any rewritten
7030 headers so that at least the next lot of recipients benefit from the rewriting
7031 that has already been done.
7033 If any headers have been rewritten during routing, update the spool file to
7034 remember them for all subsequent deliveries. This can be delayed till later if
7035 there is only address to be delivered - if it succeeds the spool write need not
7038 if ( f.header_rewritten
7039 && ( addr_local && (addr_local->next || addr_remote)
7040 || addr_remote && addr_remote->next
7043 /* Panic-dies on error */
7044 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7045 f.header_rewritten = FALSE;
7049 /* If there are any deliveries to be and we do not already have the journal
7050 file, create it. This is used to record successful deliveries as soon as
7051 possible after each delivery is known to be complete. A file opened with
7052 O_APPEND is used so that several processes can run simultaneously.
7054 The journal is just insurance against crashes. When the spool file is
7055 ultimately updated at the end of processing, the journal is deleted. If a
7056 journal is found to exist at the start of delivery, the addresses listed
7057 therein are added to the non-recipients. */
7059 if (addr_local || addr_remote)
7063 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7065 if ((journal_fd = Uopen(fname,
7069 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7071 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7072 fname, strerror(errno));
7073 return DELIVER_NOT_ATTEMPTED;
7076 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7077 that the mode is correct - the group setting doesn't always seem to get
7078 set automatically. */
7080 if( fchown(journal_fd, exim_uid, exim_gid)
7081 || fchmod(journal_fd, SPOOL_MODE)
7083 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7087 int ret = Uunlink(fname);
7088 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7089 fname, strerror(errno));
7090 if(ret && errno != ENOENT)
7091 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7092 fname, strerror(errno));
7093 return DELIVER_NOT_ATTEMPTED;
7097 else if (journal_fd >= 0)
7105 /* Now we can get down to the business of actually doing deliveries. Local
7106 deliveries are done first, then remote ones. If ever the problems of how to
7107 handle fallback transports are figured out, this section can be put into a loop
7108 for handling fallbacks, though the uid switching will have to be revised. */
7110 /* Precompile a regex that is used to recognize a parameter in response
7111 to an LHLO command, if is isn't already compiled. This may be used on both
7112 local and remote LMTP deliveries. */
7114 if (!regex_IGNOREQUOTA)
7116 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7118 /* Handle local deliveries */
7122 DEBUG(D_deliver|D_transport)
7123 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7124 do_local_deliveries();
7125 f.disable_logging = FALSE;
7128 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7129 so just queue them all. */
7131 if (f.queue_run_local)
7134 address_item *addr = addr_remote;
7135 addr_remote = addr->next;
7137 addr->basic_errno = ERRNO_LOCAL_ONLY;
7138 addr->message = US"remote deliveries suppressed";
7139 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7142 /* Handle remote deliveries */
7146 DEBUG(D_deliver|D_transport)
7147 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7149 /* Precompile some regex that are used to recognize parameters in response
7150 to an EHLO command, if they aren't already compiled. */
7154 /* Now sort the addresses if required, and do the deliveries. The yield of
7155 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7156 cannot be delivered in one transaction. */
7158 if (remote_sort_domains) sort_remote_deliveries();
7159 if (!do_remote_deliveries(FALSE))
7161 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7162 "be delivered in one transaction");
7163 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7165 final_yield = DELIVER_MUA_FAILED;
7166 addr_failed = addr_defer = NULL; /* So that we remove the message */
7167 goto DELIVERY_TIDYUP;
7170 /* See if any of the addresses that failed got put on the queue for delivery
7171 to their fallback hosts. We do it this way because often the same fallback
7172 host is used for many domains, so all can be sent in a single transaction
7173 (if appropriately configured). */
7175 if (addr_fallback && !mua_wrapper)
7177 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7178 addr_remote = addr_fallback;
7179 addr_fallback = NULL;
7180 if (remote_sort_domains) sort_remote_deliveries();
7181 do_remote_deliveries(TRUE);
7183 f.disable_logging = FALSE;
7187 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7188 phase, to minimize cases of half-done things. */
7191 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7192 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7194 /* Root privilege is no longer needed */
7196 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7198 set_process_info("tidying up after delivering %s", message_id);
7199 signal(SIGTERM, SIG_IGN);
7201 /* When we are acting as an MUA wrapper, the smtp transport will either have
7202 succeeded for all addresses, or failed them all in normal cases. However, there
7203 are some setup situations (e.g. when a named port does not exist) that cause an
7204 immediate exit with deferral of all addresses. Convert those into failures. We
7205 do not ever want to retry, nor do we want to send a bounce message. */
7211 address_item *addr, *nextaddr;
7212 for (addr = addr_defer; addr; addr = nextaddr)
7214 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7215 "delivery", addr->address);
7216 nextaddr = addr->next;
7217 addr->next = addr_failed;
7223 /* Now all should either have succeeded or failed. */
7226 final_yield = DELIVER_MUA_SUCCEEDED;
7230 uschar *s = addr_failed->user_message;
7232 if (!s) s = addr_failed->message;
7234 fprintf(stderr, "Delivery failed: ");
7235 if (addr_failed->basic_errno > 0)
7237 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7238 if (s) fprintf(stderr, ": ");
7240 if ((host = addr_failed->host_used))
7241 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7243 fprintf(stderr, "%s", CS s);
7244 else if (addr_failed->basic_errno <= 0)
7245 fprintf(stderr, "unknown error");
7246 fprintf(stderr, "\n");
7248 final_yield = DELIVER_MUA_FAILED;
7253 /* In a normal configuration, we now update the retry database. This is done in
7254 one fell swoop at the end in order not to keep opening and closing (and
7255 locking) the database. The code for handling retries is hived off into a
7256 separate module for convenience. We pass it the addresses of the various
7257 chains, because deferred addresses can get moved onto the failed chain if the
7258 retry cutoff time has expired for all alternative destinations. Bypass the
7259 updating of the database if the -N flag is set, which is a debugging thing that
7260 prevents actual delivery. */
7262 else if (!f.dont_deliver)
7263 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7265 /* Send DSN for successful messages if requested */
7266 addr_senddsn = NULL;
7268 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7270 /* af_ignore_error not honored here. it's not an error */
7271 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7272 "DSN: processing successful delivery address: %s\n"
7273 "DSN: Sender_address: %s\n"
7274 "DSN: orcpt: %s flags: %d\n"
7275 "DSN: envid: %s ret: %d\n"
7276 "DSN: Final recipient: %s\n"
7277 "DSN: Remote SMTP server supports DSN: %d\n",
7278 addr_dsntmp->router ? addr_dsntmp->router->name : US"(unknown)",
7279 addr_dsntmp->address,
7281 addr_dsntmp->dsn_orcpt ? addr_dsntmp->dsn_orcpt : US"NULL",
7282 addr_dsntmp->dsn_flags,
7283 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7284 addr_dsntmp->address,
7285 addr_dsntmp->dsn_aware
7288 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7289 and a report was requested */
7290 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7291 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7293 && addr_dsntmp->dsn_flags & rf_notify_success
7296 /* copy and relink address_item and send report with all of them at once later */
7297 address_item * addr_next = addr_senddsn;
7298 addr_senddsn = store_get(sizeof(address_item));
7299 *addr_senddsn = *addr_dsntmp;
7300 addr_senddsn->next = addr_next;
7303 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7311 /* create exim process to send message */
7312 pid = child_open_exim(&fd);
7314 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7316 if (pid < 0) /* Creation of child failed */
7318 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7319 "create child process to send failure message: %s", getpid(),
7320 getppid(), strerror(errno));
7322 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7324 else /* Creation of child succeeded */
7326 FILE * f = fdopen(fd, "wb");
7327 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7329 transport_ctx tctx = {{0}};
7332 debug_printf("sending error message to: %s\n", sender_address);
7334 /* build unique id for MIME boundary */
7335 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7336 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7338 if (errors_reply_to)
7339 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7341 fprintf(f, "Auto-Submitted: auto-generated\n"
7342 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7344 "Subject: Delivery Status Notification\n"
7345 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7346 "MIME-Version: 1.0\n\n"
7349 "Content-type: text/plain; charset=us-ascii\n\n"
7351 "This message was created automatically by mail delivery software.\n"
7352 " ----- The following addresses had successful delivery notifications -----\n",
7353 qualify_domain_sender, sender_address, bound, bound);
7355 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7356 addr_dsntmp = addr_dsntmp->next)
7357 fprintf(f, "<%s> (relayed %s)\n\n",
7358 addr_dsntmp->address,
7359 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7360 : addr_dsntmp->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7361 : "via non \"Remote SMTP\" router"
7365 "Content-type: message/delivery-status\n\n"
7366 "Reporting-MTA: dns; %s\n",
7367 bound, smtp_active_hostname);
7370 { /* must be decoded from xtext: see RFC 3461:6.3a */
7372 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7373 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7375 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7379 for (addr_dsntmp = addr_senddsn;
7381 addr_dsntmp = addr_dsntmp->next)
7383 if (addr_dsntmp->dsn_orcpt)
7384 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7386 fprintf(f, "Action: delivered\n"
7387 "Final-Recipient: rfc822;%s\n"
7389 addr_dsntmp->address);
7391 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7392 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7393 addr_dsntmp->host_used->name);
7395 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7396 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7399 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7402 transport_filter_argv = NULL; /* Just in case */
7403 return_path = sender_address; /* In case not previously set */
7405 /* Write the original email out */
7408 tctx.options = topt_add_return_path | topt_no_body;
7409 /*XXX hmm, retval ignored.
7410 Could error for any number of reasons, and they are not handled. */
7411 transport_write_message(&tctx, 0);
7414 fprintf(f,"\n--%s--\n", bound);
7418 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7422 /* If any addresses failed, we must send a message to somebody, unless
7423 af_ignore_error is set, in which case no action is taken. It is possible for
7424 several messages to get sent if there are addresses with different
7431 uschar *logtod = tod_stamp(tod_log);
7433 address_item *handled_addr = NULL;
7434 address_item **paddr;
7435 address_item *msgchain = NULL;
7436 address_item **pmsgchain = &msgchain;
7438 /* There are weird cases when logging is disabled in the transport. However,
7439 there may not be a transport (address failed by a router). */
7441 f.disable_logging = FALSE;
7442 if (addr_failed->transport)
7443 f.disable_logging = addr_failed->transport->disable_logging;
7446 debug_printf("processing failed address %s\n", addr_failed->address);
7448 /* There are only two ways an address in a bounce message can get here:
7450 (1) When delivery was initially deferred, but has now timed out (in the call
7451 to retry_update() above). We can detect this by testing for
7452 af_retry_timedout. If the address does not have its own errors address,
7453 we arrange to ignore the error.
7455 (2) If delivery failures for bounce messages are being ignored. We can detect
7456 this by testing for af_ignore_error. This will also be set if a bounce
7457 message has been autothawed and the ignore_bounce_errors_after time has
7458 passed. It might also be set if a router was explicitly configured to
7459 ignore errors (errors_to = "").
7461 If neither of these cases obtains, something has gone wrong. Log the
7462 incident, but then ignore the error. */
7464 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7466 if ( !testflag(addr_failed, af_retry_timedout)
7467 && !addr_failed->prop.ignore_error)
7468 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7469 "failure is neither frozen nor ignored (it's been ignored)");
7471 addr_failed->prop.ignore_error = TRUE;
7474 /* If the first address on the list has af_ignore_error set, just remove
7475 it from the list, throw away any saved message file, log it, and
7476 mark the recipient done. */
7478 if ( addr_failed->prop.ignore_error
7479 || addr_failed->dsn_flags & (rf_dsnflags & ~rf_notify_failure)
7483 addr_failed = addr->next;
7484 if (addr->return_filename) Uunlink(addr->return_filename);
7486 #ifndef DISABLE_EVENT
7487 msg_event_raise(US"msg:fail:delivery", addr);
7489 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7491 !addr->parent ? US"" : US" <",
7492 !addr->parent ? US"" : addr->parent->address,
7493 !addr->parent ? US"" : US">");
7495 address_done(addr, logtod);
7496 child_done(addr, logtod);
7497 /* Panic-dies on error */
7498 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7501 /* Otherwise, handle the sending of a message. Find the error address for
7502 the first address, then send a message that includes all failed addresses
7503 that have the same error address. Note the bounce_recipient is a global so
7504 that it can be accessed by $bounce_recipient while creating a customized
7509 if (!(bounce_recipient = addr_failed->prop.errors_address))
7510 bounce_recipient = sender_address;
7512 /* Make a subprocess to send a message */
7514 if ((pid = child_open_exim(&fd)) < 0)
7515 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7516 "create child process to send failure message: %s", getpid(),
7517 getppid(), strerror(errno));
7519 /* Creation of child succeeded */
7526 uschar *bcc, *emf_text;
7527 FILE * fp = fdopen(fd, "wb");
7529 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7530 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7531 DELIVER_IN_BUFFER_SIZE;
7533 uschar *dsnlimitmsg;
7534 uschar *dsnnotifyhdr;
7538 debug_printf("sending error message to: %s\n", bounce_recipient);
7540 /* Scan the addresses for all that have the same errors address, removing
7541 them from the addr_failed chain, and putting them on msgchain. */
7543 paddr = &addr_failed;
7544 for (addr = addr_failed; addr; addr = *paddr)
7545 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7546 ? addr->prop.errors_address : sender_address) == 0)
7547 { /* The same - dechain */
7548 *paddr = addr->next;
7551 pmsgchain = &(addr->next);
7554 paddr = &addr->next; /* Not the same; skip */
7556 /* Include X-Failed-Recipients: for automatic interpretation, but do
7557 not let any one header line get too long. We do this by starting a
7558 new header every 50 recipients. Omit any addresses for which the
7559 "hide_child" flag is set. */
7561 for (addr = msgchain; addr; addr = addr->next)
7563 if (testflag(addr, af_hide_child)) continue;
7571 ? "X-Failed-Recipients: "
7573 testflag(addr, af_pfr) && addr->parent
7574 ? string_printing(addr->parent->address)
7575 : string_printing(addr->address));
7577 if (rcount > 0) fprintf(fp, "\n");
7579 /* Output the standard headers */
7581 if (errors_reply_to)
7582 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7583 fprintf(fp, "Auto-Submitted: auto-replied\n");
7584 moan_write_from(fp);
7585 fprintf(fp, "To: %s\n", bounce_recipient);
7587 /* generate boundary string and output MIME-Headers */
7588 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7590 fprintf(fp, "Content-Type: multipart/report;"
7591 " report-type=delivery-status; boundary=%s\n"
7592 "MIME-Version: 1.0\n",
7595 /* Open a template file if one is provided. Log failure to open, but
7596 carry on - default texts will be used. */
7598 if (bounce_message_file)
7599 if (!(emf = Ufopen(bounce_message_file, "rb")))
7600 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7601 "message texts: %s", bounce_message_file, strerror(errno));
7603 /* Quietly copy to configured additional addresses if required. */
7605 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7606 fprintf(fp, "Bcc: %s\n", bcc);
7608 /* The texts for the message can be read from a template file; if there
7609 isn't one, or if it is too short, built-in texts are used. The first
7610 emf text is a Subject: and any other headers. */
7612 if ((emf_text = next_emf(emf, US"header")))
7613 fprintf(fp, "%s\n", emf_text);
7615 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7616 to_sender? ": returning message to sender" : "");
7618 /* output human readable part as text/plain section */
7619 fprintf(fp, "--%s\n"
7620 "Content-type: text/plain; charset=us-ascii\n\n",
7623 if ((emf_text = next_emf(emf, US"intro")))
7624 fprintf(fp, "%s", CS emf_text);
7628 /* This message has been reworded several times. It seems to be confusing to
7629 somebody, however it is worded. I have retreated to the original, simple
7631 "This message was created automatically by mail delivery software.\n");
7633 if (bounce_message_text)
7634 fprintf(fp, "%s", CS bounce_message_text);
7637 "\nA message that you sent could not be delivered to one or more of its\n"
7638 "recipients. This is a permanent error. The following address(es) failed:\n");
7641 "\nA message sent by\n\n <%s>\n\n"
7642 "could not be delivered to one or more of its recipients. The following\n"
7643 "address(es) failed:\n", sender_address);
7647 /* Process the addresses, leaving them on the msgchain if they have a
7648 file name for a return message. (There has already been a check in
7649 post_process_one() for the existence of data in the message file.) A TRUE
7650 return from print_address_information() means that the address is not
7654 for (addr = msgchain; addr; addr = *paddr)
7656 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7657 print_address_error(addr, fp, US"");
7659 /* End the final line for the address */
7663 /* Leave on msgchain if there's a return file. */
7665 if (addr->return_file >= 0)
7667 paddr = &(addr->next);
7671 /* Else save so that we can tick off the recipient when the
7676 *paddr = addr->next;
7677 addr->next = handled_addr;
7678 handled_addr = addr;
7684 /* Get the next text, whether we need it or not, so as to be
7685 positioned for the one after. */
7687 emf_text = next_emf(emf, US"generated text");
7689 /* If there were any file messages passed by the local transports,
7690 include them in the message. Then put the address on the handled chain.
7691 In the case of a batch of addresses that were all sent to the same
7692 transport, the return_file field in all of them will contain the same
7693 fd, and the return_filename field in the *last* one will be set (to the
7694 name of the file). */
7698 address_item *nextaddr;
7701 fprintf(fp, "%s", CS emf_text);
7704 "The following text was generated during the delivery "
7705 "attempt%s:\n", (filecount > 1)? "s" : "");
7707 for (addr = msgchain; addr; addr = nextaddr)
7710 address_item *topaddr = addr;
7712 /* List all the addresses that relate to this file */
7715 while(addr) /* Insurance */
7717 print_address_information(addr, fp, US"------ ", US"\n ",
7719 if (addr->return_filename) break;
7724 /* Now copy the file */
7726 if (!(fm = Ufopen(addr->return_filename, "rb")))
7727 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7731 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7734 Uunlink(addr->return_filename);
7736 /* Can now add to handled chain, first fishing off the next
7737 address on the msgchain. */
7739 nextaddr = addr->next;
7740 addr->next = handled_addr;
7741 handled_addr = topaddr;
7746 /* output machine readable part */
7748 if (message_smtputf8)
7749 fprintf(fp, "--%s\n"
7750 "Content-type: message/global-delivery-status\n\n"
7751 "Reporting-MTA: dns; %s\n",
7752 bound, smtp_active_hostname);
7755 fprintf(fp, "--%s\n"
7756 "Content-type: message/delivery-status\n\n"
7757 "Reporting-MTA: dns; %s\n",
7758 bound, smtp_active_hostname);
7762 /* must be decoded from xtext: see RFC 3461:6.3a */
7764 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7765 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7767 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7771 for (addr = handled_addr; addr; addr = addr->next)
7774 fprintf(fp, "Action: failed\n"
7775 "Final-Recipient: rfc822;%s\n"
7778 if ((hu = addr->host_used) && hu->name)
7780 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7781 #ifdef EXPERIMENTAL_DSN_INFO
7786 uschar * p = hu->port == 25
7787 ? US"" : string_sprintf(":%d", hu->port);
7788 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7790 if ((s = addr->smtp_greeting) && *s)
7791 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7792 if ((s = addr->helo_response) && *s)
7793 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7794 if ((s = addr->message) && *s)
7795 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7798 print_dsn_diagnostic_code(addr, fp);
7803 /* Now copy the message, trying to give an intelligible comment if
7804 it is too long for it all to be copied. The limit isn't strictly
7805 applied because of the buffering. There is, however, an option
7806 to suppress copying altogether. */
7808 emf_text = next_emf(emf, US"copy");
7811 we ignore the intro text from template and add
7812 the text for bounce_return_size_limit at the end.
7814 bounce_return_message is ignored
7815 in case RET= is defined we honor these values
7816 otherwise bounce_return_body is honored.
7818 bounce_return_size_limit is always honored.
7821 fprintf(fp, "--%s\n", bound);
7823 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7824 dsnnotifyhdr = NULL;
7825 topt = topt_add_return_path;
7827 /* RET=HDRS? top priority */
7828 if (dsn_ret == dsn_ret_hdrs)
7829 topt |= topt_no_body;
7832 struct stat statbuf;
7834 /* no full body return at all? */
7835 if (!bounce_return_body)
7837 topt |= topt_no_body;
7838 /* add header if we overrule RET=FULL */
7839 if (dsn_ret == dsn_ret_full)
7840 dsnnotifyhdr = dsnlimitmsg;
7842 /* line length limited... return headers only if oversize */
7843 /* size limited ... return headers only if limit reached */
7844 else if ( max_received_linelength > bounce_return_linesize_limit
7845 || ( bounce_return_size_limit > 0
7846 && fstat(deliver_datafile, &statbuf) == 0
7847 && statbuf.st_size > max
7850 topt |= topt_no_body;
7851 dsnnotifyhdr = dsnlimitmsg;
7856 if (message_smtputf8)
7857 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7858 : "Content-type: message/global\n\n",
7862 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7863 : "Content-type: message/rfc822\n\n",
7867 transport_filter_argv = NULL; /* Just in case */
7868 return_path = sender_address; /* In case not previously set */
7869 { /* Dummy transport for headers add */
7870 transport_ctx tctx = {{0}};
7871 transport_instance tb = {0};
7873 tctx.u.fd = fileno(fp);
7875 tctx.options = topt;
7876 tb.add_headers = dsnnotifyhdr;
7878 /*XXX no checking for failure! buggy! */
7879 transport_write_message(&tctx, 0);
7883 /* we never add the final text. close the file */
7887 fprintf(fp, "\n--%s--\n", bound);
7889 /* Close the file, which should send an EOF to the child process
7890 that is receiving the message. Wait for it to finish. */
7893 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7895 /* In the test harness, let the child do it's thing first. */
7897 if (f.running_in_test_harness) millisleep(500);
7899 /* If the process failed, there was some disaster in setting up the
7900 error message. Unless the message is very old, ensure that addr_defer
7901 is non-null, which will have the effect of leaving the message on the
7902 spool. The failed addresses will get tried again next time. However, we
7903 don't really want this to happen too often, so freeze the message unless
7904 there are some genuine deferred addresses to try. To do this we have
7905 to call spool_write_header() here, because with no genuine deferred
7906 addresses the normal code below doesn't get run. */
7911 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7913 addr_defer = (address_item *)(+1);
7914 f.deliver_freeze = TRUE;
7915 deliver_frozen_at = time(NULL);
7916 /* Panic-dies on error */
7917 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7920 deliver_msglog("Process failed (%d) when writing error message "
7921 "to %s%s", rc, bounce_recipient, s);
7922 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7923 "to %s%s", rc, bounce_recipient, s);
7926 /* The message succeeded. Ensure that the recipients that failed are
7927 now marked finished with on the spool and their parents updated. */
7931 for (addr = handled_addr; addr; addr = addr->next)
7933 address_done(addr, logtod);
7934 child_done(addr, logtod);
7936 /* Panic-dies on error */
7937 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7943 f.disable_logging = FALSE; /* In case left set */
7945 /* Come here from the mua_wrapper case if routing goes wrong */
7949 /* If there are now no deferred addresses, we are done. Preserve the
7950 message log if so configured, and we are using them. Otherwise, sling it.
7951 Then delete the message itself. */
7959 fname = spool_fname(US"msglog", message_subdir, id, US"");
7960 if (preserve_message_logs)
7963 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7965 if ((rc = Urename(fname, moname)) < 0)
7967 (void)directory_make(spool_directory,
7968 spool_sname(US"msglog.OLD", US""),
7969 MSGLOG_DIRECTORY_MODE, TRUE);
7970 rc = Urename(fname, moname);
7973 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7974 "msglog.OLD directory", fname);
7977 if (Uunlink(fname) < 0)
7978 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7979 fname, strerror(errno));
7982 /* Remove the two message files. */
7984 fname = spool_fname(US"input", message_subdir, id, US"-D");
7985 if (Uunlink(fname) < 0)
7986 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7987 fname, strerror(errno));
7988 fname = spool_fname(US"input", message_subdir, id, US"-H");
7989 if (Uunlink(fname) < 0)
7990 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7991 fname, strerror(errno));
7993 /* Log the end of this message, with queue time if requested. */
7995 if (LOGGING(queue_time_overall))
7996 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
7998 log_write(0, LOG_MAIN, "Completed");
8000 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8001 f.deliver_freeze = FALSE;
8003 #ifndef DISABLE_EVENT
8004 (void) event_raise(event_action, US"msg:complete", NULL);
8008 /* If there are deferred addresses, we are keeping this message because it is
8009 not yet completed. Lose any temporary files that were catching output from
8010 pipes for any of the deferred addresses, handle one-time aliases, and see if
8011 the message has been on the queue for so long that it is time to send a warning
8012 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8013 have the same domain, we can set deliver_domain for the expansion of
8014 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8015 the parent's domain.
8017 If all the deferred addresses have an error number that indicates "retry time
8018 not reached", skip sending the warning message, because it won't contain the
8019 reason for the delay. It will get sent at the next real delivery attempt.
8020 However, if at least one address has tried, we'd better include all of them in
8023 If we can't make a process to send the message, don't worry.
8025 For mailing list expansions we want to send the warning message to the
8026 mailing list manager. We can't do a perfect job here, as some addresses may
8027 have different errors addresses, but if we take the errors address from
8028 each deferred address it will probably be right in most cases.
8030 If addr_defer == +1, it means there was a problem sending an error message
8031 for failed addresses, and there were no "real" deferred addresses. The value
8032 was set just to keep the message on the spool, so there is nothing to do here.
8035 else if (addr_defer != (address_item *)(+1))
8038 uschar *recipients = US"";
8039 BOOL delivery_attempted = FALSE;
8041 deliver_domain = testflag(addr_defer, af_pfr)
8042 ? addr_defer->parent->domain : addr_defer->domain;
8044 for (addr = addr_defer; addr; addr = addr->next)
8046 address_item *otaddr;
8048 if (addr->basic_errno > ERRNO_RETRY_BASE) delivery_attempted = TRUE;
8052 const uschar *d = testflag(addr, af_pfr)
8053 ? addr->parent->domain : addr->domain;
8055 /* The domain may be unset for an address that has never been routed
8056 because the system filter froze the message. */
8058 if (!d || Ustrcmp(d, deliver_domain) != 0)
8059 deliver_domain = NULL;
8062 if (addr->return_filename) Uunlink(addr->return_filename);
8064 /* Handle the case of one-time aliases. If any address in the ancestry
8065 of this one is flagged, ensure it is in the recipients list, suitably
8066 flagged, and that its parent is marked delivered. */
8068 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8069 if (otaddr->onetime_parent) break;
8074 int t = recipients_count;
8076 for (i = 0; i < recipients_count; i++)
8078 uschar *r = recipients_list[i].address;
8079 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8080 if (Ustrcmp(otaddr->address, r) == 0) break;
8083 /* Didn't find the address already in the list, and did find the
8084 ultimate parent's address in the list, and they really are different
8085 (i.e. not from an identity-redirect). After adding the recipient,
8086 update the errors address in the recipients list. */
8088 if ( i >= recipients_count && t < recipients_count
8089 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8091 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8092 otaddr->address, otaddr->parent->address);
8093 receive_add_recipient(otaddr->address, t);
8094 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8095 tree_add_nonrecipient(otaddr->parent->address);
8096 update_spool = TRUE;
8100 /* Except for error messages, ensure that either the errors address for
8101 this deferred address or, if there is none, the sender address, is on the
8102 list of recipients for a warning message. */
8104 if (sender_address[0])
8106 uschar * s = addr->prop.errors_address;
8107 if (!s) s = sender_address;
8108 if (Ustrstr(recipients, s) == NULL)
8109 recipients = string_sprintf("%s%s%s", recipients,
8110 recipients[0] ? "," : "", s);
8114 /* Send a warning message if the conditions are right. If the condition check
8115 fails because of a lookup defer, there is nothing we can do. The warning
8116 is not sent. Another attempt will be made at the next delivery attempt (if
8119 if ( !f.queue_2stage
8120 && delivery_attempted
8121 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8122 || addr_defer->dsn_flags & rf_notify_delay
8124 && delay_warning[1] > 0
8125 && sender_address[0] != 0
8126 && ( !delay_warning_condition
8127 || expand_check_condition(delay_warning_condition,
8128 US"delay_warning", US"option")
8134 int queue_time = time(NULL) - received_time.tv_sec;
8136 /* When running in the test harness, there's an option that allows us to
8137 fudge this time so as to get repeatability of the tests. Take the first
8138 time off the list. In queue runs, the list pointer gets updated in the
8141 if (f.running_in_test_harness && fudged_queue_times[0] != 0)
8143 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8146 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8147 fudged_queue_times);
8152 /* See how many warnings we should have sent by now */
8154 for (count = 0; count < delay_warning[1]; count++)
8155 if (queue_time < delay_warning[count+2]) break;
8157 show_time = delay_warning[count+1];
8159 if (count >= delay_warning[1])
8162 int last_gap = show_time;
8163 if (count > 1) last_gap -= delay_warning[count];
8164 extra = (queue_time - delay_warning[count+1])/last_gap;
8165 show_time += last_gap * extra;
8171 debug_printf("time on queue = %s\n", readconf_printtime(queue_time));
8172 debug_printf("warning counts: required %d done %d\n", count,
8176 /* We have computed the number of warnings there should have been by now.
8177 If there haven't been enough, send one, and up the count to what it should
8180 if (warning_count < count)
8184 pid_t pid = child_open_exim(&fd);
8190 FILE *f = fdopen(fd, "wb");
8192 transport_ctx tctx = {{0}};
8194 if (warn_message_file)
8195 if (!(wmf = Ufopen(warn_message_file, "rb")))
8196 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8197 "message texts: %s", warn_message_file, strerror(errno));
8199 warnmsg_recipients = recipients;
8200 warnmsg_delay = queue_time < 120*60
8201 ? string_sprintf("%d minutes", show_time/60)
8202 : string_sprintf("%d hours", show_time/3600);
8204 if (errors_reply_to)
8205 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8206 fprintf(f, "Auto-Submitted: auto-replied\n");
8208 fprintf(f, "To: %s\n", recipients);
8210 /* generated boundary string and output MIME-Headers */
8211 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8213 fprintf(f, "Content-Type: multipart/report;"
8214 " report-type=delivery-status; boundary=%s\n"
8215 "MIME-Version: 1.0\n",
8218 if ((wmf_text = next_emf(wmf, US"header")))
8219 fprintf(f, "%s\n", wmf_text);
8221 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8222 message_id, warnmsg_delay);
8224 /* output human readable part as text/plain section */
8226 "Content-type: text/plain; charset=us-ascii\n\n",
8229 if ((wmf_text = next_emf(wmf, US"intro")))
8230 fprintf(f, "%s", CS wmf_text);
8234 "This message was created automatically by mail delivery software.\n");
8236 if (Ustrcmp(recipients, sender_address) == 0)
8238 "A message that you sent has not yet been delivered to one or more of its\n"
8239 "recipients after more than ");
8243 "A message sent by\n\n <%s>\n\n"
8244 "has not yet been delivered to one or more of its recipients after more than \n",
8247 fprintf(f, "%s on the queue on %s.\n\n"
8248 "The message identifier is: %s\n",
8249 warnmsg_delay, primary_hostname, message_id);
8251 for (h = header_list; h; h = h->next)
8252 if (strncmpic(h->text, US"Subject:", 8) == 0)
8253 fprintf(f, "The subject of the message is: %s", h->text + 9);
8254 else if (strncmpic(h->text, US"Date:", 5) == 0)
8255 fprintf(f, "The date of the message is: %s", h->text + 6);
8258 fprintf(f, "The address%s to which the message has not yet been "
8260 !addr_defer->next ? "" : "es",
8261 !addr_defer->next ? "is": "are");
8264 /* List the addresses, with error information if allowed */
8266 /* store addr_defer for machine readable part */
8267 address_item *addr_dsndefer = addr_defer;
8271 address_item *addr = addr_defer;
8272 addr_defer = addr->next;
8273 if (print_address_information(addr, f, US" ", US"\n ", US""))
8274 print_address_error(addr, f, US"Delay reason: ");
8283 if ((wmf_text = next_emf(wmf, US"final")))
8284 fprintf(f, "%s", CS wmf_text);
8290 "No action is required on your part. Delivery attempts will continue for\n"
8291 "some time, and this warning may be repeated at intervals if the message\n"
8292 "remains undelivered. Eventually the mail delivery software will give up,\n"
8293 "and when that happens, the message will be returned to you.\n");
8296 /* output machine readable part */
8297 fprintf(f, "\n--%s\n"
8298 "Content-type: message/delivery-status\n\n"
8299 "Reporting-MTA: dns; %s\n",
8301 smtp_active_hostname);
8306 /* must be decoded from xtext: see RFC 3461:6.3a */
8308 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8309 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8311 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8315 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8317 if (addr_dsndefer->dsn_orcpt)
8318 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8320 fprintf(f, "Action: delayed\n"
8321 "Final-Recipient: rfc822;%s\n"
8323 addr_dsndefer->address);
8324 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8326 fprintf(f, "Remote-MTA: dns; %s\n",
8327 addr_dsndefer->host_used->name);
8328 print_dsn_diagnostic_code(addr_dsndefer, f);
8334 "Content-type: text/rfc822-headers\n\n",
8338 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8339 tctx.u.fd = fileno(f);
8340 tctx.options = topt_add_return_path | topt_no_body;
8341 transport_filter_argv = NULL; /* Just in case */
8342 return_path = sender_address; /* In case not previously set */
8344 /* Write the original email out */
8345 /*XXX no checking for failure! buggy! */
8346 transport_write_message(&tctx, 0);
8349 fprintf(f,"\n--%s--\n", bound);
8353 /* Close and wait for child process to complete, without a timeout.
8354 If there's an error, don't update the count. */
8357 if (child_close(pid, 0) == 0)
8359 warning_count = count;
8360 update_spool = TRUE; /* Ensure spool rewritten */
8366 /* Clear deliver_domain */
8368 deliver_domain = NULL;
8370 /* If this was a first delivery attempt, unset the first time flag, and
8371 ensure that the spool gets updated. */
8373 if (f.deliver_firsttime)
8375 f.deliver_firsttime = FALSE;
8376 update_spool = TRUE;
8379 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8380 message, unless the message is a local error message (to avoid loops). Then
8381 log the freezing. If the text in "frozen_info" came from a system filter,
8382 it has been escaped into printing characters so as not to mess up log lines.
8383 For the "tell" message, we turn \n back into newline. Also, insert a newline
8384 near the start instead of the ": " string. */
8386 if (f.deliver_freeze)
8388 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8390 uschar *s = string_copy(frozen_info);
8391 uschar *ss = Ustrstr(s, " by the system filter: ");
8402 if (*ss == '\\' && ss[1] == 'n')
8409 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8410 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8414 /* Log freezing just before we update the -H file, to minimize the chance
8415 of a race problem. */
8417 deliver_msglog("*** Frozen%s\n", frozen_info);
8418 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8421 /* If there have been any updates to the non-recipients list, or other things
8422 that get written to the spool, we must now update the spool header file so
8423 that it has the right information for the next delivery attempt. If there
8424 was more than one address being delivered, the header_change update is done
8425 earlier, in case one succeeds and then something crashes. */
8428 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8429 update_spool, f.header_rewritten);
8431 if (update_spool || f.header_rewritten)
8432 /* Panic-dies on error */
8433 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8436 /* Finished with the message log. If the message is complete, it will have
8437 been unlinked or renamed above. */
8439 if (message_logs) (void)fclose(message_log);
8441 /* Now we can close and remove the journal file. Its only purpose is to record
8442 successfully completed deliveries asap so that this information doesn't get
8443 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8444 not serious, as trying it again is not harmful. The journal might not be open
8445 if all addresses were deferred at routing or directing. Nevertheless, we must
8446 remove it if it exists (may have been lying around from a crash during the
8447 previous delivery attempt). We don't remove the journal if a delivery
8448 subprocess failed to pass back delivery information; this is controlled by
8449 the remove_journal flag. When the journal is left, we also don't move the
8450 message off the main spool if frozen and the option is set. It should get moved
8451 at the next attempt, after the journal has been inspected. */
8453 if (journal_fd >= 0) (void)close(journal_fd);
8457 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8459 if (Uunlink(fname) < 0 && errno != ENOENT)
8460 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8463 /* Move the message off the spool if requested */
8465 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8466 if (f.deliver_freeze && move_frozen_messages)
8467 (void)spool_move_message(id, message_subdir, US"", US"F");
8471 /* Closing the data file frees the lock; if the file has been unlinked it
8472 will go away. Otherwise the message becomes available for another process
8475 (void)close(deliver_datafile);
8476 deliver_datafile = -1;
8477 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8479 /* It is unlikely that there will be any cached resources, since they are
8480 released after routing, and in the delivery subprocesses. However, it's
8481 possible for an expansion for something afterwards (for example,
8482 expand_check_condition) to do a lookup. We must therefore be sure everything is
8486 acl_where = ACL_WHERE_UNKNOWN;
8495 #ifdef EXIM_TFO_PROBE
8498 f.tcp_fastopen_ok = TRUE;
8502 if (!regex_PIPELINING) regex_PIPELINING =
8503 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8505 if (!regex_SIZE) regex_SIZE =
8506 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8508 if (!regex_AUTH) regex_AUTH =
8509 regex_must_compile(AUTHS_REGEX, FALSE, TRUE);
8512 if (!regex_STARTTLS) regex_STARTTLS =
8513 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8515 # ifdef EXPERIMENTAL_REQUIRETLS
8516 if (!regex_REQUIRETLS) regex_REQUIRETLS =
8517 regex_must_compile(US"\\n250[\\s\\-]REQUIRETLS(\\s|\\n|$)", FALSE, TRUE);
8521 if (!regex_CHUNKING) regex_CHUNKING =
8522 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8524 #ifndef DISABLE_PRDR
8525 if (!regex_PRDR) regex_PRDR =
8526 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8530 if (!regex_UTF8) regex_UTF8 =
8531 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8534 if (!regex_DSN) regex_DSN =
8535 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8537 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8538 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8540 #ifdef EXPERIMENTAL_PIPE_CONNECT
8541 if (!regex_EARLY_PIPE) regex_EARLY_PIPE =
8542 regex_must_compile(US"\\n250[\\s\\-]" EARLY_PIPE_FEATURE_NAME "(\\s|\\n|$)", FALSE, TRUE);
8548 deliver_get_sender_address (uschar * id)
8551 uschar * new_sender_address,
8552 * save_sender_address;
8553 BOOL save_qr = f.queue_running;
8556 /* make spool_open_datafile non-noisy on fail */
8558 f.queue_running = TRUE;
8560 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8562 deliver_datafile = spool_open_datafile(id);
8563 f.queue_running = save_qr;
8564 if (deliver_datafile < 0)
8567 /* Save and restore the global sender_address. I'm not sure if we should
8568 not save/restore all the other global variables too, because
8569 spool_read_header() may change all of them. But OTOH, when this
8570 deliver_get_sender_address() gets called, the current message is done
8571 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8573 spoolname = string_sprintf("%s-H", id);
8574 save_sender_address = sender_address;
8576 rc = spool_read_header(spoolname, TRUE, TRUE);
8578 new_sender_address = sender_address;
8579 sender_address = save_sender_address;
8581 if (rc != spool_read_OK)
8584 assert(new_sender_address);
8586 (void)close(deliver_datafile);
8587 deliver_datafile = -1;
8589 return new_sender_address;
8595 delivery_re_exec(int exec_type)
8599 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8601 int channel_fd = cutthrough.cctx.sock;
8603 smtp_peer_options = cutthrough.peer_options;
8604 continue_sequence = 0;
8607 if (cutthrough.is_tls)
8611 smtp_peer_options |= OPTION_TLS;
8612 sending_ip_address = cutthrough.snd_ip;
8613 sending_port = cutthrough.snd_port;
8615 where = US"socketpair";
8616 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8620 if ((pid = fork()) < 0)
8623 else if (pid == 0) /* child: fork again to totally disconnect */
8625 if (f.running_in_test_harness) millisleep(100); /* let parent debug out */
8626 /* does not return */
8627 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8631 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8633 waitpid(pid, NULL, 0);
8634 (void) close(channel_fd); /* release the client socket */
8635 channel_fd = pfd[1];
8639 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8640 cutthrough.host.address, message_id, channel_fd);
8644 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8645 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8647 return; /* compiler quietening; control does not reach here. */
8652 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8653 "delivery re-exec %s failed: %s", where, strerror(errno));
8655 /* Get here if exec_type == CEE_EXEC_EXIT.
8656 Note: this must be _exit(), not exit(). */
8658 _exit(EX_EXECFAILED);
8664 /* End of deliver.c */