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. */
287 if (testflag(addr, af_pfr))
289 if (testflag(addr, af_file)) address_file = addr->local_part;
290 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
292 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
294 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
295 deliver_domain = NULL;
297 && ( !addr2->self_hostname
298 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
300 self_hostname = NULL;
301 if (!deliver_domain && !self_hostname) break;
309 /*************************************************
310 * Open a msglog file *
311 *************************************************/
313 /* This function is used both for normal message logs, and for files in the
314 msglog directory that are used to catch output from pipes. Try to create the
315 directory if it does not exist. From release 4.21, normal message logs should
316 be created when the message is received.
318 Called from deliver_message(), can be operating as root.
321 filename the file name
322 mode the mode required
323 error used for saying what failed
325 Returns: a file descriptor, or -1 (with errno set)
329 open_msglog_file(uschar *filename, int mode, uschar **error)
331 for (int i = 2; i > 0; i--)
333 int fd = Uopen(filename,
340 O_WRONLY|O_APPEND|O_CREAT, mode);
343 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
344 function is called as root). Double check the mode, because the group setting
345 doesn't always get set automatically. */
348 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
350 if (fchown(fd, exim_uid, exim_gid) < 0)
355 if (fchmod(fd, mode) < 0)
365 (void)directory_make(spool_directory,
366 spool_sname(US"msglog", message_subdir),
367 MSGLOG_DIRECTORY_MODE, TRUE);
377 /*************************************************
378 * Write to msglog if required *
379 *************************************************/
381 /* Write to the message log, if configured. This function may also be called
385 format a string format
391 deliver_msglog(const char *format, ...)
394 if (!message_logs) return;
395 va_start(ap, format);
396 vfprintf(message_log, format, ap);
404 /*************************************************
405 * Replicate status for batch *
406 *************************************************/
408 /* When a transport handles a batch of addresses, it may treat them
409 individually, or it may just put the status in the first one, and return FALSE,
410 requesting that the status be copied to all the others externally. This is the
411 replication function. As well as the status, it copies the transport pointer,
412 which may have changed if appendfile passed the addresses on to a different
415 Argument: pointer to the first address in a chain
420 replicate_status(address_item *addr)
422 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
424 addr2->transport = addr->transport;
425 addr2->transport_return = addr->transport_return;
426 addr2->basic_errno = addr->basic_errno;
427 addr2->more_errno = addr->more_errno;
428 addr2->delivery_usec = addr->delivery_usec;
429 addr2->special_action = addr->special_action;
430 addr2->message = addr->message;
431 addr2->user_message = addr->user_message;
437 /*************************************************
438 * Compare lists of hosts *
439 *************************************************/
441 /* This function is given two pointers to chains of host items, and it yields
442 TRUE if the lists refer to the same hosts in the same order, except that
444 (1) Multiple hosts with the same non-negative MX values are permitted to appear
445 in different orders. Round-robinning nameservers can cause this to happen.
447 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
448 permitted to appear in different orders. This is caused by randomizing
451 This enables Exim to use a single SMTP transaction for sending to two entirely
452 different domains that happen to end up pointing at the same hosts.
455 one points to the first host list
456 two points to the second host list
458 Returns: TRUE if the lists refer to the same host set
462 same_hosts(host_item *one, host_item *two)
466 if (Ustrcmp(one->name, two->name) != 0)
469 host_item *end_one = one;
470 host_item *end_two = two;
472 /* Batch up only if there was no MX and the list was not randomized */
474 if (mx == MX_NONE) return FALSE;
476 /* Find the ends of the shortest sequence of identical MX values */
478 while ( end_one->next && end_one->next->mx == mx
479 && end_two->next && end_two->next->mx == mx)
481 end_one = end_one->next;
482 end_two = end_two->next;
485 /* If there aren't any duplicates, there's no match. */
487 if (end_one == one) return FALSE;
489 /* For each host in the 'one' sequence, check that it appears in the 'two'
490 sequence, returning FALSE if not. */
495 for (hi = two; hi != end_two->next; hi = hi->next)
496 if (Ustrcmp(one->name, hi->name) == 0) break;
497 if (hi == end_two->next) return FALSE;
498 if (one == end_one) break;
502 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
503 Ensure both are pointing at the last host, and carry on as for equality. */
508 /* if the names matched but ports do not, mismatch */
509 else if (one->port != two->port)
518 /* True if both are NULL */
525 /*************************************************
526 * Compare header lines *
527 *************************************************/
529 /* This function is given two pointers to chains of header items, and it yields
530 TRUE if they are the same header texts in the same order.
533 one points to the first header list
534 two points to the second header list
536 Returns: TRUE if the lists refer to the same header set
540 same_headers(header_line *one, header_line *two)
542 for (;; one = one->next, two = two->next)
544 if (one == two) return TRUE; /* Includes the case where both NULL */
545 if (!one || !two) return FALSE;
546 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
552 /*************************************************
553 * Compare string settings *
554 *************************************************/
556 /* This function is given two pointers to strings, and it returns
557 TRUE if they are the same pointer, or if the two strings are the same.
560 one points to the first string
561 two points to the second string
563 Returns: TRUE or FALSE
567 same_strings(uschar *one, uschar *two)
569 if (one == two) return TRUE; /* Includes the case where both NULL */
570 if (!one || !two) return FALSE;
571 return (Ustrcmp(one, two) == 0);
576 /*************************************************
577 * Compare uid/gid for addresses *
578 *************************************************/
580 /* This function is given a transport and two addresses. It yields TRUE if the
581 uid/gid/initgroups settings for the two addresses are going to be the same when
586 addr1 the first address
587 addr2 the second address
589 Returns: TRUE or FALSE
593 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
595 if ( !tp->uid_set && !tp->expand_uid
596 && !tp->deliver_as_creator
597 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
598 || ( testflag(addr1, af_uid_set)
599 && ( addr1->uid != addr2->uid
600 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
604 if ( !tp->gid_set && !tp->expand_gid
605 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
606 || ( testflag(addr1, af_gid_set)
607 && addr1->gid != addr2->gid
617 /*************************************************
618 * Record that an address is complete *
619 *************************************************/
621 /* This function records that an address is complete. This is straightforward
622 for most addresses, where the unique address is just the full address with the
623 domain lower cased. For homonyms (addresses that are the same as one of their
624 ancestors) their are complications. Their unique addresses have \x\ prepended
625 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
628 Exim used to record the unique addresses of homonyms as "complete". This,
629 however, fails when the pattern of redirection varies over time (e.g. if taking
630 unseen copies at only some times of day) because the prepended numbers may vary
631 from one delivery run to the next. This problem is solved by never recording
632 prepended unique addresses as complete. Instead, when a homonymic address has
633 actually been delivered via a transport, we record its basic unique address
634 followed by the name of the transport. This is checked in subsequent delivery
635 runs whenever an address is routed to a transport.
637 If the completed address is a top-level one (has no parent, which means it
638 cannot be homonymic) we also add the original address to the non-recipients
639 tree, so that it gets recorded in the spool file and therefore appears as
640 "done" in any spool listings. The original address may differ from the unique
641 address in the case of the domain.
643 Finally, this function scans the list of duplicates, marks as done any that
644 match this address, and calls child_done() for their ancestors.
647 addr address item that has been completed
648 now current time as a string
654 address_done(address_item *addr, uschar *now)
656 update_spool = TRUE; /* Ensure spool gets updated */
658 /* Top-level address */
662 tree_add_nonrecipient(addr->unique);
663 tree_add_nonrecipient(addr->address);
666 /* Homonymous child address */
668 else if (testflag(addr, af_homonym))
671 tree_add_nonrecipient(
672 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
675 /* Non-homonymous child address */
677 else tree_add_nonrecipient(addr->unique);
679 /* Check the list of duplicate addresses and ensure they are now marked
682 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
683 if (Ustrcmp(addr->unique, dup->unique) == 0)
685 tree_add_nonrecipient(dup->unique);
686 child_done(dup, now);
693 /*************************************************
694 * Decrease counts in parents and mark done *
695 *************************************************/
697 /* This function is called when an address is complete. If there is a parent
698 address, its count of children is decremented. If there are still other
699 children outstanding, the function exits. Otherwise, if the count has become
700 zero, address_done() is called to mark the parent and its duplicates complete.
701 Then loop for any earlier ancestors.
704 addr points to the completed address item
705 now the current time as a string, for writing to the message log
711 child_done(address_item *addr, uschar *now)
718 if (--addr->child_count > 0) return; /* Incomplete parent */
719 address_done(addr, now);
721 /* Log the completion of all descendents only when there is no ancestor with
722 the same original address. */
724 for (aa = addr->parent; aa; aa = aa->parent)
725 if (Ustrcmp(aa->address, addr->address) == 0) break;
728 deliver_msglog("%s %s: children all complete\n", now, addr->address);
729 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
735 /*************************************************
736 * Delivery logging support functions *
737 *************************************************/
739 /* The LOGGING() checks in d_log_interface() are complicated for backwards
740 compatibility. When outgoing interface logging was originally added, it was
741 conditional on just incoming_interface (which is off by default). The
742 outgoing_interface option is on by default to preserve this behaviour, but
743 you can enable incoming_interface and disable outgoing_interface to get I=
744 fields on incoming lines only.
748 addr The address to be logged
750 Returns: New value for s
754 d_log_interface(gstring * g)
756 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
757 && sending_ip_address)
759 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
760 if (LOGGING(outgoing_port))
761 g = string_fmt_append(g, "%d", sending_port);
769 d_hostlog(gstring * g, address_item * addr)
771 host_item * h = addr->host_used;
773 g = string_append(g, 2, US" H=", h->name);
775 if (LOGGING(dnssec) && h->dnssec == DS_YES)
776 g = string_catn(g, US" DS", 3);
778 g = string_append(g, 3, US" [", h->address, US"]");
780 if (LOGGING(outgoing_port))
781 g = string_fmt_append(g, ":%d", h->port);
784 if (LOGGING(proxy) && proxy_local_address)
786 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
787 if (LOGGING(outgoing_port))
788 g = string_fmt_append(g, ":%d", proxy_local_port);
792 g = d_log_interface(g);
794 if (testflag(addr, af_tcp_fastopen))
795 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
806 d_tlslog(gstring * s, address_item * addr)
808 if (LOGGING(tls_cipher) && addr->cipher)
809 s = string_append(s, 2, US" X=", addr->cipher);
810 if (LOGGING(tls_certificate_verified) && addr->cipher)
811 s = string_append(s, 2, US" CV=",
812 testflag(addr, af_cert_verified)
815 testflag(addr, af_dane_verified)
821 if (LOGGING(tls_peerdn) && addr->peerdn)
822 s = string_append(s, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
830 #ifndef DISABLE_EVENT
832 event_raise(uschar * action, const uschar * event, uschar * ev_data)
838 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
840 action, deliver_host_address);
843 event_data = ev_data;
845 if (!(s = expand_string(action)) && *expand_string_message)
846 log_write(0, LOG_MAIN|LOG_PANIC,
847 "failed to expand event_action %s in %s: %s\n",
848 event, transport_name ? transport_name : US"main", expand_string_message);
850 event_name = event_data = NULL;
852 /* If the expansion returns anything but an empty string, flag for
853 the caller to modify his normal processing
858 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
866 msg_event_raise(const uschar * event, const address_item * addr)
868 const uschar * save_domain = deliver_domain;
869 uschar * save_local = deliver_localpart;
870 const uschar * save_host = deliver_host;
871 const uschar * save_address = deliver_host_address;
872 const int save_port = deliver_host_port;
874 router_name = addr->router ? addr->router->name : NULL;
875 deliver_domain = addr->domain;
876 deliver_localpart = addr->local_part;
877 deliver_host = addr->host_used ? addr->host_used->name : NULL;
879 if (!addr->transport)
881 if (Ustrcmp(event, "msg:fail:delivery") == 0)
883 /* An address failed with no transport involved. This happens when
884 a filter was used which triggered a fail command (in such a case
885 a transport isn't needed). Convert it to an internal fail event. */
887 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
892 transport_name = addr->transport->name;
894 (void) event_raise(addr->transport->event_action, event,
896 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
897 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
898 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
899 ? addr->message : NULL);
902 deliver_host_port = save_port;
903 deliver_host_address = save_address;
904 deliver_host = save_host;
905 deliver_localpart = save_local;
906 deliver_domain = save_domain;
907 router_name = transport_name = NULL;
909 #endif /*DISABLE_EVENT*/
913 /******************************************************************************/
916 /*************************************************
917 * Generate local prt for logging *
918 *************************************************/
920 /* This function is a subroutine for use in string_log_address() below.
923 addr the address being logged
924 yield the current dynamic buffer pointer
926 Returns: the new value of the buffer pointer
930 string_get_localpart(address_item * addr, gstring * yield)
935 if (testflag(addr, af_include_affixes) && s)
938 if (testflag(addr, af_utf8_downcvt))
939 s = string_localpart_utf8_to_alabel(s, NULL);
941 yield = string_cat(yield, s);
944 s = addr->local_part;
946 if (testflag(addr, af_utf8_downcvt))
947 s = string_localpart_utf8_to_alabel(s, NULL);
949 yield = string_cat(yield, s);
952 if (testflag(addr, af_include_affixes) && s)
955 if (testflag(addr, af_utf8_downcvt))
956 s = string_localpart_utf8_to_alabel(s, NULL);
958 yield = string_cat(yield, s);
965 /*************************************************
966 * Generate log address list *
967 *************************************************/
969 /* This function generates a list consisting of an address and its parents, for
970 use in logging lines. For saved onetime aliased addresses, the onetime parent
971 field is used. If the address was delivered by a transport with rcpt_include_
972 affixes set, the af_include_affixes bit will be set in the address. In that
973 case, we include the affixes here too.
976 g points to growing-string struct
977 addr bottom (ultimate) address
978 all_parents if TRUE, include all parents
979 success TRUE for successful delivery
981 Returns: a growable string in dynamic store
985 string_log_address(gstring * g,
986 address_item *addr, BOOL all_parents, BOOL success)
988 BOOL add_topaddr = TRUE;
989 address_item *topaddr;
991 /* Find the ultimate parent */
993 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
995 /* We start with just the local part for pipe, file, and reply deliveries, and
996 for successful local deliveries from routers that have the log_as_local flag
997 set. File deliveries from filters can be specified as non-absolute paths in
998 cases where the transport is going to complete the path. If there is an error
999 before this happens (expansion failure) the local part will not be updated, and
1000 so won't necessarily look like a path. Add extra text for this case. */
1002 if ( testflag(addr, af_pfr)
1004 && addr->router && addr->router->log_as_local
1005 && addr->transport && addr->transport->info->local
1008 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1009 g = string_catn(g, CUS"save ", 5);
1010 g = string_get_localpart(addr, g);
1013 /* Other deliveries start with the full address. It we have split it into local
1014 part and domain, use those fields. Some early failures can happen before the
1015 splitting is done; in those cases use the original field. */
1019 uschar * cmp = g->s + g->ptr;
1021 if (addr->local_part)
1024 g = string_get_localpart(addr, g);
1025 g = string_catn(g, US"@", 1);
1028 if (testflag(addr, af_utf8_downcvt))
1029 s = string_localpart_utf8_to_alabel(s, NULL);
1031 g = string_cat(g, s);
1034 g = string_cat(g, addr->address);
1036 /* If the address we are going to print is the same as the top address,
1037 and all parents are not being included, don't add on the top address. First
1038 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1039 on the local parts. */
1041 string_from_gstring(g); /* ensure nul-terminated */
1042 if ( strcmpic(cmp, topaddr->address) == 0
1043 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1044 && !addr->onetime_parent
1045 && (!all_parents || !addr->parent || addr->parent == topaddr)
1047 add_topaddr = FALSE;
1050 /* If all parents are requested, or this is a local pipe/file/reply, and
1051 there is at least one intermediate parent, show it in brackets, and continue
1052 with all of them if all are wanted. */
1054 if ( (all_parents || testflag(addr, af_pfr))
1056 && addr->parent != topaddr)
1059 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1061 g = string_catn(g, s, 2);
1062 g = string_cat (g, addr2->address);
1063 if (!all_parents) break;
1066 g = string_catn(g, US")", 1);
1069 /* Add the top address if it is required */
1072 g = string_append(g, 3,
1074 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1083 timesince(struct timeval * diff, struct timeval * then)
1085 gettimeofday(diff, NULL);
1086 diff->tv_sec -= then->tv_sec;
1087 if ((diff->tv_usec -= then->tv_usec) < 0)
1090 diff->tv_usec += 1000*1000;
1097 string_timediff(struct timeval * diff)
1099 static uschar buf[sizeof("0.000s")];
1101 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1102 return readconf_printtime((int)diff->tv_sec);
1104 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1110 string_timesince(struct timeval * then)
1112 struct timeval diff;
1114 timesince(&diff, then);
1115 return string_timediff(&diff);
1118 /******************************************************************************/
1122 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1123 this is a nonstandard call; no two-character delivery flag is written
1124 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1127 flags passed to log_write()
1130 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1132 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1133 void * reset_point; /* released afterwards. */
1135 /* Log the delivery on the main log. We use an extensible string to build up
1136 the log line, and reset the store afterwards. Remote deliveries should always
1137 have a pointer to the host item that succeeded; local deliveries can have a
1138 pointer to a single host item in their host list, for use by the transport. */
1140 #ifndef DISABLE_EVENT
1141 /* presume no successful remote delivery */
1142 lookup_dnssec_authenticated = NULL;
1145 g = reset_point = string_get(256);
1148 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1151 g->s[0] = logchar; g->ptr = 1;
1152 g = string_catn(g, US"> ", 2);
1154 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1156 if (LOGGING(sender_on_delivery) || msg)
1157 g = string_append(g, 3, US" F=<",
1159 testflag(addr, af_utf8_downcvt)
1160 ? string_address_utf8_to_alabel(sender_address, NULL)
1167 g = string_append(g, 2, US" Q=", queue_name);
1169 #ifdef EXPERIMENTAL_SRS
1170 if(addr->prop.srs_sender)
1171 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1174 /* You might think that the return path must always be set for a successful
1175 delivery; indeed, I did for some time, until this statement crashed. The case
1176 when it is not set is for a delivery to /dev/null which is optimised by not
1177 being run at all. */
1179 if (used_return_path && LOGGING(return_path_on_delivery))
1180 g = string_append(g, 3, US" P=<", used_return_path, US">");
1183 g = string_append(g, 2, US" ", msg);
1185 /* For a delivery from a system filter, there may not be a router */
1187 g = string_append(g, 2, US" R=", addr->router->name);
1189 g = string_append(g, 2, US" T=", addr->transport->name);
1191 if (LOGGING(delivery_size))
1192 g = string_fmt_append(g, " S=%d", transport_count);
1194 /* Local delivery */
1196 if (addr->transport->info->local)
1198 if (addr->host_list)
1199 g = string_append(g, 2, US" H=", addr->host_list->name);
1200 g = d_log_interface(g);
1201 if (addr->shadow_message)
1202 g = string_cat(g, addr->shadow_message);
1205 /* Remote delivery */
1209 if (addr->host_used)
1211 g = d_hostlog(g, addr);
1212 if (continue_sequence > 1)
1213 g = string_catn(g, US"*", 1);
1215 #ifndef DISABLE_EVENT
1216 deliver_host_address = addr->host_used->address;
1217 deliver_host_port = addr->host_used->port;
1218 deliver_host = addr->host_used->name;
1220 /* DNS lookup status */
1221 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1222 : addr->host_used->dnssec==DS_NO ? US"no"
1228 g = d_tlslog(g, addr);
1231 if (addr->authenticator)
1233 g = string_append(g, 2, US" A=", addr->authenticator);
1236 g = string_append(g, 2, US":", addr->auth_id);
1237 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1238 g = string_append(g, 2, US":", addr->auth_sndr);
1242 if (LOGGING(pipelining))
1244 if (testflag(addr, af_pipelining))
1245 g = string_catn(g, US" L", 2);
1246 #ifdef EXPERIMENTAL_PIPE_CONNECT
1247 if (testflag(addr, af_early_pipe))
1248 g = string_catn(g, US"*", 1);
1252 #ifndef DISABLE_PRDR
1253 if (testflag(addr, af_prdr_used))
1254 g = string_catn(g, US" PRDR", 5);
1257 if (testflag(addr, af_chunking_used))
1258 g = string_catn(g, US" K", 2);
1261 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1263 if ( LOGGING(smtp_confirmation)
1265 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1268 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1269 uschar *p = big_buffer;
1270 uschar *ss = addr->message;
1272 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1274 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1279 g = string_append(g, 2, US" C=", big_buffer);
1282 /* Time on queue and actual time taken to deliver */
1284 if (LOGGING(queue_time))
1285 g = string_append(g, 2, US" QT=",
1286 string_timesince(&received_time));
1288 if (LOGGING(deliver_time))
1290 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1291 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1294 /* string_cat() always leaves room for the terminator. Release the
1295 store we used to build the line after writing it. */
1297 log_write(0, flags, "%s", string_from_gstring(g));
1299 #ifndef DISABLE_EVENT
1300 if (!msg) msg_event_raise(US"msg:delivery", addr);
1303 store_reset(reset_point);
1310 deferral_log(address_item * addr, uschar * now,
1311 int logflags, uschar * driver_name, uschar * driver_kind)
1316 /* Build up the line that is used for both the message log and the main
1319 g = reset_point = string_get(256);
1321 /* Create the address string for logging. Must not do this earlier, because
1322 an OK result may be changed to FAIL when a pipe returns text. */
1324 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1327 g = string_append(g, 2, US" Q=", queue_name);
1329 /* Either driver_name contains something and driver_kind contains
1330 " router" or " transport" (note the leading space), or driver_name is
1331 a null string and driver_kind contains "routing" without the leading
1332 space, if all routing has been deferred. When a domain has been held,
1333 so nothing has been done at all, both variables contain null strings. */
1337 if (driver_kind[1] == 't' && addr->router)
1338 g = string_append(g, 2, US" R=", addr->router->name);
1339 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1341 else if (driver_kind)
1342 g = string_append(g, 2, US" ", driver_kind);
1344 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1346 if (addr->basic_errno > 0)
1347 g = string_append(g, 2, US": ",
1348 US strerror(addr->basic_errno));
1350 if (addr->host_used)
1352 g = string_append(g, 5,
1353 US" H=", addr->host_used->name,
1354 US" [", addr->host_used->address, US"]");
1355 if (LOGGING(outgoing_port))
1357 int port = addr->host_used->port;
1358 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1363 g = string_append(g, 2, US": ", addr->message);
1365 (void) string_from_gstring(g);
1367 /* Log the deferment in the message log, but don't clutter it
1368 up with retry-time defers after the first delivery attempt. */
1370 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1371 deliver_msglog("%s %s\n", now, g->s);
1373 /* Write the main log and reset the store.
1374 For errors of the type "retry time not reached" (also remotes skipped
1375 on queue run), logging is controlled by L_retry_defer. Note that this kind
1376 of error number is negative, and all the retry ones are less than any
1380 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1383 store_reset(reset_point);
1390 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1393 gstring * g = reset_point = string_get(256);
1395 #ifndef DISABLE_EVENT
1396 /* Message failures for which we will send a DSN get their event raised
1397 later so avoid doing it here. */
1399 if ( !addr->prop.ignore_error
1400 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1402 msg_event_raise(US"msg:fail:delivery", addr);
1405 /* Build up the log line for the message and main logs */
1407 /* Create the address string for logging. Must not do this earlier, because
1408 an OK result may be changed to FAIL when a pipe returns text. */
1410 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1412 if (LOGGING(sender_on_delivery))
1413 g = string_append(g, 3, US" F=<", sender_address, US">");
1416 g = string_append(g, 2, US" Q=", queue_name);
1418 /* Return path may not be set if no delivery actually happened */
1420 if (used_return_path && LOGGING(return_path_on_delivery))
1421 g = string_append(g, 3, US" P=<", used_return_path, US">");
1424 g = string_append(g, 2, US" R=", addr->router->name);
1425 if (addr->transport)
1426 g = string_append(g, 2, US" T=", addr->transport->name);
1428 if (addr->host_used)
1429 g = d_hostlog(g, addr);
1432 g = d_tlslog(g, addr);
1435 if (addr->basic_errno > 0)
1436 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1439 g = string_append(g, 2, US": ", addr->message);
1441 (void) string_from_gstring(g);
1443 /* Do the logging. For the message log, "routing failed" for those cases,
1444 just to make it clearer. */
1447 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1449 deliver_msglog("%s %s\n", now, g->s);
1451 log_write(0, LOG_MAIN, "** %s", g->s);
1453 store_reset(reset_point);
1459 /*************************************************
1460 * Actions at the end of handling an address *
1461 *************************************************/
1463 /* This is a function for processing a single address when all that can be done
1464 with it has been done.
1467 addr points to the address block
1468 result the result of the delivery attempt
1469 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1470 driver_type indicates which type of driver (transport, or router) was last
1471 to process the address
1472 logchar '=' or '-' for use when logging deliveries with => or ->
1478 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1481 uschar *now = tod_stamp(tod_log);
1482 uschar *driver_kind = NULL;
1483 uschar *driver_name = NULL;
1485 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1487 /* Set up driver kind and name for logging. Disable logging if the router or
1488 transport has disabled it. */
1490 if (driver_type == EXIM_DTYPE_TRANSPORT)
1492 if (addr->transport)
1494 driver_name = addr->transport->name;
1495 driver_kind = US" transport";
1496 f.disable_logging = addr->transport->disable_logging;
1498 else driver_kind = US"transporting";
1500 else if (driver_type == EXIM_DTYPE_ROUTER)
1504 driver_name = addr->router->name;
1505 driver_kind = US" router";
1506 f.disable_logging = addr->router->disable_logging;
1508 else driver_kind = US"routing";
1511 /* If there's an error message set, ensure that it contains only printing
1512 characters - it should, but occasionally things slip in and this at least
1513 stops the log format from getting wrecked. We also scan the message for an LDAP
1514 expansion item that has a password setting, and flatten the password. This is a
1515 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1516 malformed, it won't ever have gone near LDAP.) */
1520 const uschar * s = string_printing(addr->message);
1522 /* deconst cast ok as string_printing known to have alloc'n'copied */
1523 addr->message = expand_hide_passwords(US s);
1526 /* If we used a transport that has one of the "return_output" options set, and
1527 if it did in fact generate some output, then for return_output we treat the
1528 message as failed if it was not already set that way, so that the output gets
1529 returned to the sender, provided there is a sender to send it to. For
1530 return_fail_output, do this only if the delivery failed. Otherwise we just
1531 unlink the file, and remove the name so that if the delivery failed, we don't
1532 try to send back an empty or unwanted file. The log_output options operate only
1533 on a non-empty file.
1535 In any case, we close the message file, because we cannot afford to leave a
1536 file-descriptor for one address while processing (maybe very many) others. */
1538 if (addr->return_file >= 0 && addr->return_filename)
1540 BOOL return_output = FALSE;
1541 struct stat statbuf;
1542 (void)EXIMfsync(addr->return_file);
1544 /* If there is no output, do nothing. */
1546 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1548 transport_instance *tb = addr->transport;
1550 /* Handle logging options */
1553 || result == FAIL && tb->log_fail_output
1554 || result == DEFER && tb->log_defer_output
1558 FILE *f = Ufopen(addr->return_filename, "rb");
1560 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1561 "from %s transport: %s", addr->return_filename, tb->name,
1564 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1566 uschar *p = big_buffer + Ustrlen(big_buffer);
1568 while (p > big_buffer && isspace(p[-1])) p--;
1570 sp = string_printing(big_buffer);
1571 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1572 addr->address, tb->name, sp);
1577 /* Handle returning options, but only if there is an address to return
1580 if (sender_address[0] != 0 || addr->prop.errors_address)
1581 if (tb->return_output)
1583 addr->transport_return = result = FAIL;
1584 if (addr->basic_errno == 0 && !addr->message)
1585 addr->message = US"return message generated";
1586 return_output = TRUE;
1589 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1592 /* Get rid of the file unless it might be returned, but close it in
1597 Uunlink(addr->return_filename);
1598 addr->return_filename = NULL;
1599 addr->return_file = -1;
1602 (void)close(addr->return_file);
1605 /* The success case happens only after delivery by a transport. */
1609 addr->next = addr_succeed;
1610 addr_succeed = addr;
1612 /* Call address_done() to ensure that we don't deliver to this address again,
1613 and write appropriate things to the message log. If it is a child address, we
1614 call child_done() to scan the ancestors and mark them complete if this is the
1615 last child to complete. */
1617 address_done(addr, now);
1618 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1621 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1622 driver_name, driver_kind);
1625 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1626 addr->parent->address, driver_name, driver_kind);
1627 child_done(addr, now);
1630 /* Certificates for logging (via events) */
1632 tls_out.ourcert = addr->ourcert;
1633 addr->ourcert = NULL;
1634 tls_out.peercert = addr->peercert;
1635 addr->peercert = NULL;
1637 tls_out.cipher = addr->cipher;
1638 tls_out.peerdn = addr->peerdn;
1639 tls_out.ocsp = addr->ocsp;
1640 # ifdef SUPPORT_DANE
1641 tls_out.dane_verified = testflag(addr, af_dane_verified);
1645 delivery_log(LOG_MAIN, addr, logchar, NULL);
1648 tls_free_cert(&tls_out.ourcert);
1649 tls_free_cert(&tls_out.peercert);
1650 tls_out.cipher = NULL;
1651 tls_out.peerdn = NULL;
1652 tls_out.ocsp = OCSP_NOT_REQ;
1653 # ifdef SUPPORT_DANE
1654 tls_out.dane_verified = FALSE;
1660 /* Soft failure, or local delivery process failed; freezing may be
1663 else if (result == DEFER || result == PANIC)
1665 if (result == PANIC) logflags |= LOG_PANIC;
1667 /* This puts them on the chain in reverse order. Do not change this, because
1668 the code for handling retries assumes that the one with the retry
1669 information is last. */
1671 addr->next = addr_defer;
1674 /* The only currently implemented special action is to freeze the
1675 message. Logging of this is done later, just before the -H file is
1678 if (addr->special_action == SPECIAL_FREEZE)
1680 f.deliver_freeze = TRUE;
1681 deliver_frozen_at = time(NULL);
1682 update_spool = TRUE;
1685 /* If doing a 2-stage queue run, we skip writing to either the message
1686 log or the main log for SMTP defers. */
1688 if (!f.queue_2stage || addr->basic_errno != 0)
1689 deferral_log(addr, now, logflags, driver_name, driver_kind);
1693 /* Hard failure. If there is an address to which an error message can be sent,
1694 put this address on the failed list. If not, put it on the deferred list and
1695 freeze the mail message for human attention. The latter action can also be
1696 explicitly requested by a router or transport. */
1700 /* If this is a delivery error, or a message for which no replies are
1701 wanted, and the message's age is greater than ignore_bounce_errors_after,
1702 force the af_ignore_error flag. This will cause the address to be discarded
1703 later (with a log entry). */
1705 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1706 addr->prop.ignore_error = TRUE;
1708 /* Freeze the message if requested, or if this is a bounce message (or other
1709 message with null sender) and this address does not have its own errors
1710 address. However, don't freeze if errors are being ignored. The actual code
1711 to ignore occurs later, instead of sending a message. Logging of freezing
1712 occurs later, just before writing the -H file. */
1714 if ( !addr->prop.ignore_error
1715 && ( addr->special_action == SPECIAL_FREEZE
1716 || (sender_address[0] == 0 && !addr->prop.errors_address)
1719 frozen_info = addr->special_action == SPECIAL_FREEZE
1721 : f.sender_local && !f.local_error_message
1722 ? US" (message created with -f <>)"
1723 : US" (delivery error message)";
1724 f.deliver_freeze = TRUE;
1725 deliver_frozen_at = time(NULL);
1726 update_spool = TRUE;
1728 /* The address is put on the defer rather than the failed queue, because
1729 the message is being retained. */
1731 addr->next = addr_defer;
1735 /* Don't put the address on the nonrecipients tree yet; wait until an
1736 error message has been successfully sent. */
1740 addr->next = addr_failed;
1744 failure_log(addr, driver_name ? NULL : driver_kind, now);
1747 /* Ensure logging is turned on again in all cases */
1749 f.disable_logging = FALSE;
1755 /*************************************************
1756 * Address-independent error *
1757 *************************************************/
1759 /* This function is called when there's an error that is not dependent on a
1760 particular address, such as an expansion string failure. It puts the error into
1761 all the addresses in a batch, logs the incident on the main and panic logs, and
1762 clears the expansions. It is mostly called from local_deliver(), but can be
1763 called for a remote delivery via findugid().
1766 logit TRUE if (MAIN+PANIC) logging required
1767 addr the first of the chain of addresses
1769 format format string for error message, or NULL if already set in addr
1770 ... arguments for the format
1776 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1778 addr->basic_errno = code;
1785 va_start(ap, format);
1786 g = string_vformat(NULL, TRUE, CS format, ap);
1788 addr->message = string_from_gstring(g);
1791 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1793 addr2->basic_errno = code;
1794 addr2->message = addr->message;
1797 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1798 deliver_set_expansions(NULL);
1804 /*************************************************
1805 * Check a "never users" list *
1806 *************************************************/
1808 /* This function is called to check whether a uid is on one of the two "never
1812 uid the uid to be checked
1813 nusers the list to be scanned; the first item in the list is the count
1815 Returns: TRUE if the uid is on the list
1819 check_never_users(uid_t uid, uid_t *nusers)
1821 if (!nusers) return FALSE;
1822 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1828 /*************************************************
1829 * Find uid and gid for a transport *
1830 *************************************************/
1832 /* This function is called for both local and remote deliveries, to find the
1833 uid/gid under which to run the delivery. The values are taken preferentially
1834 from the transport (either explicit or deliver_as_creator), then from the
1835 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1836 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1837 panic error is logged, and the function fails (which normally leads to delivery
1841 addr the address (possibly a chain)
1843 uidp pointer to uid field
1844 gidp pointer to gid field
1845 igfp pointer to the use_initgroups field
1847 Returns: FALSE if failed - error has been set in address(es)
1851 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1855 BOOL gid_set = FALSE;
1857 /* Default initgroups flag comes from the transport */
1859 *igfp = tp->initgroups;
1861 /* First see if there's a gid on the transport, either fixed or expandable.
1862 The expanding function always logs failure itself. */
1869 else if (tp->expand_gid)
1871 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1874 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1880 /* If the transport did not set a group, see if the router did. */
1882 if (!gid_set && testflag(addr, af_gid_set))
1888 /* Pick up a uid from the transport if one is set. */
1890 if (tp->uid_set) *uidp = tp->uid;
1892 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1893 it does not provide a passwd value from which a gid can be taken. */
1895 else if (tp->expand_uid)
1898 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1899 uidp, &(addr->message)))
1901 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1911 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1913 else if (tp->deliver_as_creator)
1915 *uidp = originator_uid;
1918 *gidp = originator_gid;
1923 /* Otherwise see if the address specifies the uid and if so, take it and its
1926 else if (testflag(addr, af_uid_set))
1929 *igfp = testflag(addr, af_initgroups);
1932 /* Nothing has specified the uid - default to the Exim user, and group if the
1945 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1946 defaulting to the Exim uid. In other words, if the configuration has specified
1947 a uid, it must also provide a gid. */
1951 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1952 "%s transport", tp->name);
1956 /* Check that the uid is not on the lists of banned uids that may not be used
1957 for delivery processes. */
1959 nuname = check_never_users(*uidp, never_users)
1961 : check_never_users(*uidp, fixed_never_users)
1962 ? US"fixed_never_users"
1966 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1967 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1979 /*************************************************
1980 * Check the size of a message for a transport *
1981 *************************************************/
1983 /* Checks that the message isn't too big for the selected transport.
1984 This is called only when it is known that the limit is set.
1988 addr the (first) address being delivered
1991 DEFER expansion failed or did not yield an integer
1992 FAIL message too big
1996 check_message_size(transport_instance *tp, address_item *addr)
2001 deliver_set_expansions(addr);
2002 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2003 deliver_set_expansions(NULL);
2005 if (expand_string_message)
2008 addr->message = size_limit == -1
2009 ? string_sprintf("failed to expand message_size_limit "
2010 "in %s transport: %s", tp->name, expand_string_message)
2011 : string_sprintf("invalid message_size_limit "
2012 "in %s transport: %s", tp->name, expand_string_message);
2014 else if (size_limit > 0 && message_size > size_limit)
2018 string_sprintf("message is too big (transport limit = %d)",
2027 /*************************************************
2028 * Transport-time check for a previous delivery *
2029 *************************************************/
2031 /* Check that this base address hasn't previously been delivered to its routed
2032 transport. If it has been delivered, mark it done. The check is necessary at
2033 delivery time in order to handle homonymic addresses correctly in cases where
2034 the pattern of redirection changes between delivery attempts (so the unique
2035 fields change). Non-homonymic previous delivery is detected earlier, at routing
2036 time (which saves unnecessary routing).
2039 addr the address item
2040 testing TRUE if testing wanted only, without side effects
2042 Returns: TRUE if previously delivered by the transport
2046 previously_transported(address_item *addr, BOOL testing)
2048 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
2049 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2051 if (tree_search(tree_nonrecipients, big_buffer) != 0)
2053 DEBUG(D_deliver|D_route|D_transport)
2054 debug_printf("%s was previously delivered (%s transport): discarded\n",
2055 addr->address, addr->transport->name);
2056 if (!testing) child_done(addr, tod_stamp(tod_log));
2065 /******************************************************
2066 * Check for a given header in a header string *
2067 ******************************************************/
2069 /* This function is used when generating quota warnings. The configuration may
2070 specify any header lines it likes in quota_warn_message. If certain of them are
2071 missing, defaults are inserted, so we need to be able to test for the presence
2075 hdr the required header name
2076 hstring the header string
2078 Returns: TRUE the header is in the string
2079 FALSE the header is not in the string
2083 contains_header(uschar *hdr, uschar *hstring)
2085 int len = Ustrlen(hdr);
2086 uschar *p = hstring;
2089 if (strncmpic(p, hdr, len) == 0)
2092 while (*p == ' ' || *p == '\t') p++;
2093 if (*p == ':') return TRUE;
2095 while (*p != 0 && *p != '\n') p++;
2096 if (*p == '\n') p++;
2104 /*************************************************
2105 * Perform a local delivery *
2106 *************************************************/
2108 /* Each local delivery is performed in a separate process which sets its
2109 uid and gid as specified. This is a safer way than simply changing and
2110 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2111 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2112 all systems have seteuid().
2114 If the uid/gid are specified in the transport_instance, they are used; the
2115 transport initialization must ensure that either both or neither are set.
2116 Otherwise, the values associated with the address are used. If neither are set,
2117 it is a configuration error.
2119 The transport or the address may specify a home directory (transport over-
2120 rides), and if they do, this is set as $home. If neither have set a working
2121 directory, this value is used for that as well. Otherwise $home is left unset
2122 and the cwd is set to "/" - a directory that should be accessible to all users.
2124 Using a separate process makes it more complicated to get error information
2125 back. We use a pipe to pass the return code and also an error code and error
2126 text string back to the parent process.
2129 addr points to an address block for this delivery; for "normal" local
2130 deliveries this is the only address to be delivered, but for
2131 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2132 a number of addresses can be handled simultaneously, and in this
2133 case addr will point to a chain of addresses with the same
2136 shadowing TRUE if running a shadow transport; this causes output from pipes
2143 deliver_local(address_item *addr, BOOL shadowing)
2145 BOOL use_initgroups;
2148 int status, len, rc;
2151 uschar *working_directory;
2152 address_item *addr2;
2153 transport_instance *tp = addr->transport;
2155 /* Set up the return path from the errors or sender address. If the transport
2156 has its own return path setting, expand it and replace the existing value. */
2158 if(addr->prop.errors_address)
2159 return_path = addr->prop.errors_address;
2160 #ifdef EXPERIMENTAL_SRS
2161 else if (addr->prop.srs_sender)
2162 return_path = addr->prop.srs_sender;
2165 return_path = sender_address;
2167 if (tp->return_path)
2169 uschar *new_return_path = expand_string(tp->return_path);
2170 if (!new_return_path)
2172 if (!f.expand_string_forcedfail)
2174 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2175 US"Failed to expand return path \"%s\" in %s transport: %s",
2176 tp->return_path, tp->name, expand_string_message);
2180 else return_path = new_return_path;
2183 /* For local deliveries, one at a time, the value used for logging can just be
2184 set directly, once and for all. */
2186 used_return_path = return_path;
2188 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2189 gets put into the address(es), and the expansions are unset, so we can just
2192 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2194 /* See if either the transport or the address specifies a home directory. A
2195 home directory set in the address may already be expanded; a flag is set to
2196 indicate that. In other cases we must expand it. */
2198 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2199 || ( (deliver_home = addr->home_dir) /* Set in address and */
2200 && !testflag(addr, af_home_expanded) /* not expanded */
2203 uschar *rawhome = deliver_home;
2204 deliver_home = NULL; /* in case it contains $home */
2205 if (!(deliver_home = expand_string(rawhome)))
2207 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2208 "to expand for %s transport: %s", rawhome, tp->name,
2209 expand_string_message);
2212 if (*deliver_home != '/')
2214 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2215 "is not absolute for %s transport", deliver_home, tp->name);
2220 /* See if either the transport or the address specifies a current directory,
2221 and if so, expand it. If nothing is set, use the home directory, unless it is
2222 also unset in which case use "/", which is assumed to be a directory to which
2223 all users have access. It is necessary to be in a visible directory for some
2224 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2225 2.5) require this. */
2227 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2228 if (working_directory)
2230 uschar *raw = working_directory;
2231 if (!(working_directory = expand_string(raw)))
2233 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2234 "failed to expand for %s transport: %s", raw, tp->name,
2235 expand_string_message);
2238 if (*working_directory != '/')
2240 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2241 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2245 else working_directory = deliver_home ? deliver_home : US"/";
2247 /* If one of the return_output flags is set on the transport, create and open a
2248 file in the message log directory for the transport to write its output onto.
2249 This is mainly used by pipe transports. The file needs to be unique to the
2250 address. This feature is not available for shadow transports. */
2253 && ( tp->return_output || tp->return_fail_output
2254 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2259 addr->return_filename =
2260 spool_fname(US"msglog", message_subdir, message_id,
2261 string_sprintf("-%d-%d", getpid(), return_count++));
2263 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2265 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2266 "to return message: %s", error, tp->name, strerror(errno));
2271 /* Create the pipe for inter-process communication. */
2275 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2280 /* Now fork the process to do the real work in the subprocess, but first
2281 ensure that all cached resources are freed so that the subprocess starts with
2282 a clean slate and doesn't interfere with the parent process. */
2286 if ((pid = fork()) == 0)
2288 BOOL replicate = TRUE;
2290 /* Prevent core dumps, as we don't want them in users' home directories.
2291 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2292 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2293 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2294 complain if the error is "not supported".
2296 There are two scenarios where changing the max limit has an effect. In one,
2297 the user is using a .forward and invoking a command of their choice via pipe;
2298 for these, we do need the max limit to be 0 unless the admin chooses to
2299 permit an increased limit. In the other, the command is invoked directly by
2300 the transport and is under administrator control, thus being able to raise
2301 the limit aids in debugging. So there's no general always-right answer.
2303 Thus we inhibit core-dumps completely but let individual transports, while
2304 still root, re-raise the limits back up to aid debugging. We make the
2305 default be no core-dumps -- few enough people can use core dumps in
2306 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2313 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2315 # ifdef SETRLIMIT_NOT_SUPPORTED
2316 if (errno != ENOSYS && errno != ENOTSUP)
2318 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2323 /* Reset the random number generator, so different processes don't all
2324 have the same sequence. */
2328 /* If the transport has a setup entry, call this first, while still
2329 privileged. (Appendfile uses this to expand quota, for example, while
2330 able to read private files.) */
2332 if (addr->transport->setup)
2333 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2337 addr->transport_return = DEFER;
2341 addr->transport_return = PANIC;
2345 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2346 when the process becomes unprivileged, it won't be able to write to the
2347 process log. SIGHUP is ignored throughout exim, except when it is being
2350 signal(SIGINT, SIG_IGN);
2351 signal(SIGTERM, SIG_IGN);
2352 signal(SIGUSR1, SIG_IGN);
2354 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2355 half - for transports that exec things (e.g. pipe). Then set the required
2358 (void)close(pfd[pipe_read]);
2359 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2361 exim_setugid(uid, gid, use_initgroups,
2362 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2363 addr->address, addr->transport->name));
2367 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2368 for (address_item * batched = addr->next; batched; batched = batched->next)
2369 debug_printf("additional batched address: %s\n", batched->address);
2372 /* Set an appropriate working directory. */
2374 if (Uchdir(working_directory) < 0)
2376 addr->transport_return = DEFER;
2377 addr->basic_errno = errno;
2378 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2381 /* If successful, call the transport */
2386 set_process_info("delivering %s to %s using %s", message_id,
2387 addr->local_part, addr->transport->name);
2389 /* Setting this global in the subprocess means we need never clear it */
2390 transport_name = addr->transport->name;
2392 /* If a transport filter has been specified, set up its argument list.
2393 Any errors will get put into the address, and FALSE yielded. */
2395 if (addr->transport->filter_command)
2397 ok = transport_set_up_command(&transport_filter_argv,
2398 addr->transport->filter_command,
2399 TRUE, PANIC, addr, US"transport filter", NULL);
2400 transport_filter_timeout = addr->transport->filter_timeout;
2402 else transport_filter_argv = NULL;
2406 debug_print_string(addr->transport->debug_string);
2407 replicate = !(addr->transport->info->code)(addr->transport, addr);
2411 /* Pass the results back down the pipe. If necessary, first replicate the
2412 status in the top address to the others in the batch. The label is the
2413 subject of a goto when a call to the transport's setup function fails. We
2414 pass the pointer to the transport back in case it got changed as a result of
2415 file_format in appendfile. */
2419 if (replicate) replicate_status(addr);
2420 for (addr2 = addr; addr2; addr2 = addr2->next)
2423 int local_part_length = Ustrlen(addr2->local_part);
2427 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2428 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2429 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2430 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2431 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2432 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2433 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2434 || (ret = write(pfd[pipe_write], &addr2->transport,
2435 sizeof(transport_instance *))) != sizeof(transport_instance *)
2437 /* For a file delivery, pass back the local part, in case the original
2438 was only part of the final delivery path. This gives more complete
2441 || (testflag(addr2, af_file)
2442 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2443 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2447 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2448 ret == -1 ? strerror(errno) : "short write");
2450 /* Now any messages */
2452 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2454 int message_length = s ? Ustrlen(s) + 1 : 0;
2455 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2456 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2458 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2459 ret == -1 ? strerror(errno) : "short write");
2463 /* OK, this process is now done. Free any cached resources that it opened,
2464 and close the pipe we were writing down before exiting. */
2466 (void)close(pfd[pipe_write]);
2471 /* Back in the main process: panic if the fork did not succeed. This seems
2472 better than returning an error - if forking is failing it is probably best
2473 not to try other deliveries for this message. */
2476 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2479 /* Read the pipe to get the delivery status codes and error messages. Our copy
2480 of the writing end must be closed first, as otherwise read() won't return zero
2481 on an empty pipe. We check that a status exists for each address before
2482 overwriting the address structure. If data is missing, the default DEFER status
2483 will remain. Afterwards, close the reading end. */
2485 (void)close(pfd[pipe_write]);
2487 for (addr2 = addr; addr2; addr2 = addr2->next)
2489 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2494 addr2->transport_return = status;
2495 len = read(pfd[pipe_read], &transport_count,
2496 sizeof(transport_count));
2497 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2498 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2499 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2500 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2501 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2502 len = read(pfd[pipe_read], &addr2->transport,
2503 sizeof(transport_instance *));
2505 if (testflag(addr2, af_file))
2508 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2509 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2512 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2513 " from delivery subprocess");
2516 /* sanity-checked llen so disable the Coverity error */
2517 /* coverity[tainted_data] */
2518 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2520 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2521 " from delivery subprocess");
2524 big_buffer[llen] = 0;
2525 addr2->local_part = string_copy(big_buffer);
2528 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2531 len = read(pfd[pipe_read], &message_length, sizeof(int));
2532 if (message_length > 0)
2534 len = read(pfd[pipe_read], big_buffer, message_length);
2535 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2536 if (len > 0) *sptr = string_copy(big_buffer);
2543 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2544 "from delivery subprocess", addr2->unique);
2549 (void)close(pfd[pipe_read]);
2551 /* Unless shadowing, write all successful addresses immediately to the journal
2552 file, to ensure they are recorded asap. For homonymic addresses, use the base
2553 address plus the transport name. Failure to write the journal is panic-worthy,
2554 but don't stop, as it may prove possible subsequently to update the spool file
2555 in order to record the delivery. */
2559 for (addr2 = addr; addr2; addr2 = addr2->next)
2560 if (addr2->transport_return == OK)
2562 if (testflag(addr2, af_homonym))
2563 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2565 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2567 /* In the test harness, wait just a bit to let the subprocess finish off
2568 any debug output etc first. */
2570 if (f.running_in_test_harness) millisleep(300);
2572 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2573 len = Ustrlen(big_buffer);
2574 if (write(journal_fd, big_buffer, len) != len)
2575 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2576 big_buffer, strerror(errno));
2579 /* Ensure the journal file is pushed out to disk. */
2581 if (EXIMfsync(journal_fd) < 0)
2582 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2586 /* Wait for the process to finish. If it terminates with a non-zero code,
2587 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2588 status values of all the addresses as they are. Take care to handle the case
2589 when the subprocess doesn't seem to exist. This has been seen on one system
2590 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2591 happens, wait() doesn't recognize the termination of child processes. Exim now
2592 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2594 while ((rc = wait(&status)) != pid)
2595 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2597 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2598 addr->transport->driver_name);
2603 if ((status & 0xffff) != 0)
2605 int msb = (status >> 8) & 255;
2606 int lsb = status & 255;
2607 int code = (msb == 0)? (lsb & 0x7f) : msb;
2608 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2609 addr->special_action = SPECIAL_FREEZE;
2610 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2611 "status 0x%04x: %s %d",
2612 addr->transport->driver_name,
2614 msb == 0 ? "terminated by signal" : "exit code",
2618 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2620 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2623 uschar *warn_message;
2626 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2628 if (!(warn_message = expand_string(addr->transport->warn_message)))
2629 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2630 "message for %s transport): %s", addr->transport->warn_message,
2631 addr->transport->name, expand_string_message);
2633 else if ((pid = child_open_exim(&fd)) > 0)
2635 FILE *f = fdopen(fd, "wb");
2636 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2637 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2638 fprintf(f, "Auto-Submitted: auto-replied\n");
2639 if (!contains_header(US"From", warn_message))
2641 fprintf(f, "%s", CS warn_message);
2643 /* Close and wait for child process to complete, without a timeout. */
2646 (void)child_close(pid, 0);
2649 addr->special_action = SPECIAL_NONE;
2656 /* Check transport for the given concurrency limit. Return TRUE if over
2657 the limit (or an expansion failure), else FALSE and if there was a limit,
2658 the key for the hints database used for the concurrency count. */
2661 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2663 unsigned max_parallel;
2665 if (!tp->max_parallel) return FALSE;
2667 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2668 if (expand_string_message)
2670 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2671 "in %s transport (%s): %s", tp->name, addr->address,
2672 expand_string_message);
2676 if (max_parallel > 0)
2678 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2679 if (!enq_start(serialize_key, max_parallel))
2681 address_item * next;
2683 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2684 tp->name, max_parallel);
2688 addr->message = US"concurrency limit reached for transport";
2689 addr->basic_errno = ERRNO_TRETRY;
2690 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2691 } while ((addr = next));
2694 *key = serialize_key;
2701 /*************************************************
2702 * Do local deliveries *
2703 *************************************************/
2705 /* This function processes the list of addresses in addr_local. True local
2706 deliveries are always done one address at a time. However, local deliveries can
2707 be batched up in some cases. Typically this is when writing batched SMTP output
2708 files for use by some external transport mechanism, or when running local
2709 deliveries over LMTP.
2716 do_local_deliveries(void)
2719 open_db *dbm_file = NULL;
2720 time_t now = time(NULL);
2722 /* Loop until we have exhausted the supply of local deliveries */
2726 struct timeval delivery_start;
2727 struct timeval deliver_time;
2728 address_item *addr2, *addr3, *nextaddr;
2729 int logflags = LOG_MAIN;
2730 int logchar = f.dont_deliver? '*' : '=';
2731 transport_instance *tp;
2732 uschar * serialize_key = NULL;
2734 /* Pick the first undelivered address off the chain */
2736 address_item *addr = addr_local;
2737 addr_local = addr->next;
2740 DEBUG(D_deliver|D_transport)
2741 debug_printf("--------> %s <--------\n", addr->address);
2743 /* An internal disaster if there is no transport. Should not occur! */
2745 if (!(tp = addr->transport))
2747 logflags |= LOG_PANIC;
2748 f.disable_logging = FALSE; /* Jic */
2749 addr->message = addr->router
2750 ? string_sprintf("No transport set by %s router", addr->router->name)
2751 : string_sprintf("No transport set by system filter");
2752 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2756 /* Check that this base address hasn't previously been delivered to this
2757 transport. The check is necessary at this point to handle homonymic addresses
2758 correctly in cases where the pattern of redirection changes between delivery
2759 attempts. Non-homonymic previous delivery is detected earlier, at routing
2762 if (previously_transported(addr, FALSE)) continue;
2764 /* There are weird cases where logging is disabled */
2766 f.disable_logging = tp->disable_logging;
2768 /* Check for batched addresses and possible amalgamation. Skip all the work
2769 if either batch_max <= 1 or there aren't any other addresses for local
2772 if (tp->batch_max > 1 && addr_local)
2774 int batch_count = 1;
2775 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2776 BOOL uses_lp = ( testflag(addr, af_pfr)
2777 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2779 || readconf_depends((driver_instance *)tp, US"local_part");
2780 uschar *batch_id = NULL;
2781 address_item **anchor = &addr_local;
2782 address_item *last = addr;
2785 /* Expand the batch_id string for comparison with other addresses.
2786 Expansion failure suppresses batching. */
2790 deliver_set_expansions(addr);
2791 batch_id = expand_string(tp->batch_id);
2792 deliver_set_expansions(NULL);
2795 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2796 "in %s transport (%s): %s", tp->name, addr->address,
2797 expand_string_message);
2798 batch_count = tp->batch_max;
2802 /* Until we reach the batch_max limit, pick off addresses which have the
2803 same characteristics. These are:
2806 not previously delivered (see comment about 50 lines above)
2807 same local part if the transport's configuration contains $local_part
2808 or if this is a file or pipe delivery from a redirection
2809 same domain if the transport's configuration contains $domain
2811 same additional headers
2812 same headers to be removed
2813 same uid/gid for running the transport
2814 same first host if a host list is set
2817 while ((next = *anchor) && batch_count < tp->batch_max)
2820 tp == next->transport
2821 && !previously_transported(next, TRUE)
2822 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2823 && testflag(addr, af_file) == testflag(next, af_file)
2824 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2825 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2826 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2827 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2828 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2829 && same_ugid(tp, addr, next)
2830 && ( !addr->host_list && !next->host_list
2833 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2836 /* If the transport has a batch_id setting, batch_id will be non-NULL
2837 from the expansion outside the loop. Expand for this address and compare.
2838 Expansion failure makes this address ineligible for batching. */
2843 address_item *save_nextnext = next->next;
2844 next->next = NULL; /* Expansion for a single address */
2845 deliver_set_expansions(next);
2846 next->next = save_nextnext;
2847 bid = expand_string(tp->batch_id);
2848 deliver_set_expansions(NULL);
2851 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2852 "in %s transport (%s): %s", tp->name, next->address,
2853 expand_string_message);
2856 else ok = (Ustrcmp(batch_id, bid) == 0);
2859 /* Take address into batch if OK. */
2863 *anchor = next->next; /* Include the address */
2869 else anchor = &next->next; /* Skip the address */
2873 /* We now have one or more addresses that can be delivered in a batch. Check
2874 whether the transport is prepared to accept a message of this size. If not,
2875 fail them all forthwith. If the expansion fails, or does not yield an
2876 integer, defer delivery. */
2878 if (tp->message_size_limit)
2880 int rc = check_message_size(tp, addr);
2883 replicate_status(addr);
2887 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2890 continue; /* With next batch of addresses */
2894 /* If we are not running the queue, or if forcing, all deliveries will be
2895 attempted. Otherwise, we must respect the retry times for each address. Even
2896 when not doing this, we need to set up the retry key string, and determine
2897 whether a retry record exists, because after a successful delivery, a delete
2898 retry item must be set up. Keep the retry database open only for the duration
2899 of these checks, rather than for all local deliveries, because some local
2900 deliveries (e.g. to pipes) can take a substantial time. */
2902 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2904 DEBUG(D_deliver|D_retry|D_hints_lookup)
2905 debug_printf("no retry data available\n");
2912 BOOL ok = TRUE; /* to deliver this address */
2915 /* Set up the retry key to include the domain or not, and change its
2916 leading character from "R" to "T". Must make a copy before doing this,
2917 because the old key may be pointed to from a "delete" retry item after
2920 retry_key = string_copy(
2921 tp->retry_use_local_part ? addr2->address_retry_key :
2922 addr2->domain_retry_key);
2925 /* Inspect the retry data. If there is no hints file, delivery happens. */
2929 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2931 /* If there is no retry record, delivery happens. If there is,
2932 remember it exists so it can be deleted after a successful delivery. */
2936 setflag(addr2, af_lt_retry_exists);
2938 /* A retry record exists for this address. If queue running and not
2939 forcing, inspect its contents. If the record is too old, or if its
2940 retry time has come, or if it has passed its cutoff time, delivery
2945 debug_printf("retry record exists: age=%s ",
2946 readconf_printtime(now - retry_record->time_stamp));
2947 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2948 debug_printf(" time to retry = %s expired = %d\n",
2949 readconf_printtime(retry_record->next_try - now),
2950 retry_record->expired);
2953 if (f.queue_running && !f.deliver_force)
2955 ok = (now - retry_record->time_stamp > retry_data_expire)
2956 || (now >= retry_record->next_try)
2957 || retry_record->expired;
2959 /* If we haven't reached the retry time, there is one more check
2960 to do, which is for the ultimate address timeout. */
2963 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2967 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2970 /* This address is to be delivered. Leave it on the chain. */
2975 addr2 = addr2->next;
2978 /* This address is to be deferred. Take it out of the chain, and
2979 post-process it as complete. Must take it out of the chain first,
2980 because post processing puts it on another chain. */
2984 address_item *this = addr2;
2985 this->message = US"Retry time not yet reached";
2986 this->basic_errno = ERRNO_LRETRY;
2987 addr2 = addr3 ? (addr3->next = addr2->next)
2988 : (addr = addr2->next);
2989 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2993 if (dbm_file) dbfn_close(dbm_file);
2995 /* If there are no addresses left on the chain, they all deferred. Loop
2996 for the next set of addresses. */
2998 if (!addr) continue;
3000 /* If the transport is limited for parallellism, enforce that here.
3001 We use a hints DB entry, incremented here and decremented after
3002 the transport (and any shadow transport) completes. */
3004 if (tpt_parallel_check(tp, addr, &serialize_key))
3006 if (expand_string_message)
3008 logflags |= LOG_PANIC;
3012 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3013 } while ((addr = addr2));
3015 continue; /* Loop for the next set of addresses. */
3019 /* So, finally, we do have some addresses that can be passed to the
3020 transport. Before doing so, set up variables that are relevant to a
3023 deliver_set_expansions(addr);
3025 gettimeofday(&delivery_start, NULL);
3026 deliver_local(addr, FALSE);
3027 timesince(&deliver_time, &delivery_start);
3029 /* If a shadow transport (which must perforce be another local transport), is
3030 defined, and its condition is met, we must pass the message to the shadow
3031 too, but only those addresses that succeeded. We do this by making a new
3032 chain of addresses - also to keep the original chain uncontaminated. We must
3033 use a chain rather than doing it one by one, because the shadow transport may
3036 NOTE: if the condition fails because of a lookup defer, there is nothing we
3040 && ( !tp->shadow_condition
3041 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3044 transport_instance *stp;
3045 address_item *shadow_addr = NULL;
3046 address_item **last = &shadow_addr;
3048 for (stp = transports; stp; stp = stp->next)
3049 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3052 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3055 /* Pick off the addresses that have succeeded, and make clones. Put into
3056 the shadow_message field a pointer to the shadow_message field of the real
3059 else for (addr2 = addr; addr2; addr2 = addr2->next)
3060 if (addr2->transport_return == OK)
3062 addr3 = store_get(sizeof(address_item));
3065 addr3->shadow_message = US &addr2->shadow_message;
3066 addr3->transport = stp;
3067 addr3->transport_return = DEFER;
3068 addr3->return_filename = NULL;
3069 addr3->return_file = -1;
3071 last = &addr3->next;
3074 /* If we found any addresses to shadow, run the delivery, and stick any
3075 message back into the shadow_message field in the original. */
3079 int save_count = transport_count;
3081 DEBUG(D_deliver|D_transport)
3082 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3083 deliver_local(shadow_addr, TRUE);
3085 for(; shadow_addr; shadow_addr = shadow_addr->next)
3087 int sresult = shadow_addr->transport_return;
3088 *(uschar **)shadow_addr->shadow_message =
3090 ? string_sprintf(" ST=%s", stp->name)
3091 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3092 shadow_addr->basic_errno <= 0
3094 : US strerror(shadow_addr->basic_errno),
3095 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3098 shadow_addr->message
3099 ? shadow_addr->message
3100 : shadow_addr->basic_errno <= 0
3104 DEBUG(D_deliver|D_transport)
3105 debug_printf("%s shadow transport returned %s for %s\n",
3107 sresult == OK ? "OK" :
3108 sresult == DEFER ? "DEFER" :
3109 sresult == FAIL ? "FAIL" :
3110 sresult == PANIC ? "PANIC" : "?",
3111 shadow_addr->address);
3114 DEBUG(D_deliver|D_transport)
3115 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3117 transport_count = save_count; /* Restore original transport count */
3121 /* Cancel the expansions that were set up for the delivery. */
3123 deliver_set_expansions(NULL);
3125 /* If the transport was parallelism-limited, decrement the hints DB record. */
3127 if (serialize_key) enq_end(serialize_key);
3129 /* Now we can process the results of the real transport. We must take each
3130 address off the chain first, because post_process_one() puts it on another
3133 for (addr2 = addr; addr2; addr2 = nextaddr)
3135 int result = addr2->transport_return;
3136 nextaddr = addr2->next;
3138 DEBUG(D_deliver|D_transport)
3139 debug_printf("%s transport returned %s for %s\n",
3141 result == OK ? "OK" :
3142 result == DEFER ? "DEFER" :
3143 result == FAIL ? "FAIL" :
3144 result == PANIC ? "PANIC" : "?",
3147 /* If there is a retry_record, or if delivery is deferred, build a retry
3148 item for setting a new retry time or deleting the old retry record from
3149 the database. These items are handled all together after all addresses
3150 have been handled (so the database is open just for a short time for
3153 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3155 int flags = result == DEFER ? 0 : rf_delete;
3156 uschar *retry_key = string_copy(tp->retry_use_local_part
3157 ? addr2->address_retry_key : addr2->domain_retry_key);
3159 retry_add_item(addr2, retry_key, flags);
3162 /* Done with this address */
3166 addr2->more_errno = deliver_time.tv_sec;
3167 addr2->delivery_usec = deliver_time.tv_usec;
3169 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3171 /* If a pipe delivery generated text to be sent back, the result may be
3172 changed to FAIL, and we must copy this for subsequent addresses in the
3175 if (addr2->transport_return != result)
3177 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3179 addr3->transport_return = addr2->transport_return;
3180 addr3->basic_errno = addr2->basic_errno;
3181 addr3->message = addr2->message;
3183 result = addr2->transport_return;
3186 /* Whether or not the result was changed to FAIL, we need to copy the
3187 return_file value from the first address into all the addresses of the
3188 batch, so they are all listed in the error message. */
3190 addr2->return_file = addr->return_file;
3192 /* Change log character for recording successful deliveries. */
3194 if (result == OK) logchar = '-';
3196 } /* Loop back for next batch of addresses */
3202 /*************************************************
3203 * Sort remote deliveries *
3204 *************************************************/
3206 /* This function is called if remote_sort_domains is set. It arranges that the
3207 chain of addresses for remote deliveries is ordered according to the strings
3208 specified. Try to make this shuffling reasonably efficient by handling
3209 sequences of addresses rather than just single ones.
3216 sort_remote_deliveries(void)
3219 address_item **aptr = &addr_remote;
3220 const uschar *listptr = remote_sort_domains;
3225 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3228 address_item *moved = NULL;
3229 address_item **bptr = &moved;
3233 address_item **next;
3234 deliver_domain = (*aptr)->domain; /* set $domain */
3235 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3236 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3238 aptr = &(*aptr)->next;
3242 next = &(*aptr)->next;
3244 && (deliver_domain = (*next)->domain, /* Set $domain */
3245 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3246 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3248 next = &(*next)->next;
3250 /* If the batch of non-matchers is at the end, add on any that were
3251 extracted further up the chain, and end this iteration. Otherwise,
3252 extract them from the chain and hang on the moved chain. */
3264 aptr = &(*aptr)->next;
3267 /* If the loop ended because the final address matched, *aptr will
3268 be NULL. Add on to the end any extracted non-matching addresses. If
3269 *aptr is not NULL, the loop ended via "break" when *next is null, that
3270 is, there was a string of non-matching addresses at the end. In this
3271 case the extracted addresses have already been added on the end. */
3273 if (!*aptr) *aptr = moved;
3278 debug_printf("remote addresses after sorting:\n");
3279 for (address_item * addr = addr_remote; addr; addr = addr->next)
3280 debug_printf(" %s\n", addr->address);
3286 /*************************************************
3287 * Read from pipe for remote delivery subprocess *
3288 *************************************************/
3290 /* This function is called when the subprocess is complete, but can also be
3291 called before it is complete, in order to empty a pipe that is full (to prevent
3292 deadlock). It must therefore keep track of its progress in the parlist data
3295 We read the pipe to get the delivery status codes and a possible error message
3296 for each address, optionally preceded by unusability data for the hosts and
3297 also by optional retry data.
3299 Read in large chunks into the big buffer and then scan through, interpreting
3300 the data therein. In most cases, only a single read will be necessary. No
3301 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3302 that we read the next chunk when there is less than 2500 bytes left in the
3303 non-final chunk, we can assume each item is complete in the buffer before
3304 handling it. Each item is written using a single write(), which is atomic for
3305 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3306 often bigger) so even if we are reading while the subprocess is still going, we
3307 should never have only a partial item in the buffer.
3309 hs12: This assumption is not true anymore, since we get quite large items (certificate
3310 information and such).
3313 poffset the offset of the parlist item
3314 eop TRUE if the process has completed
3316 Returns: TRUE if the terminating 'Z' item has been read,
3317 or there has been a disaster (i.e. no more data needed);
3322 par_read_pipe(int poffset, BOOL eop)
3325 pardata *p = parlist + poffset;
3326 address_item *addrlist = p->addrlist;
3327 address_item *addr = p->addr;
3331 uschar *msg = p->msg;
3332 BOOL done = p->done;
3334 /* Loop through all items, reading from the pipe when necessary. The pipe
3335 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3336 here, as the preceding select() tells us, if data is available for reading.
3338 A read() on a "selected" handle should never block, but(!) it may return
3339 less data then we expected. (The buffer size we pass to read() shouldn't be
3340 understood as a "request", but as a "limit".)
3342 Each separate item is written to the pipe in a timely manner. But, especially for
3343 larger items, the read(2) may already return partial data from the write(2).
3345 The write is atomic mostly (depending on the amount written), but atomic does
3346 not imply "all or noting", it just is "not intermixed" with other writes on the
3347 same channel (pipe).
3351 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3352 (int)p->pid, eop? "ended" : "not ended yet");
3356 retry_item *r, **rp;
3357 uschar pipeheader[PIPE_HEADER_SIZE+1];
3358 uschar *id = &pipeheader[0];
3359 uschar *subid = &pipeheader[1];
3360 uschar *ptr = big_buffer;
3361 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3364 DEBUG(D_deliver) debug_printf(
3365 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3367 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3368 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3369 If we get less, we can assume the subprocess do be done and do not expect any further
3370 information from it. */
3372 if ((got = readn(fd, pipeheader, required)) != required)
3374 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3375 "from transport process %d for transport %s",
3376 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3381 pipeheader[PIPE_HEADER_SIZE] = '\0';
3383 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3387 /* If we can't decode the pipeheader, the subprocess seems to have a
3388 problem, we do not expect any furher information from it. */
3390 required = Ustrtol(pipeheader+2, &endc, 10);
3393 msg = string_sprintf("failed to read pipe "
3394 "from transport process %d for transport %s: error decoding size from header",
3395 pid, addr->transport->driver_name);
3402 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3403 (u_long)required, pid);
3405 /* Same as above, the transport process will write the bytes announced
3406 in a timely manner, so we can just wait for the bytes, getting less than expected
3407 is considered a problem of the subprocess, we do not expect anything else from it. */
3408 if ((got = readn(fd, big_buffer, required)) != required)
3410 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3411 " bytes (pipedata) from transport process %d for transport %s",
3412 got, required, pid, addr->transport->driver_name);
3417 /* Handle each possible type of item, assuming the complete item is
3418 available in store. */
3422 /* Host items exist only if any hosts were marked unusable. Match
3423 up by checking the IP address. */
3426 for (h = addrlist->host_list; h; h = h->next)
3428 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3436 /* Retry items are sent in a preceding R item for each address. This is
3437 kept separate to keep each message short enough to guarantee it won't
3438 be split in the pipe. Hopefully, in the majority of cases, there won't in
3439 fact be any retry items at all.
3441 The complete set of retry items might include an item to delete a
3442 routing retry if there was a previous routing delay. However, routing
3443 retries are also used when a remote transport identifies an address error.
3444 In that case, there may also be an "add" item for the same key. Arrange
3445 that a "delete" item is dropped in favour of an "add" item. */
3448 if (!addr) goto ADDR_MISMATCH;
3450 DEBUG(D_deliver|D_retry)
3451 debug_printf("reading retry information for %s from subprocess\n",
3454 /* Cut out any "delete" items on the list. */
3456 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3457 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3459 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3460 *rp = r->next; /* Excise a delete item */
3461 DEBUG(D_deliver|D_retry)
3462 debug_printf(" existing delete item dropped\n");
3465 /* We want to add a delete item only if there is no non-delete item;
3466 however we still have to step ptr through the data. */
3468 if (!r || !(*ptr & rf_delete))
3470 r = store_get(sizeof(retry_item));
3471 r->next = addr->retries;
3474 r->key = string_copy(ptr);
3476 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3477 ptr += sizeof(r->basic_errno);
3478 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3479 ptr += sizeof(r->more_errno);
3480 r->message = *ptr ? string_copy(ptr) : NULL;
3481 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3482 r->flags & rf_delete ? "delete" : "retry");
3487 DEBUG(D_deliver|D_retry)
3488 debug_printf(" delete item not added: non-delete item exists\n");
3491 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3497 /* Put the amount of data written into the parlist block */
3500 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3501 ptr += sizeof(transport_count);
3504 /* Address items are in the order of items on the address chain. We
3505 remember the current address value in case this function is called
3506 several times to empty the pipe in stages. Information about delivery
3507 over TLS is sent in a preceding X item for each address. We don't put
3508 it in with the other info, in order to keep each message short enough to
3509 guarantee it won't be split in the pipe. */
3513 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3517 addr->cipher = NULL;
3518 addr->peerdn = NULL;
3521 addr->cipher = string_copy(ptr);
3524 addr->peerdn = string_copy(ptr);
3529 (void) tls_import_cert(ptr, &addr->peercert);
3531 addr->peercert = NULL;
3536 (void) tls_import_cert(ptr, &addr->ourcert);
3538 addr->ourcert = NULL;
3541 # ifndef DISABLE_OCSP
3543 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3549 #endif /*SUPPORT_TLS*/
3551 case 'C': /* client authenticator information */
3554 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3555 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3556 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3561 #ifndef DISABLE_PRDR
3563 setflag(addr, af_prdr_used);
3570 #ifdef EXPERIMENTAL_PIPE_CONNECT
3571 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3573 case 1: setflag(addr, af_pipelining); break;
3578 setflag(addr, af_chunking_used);
3582 setflag(addr, af_tcp_fastopen_conn);
3583 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3584 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3588 if (!addr) goto ADDR_MISMATCH;
3589 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3590 ptr += sizeof(addr->dsn_aware);
3591 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3598 msg = string_sprintf("address count mismatch for data read from pipe "
3599 "for transport process %d for transport %s", pid,
3600 addrlist->transport->driver_name);
3607 #ifdef SUPPORT_SOCKS
3608 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3609 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3614 proxy_local_address = string_copy(ptr);
3616 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3617 ptr += sizeof(proxy_local_port);
3622 #ifdef EXPERIMENTAL_DSN_INFO
3623 case '1': /* must arrive before A0, and applies to that addr */
3624 /* Two strings: smtp_greeting and helo_response */
3625 addr->smtp_greeting = string_copy(ptr);
3627 addr->helo_response = string_copy(ptr);
3633 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3634 addr->transport_return = *ptr++;
3635 addr->special_action = *ptr++;
3636 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3637 ptr += sizeof(addr->basic_errno);
3638 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3639 ptr += sizeof(addr->more_errno);
3640 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3641 ptr += sizeof(addr->delivery_usec);
3642 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3643 ptr += sizeof(addr->flags);
3644 addr->message = *ptr ? string_copy(ptr) : NULL;
3646 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3649 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3653 h = store_get(sizeof(host_item));
3654 h->name = string_copy(ptr);
3656 h->address = string_copy(ptr);
3658 memcpy(&h->port, ptr, sizeof(h->port));
3659 ptr += sizeof(h->port);
3660 h->dnssec = *ptr == '2' ? DS_YES
3661 : *ptr == '1' ? DS_NO
3664 addr->host_used = h;
3668 /* Finished with this address */
3675 /* Local interface address/port */
3677 if (*ptr) sending_ip_address = string_copy(ptr);
3679 if (*ptr) sending_port = atoi(CS ptr);
3683 /* Z marks the logical end of the data. It is followed by '0' if
3684 continue_transport was NULL at the end of transporting, otherwise '1'.
3685 We need to know when it becomes NULL during a delivery down a passed SMTP
3686 channel so that we don't try to pass anything more down it. Of course, for
3687 most normal messages it will remain NULL all the time. */
3692 continue_transport = NULL;
3693 continue_hostname = NULL;
3696 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3699 /* Anything else is a disaster. */
3702 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3703 "process %d for transport %s", ptr[-1], pid,
3704 addr->transport->driver_name);
3710 /* The done flag is inspected externally, to determine whether or not to
3711 call the function again when the process finishes. */
3715 /* If the process hadn't finished, and we haven't seen the end of the data
3716 or if we suffered a disaster, update the rest of the state, and return FALSE to
3717 indicate "not finished". */
3726 /* Close our end of the pipe, to prevent deadlock if the far end is still
3727 pushing stuff into it. */
3732 /* If we have finished without error, but haven't had data for every address,
3733 something is wrong. */
3736 msg = string_sprintf("insufficient address data read from pipe "
3737 "for transport process %d for transport %s", pid,
3738 addr->transport->driver_name);
3740 /* If an error message is set, something has gone wrong in getting back
3741 the delivery data. Put the message into each address and freeze it. */
3744 for (addr = addrlist; addr; addr = addr->next)
3746 addr->transport_return = DEFER;
3747 addr->special_action = SPECIAL_FREEZE;
3748 addr->message = msg;
3749 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3752 /* Return TRUE to indicate we have got all we need from this process, even
3753 if it hasn't actually finished yet. */
3760 /*************************************************
3761 * Post-process a set of remote addresses *
3762 *************************************************/
3764 /* Do what has to be done immediately after a remote delivery for each set of
3765 addresses, then re-write the spool if necessary. Note that post_process_one
3766 puts the address on an appropriate queue; hence we must fish off the next
3767 one first. This function is also called if there is a problem with setting
3768 up a subprocess to do a remote delivery in parallel. In this case, the final
3769 argument contains a message, and the action must be forced to DEFER.
3772 addr pointer to chain of address items
3773 logflags flags for logging
3774 msg NULL for normal cases; -> error message for unexpected problems
3775 fallback TRUE if processing fallback hosts
3781 remote_post_process(address_item *addr, int logflags, uschar *msg,
3784 /* If any host addresses were found to be unusable, add them to the unusable
3785 tree so that subsequent deliveries don't try them. */
3787 for (host_item * h = addr->host_list; h; h = h->next)
3789 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3791 /* Now handle each address on the chain. The transport has placed '=' or '-'
3792 into the special_action field for each successful delivery. */
3796 address_item *next = addr->next;
3798 /* If msg == NULL (normal processing) and the result is DEFER and we are
3799 processing the main hosts and there are fallback hosts available, put the
3800 address on the list for fallback delivery. */
3802 if ( addr->transport_return == DEFER
3803 && addr->fallback_hosts
3808 addr->host_list = addr->fallback_hosts;
3809 addr->next = addr_fallback;
3810 addr_fallback = addr;
3811 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3814 /* If msg is set (=> unexpected problem), set it in the address before
3815 doing the ordinary post processing. */
3821 addr->message = msg;
3822 addr->transport_return = DEFER;
3824 (void)post_process_one(addr, addr->transport_return, logflags,
3825 EXIM_DTYPE_TRANSPORT, addr->special_action);
3833 /* If we have just delivered down a passed SMTP channel, and that was
3834 the last address, the channel will have been closed down. Now that
3835 we have logged that delivery, set continue_sequence to 1 so that
3836 any subsequent deliveries don't get "*" incorrectly logged. */
3838 if (!continue_transport) continue_sequence = 1;
3843 /*************************************************
3844 * Wait for one remote delivery subprocess *
3845 *************************************************/
3847 /* This function is called while doing remote deliveries when either the
3848 maximum number of processes exist and we need one to complete so that another
3849 can be created, or when waiting for the last ones to complete. It must wait for
3850 the completion of one subprocess, empty the control block slot, and return a
3851 pointer to the address chain.
3854 Returns: pointer to the chain of addresses handled by the process;
3855 NULL if no subprocess found - this is an unexpected error
3858 static address_item *
3861 int poffset, status;
3862 address_item *addr, *addrlist;
3865 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3866 "to finish", message_id);
3868 /* Loop until either a subprocess completes, or there are no subprocesses in
3869 existence - in which case give an error return. We cannot proceed just by
3870 waiting for a completion, because a subprocess may have filled up its pipe, and
3871 be waiting for it to be emptied. Therefore, if no processes have finished, we
3872 wait for one of the pipes to acquire some data by calling select(), with a
3873 timeout just in case.
3875 The simple approach is just to iterate after reading data from a ready pipe.
3876 This leads to non-ideal behaviour when the subprocess has written its final Z
3877 item, closed the pipe, and is in the process of exiting (the common case). A
3878 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3879 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3882 To avoid this, if all the data that is needed has been read from a subprocess
3883 after select(), an explicit wait() for it is done. We know that all it is doing
3884 is writing to the pipe and then exiting, so the wait should not be long.
3886 The non-blocking waitpid() is to some extent just insurance; if we could
3887 reliably detect end-of-file on the pipe, we could always know when to do a
3888 blocking wait() for a completed process. However, because some systems use
3889 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3890 use code that functions without the need to recognize EOF.
3892 There's a double loop here just in case we end up with a process that is not in
3893 the list of remote delivery processes. Something has obviously gone wrong if
3894 this is the case. (For example, a process that is incorrectly left over from
3895 routing or local deliveries might be found.) The damage can be minimized by
3896 looping back and looking for another process. If there aren't any, the error
3897 return will happen. */
3899 for (;;) /* Normally we do not repeat this loop */
3901 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3904 fd_set select_pipes;
3905 int maxpipe, readycount;
3907 /* A return value of -1 can mean several things. If errno != ECHILD, it
3908 either means invalid options (which we discount), or that this process was
3909 interrupted by a signal. Just loop to try the waitpid() again.
3911 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3912 in existence. This should never happen, and is an unexpected error.
3913 However, there is a nasty complication when running under Linux. If "strace
3914 -f" is being used under Linux to trace this process and its children,
3915 subprocesses are "stolen" from their parents and become the children of the
3916 tracing process. A general wait such as the one we've just obeyed returns
3917 as if there are no children while subprocesses are running. Once a
3918 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3919 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3922 This does not happen using "truss" on Solaris, nor (I think) with other
3923 tracing facilities on other OS. It seems to be specific to Linux.
3925 What we do to get round this is to use kill() to see if any of our
3926 subprocesses are still in existence. If kill() gives an OK return, we know
3927 it must be for one of our processes - it can't be for a re-use of the pid,
3928 because if our process had finished, waitpid() would have found it. If any
3929 of our subprocesses are in existence, we proceed to use select() as if
3930 waitpid() had returned zero. I think this is safe. */
3934 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3937 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3938 "for process existence\n");
3940 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3942 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3944 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3945 "stolen by strace\n", (int)pid);
3946 break; /* With poffset set */
3950 if (poffset >= remote_max_parallel)
3952 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3953 return NULL; /* This is the error return */
3957 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3958 been handled above. A return value of zero means that there is at least one
3959 subprocess, but there are no completed subprocesses. See if any pipes are
3960 ready with any data for reading. */
3962 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3965 FD_ZERO(&select_pipes);
3966 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3967 if (parlist[poffset].pid != 0)
3969 int fd = parlist[poffset].fd;
3970 FD_SET(fd, &select_pipes);
3971 if (fd > maxpipe) maxpipe = fd;
3974 /* Stick in a 60-second timeout, just in case. */
3979 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3982 /* Scan through the pipes and read any that are ready; use the count
3983 returned by select() to stop when there are no more. Select() can return
3984 with no processes (e.g. if interrupted). This shouldn't matter.
3986 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3987 read, or there was a disaster. In either case, we are finished with this
3988 process. Do an explicit wait() for the process and break the main loop if
3991 It turns out that we have to deal with the case of an interrupted system
3992 call, which can happen on some operating systems if the signal handling is
3993 set up to do that by default. */
3996 readycount > 0 && poffset < remote_max_parallel;
3999 if ( (pid = parlist[poffset].pid) != 0
4000 && FD_ISSET(parlist[poffset].fd, &select_pipes)
4004 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4005 for (;;) /* Loop for signals */
4007 pid_t endedpid = waitpid(pid, &status, 0);
4008 if (endedpid == pid) goto PROCESS_DONE;
4009 if (endedpid != (pid_t)(-1) || errno != EINTR)
4010 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4011 "%d (errno = %d) from waitpid() for process %d",
4012 (int)endedpid, errno, (int)pid);
4017 /* Now go back and look for a completed subprocess again. */
4020 /* A completed process was detected by the non-blocking waitpid(). Find the
4021 data block that corresponds to this subprocess. */
4023 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4024 if (pid == parlist[poffset].pid) break;
4026 /* Found the data block; this is a known remote delivery process. We don't
4027 need to repeat the outer loop. This should be what normally happens. */
4029 if (poffset < remote_max_parallel) break;
4031 /* This situation is an error, but it's probably better to carry on looking
4032 for another process than to give up (as we used to do). */
4034 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4035 "transport process list", pid);
4036 } /* End of the "for" loop */
4038 /* Come here when all the data was completely read after a select(), and
4039 the process in pid has been wait()ed for. */
4046 debug_printf("remote delivery process %d ended\n", (int)pid);
4048 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4052 set_process_info("delivering %s", message_id);
4054 /* Get the chain of processed addresses */
4056 addrlist = parlist[poffset].addrlist;
4058 /* If the process did not finish cleanly, record an error and freeze (except
4059 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4060 in case the delivery did actually happen. */
4062 if ((status & 0xffff) != 0)
4065 int msb = (status >> 8) & 255;
4066 int lsb = status & 255;
4067 int code = (msb == 0)? (lsb & 0x7f) : msb;
4069 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4071 addrlist->transport->driver_name,
4073 (msb == 0)? "terminated by signal" : "exit code",
4076 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4077 addrlist->special_action = SPECIAL_FREEZE;
4079 for (addr = addrlist; addr; addr = addr->next)
4081 addr->transport_return = DEFER;
4082 addr->message = msg;
4085 remove_journal = FALSE;
4088 /* Else complete reading the pipe to get the result of the delivery, if all
4089 the data has not yet been obtained. */
4091 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4093 /* Put the data count and return path into globals, mark the data slot unused,
4094 decrement the count of subprocesses, and return the address chain. */
4096 transport_count = parlist[poffset].transport_count;
4097 used_return_path = parlist[poffset].return_path;
4098 parlist[poffset].pid = 0;
4105 /*************************************************
4106 * Wait for subprocesses and post-process *
4107 *************************************************/
4109 /* This function waits for subprocesses until the number that are still running
4110 is below a given threshold. For each complete subprocess, the addresses are
4111 post-processed. If we can't find a running process, there is some shambles.
4112 Better not bomb out, as that might lead to multiple copies of the message. Just
4113 log and proceed as if all done.
4116 max maximum number of subprocesses to leave running
4117 fallback TRUE if processing fallback hosts
4123 par_reduce(int max, BOOL fallback)
4125 while (parcount > max)
4127 address_item *doneaddr = par_wait();
4130 log_write(0, LOG_MAIN|LOG_PANIC,
4131 "remote delivery process count got out of step");
4136 transport_instance * tp = doneaddr->transport;
4137 if (tp->max_parallel)
4138 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4140 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4146 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4148 uschar pipe_header[PIPE_HEADER_SIZE+1];
4149 size_t total_len = PIPE_HEADER_SIZE + size;
4151 struct iovec iov[2] = {
4152 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4153 { buf, size } /* *the* data */
4158 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4159 /* complain to log if someone tries with buffer sizes we can't handle*/
4161 if (size > BIG_BUFFER_SIZE-1)
4163 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4164 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4166 size = BIG_BUFFER_SIZE;
4169 /* Should we check that we do not write more than PIPE_BUF? What would
4172 /* convert size to human readable string prepended by id and subid */
4173 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4174 id, subid, (long)size))
4175 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4177 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4178 id, subid, (long)size, pipe_header);
4180 if ((ret = writev(fd, iov, 2)) != total_len)
4181 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4182 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4183 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4186 /*************************************************
4187 * Do remote deliveries *
4188 *************************************************/
4190 /* This function is called to process the addresses in addr_remote. We must
4191 pick off the queue all addresses that have the same transport, remote
4192 destination, and errors address, and hand them to the transport in one go,
4193 subject to some configured limitations. If this is a run to continue delivering
4194 to an existing delivery channel, skip all but those addresses that can go to
4195 that channel. The skipped addresses just get deferred.
4197 If mua_wrapper is set, all addresses must be able to be sent in a single
4198 transaction. If not, this function yields FALSE.
4200 In Exim 4, remote deliveries are always done in separate processes, even
4201 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4202 is so that the base process can retain privilege. This makes the
4203 implementation of fallback transports feasible (though not initially done.)
4205 We create up to the configured number of subprocesses, each of which passes
4206 back the delivery state via a pipe. (However, when sending down an existing
4207 connection, remote_max_parallel is forced to 1.)
4210 fallback TRUE if processing fallback hosts
4212 Returns: TRUE normally
4213 FALSE if mua_wrapper is set and the addresses cannot all be sent
4218 do_remote_deliveries(BOOL fallback)
4223 parcount = 0; /* Number of executing subprocesses */
4225 /* When sending down an existing channel, only do one delivery at a time.
4226 We use a local variable (parmax) to hold the maximum number of processes;
4227 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4229 if (continue_transport) remote_max_parallel = 1;
4230 parmax = remote_max_parallel;
4232 /* If the data for keeping a list of processes hasn't yet been
4237 parlist = store_get(remote_max_parallel * sizeof(pardata));
4238 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4239 parlist[poffset].pid = 0;
4242 /* Now loop for each remote delivery */
4244 for (int delivery_count = 0; addr_remote; delivery_count++)
4250 int address_count = 1;
4251 int address_count_max;
4253 BOOL use_initgroups;
4254 BOOL pipe_done = FALSE;
4255 transport_instance *tp;
4256 address_item **anchor = &addr_remote;
4257 address_item *addr = addr_remote;
4258 address_item *last = addr;
4261 uschar * serialize_key = NULL;
4263 /* Pull the first address right off the list. */
4265 addr_remote = addr->next;
4268 DEBUG(D_deliver|D_transport)
4269 debug_printf("--------> %s <--------\n", addr->address);
4271 /* If no transport has been set, there has been a big screw-up somewhere. */
4273 if (!(tp = addr->transport))
4275 f.disable_logging = FALSE; /* Jic */
4276 panicmsg = US"No transport set by router";
4277 goto panic_continue;
4280 /* Check that this base address hasn't previously been delivered to this
4281 transport. The check is necessary at this point to handle homonymic addresses
4282 correctly in cases where the pattern of redirection changes between delivery
4283 attempts. Non-homonymic previous delivery is detected earlier, at routing
4286 if (previously_transported(addr, FALSE)) continue;
4288 /* Force failure if the message is too big. */
4290 if (tp->message_size_limit)
4292 int rc = check_message_size(tp, addr);
4295 addr->transport_return = rc;
4296 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4301 /* Get the flag which specifies whether the transport can handle different
4302 domains that nevertheless resolve to the same set of hosts. If it needs
4303 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4304 $host, $host_address, $host_port. */
4305 if (tp->expand_multi_domain)
4306 deliver_set_expansions(addr);
4308 if (exp_bool(addr, US"transport", tp->name, D_transport,
4309 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4310 &multi_domain) != OK)
4312 deliver_set_expansions(NULL);
4313 panicmsg = addr->message;
4314 goto panic_continue;
4317 /* Get the maximum it can handle in one envelope, with zero meaning
4318 unlimited, which is forced for the MUA wrapper case. */
4320 address_count_max = tp->max_addresses;
4321 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4324 /************************************************************************/
4325 /***** This is slightly experimental code, but should be safe. *****/
4327 /* The address_count_max value is the maximum number of addresses that the
4328 transport can send in one envelope. However, the transport must be capable of
4329 dealing with any number of addresses. If the number it gets exceeds its
4330 envelope limitation, it must send multiple copies of the message. This can be
4331 done over a single connection for SMTP, so uses less resources than making
4332 multiple connections. On the other hand, if remote_max_parallel is greater
4333 than one, it is perhaps a good idea to use parallel processing to move the
4334 message faster, even if that results in multiple simultaneous connections to
4337 How can we come to some compromise between these two ideals? What we do is to
4338 limit the number of addresses passed to a single instance of a transport to
4339 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4340 number of addresses routed to remote transports divided by
4341 remote_max_parallel. For example, if the message has 100 remote recipients,
4342 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4343 once. But if rcpt_max is 100, we could send up to 100.
4345 Of course, not all the remotely addresses in a message are going to go to the
4346 same set of hosts (except in smarthost configurations), so this is just a
4347 heuristic way of dividing up the work.
4349 Furthermore (1), because this may not be wanted in some cases, and also to
4350 cope with really pathological cases, there is also a limit to the number of
4351 messages that are sent over one connection. This is the same limit that is
4352 used when sending several different messages over the same connection.
4353 Continue_sequence is set when in this situation, to the number sent so
4354 far, including this message.
4356 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4357 is probably because they are using VERP, in which case they want to pass only
4358 one address at a time to the transport, in order to be able to use
4359 $local_part and $domain in constructing a new return path. We could test for
4360 the use of these variables, but as it is so likely they will be used when the
4361 maximum is 1, we don't bother. Just leave the value alone. */
4363 if ( address_count_max != 1
4364 && address_count_max < remote_delivery_count/remote_max_parallel
4367 int new_max = remote_delivery_count/remote_max_parallel;
4368 int message_max = tp->connection_max_messages;
4369 if (connection_max_messages >= 0) message_max = connection_max_messages;
4370 message_max -= continue_sequence - 1;
4371 if (message_max > 0 && new_max > address_count_max * message_max)
4372 new_max = address_count_max * message_max;
4373 address_count_max = new_max;
4376 /************************************************************************/
4379 /* Pick off all addresses which have the same transport, errors address,
4380 destination, and extra headers. In some cases they point to the same host
4381 list, but we also need to check for identical host lists generated from
4382 entirely different domains. The host list pointers can be NULL in the case
4383 where the hosts are defined in the transport. There is also a configured
4384 maximum limit of addresses that can be handled at once (see comments above
4385 for how it is computed).
4386 If the transport does not handle multiple domains, enforce that also,
4387 and if it might need a per-address check for this, re-evaluate it.
4390 while ((next = *anchor) && address_count < address_count_max)
4393 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4394 && tp == next->transport
4395 && same_hosts(next->host_list, addr->host_list)
4396 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4397 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4398 && same_ugid(tp, next, addr)
4399 && ( next->prop.remove_headers == addr->prop.remove_headers
4400 || ( next->prop.remove_headers
4401 && addr->prop.remove_headers
4402 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4406 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4408 US"transport", next->transport->name, D_transport,
4409 US"multi_domain", next->transport->multi_domain,
4410 next->transport->expand_multi_domain, &md) == OK
4415 *anchor = next->next;
4417 next->first = addr; /* remember top one (for retry processing) */
4422 else anchor = &(next->next);
4423 deliver_set_expansions(NULL);
4426 /* If we are acting as an MUA wrapper, all addresses must go in a single
4427 transaction. If not, put them back on the chain and yield FALSE. */
4429 if (mua_wrapper && addr_remote)
4431 last->next = addr_remote;
4436 /* If the transport is limited for parallellism, enforce that here.
4437 The hints DB entry is decremented in par_reduce(), when we reap the
4438 transport process. */
4440 if (tpt_parallel_check(tp, addr, &serialize_key))
4441 if ((panicmsg = expand_string_message))
4442 goto panic_continue;
4444 continue; /* Loop for the next set of addresses. */
4446 /* Set up the expansion variables for this set of addresses */
4448 deliver_set_expansions(addr);
4450 /* Ensure any transport-set auth info is fresh */
4451 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4453 /* Compute the return path, expanding a new one if required. The old one
4454 must be set first, as it might be referred to in the expansion. */
4456 if(addr->prop.errors_address)
4457 return_path = addr->prop.errors_address;
4458 #ifdef EXPERIMENTAL_SRS
4459 else if(addr->prop.srs_sender)
4460 return_path = addr->prop.srs_sender;
4463 return_path = sender_address;
4465 if (tp->return_path)
4467 uschar *new_return_path = expand_string(tp->return_path);
4468 if (new_return_path)
4469 return_path = new_return_path;
4470 else if (!f.expand_string_forcedfail)
4472 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4473 tp->return_path, expand_string_message);
4478 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4479 logs and sets up error messages, so we just post-process and continue with
4480 the next address. */
4482 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4488 /* If this transport has a setup function, call it now so that it gets
4489 run in this process and not in any subprocess. That way, the results of
4490 any setup that are retained by the transport can be reusable. One of the
4491 things the setup does is to set the fallback host lists in the addresses.
4492 That is why it is called at this point, before the continue delivery
4493 processing, because that might use the fallback hosts. */
4496 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4498 /* If we have a connection still open from a verify stage (lazy-close)
4499 treat it as if it is a continued connection (apart from the counter used
4500 for the log line mark). */
4502 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4505 debug_printf("lazy-callout-close: have conn still open from verification\n");
4506 continue_transport = cutthrough.transport;
4507 continue_hostname = string_copy(cutthrough.host.name);
4508 continue_host_address = string_copy(cutthrough.host.address);
4509 continue_sequence = 1;
4510 sending_ip_address = cutthrough.snd_ip;
4511 sending_port = cutthrough.snd_port;
4512 smtp_peer_options = cutthrough.peer_options;
4515 /* If this is a run to continue delivery down an already-established
4516 channel, check that this set of addresses matches the transport and
4517 the channel. If it does not, defer the addresses. If a host list exists,
4518 we must check that the continue host is on the list. Otherwise, the
4519 host is set in the transport. */
4521 f.continue_more = FALSE; /* In case got set for the last lot */
4522 if (continue_transport)
4524 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4526 /* If the transport is about to override the host list do not check
4527 it here but take the cost of running the transport process to discover
4528 if the continued_hostname connection is suitable. This is a layering
4529 violation which is unfortunate as it requires we haul in the smtp
4534 smtp_transport_options_block * ob;
4536 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4537 && (ob = (smtp_transport_options_block *)tp->options_block)
4538 && ob->hosts_override && ob->hosts
4544 for (host_item * h = addr->host_list; h; h = h->next)
4545 if (Ustrcmp(h->name, continue_hostname) == 0)
4546 /*XXX should also check port here */
4547 { ok = TRUE; break; }
4551 /* Addresses not suitable; defer or queue for fallback hosts (which
4552 might be the continue host) and skip to next address. */
4556 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4557 Ustrcmp(continue_transport, tp->name) != 0
4558 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4559 : string_sprintf("no host matching %s", continue_hostname));
4560 if (serialize_key) enq_end(serialize_key);
4562 if (addr->fallback_hosts && !fallback)
4564 for (next = addr; ; next = next->next)
4566 next->host_list = next->fallback_hosts;
4567 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4568 if (!next->next) break;
4570 next->next = addr_fallback;
4571 addr_fallback = addr;
4576 for (next = addr; ; next = next->next)
4578 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4579 if (!next->next) break;
4581 next->next = addr_defer;
4588 /* Set a flag indicating whether there are further addresses that list
4589 the continued host. This tells the transport to leave the channel open,
4590 but not to pass it to another delivery process. We'd like to do that
4591 for non-continue_transport cases too but the knowlege of which host is
4592 connected to is too hard to manage. Perhaps we need a finer-grain
4593 interface to the transport. */
4595 for (next = addr_remote; next && !f.continue_more; next = next->next)
4596 for (host_item * h = next->host_list; h; h = h->next)
4597 if (Ustrcmp(h->name, continue_hostname) == 0)
4598 { f.continue_more = TRUE; break; }
4601 /* The transports set up the process info themselves as they may connect
4602 to more than one remote machine. They also have to set up the filter
4603 arguments, if required, so that the host name and address are available
4606 transport_filter_argv = NULL;
4608 /* Create the pipe for inter-process communication. If pipe creation
4609 fails, it is probably because the value of remote_max_parallel is so
4610 large that too many file descriptors for pipes have been created. Arrange
4611 to wait for a process to finish, and then try again. If we still can't
4612 create a pipe when all processes have finished, break the retry loop. */
4616 if (pipe(pfd) == 0) pipe_done = TRUE;
4617 else if (parcount > 0) parmax = parcount;
4620 /* We need to make the reading end of the pipe non-blocking. There are
4621 two different options for this. Exim is cunningly (I hope!) coded so
4622 that it can use either of them, though it prefers O_NONBLOCK, which
4623 distinguishes between EOF and no-more-data. */
4625 /* The data appears in a timely manner and we already did a select on
4626 all pipes, so I do not see a reason to use non-blocking IO here
4629 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4631 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4635 /* If the maximum number of subprocesses already exist, wait for a process
4636 to finish. If we ran out of file descriptors, parmax will have been reduced
4637 from its initial value of remote_max_parallel. */
4639 par_reduce(parmax - 1, fallback);
4642 /* If we failed to create a pipe and there were no processes to wait
4643 for, we have to give up on this one. Do this outside the above loop
4644 so that we can continue the main loop. */
4648 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4652 /* Find a free slot in the pardata list. Must do this after the possible
4653 waiting for processes to finish, because a terminating process will free
4656 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4657 if (parlist[poffset].pid == 0)
4660 /* If there isn't one, there has been a horrible disaster. */
4662 if (poffset >= remote_max_parallel)
4664 (void)close(pfd[pipe_write]);
4665 (void)close(pfd[pipe_read]);
4666 panicmsg = US"Unexpectedly no free subprocess slot";
4670 /* Now fork a subprocess to do the remote delivery, but before doing so,
4671 ensure that any cached resources are released so as not to interfere with
4672 what happens in the subprocess. */
4676 if ((pid = fork()) == 0)
4678 int fd = pfd[pipe_write];
4681 /* Setting this global in the subprocess means we need never clear it */
4682 transport_name = tp->name;
4684 /* There are weird circumstances in which logging is disabled */
4685 f.disable_logging = tp->disable_logging;
4687 /* Show pids on debug output if parallelism possible */
4689 if (parmax > 1 && (parcount > 0 || addr_remote))
4691 DEBUG(D_any|D_v) debug_selector |= D_pid;
4692 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4695 /* Reset the random number generator, so different processes don't all
4696 have the same sequence. In the test harness we want different, but
4697 predictable settings for each delivery process, so do something explicit
4698 here rather they rely on the fixed reset in the random number function. */
4700 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4702 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4703 a new process that may be forked to do another delivery down the same
4706 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4708 /* Close open file descriptors for the pipes of other processes
4709 that are running in parallel. */
4711 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4712 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4714 /* This process has inherited a copy of the file descriptor
4715 for the data file, but its file pointer is shared with all the
4716 other processes running in parallel. Therefore, we have to re-open
4717 the file in order to get a new file descriptor with its own
4718 file pointer. We don't need to lock it, as the lock is held by
4719 the parent process. There doesn't seem to be any way of doing
4720 a dup-with-new-file-pointer. */
4722 (void)close(deliver_datafile);
4724 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4726 if ((deliver_datafile = Uopen(fname,
4730 O_RDWR | O_APPEND, 0)) < 0)
4731 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4732 "parallel delivery: %s", fname, strerror(errno));
4735 /* Set the close-on-exec flag */
4737 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4741 /* Set the uid/gid of this process; bombs out on failure. */
4743 exim_setugid(uid, gid, use_initgroups,
4744 string_sprintf("remote delivery to %s with transport=%s",
4745 addr->address, tp->name));
4747 /* Close the unwanted half of this process' pipe, set the process state,
4748 and run the transport. Afterwards, transport_count will contain the number
4749 of bytes written. */
4751 (void)close(pfd[pipe_read]);
4752 set_process_info("delivering %s using %s", message_id, tp->name);
4753 debug_print_string(tp->debug_string);
4754 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4756 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4757 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4759 /* Ensure any cached resources that we used are now released */
4763 /* Pass the result back down the pipe. This is a lot more information
4764 than is needed for a local delivery. We have to send back the error
4765 status for each address, the usability status for each host that is
4766 flagged as unusable, and all the retry items. When TLS is in use, we
4767 send also the cipher and peerdn information. Each type of information
4768 is flagged by an identifying byte, and is then in a fixed format (with
4769 strings terminated by zeros), and there is a final terminator at the
4770 end. The host information and retry information is all attached to
4771 the first address, so that gets sent at the start. */
4773 /* Host unusability information: for most success cases this will
4776 for (h = addr->host_list; h; h = h->next)
4778 if (!h->address || h->status < hstatus_unusable) continue;
4779 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4780 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4783 /* The number of bytes written. This is the same for each address. Even
4784 if we sent several copies of the message down the same connection, the
4785 size of each one is the same, and it's that value we have got because
4786 transport_count gets reset before calling transport_write_message(). */
4788 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4789 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4791 /* Information about what happened to each address. Four item types are
4792 used: an optional 'X' item first, for TLS information, then an optional "C"
4793 item for any client-auth info followed by 'R' items for any retry settings,
4794 and finally an 'A' item for the remaining data. */
4796 for(; addr; addr = addr->next)
4801 /* The certificate verification status goes into the flags */
4802 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4804 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4807 /* Use an X item only if there's something to send */
4811 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4815 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4817 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4819 else if (continue_proxy_cipher)
4821 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4823 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4829 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4833 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4838 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4842 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4844 # ifndef DISABLE_OCSP
4845 if (addr->ocsp > OCSP_NOT_REQ)
4847 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4848 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4851 #endif /*SUPPORT_TLS*/
4853 if (client_authenticator)
4855 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4856 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4858 if (client_authenticated_id)
4860 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4861 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4863 if (client_authenticated_sender)
4865 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4866 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4869 #ifndef DISABLE_PRDR
4870 if (testflag(addr, af_prdr_used))
4871 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4874 if (testflag(addr, af_pipelining))
4875 #ifdef EXPERIMENTAL_PIPE_CONNECT
4876 if (testflag(addr, af_early_pipe))
4877 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4880 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4882 if (testflag(addr, af_chunking_used))
4883 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4885 if (testflag(addr, af_tcp_fastopen_conn))
4886 rmt_dlv_checked_write(fd, 'T',
4887 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4891 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4892 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4894 /* Retry information: for most success cases this will be null. */
4896 for (r = addr->retries; r; r = r->next)
4898 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4899 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4900 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4901 ptr += sizeof(r->basic_errno);
4902 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4903 ptr += sizeof(r->more_errno);
4904 if (!r->message) *ptr++ = 0; else
4906 sprintf(CS ptr, "%.512s", r->message);
4909 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4912 #ifdef SUPPORT_SOCKS
4913 if (LOGGING(proxy) && proxy_session)
4916 if (proxy_local_address)
4918 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4919 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4920 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4921 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4922 ptr += sizeof(proxy_local_port);
4926 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4930 #ifdef EXPERIMENTAL_DSN_INFO
4931 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4932 if (addr->smtp_greeting)
4934 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4935 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4936 if (addr->helo_response)
4938 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4939 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4943 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4947 /* The rest of the information goes in an 'A0' item. */
4949 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4950 ptr = big_buffer + 2;
4951 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4952 ptr += sizeof(addr->basic_errno);
4953 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4954 ptr += sizeof(addr->more_errno);
4955 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4956 ptr += sizeof(addr->delivery_usec);
4957 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4958 ptr += sizeof(addr->flags);
4960 if (!addr->message) *ptr++ = 0; else
4961 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4963 if (!addr->user_message) *ptr++ = 0; else
4964 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4966 if (!addr->host_used) *ptr++ = 0; else
4968 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4969 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4970 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4971 ptr += sizeof(addr->host_used->port);
4973 /* DNS lookup status */
4974 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4975 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4978 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4981 /* Local interface address/port */
4982 #ifdef EXPERIMENTAL_DSN_INFO
4983 if (sending_ip_address)
4985 if (LOGGING(incoming_interface) && sending_ip_address)
4989 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4990 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4991 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4994 /* Add termination flag, close the pipe, and that's it. The character
4995 after 'Z' indicates whether continue_transport is now NULL or not.
4996 A change from non-NULL to NULL indicates a problem with a continuing
4999 big_buffer[0] = continue_transport ? '1' : '0';
5000 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5005 /* Back in the mainline: close the unwanted half of the pipe. */
5007 (void)close(pfd[pipe_write]);
5009 /* If we have a connection still open from a verify stage (lazy-close)
5010 release its TLS library context (if any) as responsibility was passed to
5011 the delivery child process. */
5013 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5016 if (cutthrough.is_tls)
5017 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5019 (void) close(cutthrough.cctx.sock);
5020 release_cutthrough_connection(US"passed to transport proc");
5023 /* Fork failed; defer with error message */
5027 (void)close(pfd[pipe_read]);
5028 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5029 addr->domain, strerror(errno));
5033 /* Fork succeeded; increment the count, and remember relevant data for
5034 when the process finishes. */
5037 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5038 parlist[poffset].pid = pid;
5039 parlist[poffset].fd = pfd[pipe_read];
5040 parlist[poffset].done = FALSE;
5041 parlist[poffset].msg = NULL;
5042 parlist[poffset].return_path = return_path;
5044 /* If the process we've just started is sending a message down an existing
5045 channel, wait for it now. This ensures that only one such process runs at
5046 once, whatever the value of remote_max parallel. Otherwise, we might try to
5047 send two or more messages simultaneously down the same channel. This could
5048 happen if there are different domains that include the same host in otherwise
5049 different host lists.
5051 Also, if the transport closes down the channel, this information gets back
5052 (continue_transport gets set to NULL) before we consider any other addresses
5055 if (continue_transport) par_reduce(0, fallback);
5057 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5058 newly created process get going before we create another process. This should
5059 ensure repeatability in the tests. We only need to wait a tad. */
5061 else if (f.running_in_test_harness) millisleep(500);
5066 if (serialize_key) enq_end(serialize_key);
5068 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5072 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5073 are still running and post-process their addresses. */
5075 par_reduce(0, fallback);
5082 /*************************************************
5083 * Split an address into local part and domain *
5084 *************************************************/
5086 /* This function initializes an address for routing by splitting it up into a
5087 local part and a domain. The local part is set up twice - once in its original
5088 casing, and once in lower case, and it is dequoted. We also do the "percent
5089 hack" for configured domains. This may lead to a DEFER result if a lookup
5090 defers. When a percent-hacking takes place, we insert a copy of the original
5091 address as a new parent of this address, as if we have had a redirection.
5094 addr points to an addr_item block containing the address
5097 DEFER - could not determine if domain is %-hackable
5101 deliver_split_address(address_item * addr)
5103 uschar * address = addr->address;
5108 if (!(domain = Ustrrchr(address, '@')))
5109 return DEFER; /* should always have a domain, but just in case... */
5111 len = domain - address;
5112 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5114 /* The implication in the RFCs (though I can't say I've seen it spelled out
5115 explicitly) is that quoting should be removed from local parts at the point
5116 where they are locally interpreted. [The new draft "821" is more explicit on
5117 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5118 removing quoting backslashes and any unquoted doublequotes. */
5120 t = addr->cc_local_part = store_get(len+1);
5124 if (c == '\"') continue;
5134 /* We do the percent hack only for those domains that are listed in
5135 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5137 if (percent_hack_domains)
5140 uschar *new_address = NULL;
5141 uschar *local_part = addr->cc_local_part;
5143 deliver_domain = addr->domain; /* set $domain */
5145 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5146 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5148 && (t = Ustrrchr(local_part, '%')) != NULL
5151 new_address = string_copy(local_part);
5152 new_address[t - local_part] = '@';
5153 deliver_domain = string_copylc(t+1);
5154 local_part = string_copyn(local_part, t - local_part);
5157 if (rc == DEFER) return DEFER; /* lookup deferred */
5159 /* If hackery happened, set up new parent and alter the current address. */
5163 address_item *new_parent = store_get(sizeof(address_item));
5164 *new_parent = *addr;
5165 addr->parent = new_parent;
5166 new_parent->child_count = 1;
5167 addr->address = new_address;
5168 addr->unique = string_copy(new_address);
5169 addr->domain = deliver_domain;
5170 addr->cc_local_part = local_part;
5171 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5176 /* Create the lowercased version of the final local part, and make that the
5177 default one to be used. */
5179 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5186 /*************************************************
5187 * Get next error message text *
5188 *************************************************/
5190 /* If f is not NULL, read the next "paragraph", from a customized error message
5191 text file, terminated by a line containing ****, and expand it.
5194 f NULL or a file to read from
5195 which string indicating which string (for errors)
5197 Returns: NULL or an expanded string
5201 next_emf(FILE *f, uschar *which)
5207 if (!f) return NULL;
5209 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5212 para = string_get(256);
5215 para = string_cat(para, buffer);
5216 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5219 if ((yield = expand_string(string_from_gstring(para))))
5222 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5223 "bounce_message_file or warn_message_file (%s): %s", which,
5224 expand_string_message);
5231 /*************************************************
5232 * Close down a passed transport channel *
5233 *************************************************/
5235 /* This function is called when a passed transport channel cannot be used.
5236 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5237 so that the function call can be the argument of a "return" statement.
5240 Returns: DELIVER_NOT_ATTEMPTED
5244 continue_closedown(void)
5246 if (continue_transport)
5247 for (transport_instance * t = transports; t; t = t->next)
5248 if (Ustrcmp(t->name, continue_transport) == 0)
5250 if (t->info->closedown) (t->info->closedown)(t);
5253 return DELIVER_NOT_ATTEMPTED;
5259 /*************************************************
5260 * Print address information *
5261 *************************************************/
5263 /* This function is called to output an address, or information about an
5264 address, for bounce or defer messages. If the hide_child flag is set, all we
5265 output is the original ancestor address.
5268 addr points to the address
5269 f the FILE to print to
5270 si an initial string
5271 sc a continuation string for before "generated"
5274 Returns: TRUE if the address is not hidden
5278 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5282 uschar *printed = US"";
5283 address_item *ancestor = addr;
5284 while (ancestor->parent) ancestor = ancestor->parent;
5286 fprintf(f, "%s", CS si);
5288 if (addr->parent && testflag(addr, af_hide_child))
5290 printed = US"an undisclosed address";
5293 else if (!testflag(addr, af_pfr) || !addr->parent)
5294 printed = addr->address;
5298 uschar *s = addr->address;
5301 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5302 else if (addr->address[0] == '|') ss = US"pipe";
5305 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5306 printed = addr->parent->address;
5309 fprintf(f, "%s", CS string_printing(printed));
5311 if (ancestor != addr)
5313 uschar *original = ancestor->onetime_parent;
5314 if (!original) original= ancestor->address;
5315 if (strcmpic(original, printed) != 0)
5316 fprintf(f, "%s(%sgenerated from %s)", sc,
5317 ancestor != addr->parent ? "ultimately " : "",
5318 string_printing(original));
5321 if (addr->host_used)
5322 fprintf(f, "\n host %s [%s]",
5323 addr->host_used->name, addr->host_used->address);
5325 fprintf(f, "%s", CS se);
5333 /*************************************************
5334 * Print error for an address *
5335 *************************************************/
5337 /* This function is called to print the error information out of an address for
5338 a bounce or a warning message. It tries to format the message reasonably by
5339 introducing newlines. All lines are indented by 4; the initial printing
5340 position must be set before calling.
5342 This function used always to print the error. Nowadays we want to restrict it
5343 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5344 and filter "fail". We no longer pass other information willy-nilly in bounce
5345 and warning messages. Text in user_message is always output; text in message
5346 only if the af_pass_message flag is set.
5350 f the FILE to print on
5357 print_address_error(address_item *addr, FILE *f, uschar *t)
5359 int count = Ustrlen(t);
5360 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5362 if (!s && !(s = addr->user_message))
5365 fprintf(f, "\n %s", t);
5368 if (*s == '\\' && s[1] == 'n')
5378 if (*s++ == ':' && isspace(*s) && count > 45)
5380 fprintf(f, "\n "); /* sic (because space follows) */
5387 /***********************************************************
5388 * Print Diagnostic-Code for an address *
5389 ************************************************************/
5391 /* This function is called to print the error information out of an address for
5392 a bounce or a warning message. It tries to format the message reasonably as
5393 required by RFC 3461 by adding a space after each newline
5395 it uses the same logic as print_address_error() above. if af_pass_message is true
5396 and addr->message is set it uses the remote host answer. if not addr->user_message
5397 is used instead if available.
5401 f the FILE to print on
5407 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5409 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5411 /* af_pass_message and addr->message set ? print remote host answer */
5415 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5417 /* search first ": ". we assume to find the remote-MTA answer there */
5418 if (!(s = Ustrstr(addr->message, ": ")))
5419 return; /* not found, bail out */
5420 s += 2; /* skip ": " */
5421 fprintf(f, "Diagnostic-Code: smtp; ");
5423 /* no message available. do nothing */
5427 if (*s == '\\' && s[1] == 'n')
5429 fputs("\n ", f); /* as defined in RFC 3461 */
5439 /*************************************************
5440 * Check list of addresses for duplication *
5441 *************************************************/
5443 /* This function was introduced when the test for duplicate addresses that are
5444 not pipes, files, or autoreplies was moved from the middle of routing to when
5445 routing was complete. That was to fix obscure cases when the routing history
5446 affects the subsequent routing of identical addresses. This function is called
5447 after routing, to check that the final routed addresses are not duplicates.
5449 If we detect a duplicate, we remember what it is a duplicate of. Note that
5450 pipe, file, and autoreply de-duplication is handled during routing, so we must
5451 leave such "addresses" alone here, as otherwise they will incorrectly be
5454 Argument: address of list anchor
5459 do_duplicate_check(address_item **anchor)
5462 while ((addr = *anchor))
5465 if (testflag(addr, af_pfr))
5467 anchor = &(addr->next);
5469 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5471 DEBUG(D_deliver|D_route)
5472 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5473 *anchor = addr->next;
5474 addr->dupof = tnode->data.ptr;
5475 addr->next = addr_duplicate;
5476 addr_duplicate = addr;
5480 tree_add_duplicate(addr->unique, addr);
5481 anchor = &(addr->next);
5489 /*************************************************
5490 * Deliver one message *
5491 *************************************************/
5493 /* This is the function which is called when a message is to be delivered. It
5494 is passed the id of the message. It is possible that the message no longer
5495 exists, if some other process has delivered it, and it is also possible that
5496 the message is being worked on by another process, in which case the data file
5499 If no delivery is attempted for any of the above reasons, the function returns
5500 DELIVER_NOT_ATTEMPTED.
5502 If the give_up flag is set true, do not attempt any deliveries, but instead
5503 fail all outstanding addresses and return the message to the sender (or
5506 A delivery operation has a process all to itself; we never deliver more than
5507 one message in the same process. Therefore we needn't worry too much about
5510 Liable to be called as root.
5513 id the id of the message to be delivered
5514 forced TRUE if delivery was forced by an administrator; this overrides
5515 retry delays and causes a delivery to be tried regardless
5516 give_up TRUE if an administrator has requested that delivery attempts
5519 Returns: When the global variable mua_wrapper is FALSE:
5520 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5521 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5522 When the global variable mua_wrapper is TRUE:
5523 DELIVER_MUA_SUCCEEDED if delivery succeeded
5524 DELIVER_MUA_FAILED if delivery failed
5525 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5529 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5532 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5533 time_t now = time(NULL);
5534 address_item *addr_last = NULL;
5535 uschar *filter_message = NULL;
5536 int process_recipients = RECIP_ACCEPT;
5539 extern int acl_where;
5541 uschar *info = queue_run_pid == (pid_t)0
5542 ? string_sprintf("delivering %s", id)
5543 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5545 /* If the D_process_info bit is on, set_process_info() will output debugging
5546 information. If not, we want to show this initial information if D_deliver or
5547 D_queue_run is set or in verbose mode. */
5549 set_process_info("%s", info);
5551 if ( !(debug_selector & D_process_info)
5552 && (debug_selector & (D_deliver|D_queue_run|D_v))
5554 debug_printf("%s\n", info);
5556 /* Ensure that we catch any subprocesses that are created. Although Exim
5557 sets SIG_DFL as its initial default, some routes through the code end up
5558 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5559 has been forked, but no re-exec has been done. We use sigaction rather than
5560 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5561 sure it is turned off. (There was a problem on AIX with this.) */
5565 struct sigaction act;
5566 act.sa_handler = SIG_DFL;
5567 sigemptyset(&(act.sa_mask));
5569 sigaction(SIGCHLD, &act, NULL);
5572 signal(SIGCHLD, SIG_DFL);
5575 /* Make the forcing flag available for routers and transports, set up the
5576 global message id field, and initialize the count for returned files and the
5577 message size. This use of strcpy() is OK because the length id is checked when
5578 it is obtained from a command line (the -M or -q options), and otherwise it is
5579 known to be a valid message id. */
5581 if (id != message_id)
5582 Ustrcpy(message_id, id);
5583 f.deliver_force = forced;
5587 /* Initialize some flags */
5589 update_spool = FALSE;
5590 remove_journal = TRUE;
5592 /* Set a known context for any ACLs we call via expansions */
5593 acl_where = ACL_WHERE_DELIVERY;
5595 /* Reset the random number generator, so that if several delivery processes are
5596 started from a queue runner that has already used random numbers (for sorting),
5597 they don't all get the same sequence. */
5601 /* Open and lock the message's data file. Exim locks on this one because the
5602 header file may get replaced as it is re-written during the delivery process.
5603 Any failures cause messages to be written to the log, except for missing files
5604 while queue running - another process probably completed delivery. As part of
5605 opening the data file, message_subdir gets set. */
5607 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5608 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5610 /* The value of message_size at this point has been set to the data length,
5611 plus one for the blank line that notionally precedes the data. */
5613 /* Now read the contents of the header file, which will set up the headers in
5614 store, and also the list of recipients and the tree of non-recipients and
5615 assorted flags. It updates message_size. If there is a reading or format error,
5616 give up; if the message has been around for sufficiently long, remove it. */
5619 uschar * spoolname = string_sprintf("%s-H", id);
5620 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5622 if (errno == ERRNO_SPOOLFORMAT)
5624 struct stat statbuf;
5625 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5627 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5628 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5630 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5633 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5636 /* If we managed to read the envelope data, received_time contains the
5637 time the message was received. Otherwise, we can calculate it from the
5640 if (rc != spool_read_hdrerror)
5642 received_time.tv_sec = received_time.tv_usec = 0;
5643 /*XXX subsec precision?*/
5644 for (i = 0; i < 6; i++)
5645 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5648 /* If we've had this malformed message too long, sling it. */
5650 if (now - received_time.tv_sec > keep_malformed)
5652 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5653 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5654 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5655 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5656 log_write(0, LOG_MAIN, "Message removed because older than %s",
5657 readconf_printtime(keep_malformed));
5660 (void)close(deliver_datafile);
5661 deliver_datafile = -1;
5662 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5666 /* The spool header file has been read. Look to see if there is an existing
5667 journal file for this message. If there is, it means that a previous delivery
5668 attempt crashed (program or host) before it could update the spool header file.
5669 Read the list of delivered addresses from the journal and add them to the
5670 nonrecipients tree. Then update the spool file. We can leave the journal in
5671 existence, as it will get further successful deliveries added to it in this
5672 run, and it will be deleted if this function gets to its end successfully.
5673 Otherwise it might be needed again. */
5676 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5679 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5687 && lseek(journal_fd, 0, SEEK_SET) == 0
5688 && (jread = fdopen(journal_fd, "rb"))
5691 while (Ufgets(big_buffer, big_buffer_size, jread))
5693 int n = Ustrlen(big_buffer);
5694 big_buffer[n-1] = 0;
5695 tree_add_nonrecipient(big_buffer);
5696 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5697 "journal file\n", big_buffer);
5700 if ((journal_fd = dup(fileno(jread))) < 0)
5701 journal_fd = fileno(jread);
5703 (void) fclose(jread); /* Try to not leak the FILE resource */
5705 /* Panic-dies on error */
5706 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5708 else if (errno != ENOENT)
5710 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5711 "%s", strerror(errno));
5712 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5715 /* A null recipients list indicates some kind of disaster. */
5717 if (!recipients_list)
5719 (void)close(deliver_datafile);
5720 deliver_datafile = -1;
5721 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5722 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5727 /* Handle a message that is frozen. There are a number of different things that
5728 can happen, but in the default situation, unless forced, no delivery is
5731 if (f.deliver_freeze)
5733 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5734 /* Moving to another directory removes the message from Exim's view. Other
5735 tools must be used to deal with it. Logging of this action happens in
5736 spool_move_message() and its subfunctions. */
5738 if ( move_frozen_messages
5739 && spool_move_message(id, message_subdir, US"", US"F")
5741 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5744 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5745 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5746 flag causing all recipients to be failed. The time is the age of the
5747 message, not the time since freezing. */
5749 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5751 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5752 process_recipients = RECIP_FAIL_TIMEOUT;
5755 /* For bounce messages (and others with no sender), thaw if the error message
5756 ignore timer is exceeded. The message will be discarded if this delivery
5759 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5760 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5762 /* If this is a bounce message, or there's no auto thaw, or we haven't
5763 reached the auto thaw time yet, and this delivery is not forced by an admin
5764 user, do not attempt delivery of this message. Note that forced is set for
5765 continuing messages down the same channel, in order to skip load checking and
5766 ignore hold domains, but we don't want unfreezing in that case. */
5770 if ( ( sender_address[0] == 0
5772 || now <= deliver_frozen_at + auto_thaw
5774 && ( !forced || !f.deliver_force_thaw
5775 || !f.admin_user || continue_hostname
5778 (void)close(deliver_datafile);
5779 deliver_datafile = -1;
5780 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5781 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5784 /* If delivery was forced (by an admin user), assume a manual thaw.
5785 Otherwise it's an auto thaw. */
5789 f.deliver_manual_thaw = TRUE;
5790 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5792 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5795 /* We get here if any of the rules for unfreezing have triggered. */
5797 f.deliver_freeze = FALSE;
5798 update_spool = TRUE;
5802 /* Open the message log file if we are using them. This records details of
5803 deliveries, deferments, and failures for the benefit of the mail administrator.
5804 The log is not used by exim itself to track the progress of a message; that is
5805 done by rewriting the header spool file. */
5809 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5813 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5815 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5816 fname, strerror(errno));
5817 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5820 /* Make a C stream out of it. */
5822 if (!(message_log = fdopen(fd, "a")))
5824 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5825 fname, strerror(errno));
5826 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5831 /* If asked to give up on a message, log who did it, and set the action for all
5836 struct passwd *pw = getpwuid(real_uid);
5837 log_write(0, LOG_MAIN, "cancelled by %s",
5838 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5839 process_recipients = RECIP_FAIL;
5842 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5844 else if (received_count > received_headers_max)
5845 process_recipients = RECIP_FAIL_LOOP;
5847 /* Otherwise, if a system-wide, address-independent message filter is
5848 specified, run it now, except in the case when we are failing all recipients as
5849 a result of timeout_frozen_after. If the system filter yields "delivered", then
5850 ignore the true recipients of the message. Failure of the filter file is
5851 logged, and the delivery attempt fails. */
5853 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5858 redirect_block redirect;
5860 if (system_filter_uid_set)
5862 ugid.uid = system_filter_uid;
5863 ugid.gid = system_filter_gid;
5864 ugid.uid_set = ugid.gid_set = TRUE;
5867 ugid.uid_set = ugid.gid_set = FALSE;
5869 return_path = sender_address;
5870 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5871 f.system_filtering = TRUE;
5873 /* Any error in the filter file causes a delivery to be abandoned. */
5875 redirect.string = system_filter;
5876 redirect.isfile = TRUE;
5877 redirect.check_owner = redirect.check_group = FALSE;
5878 redirect.owners = NULL;
5879 redirect.owngroups = NULL;
5881 redirect.modemask = 0;
5883 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5886 &redirect, /* Where the data is */
5887 RDO_DEFER | /* Turn on all the enabling options */
5888 RDO_FAIL | /* Leave off all the disabling options */
5893 NULL, /* No :include: restriction (not used in filter) */
5894 NULL, /* No sieve vacation directory (not sieve!) */
5895 NULL, /* No sieve enotify mailto owner (not sieve!) */
5896 NULL, /* No sieve user address (not sieve!) */
5897 NULL, /* No sieve subaddress (not sieve!) */
5898 &ugid, /* uid/gid data */
5899 &addr_new, /* Where to hang generated addresses */
5900 &filter_message, /* Where to put error message */
5901 NULL, /* Don't skip syntax errors */
5902 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5903 US"system filter"); /* For error messages */
5905 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5907 if (rc == FF_ERROR || rc == FF_NONEXIST)
5909 (void)close(deliver_datafile);
5910 deliver_datafile = -1;
5911 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5912 string_printing(filter_message));
5913 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5916 /* Reset things. If the filter message is an empty string, which can happen
5917 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5919 f.system_filtering = FALSE;
5920 f.enable_dollar_recipients = FALSE;
5921 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5923 /* Save the values of the system filter variables so that user filters
5926 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5928 /* The filter can request that delivery of the original addresses be
5933 process_recipients = RECIP_DEFER;
5934 deliver_msglog("Delivery deferred by system filter\n");
5935 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5938 /* The filter can request that a message be frozen, but this does not
5939 take place if the message has been manually thawed. In that case, we must
5940 unset "delivered", which is forced by the "freeze" command to make -bF
5943 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5945 f.deliver_freeze = TRUE;
5946 deliver_frozen_at = time(NULL);
5947 process_recipients = RECIP_DEFER;
5948 frozen_info = string_sprintf(" by the system filter%s%s",
5949 filter_message ? US": " : US"",
5950 filter_message ? filter_message : US"");
5953 /* The filter can request that a message be failed. The error message may be
5954 quite long - it is sent back to the sender in the bounce - but we don't want
5955 to fill up the log with repetitions of it. If it starts with << then the text
5956 between << and >> is written to the log, with the rest left for the bounce
5959 else if (rc == FF_FAIL)
5961 uschar *colon = US"";
5962 uschar *logmsg = US"";
5965 process_recipients = RECIP_FAIL_FILTER;
5971 if ( filter_message[0] == '<'
5972 && filter_message[1] == '<'
5973 && (logend = Ustrstr(filter_message, ">>"))
5976 logmsg = filter_message + 2;
5977 loglen = logend - logmsg;
5978 filter_message = logend + 2;
5979 if (filter_message[0] == 0) filter_message = NULL;
5983 logmsg = filter_message;
5984 loglen = Ustrlen(filter_message);
5988 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5992 /* Delivery can be restricted only to those recipients (if any) that the
5993 filter specified. */
5995 else if (rc == FF_DELIVERED)
5997 process_recipients = RECIP_IGNORE;
5999 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6001 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6004 /* If any new addresses were created by the filter, fake up a "parent"
6005 for them. This is necessary for pipes, etc., which are expected to have
6006 parents, and it also gives some sensible logging for others. Allow
6007 pipes, files, and autoreplies, and run them as the filter uid if set,
6008 otherwise as the current uid. */
6012 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
6013 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
6015 /* The text "system-filter" is tested in transport_set_up_command() and in
6016 set_up_shell_command() in the pipe transport, to enable them to permit
6017 $recipients, so don't change it here without also changing it there. */
6019 address_item *p = addr_new;
6020 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6022 parent->domain = string_copylc(qualify_domain_recipient);
6023 parent->local_part = US"system-filter";
6025 /* As part of this loop, we arrange for addr_last to end up pointing
6026 at the final address. This is used if we go on to add addresses for the
6027 original recipients. */
6031 if (parent->child_count == USHRT_MAX)
6032 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6033 "than %d delivery addresses", USHRT_MAX);
6034 parent->child_count++;
6037 if (testflag(p, af_pfr))
6043 setflag(p, af_uid_set);
6044 setflag(p, af_gid_set);
6045 setflag(p, af_allow_file);
6046 setflag(p, af_allow_pipe);
6047 setflag(p, af_allow_reply);
6049 /* Find the name of the system filter's appropriate pfr transport */
6051 if (p->address[0] == '|')
6054 tpname = system_filter_pipe_transport;
6055 address_pipe = p->address;
6057 else if (p->address[0] == '>')
6060 tpname = system_filter_reply_transport;
6064 if (p->address[Ustrlen(p->address)-1] == '/')
6066 type = US"directory";
6067 tpname = system_filter_directory_transport;
6072 tpname = system_filter_file_transport;
6074 address_file = p->address;
6077 /* Now find the actual transport, first expanding the name. We have
6078 set address_file or address_pipe above. */
6082 uschar *tmp = expand_string(tpname);
6083 address_file = address_pipe = NULL;
6085 p->message = string_sprintf("failed to expand \"%s\" as a "
6086 "system filter transport name", tpname);
6090 p->message = string_sprintf("system_filter_%s_transport is unset",
6095 transport_instance *tp;
6096 for (tp = transports; tp; tp = tp->next)
6097 if (Ustrcmp(tp->name, tpname) == 0)
6103 p->message = string_sprintf("failed to find \"%s\" transport "
6104 "for system filter delivery", tpname);
6107 /* If we couldn't set up a transport, defer the delivery, putting the
6108 error on the panic log as well as the main log. */
6112 address_item *badp = p;
6114 if (!addr_last) addr_new = p; else addr_last->next = p;
6115 badp->local_part = badp->address; /* Needed for log line */
6116 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6119 } /* End of pfr handling */
6121 /* Either a non-pfr delivery, or we found a transport */
6123 DEBUG(D_deliver|D_filter)
6124 debug_printf("system filter added %s\n", p->address);
6128 } /* Loop through all addr_new addresses */
6133 /* Scan the recipients list, and for every one that is not in the non-
6134 recipients tree, add an addr item to the chain of new addresses. If the pno
6135 value is non-negative, we must set the onetime parent from it. This which
6136 points to the relevant entry in the recipients list.
6138 This processing can be altered by the setting of the process_recipients
6139 variable, which is changed if recipients are to be ignored, failed, or
6140 deferred. This can happen as a result of system filter activity, or if the -Mg
6141 option is used to fail all of them.
6143 Duplicate addresses are handled later by a different tree structure; we can't
6144 just extend the non-recipients tree, because that will be re-written to the
6145 spool if the message is deferred, and in any case there are casing
6146 complications for local addresses. */
6148 if (process_recipients != RECIP_IGNORE)
6149 for (i = 0; i < recipients_count; i++)
6150 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6152 recipient_item *r = recipients_list + i;
6153 address_item *new = deliver_make_addr(r->address, FALSE);
6154 new->prop.errors_address = r->errors_to;
6156 if ((new->prop.utf8_msg = message_smtputf8))
6158 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6159 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6160 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6161 new->prop.utf8_downcvt ? "yes"
6162 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6168 new->onetime_parent = recipients_list[r->pno].address;
6170 /* If DSN support is enabled, set the dsn flags and the original receipt
6171 to be passed on to other DSN enabled MTAs */
6172 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6173 new->dsn_orcpt = r->orcpt;
6174 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6175 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6177 switch (process_recipients)
6179 /* RECIP_DEFER is set when a system filter freezes a message. */
6182 new->next = addr_defer;
6187 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6190 case RECIP_FAIL_FILTER:
6192 filter_message ? filter_message : US"delivery cancelled";
6193 setflag(new, af_pass_message);
6194 goto RECIP_QUEUE_FAILED; /* below */
6197 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6198 than the value in timeout_frozen_after. Treat non-bounce messages
6199 similarly to -Mg; for bounce messages we just want to discard, so
6200 don't put the address on the failed list. The timeout has already
6203 case RECIP_FAIL_TIMEOUT:
6204 new->message = US"delivery cancelled; message timed out";
6205 goto RECIP_QUEUE_FAILED; /* below */
6208 /* RECIP_FAIL is set when -Mg has been used. */
6211 new->message = US"delivery cancelled by administrator";
6214 /* Common code for the failure cases above. If this is not a bounce
6215 message, put the address on the failed list so that it is used to
6216 create a bounce. Otherwise do nothing - this just discards the address.
6217 The incident has already been logged. */
6220 if (sender_address[0])
6222 new->next = addr_failed;
6228 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6229 in the message. Process each address as a routing failure; if this
6230 is a bounce message, it will get frozen. */
6232 case RECIP_FAIL_LOOP:
6233 new->message = US"Too many \"Received\" headers - suspected mail loop";
6234 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6238 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6241 if (!addr_new) addr_new = new; else addr_last->next = new;
6246 #ifndef DISABLE_EVENT
6247 if (process_recipients != RECIP_ACCEPT)
6249 uschar * save_local = deliver_localpart;
6250 const uschar * save_domain = deliver_domain;
6251 uschar * addr = new->address, * errmsg = NULL;
6252 int start, end, dom;
6254 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6255 log_write(0, LOG_MAIN|LOG_PANIC,
6256 "failed to parse address '%.100s': %s\n", addr, errmsg);
6260 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6261 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6263 event_raise(event_action, US"msg:fail:internal", new->message);
6265 deliver_localpart = save_local;
6266 deliver_domain = save_domain;
6274 debug_printf("Delivery address list:\n");
6275 for (address_item * p = addr_new; p; p = p->next)
6276 debug_printf(" %s %s\n", p->address,
6277 p->onetime_parent ? p->onetime_parent : US"");
6280 /* Set up the buffers used for copying over the file when delivering. */
6282 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6283 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6287 /* Until there are no more new addresses, handle each one as follows:
6289 . If this is a generated address (indicated by the presence of a parent
6290 pointer) then check to see whether it is a pipe, file, or autoreply, and
6291 if so, handle it directly here. The router that produced the address will
6292 have set the allow flags into the address, and also set the uid/gid required.
6293 Having the routers generate new addresses and then checking them here at
6294 the outer level is tidier than making each router do the checking, and
6295 means that routers don't need access to the failed address queue.
6297 . Break up the address into local part and domain, and make lowercased
6298 versions of these strings. We also make unquoted versions of the local part.
6300 . Handle the percent hack for those domains for which it is valid.
6302 . For child addresses, determine if any of the parents have the same address.
6303 If so, generate a different string for previous delivery checking. Without
6304 this code, if the address spqr generates spqr via a forward or alias file,
6305 delivery of the generated spqr stops further attempts at the top level spqr,
6306 which is not what is wanted - it may have generated other addresses.
6308 . Check on the retry database to see if routing was previously deferred, but
6309 only if in a queue run. Addresses that are to be routed are put on the
6310 addr_route chain. Addresses that are to be deferred are put on the
6311 addr_defer chain. We do all the checking first, so as not to keep the
6312 retry database open any longer than necessary.
6314 . Now we run the addresses through the routers. A router may put the address
6315 on either the addr_local or the addr_remote chain for local or remote
6316 delivery, respectively, or put it on the addr_failed chain if it is
6317 undeliveable, or it may generate child addresses and put them on the
6318 addr_new chain, or it may defer an address. All the chain anchors are
6319 passed as arguments so that the routers can be called for verification
6322 . If new addresses have been generated by the routers, da capo.
6325 f.header_rewritten = FALSE; /* No headers rewritten yet */
6326 while (addr_new) /* Loop until all addresses dealt with */
6328 address_item *addr, *parent;
6330 /* Failure to open the retry database is treated the same as if it does
6331 not exist. In both cases, dbm_file is NULL. */
6333 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6334 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6335 debug_printf("no retry data available\n");
6337 /* Scan the current batch of new addresses, to handle pipes, files and
6338 autoreplies, and determine which others are ready for routing. */
6345 dbdata_retry *domain_retry_record;
6346 dbdata_retry *address_retry_record;
6349 addr_new = addr->next;
6351 DEBUG(D_deliver|D_retry|D_route)
6353 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6354 debug_printf("Considering: %s\n", addr->address);
6357 /* Handle generated address that is a pipe or a file or an autoreply. */
6359 if (testflag(addr, af_pfr))
6361 /* If an autoreply in a filter could not generate a syntactically valid
6362 address, give up forthwith. Set af_ignore_error so that we don't try to
6363 generate a bounce. */
6365 if (testflag(addr, af_bad_reply))
6367 addr->basic_errno = ERRNO_BADADDRESS2;
6368 addr->local_part = addr->address;
6370 US"filter autoreply generated syntactically invalid recipient";
6371 addr->prop.ignore_error = TRUE;
6372 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6373 continue; /* with the next new address */
6376 /* If two different users specify delivery to the same pipe or file or
6377 autoreply, there should be two different deliveries, so build a unique
6378 string that incorporates the original address, and use this for
6379 duplicate testing and recording delivery, and also for retrying. */
6382 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6383 (testflag(addr->parent, af_homonym)? 3:0));
6385 addr->address_retry_key = addr->domain_retry_key =
6386 string_sprintf("T:%s", addr->unique);
6388 /* If a filter file specifies two deliveries to the same pipe or file,
6389 we want to de-duplicate, but this is probably not wanted for two mail
6390 commands to the same address, where probably both should be delivered.
6391 So, we have to invent a different unique string in that case. Just
6392 keep piling '>' characters on the front. */
6394 if (addr->address[0] == '>')
6396 while (tree_search(tree_duplicates, addr->unique))
6397 addr->unique = string_sprintf(">%s", addr->unique);
6400 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6402 DEBUG(D_deliver|D_route)
6403 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6404 addr->dupof = tnode->data.ptr;
6405 addr->next = addr_duplicate;
6406 addr_duplicate = addr;
6410 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6412 /* Check for previous delivery */
6414 if (tree_search(tree_nonrecipients, addr->unique))
6416 DEBUG(D_deliver|D_route)
6417 debug_printf("%s was previously delivered: discarded\n", addr->address);
6418 child_done(addr, tod_stamp(tod_log));
6422 /* Save for checking future duplicates */
6424 tree_add_duplicate(addr->unique, addr);
6426 /* Set local part and domain */
6428 addr->local_part = addr->address;
6429 addr->domain = addr->parent->domain;
6431 /* Ensure that the delivery is permitted. */
6433 if (testflag(addr, af_file))
6435 if (!testflag(addr, af_allow_file))
6437 addr->basic_errno = ERRNO_FORBIDFILE;
6438 addr->message = US"delivery to file forbidden";
6439 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6440 continue; /* with the next new address */
6443 else if (addr->address[0] == '|')
6445 if (!testflag(addr, af_allow_pipe))
6447 addr->basic_errno = ERRNO_FORBIDPIPE;
6448 addr->message = US"delivery to pipe forbidden";
6449 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6450 continue; /* with the next new address */
6453 else if (!testflag(addr, af_allow_reply))
6455 addr->basic_errno = ERRNO_FORBIDREPLY;
6456 addr->message = US"autoreply forbidden";
6457 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6458 continue; /* with the next new address */
6461 /* If the errno field is already set to BADTRANSPORT, it indicates
6462 failure to expand a transport string, or find the associated transport,
6463 or an unset transport when one is required. Leave this test till now so
6464 that the forbid errors are given in preference. */
6466 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6468 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6472 /* Treat /dev/null as a special case and abandon the delivery. This
6473 avoids having to specify a uid on the transport just for this case.
6474 Arrange for the transport name to be logged as "**bypassed**". */
6476 if (Ustrcmp(addr->address, "/dev/null") == 0)
6478 uschar *save = addr->transport->name;
6479 addr->transport->name = US"**bypassed**";
6480 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6481 addr->transport->name = save;
6482 continue; /* with the next new address */
6485 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6488 DEBUG(D_deliver|D_route)
6489 debug_printf("queued for %s transport\n", addr->transport->name);
6490 addr->next = addr_local;
6492 continue; /* with the next new address */
6495 /* Handle normal addresses. First, split up into local part and domain,
6496 handling the %-hack if necessary. There is the possibility of a defer from
6497 a lookup in percent_hack_domains. */
6499 if ((rc = deliver_split_address(addr)) == DEFER)
6501 addr->message = US"cannot check percent_hack_domains";
6502 addr->basic_errno = ERRNO_LISTDEFER;
6503 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6507 /* Check to see if the domain is held. If so, proceed only if the
6508 delivery was forced by hand. */
6510 deliver_domain = addr->domain; /* set $domain */
6511 if ( !forced && hold_domains
6512 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6513 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6519 addr->message = US"hold_domains lookup deferred";
6520 addr->basic_errno = ERRNO_LISTDEFER;
6524 addr->message = US"domain is held";
6525 addr->basic_errno = ERRNO_HELD;
6527 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6531 /* Now we can check for duplicates and previously delivered addresses. In
6532 order to do this, we have to generate a "unique" value for each address,
6533 because there may be identical actual addresses in a line of descendents.
6534 The "unique" field is initialized to the same value as the "address" field,
6535 but gets changed here to cope with identically-named descendents. */
6537 for (parent = addr->parent; parent; parent = parent->parent)
6538 if (strcmpic(addr->address, parent->address) == 0) break;
6540 /* If there's an ancestor with the same name, set the homonym flag. This
6541 influences how deliveries are recorded. Then add a prefix on the front of
6542 the unique address. We use \n\ where n starts at 0 and increases each time.
6543 It is unlikely to pass 9, but if it does, it may look odd but will still
6544 work. This means that siblings or cousins with the same names are treated
6545 as duplicates, which is what we want. */
6549 setflag(addr, af_homonym);
6550 if (parent->unique[0] != '\\')
6551 addr->unique = string_sprintf("\\0\\%s", addr->address);
6553 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6557 /* Ensure that the domain in the unique field is lower cased, because
6558 domains are always handled caselessly. */
6560 p = Ustrrchr(addr->unique, '@');
6561 while (*p != 0) { *p = tolower(*p); p++; }
6563 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6565 if (tree_search(tree_nonrecipients, addr->unique))
6567 DEBUG(D_deliver|D_route)
6568 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6569 child_done(addr, tod_stamp(tod_log));
6573 /* Get the routing retry status, saving the two retry keys (with and
6574 without the local part) for subsequent use. If there is no retry record for
6575 the standard address routing retry key, we look for the same key with the
6576 sender attached, because this form is used by the smtp transport after a
6577 4xx response to RCPT when address_retry_include_sender is true. */
6579 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6580 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6585 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6586 if ( domain_retry_record
6587 && now - domain_retry_record->time_stamp > retry_data_expire
6590 DEBUG(D_deliver|D_retry)
6591 debug_printf("domain retry record present but expired\n");
6592 domain_retry_record = NULL; /* Ignore if too old */
6595 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6596 if ( address_retry_record
6597 && now - address_retry_record->time_stamp > retry_data_expire
6600 DEBUG(D_deliver|D_retry)
6601 debug_printf("address retry record present but expired\n");
6602 address_retry_record = NULL; /* Ignore if too old */
6605 if (!address_retry_record)
6607 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6609 address_retry_record = dbfn_read(dbm_file, altkey);
6610 if ( address_retry_record
6611 && now - address_retry_record->time_stamp > retry_data_expire)
6613 DEBUG(D_deliver|D_retry)
6614 debug_printf("address<sender> retry record present but expired\n");
6615 address_retry_record = NULL; /* Ignore if too old */
6620 domain_retry_record = address_retry_record = NULL;
6622 DEBUG(D_deliver|D_retry)
6624 if (!domain_retry_record)
6625 debug_printf("no domain retry record\n");
6627 debug_printf("have domain retry record; next_try = now%+d\n",
6628 f.running_in_test_harness ? 0 :
6629 (int)(domain_retry_record->next_try - now));
6631 if (!address_retry_record)
6632 debug_printf("no address retry record\n");
6634 debug_printf("have address retry record; next_try = now%+d\n",
6635 f.running_in_test_harness ? 0 :
6636 (int)(address_retry_record->next_try - now));
6639 /* If we are sending a message down an existing SMTP connection, we must
6640 assume that the message which created the connection managed to route
6641 an address to that connection. We do not want to run the risk of taking
6642 a long time over routing here, because if we do, the server at the other
6643 end of the connection may time it out. This is especially true for messages
6644 with lots of addresses. For this kind of delivery, queue_running is not
6645 set, so we would normally route all addresses. We take a pragmatic approach
6646 and defer routing any addresses that have any kind of domain retry record.
6647 That is, we don't even look at their retry times. It doesn't matter if this
6648 doesn't work occasionally. This is all just an optimization, after all.
6650 The reason for not doing the same for address retries is that they normally
6651 arise from 4xx responses, not DNS timeouts. */
6653 if (continue_hostname && domain_retry_record)
6655 addr->message = US"reusing SMTP connection skips previous routing defer";
6656 addr->basic_errno = ERRNO_RRETRY;
6657 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6659 addr->message = domain_retry_record->text;
6660 setflag(addr, af_pass_message);
6663 /* If we are in a queue run, defer routing unless there is no retry data or
6664 we've passed the next retry time, or this message is forced. In other
6665 words, ignore retry data when not in a queue run.
6667 However, if the domain retry time has expired, always allow the routing
6668 attempt. If it fails again, the address will be failed. This ensures that
6669 each address is routed at least once, even after long-term routing
6672 If there is an address retry, check that too; just wait for the next
6673 retry time. This helps with the case when the temporary error on the
6674 address was really message-specific rather than address specific, since
6675 it allows other messages through.
6677 We also wait for the next retry time if this is a message sent down an
6678 existing SMTP connection (even though that will be forced). Otherwise there
6679 will be far too many attempts for an address that gets a 4xx error. In
6680 fact, after such an error, we should not get here because, the host should
6681 not be remembered as one this message needs. However, there was a bug that
6682 used to cause this to happen, so it is best to be on the safe side.
6684 Even if we haven't reached the retry time in the hints, there is one more
6685 check to do, which is for the ultimate address timeout. We only do this
6686 check if there is an address retry record and there is not a domain retry
6687 record; this implies that previous attempts to handle the address had the
6688 retry_use_local_parts option turned on. We use this as an approximation
6689 for the destination being like a local delivery, for example delivery over
6690 LMTP to an IMAP message store. In this situation users are liable to bump
6691 into their quota and thereby have intermittently successful deliveries,
6692 which keep the retry record fresh, which can lead to us perpetually
6693 deferring messages. */
6695 else if ( ( f.queue_running && !f.deliver_force
6696 || continue_hostname
6698 && ( ( domain_retry_record
6699 && now < domain_retry_record->next_try
6700 && !domain_retry_record->expired
6702 || ( address_retry_record
6703 && now < address_retry_record->next_try
6705 && ( domain_retry_record
6706 || !address_retry_record
6707 || !retry_ultimate_address_timeout(addr->address_retry_key,
6708 addr->domain, address_retry_record, now)
6711 addr->message = US"retry time not reached";
6712 addr->basic_errno = ERRNO_RRETRY;
6713 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6715 /* For remote-retry errors (here and just above) that we've not yet
6716 hit the rery time, use the error recorded in the retry database
6717 as info in the warning message. This lets us send a message even
6718 when we're not failing on a fresh attempt. We assume that this
6719 info is not sensitive. */
6721 addr->message = domain_retry_record
6722 ? domain_retry_record->text : address_retry_record->text;
6723 setflag(addr, af_pass_message);
6726 /* The domain is OK for routing. Remember if retry data exists so it
6727 can be cleaned up after a successful delivery. */
6731 if (domain_retry_record || address_retry_record)
6732 setflag(addr, af_dr_retry_exists);
6733 addr->next = addr_route;
6735 DEBUG(D_deliver|D_route)
6736 debug_printf("%s: queued for routing\n", addr->address);
6740 /* The database is closed while routing is actually happening. Requests to
6741 update it are put on a chain and all processed together at the end. */
6743 if (dbm_file) dbfn_close(dbm_file);
6745 /* If queue_domains is set, we don't even want to try routing addresses in
6746 those domains. During queue runs, queue_domains is forced to be unset.
6747 Optimize by skipping this pass through the addresses if nothing is set. */
6749 if (!f.deliver_force && queue_domains)
6751 address_item *okaddr = NULL;
6754 address_item *addr = addr_route;
6755 addr_route = addr->next;
6757 deliver_domain = addr->domain; /* set $domain */
6758 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6759 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6763 addr->basic_errno = ERRNO_LISTDEFER;
6764 addr->message = US"queue_domains lookup deferred";
6765 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6769 addr->next = okaddr;
6774 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6775 addr->message = US"domain is in queue_domains";
6776 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6780 addr_route = okaddr;
6783 /* Now route those addresses that are not deferred. */
6788 address_item *addr = addr_route;
6789 const uschar *old_domain = addr->domain;
6790 uschar *old_unique = addr->unique;
6791 addr_route = addr->next;
6794 /* Just in case some router parameter refers to it. */
6796 if (!(return_path = addr->prop.errors_address))
6797 return_path = sender_address;
6799 /* If a router defers an address, add a retry item. Whether or not to
6800 use the local part in the key is a property of the router. */
6802 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6803 &addr_succeed, v_none)) == DEFER)
6804 retry_add_item(addr,
6805 addr->router->retry_use_local_part
6806 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6807 : string_sprintf("R:%s", addr->domain),
6810 /* Otherwise, if there is an existing retry record in the database, add
6811 retry items to delete both forms. We must also allow for the possibility
6812 of a routing retry that includes the sender address. Since the domain might
6813 have been rewritten (expanded to fully qualified) as a result of routing,
6814 ensure that the rewritten form is also deleted. */
6816 else if (testflag(addr, af_dr_retry_exists))
6818 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6820 retry_add_item(addr, altkey, rf_delete);
6821 retry_add_item(addr, addr->address_retry_key, rf_delete);
6822 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6823 if (Ustrcmp(addr->domain, old_domain) != 0)
6824 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6827 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6828 logged, but we need to ensure the address (and maybe parents) is marked
6833 address_done(addr, tod_stamp(tod_log));
6834 continue; /* route next address */
6837 /* The address is finished with (failed or deferred). */
6841 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6842 continue; /* route next address */
6845 /* The address has been routed. If the router changed the domain, it will
6846 also have changed the unique address. We have to test whether this address
6847 has already been delivered, because it's the unique address that finally
6850 if ( addr->unique != old_unique
6851 && tree_search(tree_nonrecipients, addr->unique) != 0
6854 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6855 "discarded\n", addr->address);
6856 if (addr_remote == addr) addr_remote = addr->next;
6857 else if (addr_local == addr) addr_local = addr->next;
6860 /* If the router has same_domain_copy_routing set, we are permitted to copy
6861 the routing for any other addresses with the same domain. This is an
6862 optimisation to save repeated DNS lookups for "standard" remote domain
6863 routing. The option is settable only on routers that generate host lists.
6864 We play it very safe, and do the optimization only if the address is routed
6865 to a remote transport, there are no header changes, and the domain was not
6866 modified by the router. */
6868 if ( addr_remote == addr
6869 && addr->router->same_domain_copy_routing
6870 && !addr->prop.extra_headers
6871 && !addr->prop.remove_headers
6872 && old_domain == addr->domain
6875 address_item **chain = &addr_route;
6878 address_item *addr2 = *chain;
6879 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6881 chain = &(addr2->next);
6885 /* Found a suitable address; take it off the routing list and add it to
6886 the remote delivery list. */
6888 *chain = addr2->next;
6889 addr2->next = addr_remote;
6890 addr_remote = addr2;
6892 /* Copy the routing data */
6894 addr2->domain = addr->domain;
6895 addr2->router = addr->router;
6896 addr2->transport = addr->transport;
6897 addr2->host_list = addr->host_list;
6898 addr2->fallback_hosts = addr->fallback_hosts;
6899 addr2->prop.errors_address = addr->prop.errors_address;
6900 copyflag(addr2, addr, af_hide_child);
6901 copyflag(addr2, addr, af_local_host_removed);
6903 DEBUG(D_deliver|D_route)
6904 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6906 "Routing for %s copied from %s\n",
6907 addr2->address, addr2->address, addr->address);
6910 } /* Continue with routing the next address. */
6911 } /* Loop to process any child addresses that the routers created, and
6912 any rerouted addresses that got put back on the new chain. */
6915 /* Debugging: show the results of the routing */
6917 DEBUG(D_deliver|D_retry|D_route)
6919 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6920 debug_printf("After routing:\n Local deliveries:\n");
6921 for (address_item * p = addr_local; p; p = p->next)
6922 debug_printf(" %s\n", p->address);
6924 debug_printf(" Remote deliveries:\n");
6925 for (address_item * p = addr_remote; p; p = p->next)
6926 debug_printf(" %s\n", p->address);
6928 debug_printf(" Failed addresses:\n");
6929 for (address_item * p = addr_failed; p; p = p->next)
6930 debug_printf(" %s\n", p->address);
6932 debug_printf(" Deferred addresses:\n");
6933 for (address_item * p = addr_defer; p; p = p->next)
6934 debug_printf(" %s\n", p->address);
6937 /* Free any resources that were cached during routing. */
6942 /* These two variables are set only during routing, after check_local_user.
6943 Ensure they are not set in transports. */
6945 local_user_gid = (gid_t)(-1);
6946 local_user_uid = (uid_t)(-1);
6948 /* Check for any duplicate addresses. This check is delayed until after
6949 routing, because the flexibility of the routing configuration means that
6950 identical addresses with different parentage may end up being redirected to
6951 different addresses. Checking for duplicates too early (as we previously used
6952 to) makes this kind of thing not work. */
6954 do_duplicate_check(&addr_local);
6955 do_duplicate_check(&addr_remote);
6957 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6958 remote transport. The check that they all end up in one transaction happens in
6959 the do_remote_deliveries() function. */
6962 && (addr_local || addr_failed || addr_defer)
6966 uschar *which, *colon, *msg;
6973 else if (addr_defer)
6976 which = US"deferred";
6984 while (addr->parent) addr = addr->parent;
6989 msg = addr->message;
6991 else colon = msg = US"";
6993 /* We don't need to log here for a forced failure as it will already
6994 have been logged. Defer will also have been logged, but as a defer, so we do
6995 need to do the failure logging. */
6997 if (addr != addr_failed)
6998 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
6999 addr->address, which);
7001 /* Always write an error to the caller */
7003 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7006 final_yield = DELIVER_MUA_FAILED;
7007 addr_failed = addr_defer = NULL; /* So that we remove the message */
7008 goto DELIVERY_TIDYUP;
7012 /* If this is a run to continue deliveries to an external channel that is
7013 already set up, defer any local deliveries. */
7015 if (continue_transport)
7019 address_item *addr = addr_defer;
7020 while (addr->next) addr = addr->next;
7021 addr->next = addr_local;
7024 addr_defer = addr_local;
7029 /* Because address rewriting can happen in the routers, we should not really do
7030 ANY deliveries until all addresses have been routed, so that all recipients of
7031 the message get the same headers. However, this is in practice not always
7032 possible, since sometimes remote addresses give DNS timeouts for days on end.
7033 The pragmatic approach is to deliver what we can now, saving any rewritten
7034 headers so that at least the next lot of recipients benefit from the rewriting
7035 that has already been done.
7037 If any headers have been rewritten during routing, update the spool file to
7038 remember them for all subsequent deliveries. This can be delayed till later if
7039 there is only address to be delivered - if it succeeds the spool write need not
7042 if ( f.header_rewritten
7043 && ( addr_local && (addr_local->next || addr_remote)
7044 || addr_remote && addr_remote->next
7047 /* Panic-dies on error */
7048 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7049 f.header_rewritten = FALSE;
7053 /* If there are any deliveries to do and we do not already have the journal
7054 file, create it. This is used to record successful deliveries as soon as
7055 possible after each delivery is known to be complete. A file opened with
7056 O_APPEND is used so that several processes can run simultaneously.
7058 The journal is just insurance against crashes. When the spool file is
7059 ultimately updated at the end of processing, the journal is deleted. If a
7060 journal is found to exist at the start of delivery, the addresses listed
7061 therein are added to the non-recipients. */
7063 if (addr_local || addr_remote)
7067 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7069 if ((journal_fd = Uopen(fname,
7073 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7075 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7076 fname, strerror(errno));
7077 return DELIVER_NOT_ATTEMPTED;
7080 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7081 that the mode is correct - the group setting doesn't always seem to get
7082 set automatically. */
7084 if( fchown(journal_fd, exim_uid, exim_gid)
7085 || fchmod(journal_fd, SPOOL_MODE)
7087 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7091 int ret = Uunlink(fname);
7092 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7093 fname, strerror(errno));
7094 if(ret && errno != ENOENT)
7095 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7096 fname, strerror(errno));
7097 return DELIVER_NOT_ATTEMPTED;
7101 else if (journal_fd >= 0)
7109 /* Now we can get down to the business of actually doing deliveries. Local
7110 deliveries are done first, then remote ones. If ever the problems of how to
7111 handle fallback transports are figured out, this section can be put into a loop
7112 for handling fallbacks, though the uid switching will have to be revised. */
7114 /* Precompile a regex that is used to recognize a parameter in response
7115 to an LHLO command, if is isn't already compiled. This may be used on both
7116 local and remote LMTP deliveries. */
7118 if (!regex_IGNOREQUOTA)
7120 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7122 /* Handle local deliveries */
7126 DEBUG(D_deliver|D_transport)
7127 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7128 do_local_deliveries();
7129 f.disable_logging = FALSE;
7132 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7133 so just queue them all. */
7135 if (f.queue_run_local)
7138 address_item *addr = addr_remote;
7139 addr_remote = addr->next;
7141 addr->basic_errno = ERRNO_LOCAL_ONLY;
7142 addr->message = US"remote deliveries suppressed";
7143 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7146 /* Handle remote deliveries */
7150 DEBUG(D_deliver|D_transport)
7151 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7153 /* Precompile some regex that are used to recognize parameters in response
7154 to an EHLO command, if they aren't already compiled. */
7158 /* Now sort the addresses if required, and do the deliveries. The yield of
7159 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7160 cannot be delivered in one transaction. */
7162 if (remote_sort_domains) sort_remote_deliveries();
7163 if (!do_remote_deliveries(FALSE))
7165 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7166 "be delivered in one transaction");
7167 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7169 final_yield = DELIVER_MUA_FAILED;
7170 addr_failed = addr_defer = NULL; /* So that we remove the message */
7171 goto DELIVERY_TIDYUP;
7174 /* See if any of the addresses that failed got put on the queue for delivery
7175 to their fallback hosts. We do it this way because often the same fallback
7176 host is used for many domains, so all can be sent in a single transaction
7177 (if appropriately configured). */
7179 if (addr_fallback && !mua_wrapper)
7181 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7182 addr_remote = addr_fallback;
7183 addr_fallback = NULL;
7184 if (remote_sort_domains) sort_remote_deliveries();
7185 do_remote_deliveries(TRUE);
7187 f.disable_logging = FALSE;
7191 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7192 phase, to minimize cases of half-done things. */
7195 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7196 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7198 /* Root privilege is no longer needed */
7200 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7202 set_process_info("tidying up after delivering %s", message_id);
7203 signal(SIGTERM, SIG_IGN);
7205 /* When we are acting as an MUA wrapper, the smtp transport will either have
7206 succeeded for all addresses, or failed them all in normal cases. However, there
7207 are some setup situations (e.g. when a named port does not exist) that cause an
7208 immediate exit with deferral of all addresses. Convert those into failures. We
7209 do not ever want to retry, nor do we want to send a bounce message. */
7215 address_item * nextaddr;
7216 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7218 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7219 "delivery", addr->address);
7220 nextaddr = addr->next;
7221 addr->next = addr_failed;
7227 /* Now all should either have succeeded or failed. */
7230 final_yield = DELIVER_MUA_SUCCEEDED;
7234 uschar *s = addr_failed->user_message;
7236 if (!s) s = addr_failed->message;
7238 fprintf(stderr, "Delivery failed: ");
7239 if (addr_failed->basic_errno > 0)
7241 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7242 if (s) fprintf(stderr, ": ");
7244 if ((host = addr_failed->host_used))
7245 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7247 fprintf(stderr, "%s", CS s);
7248 else if (addr_failed->basic_errno <= 0)
7249 fprintf(stderr, "unknown error");
7250 fprintf(stderr, "\n");
7252 final_yield = DELIVER_MUA_FAILED;
7257 /* In a normal configuration, we now update the retry database. This is done in
7258 one fell swoop at the end in order not to keep opening and closing (and
7259 locking) the database. The code for handling retries is hived off into a
7260 separate module for convenience. We pass it the addresses of the various
7261 chains, because deferred addresses can get moved onto the failed chain if the
7262 retry cutoff time has expired for all alternative destinations. Bypass the
7263 updating of the database if the -N flag is set, which is a debugging thing that
7264 prevents actual delivery. */
7266 else if (!f.dont_deliver)
7267 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7269 /* Send DSN for successful messages if requested */
7270 addr_senddsn = NULL;
7272 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7274 /* af_ignore_error not honored here. it's not an error */
7275 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7276 "DSN: processing successful delivery address: %s\n"
7277 "DSN: Sender_address: %s\n"
7278 "DSN: orcpt: %s flags: %d\n"
7279 "DSN: envid: %s ret: %d\n"
7280 "DSN: Final recipient: %s\n"
7281 "DSN: Remote SMTP server supports DSN: %d\n",
7282 addr_dsntmp->router ? addr_dsntmp->router->name : US"(unknown)",
7283 addr_dsntmp->address,
7285 addr_dsntmp->dsn_orcpt ? addr_dsntmp->dsn_orcpt : US"NULL",
7286 addr_dsntmp->dsn_flags,
7287 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7288 addr_dsntmp->address,
7289 addr_dsntmp->dsn_aware
7292 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7293 and a report was requested */
7294 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7295 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7297 && addr_dsntmp->dsn_flags & rf_notify_success
7300 /* copy and relink address_item and send report with all of them at once later */
7301 address_item * addr_next = addr_senddsn;
7302 addr_senddsn = store_get(sizeof(address_item));
7303 *addr_senddsn = *addr_dsntmp;
7304 addr_senddsn->next = addr_next;
7307 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7315 /* create exim process to send message */
7316 pid = child_open_exim(&fd);
7318 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7320 if (pid < 0) /* Creation of child failed */
7322 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7323 "create child process to send failure message: %s", getpid(),
7324 getppid(), strerror(errno));
7326 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7328 else /* Creation of child succeeded */
7330 FILE * f = fdopen(fd, "wb");
7331 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7333 transport_ctx tctx = {{0}};
7336 debug_printf("sending error message to: %s\n", sender_address);
7338 /* build unique id for MIME boundary */
7339 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7340 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7342 if (errors_reply_to)
7343 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7345 fprintf(f, "Auto-Submitted: auto-generated\n"
7346 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7348 "Subject: Delivery Status Notification\n"
7349 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7350 "MIME-Version: 1.0\n\n"
7353 "Content-type: text/plain; charset=us-ascii\n\n"
7355 "This message was created automatically by mail delivery software.\n"
7356 " ----- The following addresses had successful delivery notifications -----\n",
7357 qualify_domain_sender, sender_address, bound, bound);
7359 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7360 addr_dsntmp = addr_dsntmp->next)
7361 fprintf(f, "<%s> (relayed %s)\n\n",
7362 addr_dsntmp->address,
7363 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7364 : addr_dsntmp->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7365 : "via non \"Remote SMTP\" router"
7369 "Content-type: message/delivery-status\n\n"
7370 "Reporting-MTA: dns; %s\n",
7371 bound, smtp_active_hostname);
7374 { /* must be decoded from xtext: see RFC 3461:6.3a */
7376 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7377 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7379 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7383 for (addr_dsntmp = addr_senddsn;
7385 addr_dsntmp = addr_dsntmp->next)
7387 if (addr_dsntmp->dsn_orcpt)
7388 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7390 fprintf(f, "Action: delivered\n"
7391 "Final-Recipient: rfc822;%s\n"
7393 addr_dsntmp->address);
7395 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7396 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7397 addr_dsntmp->host_used->name);
7399 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7400 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7403 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7406 transport_filter_argv = NULL; /* Just in case */
7407 return_path = sender_address; /* In case not previously set */
7409 /* Write the original email out */
7412 tctx.options = topt_add_return_path | topt_no_body;
7413 /*XXX hmm, retval ignored.
7414 Could error for any number of reasons, and they are not handled. */
7415 transport_write_message(&tctx, 0);
7418 fprintf(f,"\n--%s--\n", bound);
7422 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7426 /* If any addresses failed, we must send a message to somebody, unless
7427 af_ignore_error is set, in which case no action is taken. It is possible for
7428 several messages to get sent if there are addresses with different
7435 uschar *logtod = tod_stamp(tod_log);
7437 address_item *handled_addr = NULL;
7438 address_item **paddr;
7439 address_item *msgchain = NULL;
7440 address_item **pmsgchain = &msgchain;
7442 /* There are weird cases when logging is disabled in the transport. However,
7443 there may not be a transport (address failed by a router). */
7445 f.disable_logging = FALSE;
7446 if (addr_failed->transport)
7447 f.disable_logging = addr_failed->transport->disable_logging;
7450 debug_printf("processing failed address %s\n", addr_failed->address);
7452 /* There are only two ways an address in a bounce message can get here:
7454 (1) When delivery was initially deferred, but has now timed out (in the call
7455 to retry_update() above). We can detect this by testing for
7456 af_retry_timedout. If the address does not have its own errors address,
7457 we arrange to ignore the error.
7459 (2) If delivery failures for bounce messages are being ignored. We can detect
7460 this by testing for af_ignore_error. This will also be set if a bounce
7461 message has been autothawed and the ignore_bounce_errors_after time has
7462 passed. It might also be set if a router was explicitly configured to
7463 ignore errors (errors_to = "").
7465 If neither of these cases obtains, something has gone wrong. Log the
7466 incident, but then ignore the error. */
7468 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7470 if ( !testflag(addr_failed, af_retry_timedout)
7471 && !addr_failed->prop.ignore_error)
7472 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7473 "failure is neither frozen nor ignored (it's been ignored)");
7475 addr_failed->prop.ignore_error = TRUE;
7478 /* If the first address on the list has af_ignore_error set, just remove
7479 it from the list, throw away any saved message file, log it, and
7480 mark the recipient done. */
7482 if ( addr_failed->prop.ignore_error
7483 || addr_failed->dsn_flags & (rf_dsnflags & ~rf_notify_failure)
7487 addr_failed = addr->next;
7488 if (addr->return_filename) Uunlink(addr->return_filename);
7490 #ifndef DISABLE_EVENT
7491 msg_event_raise(US"msg:fail:delivery", addr);
7493 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7495 !addr->parent ? US"" : US" <",
7496 !addr->parent ? US"" : addr->parent->address,
7497 !addr->parent ? US"" : US">");
7499 address_done(addr, logtod);
7500 child_done(addr, logtod);
7501 /* Panic-dies on error */
7502 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7505 /* Otherwise, handle the sending of a message. Find the error address for
7506 the first address, then send a message that includes all failed addresses
7507 that have the same error address. Note the bounce_recipient is a global so
7508 that it can be accessed by $bounce_recipient while creating a customized
7513 if (!(bounce_recipient = addr_failed->prop.errors_address))
7514 bounce_recipient = sender_address;
7516 /* Make a subprocess to send a message */
7518 if ((pid = child_open_exim(&fd)) < 0)
7519 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7520 "create child process to send failure message: %s", getpid(),
7521 getppid(), strerror(errno));
7523 /* Creation of child succeeded */
7530 uschar *bcc, *emf_text;
7531 FILE * fp = fdopen(fd, "wb");
7533 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7534 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7535 DELIVER_IN_BUFFER_SIZE;
7537 uschar *dsnlimitmsg;
7538 uschar *dsnnotifyhdr;
7542 debug_printf("sending error message to: %s\n", bounce_recipient);
7544 /* Scan the addresses for all that have the same errors address, removing
7545 them from the addr_failed chain, and putting them on msgchain. */
7547 paddr = &addr_failed;
7548 for (addr = addr_failed; addr; addr = *paddr)
7549 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7550 ? addr->prop.errors_address : sender_address) == 0)
7551 { /* The same - dechain */
7552 *paddr = addr->next;
7555 pmsgchain = &(addr->next);
7558 paddr = &addr->next; /* Not the same; skip */
7560 /* Include X-Failed-Recipients: for automatic interpretation, but do
7561 not let any one header line get too long. We do this by starting a
7562 new header every 50 recipients. Omit any addresses for which the
7563 "hide_child" flag is set. */
7565 for (addr = msgchain; addr; addr = addr->next)
7567 if (testflag(addr, af_hide_child)) continue;
7575 ? "X-Failed-Recipients: "
7577 testflag(addr, af_pfr) && addr->parent
7578 ? string_printing(addr->parent->address)
7579 : string_printing(addr->address));
7581 if (rcount > 0) fprintf(fp, "\n");
7583 /* Output the standard headers */
7585 if (errors_reply_to)
7586 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7587 fprintf(fp, "Auto-Submitted: auto-replied\n");
7588 moan_write_from(fp);
7589 fprintf(fp, "To: %s\n", bounce_recipient);
7591 /* generate boundary string and output MIME-Headers */
7592 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7594 fprintf(fp, "Content-Type: multipart/report;"
7595 " report-type=delivery-status; boundary=%s\n"
7596 "MIME-Version: 1.0\n",
7599 /* Open a template file if one is provided. Log failure to open, but
7600 carry on - default texts will be used. */
7602 if (bounce_message_file)
7603 if (!(emf = Ufopen(bounce_message_file, "rb")))
7604 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7605 "message texts: %s", bounce_message_file, strerror(errno));
7607 /* Quietly copy to configured additional addresses if required. */
7609 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7610 fprintf(fp, "Bcc: %s\n", bcc);
7612 /* The texts for the message can be read from a template file; if there
7613 isn't one, or if it is too short, built-in texts are used. The first
7614 emf text is a Subject: and any other headers. */
7616 if ((emf_text = next_emf(emf, US"header")))
7617 fprintf(fp, "%s\n", emf_text);
7619 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7620 to_sender? ": returning message to sender" : "");
7622 /* output human readable part as text/plain section */
7623 fprintf(fp, "--%s\n"
7624 "Content-type: text/plain; charset=us-ascii\n\n",
7627 if ((emf_text = next_emf(emf, US"intro")))
7628 fprintf(fp, "%s", CS emf_text);
7632 /* This message has been reworded several times. It seems to be confusing to
7633 somebody, however it is worded. I have retreated to the original, simple
7635 "This message was created automatically by mail delivery software.\n");
7637 if (bounce_message_text)
7638 fprintf(fp, "%s", CS bounce_message_text);
7641 "\nA message that you sent could not be delivered to one or more of its\n"
7642 "recipients. This is a permanent error. The following address(es) failed:\n");
7645 "\nA message sent by\n\n <%s>\n\n"
7646 "could not be delivered to one or more of its recipients. The following\n"
7647 "address(es) failed:\n", sender_address);
7651 /* Process the addresses, leaving them on the msgchain if they have a
7652 file name for a return message. (There has already been a check in
7653 post_process_one() for the existence of data in the message file.) A TRUE
7654 return from print_address_information() means that the address is not
7658 for (addr = msgchain; addr; addr = *paddr)
7660 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7661 print_address_error(addr, fp, US"");
7663 /* End the final line for the address */
7667 /* Leave on msgchain if there's a return file. */
7669 if (addr->return_file >= 0)
7671 paddr = &(addr->next);
7675 /* Else save so that we can tick off the recipient when the
7680 *paddr = addr->next;
7681 addr->next = handled_addr;
7682 handled_addr = addr;
7688 /* Get the next text, whether we need it or not, so as to be
7689 positioned for the one after. */
7691 emf_text = next_emf(emf, US"generated text");
7693 /* If there were any file messages passed by the local transports,
7694 include them in the message. Then put the address on the handled chain.
7695 In the case of a batch of addresses that were all sent to the same
7696 transport, the return_file field in all of them will contain the same
7697 fd, and the return_filename field in the *last* one will be set (to the
7698 name of the file). */
7702 address_item *nextaddr;
7705 fprintf(fp, "%s", CS emf_text);
7708 "The following text was generated during the delivery "
7709 "attempt%s:\n", (filecount > 1)? "s" : "");
7711 for (addr = msgchain; addr; addr = nextaddr)
7714 address_item *topaddr = addr;
7716 /* List all the addresses that relate to this file */
7719 while(addr) /* Insurance */
7721 print_address_information(addr, fp, US"------ ", US"\n ",
7723 if (addr->return_filename) break;
7728 /* Now copy the file */
7730 if (!(fm = Ufopen(addr->return_filename, "rb")))
7731 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7735 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7738 Uunlink(addr->return_filename);
7740 /* Can now add to handled chain, first fishing off the next
7741 address on the msgchain. */
7743 nextaddr = addr->next;
7744 addr->next = handled_addr;
7745 handled_addr = topaddr;
7750 /* output machine readable part */
7752 if (message_smtputf8)
7753 fprintf(fp, "--%s\n"
7754 "Content-type: message/global-delivery-status\n\n"
7755 "Reporting-MTA: dns; %s\n",
7756 bound, smtp_active_hostname);
7759 fprintf(fp, "--%s\n"
7760 "Content-type: message/delivery-status\n\n"
7761 "Reporting-MTA: dns; %s\n",
7762 bound, smtp_active_hostname);
7766 /* must be decoded from xtext: see RFC 3461:6.3a */
7768 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7769 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7771 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7775 for (addr = handled_addr; addr; addr = addr->next)
7778 fprintf(fp, "Action: failed\n"
7779 "Final-Recipient: rfc822;%s\n"
7782 if ((hu = addr->host_used) && hu->name)
7784 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7785 #ifdef EXPERIMENTAL_DSN_INFO
7790 uschar * p = hu->port == 25
7791 ? US"" : string_sprintf(":%d", hu->port);
7792 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7794 if ((s = addr->smtp_greeting) && *s)
7795 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7796 if ((s = addr->helo_response) && *s)
7797 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7798 if ((s = addr->message) && *s)
7799 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7802 print_dsn_diagnostic_code(addr, fp);
7807 /* Now copy the message, trying to give an intelligible comment if
7808 it is too long for it all to be copied. The limit isn't strictly
7809 applied because of the buffering. There is, however, an option
7810 to suppress copying altogether. */
7812 emf_text = next_emf(emf, US"copy");
7815 we ignore the intro text from template and add
7816 the text for bounce_return_size_limit at the end.
7818 bounce_return_message is ignored
7819 in case RET= is defined we honor these values
7820 otherwise bounce_return_body is honored.
7822 bounce_return_size_limit is always honored.
7825 fprintf(fp, "--%s\n", bound);
7827 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7828 dsnnotifyhdr = NULL;
7829 topt = topt_add_return_path;
7831 /* RET=HDRS? top priority */
7832 if (dsn_ret == dsn_ret_hdrs)
7833 topt |= topt_no_body;
7836 struct stat statbuf;
7838 /* no full body return at all? */
7839 if (!bounce_return_body)
7841 topt |= topt_no_body;
7842 /* add header if we overrule RET=FULL */
7843 if (dsn_ret == dsn_ret_full)
7844 dsnnotifyhdr = dsnlimitmsg;
7846 /* line length limited... return headers only if oversize */
7847 /* size limited ... return headers only if limit reached */
7848 else if ( max_received_linelength > bounce_return_linesize_limit
7849 || ( bounce_return_size_limit > 0
7850 && fstat(deliver_datafile, &statbuf) == 0
7851 && statbuf.st_size > max
7854 topt |= topt_no_body;
7855 dsnnotifyhdr = dsnlimitmsg;
7860 if (message_smtputf8)
7861 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7862 : "Content-type: message/global\n\n",
7866 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7867 : "Content-type: message/rfc822\n\n",
7871 transport_filter_argv = NULL; /* Just in case */
7872 return_path = sender_address; /* In case not previously set */
7873 { /* Dummy transport for headers add */
7874 transport_ctx tctx = {{0}};
7875 transport_instance tb = {0};
7877 tctx.u.fd = fileno(fp);
7879 tctx.options = topt;
7880 tb.add_headers = dsnnotifyhdr;
7882 /*XXX no checking for failure! buggy! */
7883 transport_write_message(&tctx, 0);
7887 /* we never add the final text. close the file */
7891 fprintf(fp, "\n--%s--\n", bound);
7893 /* Close the file, which should send an EOF to the child process
7894 that is receiving the message. Wait for it to finish. */
7897 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7899 /* In the test harness, let the child do it's thing first. */
7901 if (f.running_in_test_harness) millisleep(500);
7903 /* If the process failed, there was some disaster in setting up the
7904 error message. Unless the message is very old, ensure that addr_defer
7905 is non-null, which will have the effect of leaving the message on the
7906 spool. The failed addresses will get tried again next time. However, we
7907 don't really want this to happen too often, so freeze the message unless
7908 there are some genuine deferred addresses to try. To do this we have
7909 to call spool_write_header() here, because with no genuine deferred
7910 addresses the normal code below doesn't get run. */
7915 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7917 addr_defer = (address_item *)(+1);
7918 f.deliver_freeze = TRUE;
7919 deliver_frozen_at = time(NULL);
7920 /* Panic-dies on error */
7921 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7924 deliver_msglog("Process failed (%d) when writing error message "
7925 "to %s%s", rc, bounce_recipient, s);
7926 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7927 "to %s%s", rc, bounce_recipient, s);
7930 /* The message succeeded. Ensure that the recipients that failed are
7931 now marked finished with on the spool and their parents updated. */
7935 for (addr = handled_addr; addr; addr = addr->next)
7937 address_done(addr, logtod);
7938 child_done(addr, logtod);
7940 /* Panic-dies on error */
7941 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7947 f.disable_logging = FALSE; /* In case left set */
7949 /* Come here from the mua_wrapper case if routing goes wrong */
7953 /* If there are now no deferred addresses, we are done. Preserve the
7954 message log if so configured, and we are using them. Otherwise, sling it.
7955 Then delete the message itself. */
7963 fname = spool_fname(US"msglog", message_subdir, id, US"");
7964 if (preserve_message_logs)
7967 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7969 if ((rc = Urename(fname, moname)) < 0)
7971 (void)directory_make(spool_directory,
7972 spool_sname(US"msglog.OLD", US""),
7973 MSGLOG_DIRECTORY_MODE, TRUE);
7974 rc = Urename(fname, moname);
7977 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7978 "msglog.OLD directory", fname);
7981 if (Uunlink(fname) < 0)
7982 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7983 fname, strerror(errno));
7986 /* Remove the two message files. */
7988 fname = spool_fname(US"input", message_subdir, id, US"-D");
7989 if (Uunlink(fname) < 0)
7990 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7991 fname, strerror(errno));
7992 fname = spool_fname(US"input", message_subdir, id, US"-H");
7993 if (Uunlink(fname) < 0)
7994 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7995 fname, strerror(errno));
7997 /* Log the end of this message, with queue time if requested. */
7999 if (LOGGING(queue_time_overall))
8000 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8002 log_write(0, LOG_MAIN, "Completed");
8004 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8005 f.deliver_freeze = FALSE;
8007 #ifndef DISABLE_EVENT
8008 (void) event_raise(event_action, US"msg:complete", NULL);
8012 /* If there are deferred addresses, we are keeping this message because it is
8013 not yet completed. Lose any temporary files that were catching output from
8014 pipes for any of the deferred addresses, handle one-time aliases, and see if
8015 the message has been on the queue for so long that it is time to send a warning
8016 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8017 have the same domain, we can set deliver_domain for the expansion of
8018 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8019 the parent's domain.
8021 If all the deferred addresses have an error number that indicates "retry time
8022 not reached", skip sending the warning message, because it won't contain the
8023 reason for the delay. It will get sent at the next real delivery attempt.
8024 Exception: for retries caused by a remote peer we use the error message
8025 store in the retry DB as the reason.
8026 However, if at least one address has tried, we'd better include all of them in
8029 If we can't make a process to send the message, don't worry.
8031 For mailing list expansions we want to send the warning message to the
8032 mailing list manager. We can't do a perfect job here, as some addresses may
8033 have different errors addresses, but if we take the errors address from
8034 each deferred address it will probably be right in most cases.
8036 If addr_defer == +1, it means there was a problem sending an error message
8037 for failed addresses, and there were no "real" deferred addresses. The value
8038 was set just to keep the message on the spool, so there is nothing to do here.
8041 else if (addr_defer != (address_item *)(+1))
8043 uschar *recipients = US"";
8044 BOOL want_warning_msg = FALSE;
8046 deliver_domain = testflag(addr_defer, af_pfr)
8047 ? addr_defer->parent->domain : addr_defer->domain;
8049 for (address_item * addr = addr_defer; addr; addr = addr->next)
8051 address_item *otaddr;
8053 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8057 const uschar *d = testflag(addr, af_pfr)
8058 ? addr->parent->domain : addr->domain;
8060 /* The domain may be unset for an address that has never been routed
8061 because the system filter froze the message. */
8063 if (!d || Ustrcmp(d, deliver_domain) != 0)
8064 deliver_domain = NULL;
8067 if (addr->return_filename) Uunlink(addr->return_filename);
8069 /* Handle the case of one-time aliases. If any address in the ancestry
8070 of this one is flagged, ensure it is in the recipients list, suitably
8071 flagged, and that its parent is marked delivered. */
8073 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8074 if (otaddr->onetime_parent) break;
8079 int t = recipients_count;
8081 for (i = 0; i < recipients_count; i++)
8083 uschar *r = recipients_list[i].address;
8084 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8085 if (Ustrcmp(otaddr->address, r) == 0) break;
8088 /* Didn't find the address already in the list, and did find the
8089 ultimate parent's address in the list, and they really are different
8090 (i.e. not from an identity-redirect). After adding the recipient,
8091 update the errors address in the recipients list. */
8093 if ( i >= recipients_count && t < recipients_count
8094 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8096 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8097 otaddr->address, otaddr->parent->address);
8098 receive_add_recipient(otaddr->address, t);
8099 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8100 tree_add_nonrecipient(otaddr->parent->address);
8101 update_spool = TRUE;
8105 /* Except for error messages, ensure that either the errors address for
8106 this deferred address or, if there is none, the sender address, is on the
8107 list of recipients for a warning message. */
8109 if (sender_address[0])
8111 uschar * s = addr->prop.errors_address;
8112 if (!s) s = sender_address;
8113 if (Ustrstr(recipients, s) == NULL)
8114 recipients = string_sprintf("%s%s%s", recipients,
8115 recipients[0] ? "," : "", s);
8119 /* Send a warning message if the conditions are right. If the condition check
8120 fails because of a lookup defer, there is nothing we can do. The warning
8121 is not sent. Another attempt will be made at the next delivery attempt (if
8124 if ( !f.queue_2stage
8126 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8127 || addr_defer->dsn_flags & rf_notify_delay
8129 && delay_warning[1] > 0
8130 && sender_address[0] != 0
8131 && ( !delay_warning_condition
8132 || expand_check_condition(delay_warning_condition,
8133 US"delay_warning", US"option")
8139 int queue_time = time(NULL) - received_time.tv_sec;
8141 /* When running in the test harness, there's an option that allows us to
8142 fudge this time so as to get repeatability of the tests. Take the first
8143 time off the list. In queue runs, the list pointer gets updated in the
8146 if (f.running_in_test_harness && fudged_queue_times[0] != 0)
8148 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8151 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8152 fudged_queue_times);
8157 /* See how many warnings we should have sent by now */
8159 for (count = 0; count < delay_warning[1]; count++)
8160 if (queue_time < delay_warning[count+2]) break;
8162 show_time = delay_warning[count+1];
8164 if (count >= delay_warning[1])
8167 int last_gap = show_time;
8168 if (count > 1) last_gap -= delay_warning[count];
8169 extra = (queue_time - delay_warning[count+1])/last_gap;
8170 show_time += last_gap * extra;
8176 debug_printf("time on queue = %s id %s addr %s\n", readconf_printtime(queue_time), message_id, addr_defer->address);
8177 debug_printf("warning counts: required %d done %d\n", count,
8181 /* We have computed the number of warnings there should have been by now.
8182 If there haven't been enough, send one, and up the count to what it should
8185 if (warning_count < count)
8189 pid_t pid = child_open_exim(&fd);
8195 FILE *f = fdopen(fd, "wb");
8197 transport_ctx tctx = {{0}};
8199 if (warn_message_file)
8200 if (!(wmf = Ufopen(warn_message_file, "rb")))
8201 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8202 "message texts: %s", warn_message_file, strerror(errno));
8204 warnmsg_recipients = recipients;
8205 warnmsg_delay = queue_time < 120*60
8206 ? string_sprintf("%d minutes", show_time/60)
8207 : string_sprintf("%d hours", show_time/3600);
8209 if (errors_reply_to)
8210 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8211 fprintf(f, "Auto-Submitted: auto-replied\n");
8213 fprintf(f, "To: %s\n", recipients);
8215 /* generated boundary string and output MIME-Headers */
8216 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8218 fprintf(f, "Content-Type: multipart/report;"
8219 " report-type=delivery-status; boundary=%s\n"
8220 "MIME-Version: 1.0\n",
8223 if ((wmf_text = next_emf(wmf, US"header")))
8224 fprintf(f, "%s\n", wmf_text);
8226 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8227 message_id, warnmsg_delay);
8229 /* output human readable part as text/plain section */
8231 "Content-type: text/plain; charset=us-ascii\n\n",
8234 if ((wmf_text = next_emf(wmf, US"intro")))
8235 fprintf(f, "%s", CS wmf_text);
8239 "This message was created automatically by mail delivery software.\n");
8241 if (Ustrcmp(recipients, sender_address) == 0)
8243 "A message that you sent has not yet been delivered to one or more of its\n"
8244 "recipients after more than ");
8248 "A message sent by\n\n <%s>\n\n"
8249 "has not yet been delivered to one or more of its recipients after more than \n",
8252 fprintf(f, "%s on the queue on %s.\n\n"
8253 "The message identifier is: %s\n",
8254 warnmsg_delay, primary_hostname, message_id);
8256 for (h = header_list; h; h = h->next)
8257 if (strncmpic(h->text, US"Subject:", 8) == 0)
8258 fprintf(f, "The subject of the message is: %s", h->text + 9);
8259 else if (strncmpic(h->text, US"Date:", 5) == 0)
8260 fprintf(f, "The date of the message is: %s", h->text + 6);
8263 fprintf(f, "The address%s to which the message has not yet been "
8265 !addr_defer->next ? "" : "es",
8266 !addr_defer->next ? "is": "are");
8269 /* List the addresses, with error information if allowed */
8271 /* store addr_defer for machine readable part */
8272 address_item *addr_dsndefer = addr_defer;
8276 address_item *addr = addr_defer;
8277 addr_defer = addr->next;
8278 if (print_address_information(addr, f, US" ", US"\n ", US""))
8279 print_address_error(addr, f, US"Delay reason: ");
8288 if ((wmf_text = next_emf(wmf, US"final")))
8289 fprintf(f, "%s", CS wmf_text);
8295 "No action is required on your part. Delivery attempts will continue for\n"
8296 "some time, and this warning may be repeated at intervals if the message\n"
8297 "remains undelivered. Eventually the mail delivery software will give up,\n"
8298 "and when that happens, the message will be returned to you.\n");
8301 /* output machine readable part */
8302 fprintf(f, "\n--%s\n"
8303 "Content-type: message/delivery-status\n\n"
8304 "Reporting-MTA: dns; %s\n",
8306 smtp_active_hostname);
8311 /* must be decoded from xtext: see RFC 3461:6.3a */
8313 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8314 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8316 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8320 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8322 if (addr_dsndefer->dsn_orcpt)
8323 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8325 fprintf(f, "Action: delayed\n"
8326 "Final-Recipient: rfc822;%s\n"
8328 addr_dsndefer->address);
8329 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8331 fprintf(f, "Remote-MTA: dns; %s\n",
8332 addr_dsndefer->host_used->name);
8333 print_dsn_diagnostic_code(addr_dsndefer, f);
8339 "Content-type: text/rfc822-headers\n\n",
8343 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8344 tctx.u.fd = fileno(f);
8345 tctx.options = topt_add_return_path | topt_no_body;
8346 transport_filter_argv = NULL; /* Just in case */
8347 return_path = sender_address; /* In case not previously set */
8349 /* Write the original email out */
8350 /*XXX no checking for failure! buggy! */
8351 transport_write_message(&tctx, 0);
8354 fprintf(f,"\n--%s--\n", bound);
8358 /* Close and wait for child process to complete, without a timeout.
8359 If there's an error, don't update the count. */
8362 if (child_close(pid, 0) == 0)
8364 warning_count = count;
8365 update_spool = TRUE; /* Ensure spool rewritten */
8371 /* Clear deliver_domain */
8373 deliver_domain = NULL;
8375 /* If this was a first delivery attempt, unset the first time flag, and
8376 ensure that the spool gets updated. */
8378 if (f.deliver_firsttime)
8380 f.deliver_firsttime = FALSE;
8381 update_spool = TRUE;
8384 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8385 message, unless the message is a local error message (to avoid loops). Then
8386 log the freezing. If the text in "frozen_info" came from a system filter,
8387 it has been escaped into printing characters so as not to mess up log lines.
8388 For the "tell" message, we turn \n back into newline. Also, insert a newline
8389 near the start instead of the ": " string. */
8391 if (f.deliver_freeze)
8393 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8395 uschar *s = string_copy(frozen_info);
8396 uschar *ss = Ustrstr(s, " by the system filter: ");
8407 if (*ss == '\\' && ss[1] == 'n')
8414 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8415 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8419 /* Log freezing just before we update the -H file, to minimize the chance
8420 of a race problem. */
8422 deliver_msglog("*** Frozen%s\n", frozen_info);
8423 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8426 /* If there have been any updates to the non-recipients list, or other things
8427 that get written to the spool, we must now update the spool header file so
8428 that it has the right information for the next delivery attempt. If there
8429 was more than one address being delivered, the header_change update is done
8430 earlier, in case one succeeds and then something crashes. */
8433 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8434 update_spool, f.header_rewritten);
8436 if (update_spool || f.header_rewritten)
8437 /* Panic-dies on error */
8438 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8441 /* Finished with the message log. If the message is complete, it will have
8442 been unlinked or renamed above. */
8444 if (message_logs) (void)fclose(message_log);
8446 /* Now we can close and remove the journal file. Its only purpose is to record
8447 successfully completed deliveries asap so that this information doesn't get
8448 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8449 not serious, as trying it again is not harmful. The journal might not be open
8450 if all addresses were deferred at routing or directing. Nevertheless, we must
8451 remove it if it exists (may have been lying around from a crash during the
8452 previous delivery attempt). We don't remove the journal if a delivery
8453 subprocess failed to pass back delivery information; this is controlled by
8454 the remove_journal flag. When the journal is left, we also don't move the
8455 message off the main spool if frozen and the option is set. It should get moved
8456 at the next attempt, after the journal has been inspected. */
8458 if (journal_fd >= 0) (void)close(journal_fd);
8462 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8464 if (Uunlink(fname) < 0 && errno != ENOENT)
8465 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8468 /* Move the message off the spool if requested */
8470 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8471 if (f.deliver_freeze && move_frozen_messages)
8472 (void)spool_move_message(id, message_subdir, US"", US"F");
8476 /* Closing the data file frees the lock; if the file has been unlinked it
8477 will go away. Otherwise the message becomes available for another process
8480 (void)close(deliver_datafile);
8481 deliver_datafile = -1;
8482 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8484 /* It is unlikely that there will be any cached resources, since they are
8485 released after routing, and in the delivery subprocesses. However, it's
8486 possible for an expansion for something afterwards (for example,
8487 expand_check_condition) to do a lookup. We must therefore be sure everything is
8491 acl_where = ACL_WHERE_UNKNOWN;
8500 #ifdef EXIM_TFO_PROBE
8503 f.tcp_fastopen_ok = TRUE;
8507 if (!regex_PIPELINING) regex_PIPELINING =
8508 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8510 if (!regex_SIZE) regex_SIZE =
8511 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8513 if (!regex_AUTH) regex_AUTH =
8514 regex_must_compile(AUTHS_REGEX, FALSE, TRUE);
8517 if (!regex_STARTTLS) regex_STARTTLS =
8518 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8520 # ifdef EXPERIMENTAL_REQUIRETLS
8521 if (!regex_REQUIRETLS) regex_REQUIRETLS =
8522 regex_must_compile(US"\\n250[\\s\\-]REQUIRETLS(\\s|\\n|$)", FALSE, TRUE);
8526 if (!regex_CHUNKING) regex_CHUNKING =
8527 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8529 #ifndef DISABLE_PRDR
8530 if (!regex_PRDR) regex_PRDR =
8531 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8535 if (!regex_UTF8) regex_UTF8 =
8536 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8539 if (!regex_DSN) regex_DSN =
8540 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8542 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8543 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8545 #ifdef EXPERIMENTAL_PIPE_CONNECT
8546 if (!regex_EARLY_PIPE) regex_EARLY_PIPE =
8547 regex_must_compile(US"\\n250[\\s\\-]" EARLY_PIPE_FEATURE_NAME "(\\s|\\n|$)", FALSE, TRUE);
8553 deliver_get_sender_address (uschar * id)
8556 uschar * new_sender_address,
8557 * save_sender_address;
8558 BOOL save_qr = f.queue_running;
8561 /* make spool_open_datafile non-noisy on fail */
8563 f.queue_running = TRUE;
8565 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8567 deliver_datafile = spool_open_datafile(id);
8568 f.queue_running = save_qr;
8569 if (deliver_datafile < 0)
8572 /* Save and restore the global sender_address. I'm not sure if we should
8573 not save/restore all the other global variables too, because
8574 spool_read_header() may change all of them. But OTOH, when this
8575 deliver_get_sender_address() gets called, the current message is done
8576 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8578 spoolname = string_sprintf("%s-H", id);
8579 save_sender_address = sender_address;
8581 rc = spool_read_header(spoolname, TRUE, TRUE);
8583 new_sender_address = sender_address;
8584 sender_address = save_sender_address;
8586 if (rc != spool_read_OK)
8589 assert(new_sender_address);
8591 (void)close(deliver_datafile);
8592 deliver_datafile = -1;
8594 return new_sender_address;
8600 delivery_re_exec(int exec_type)
8604 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8606 int channel_fd = cutthrough.cctx.sock;
8608 smtp_peer_options = cutthrough.peer_options;
8609 continue_sequence = 0;
8612 if (cutthrough.is_tls)
8616 smtp_peer_options |= OPTION_TLS;
8617 sending_ip_address = cutthrough.snd_ip;
8618 sending_port = cutthrough.snd_port;
8620 where = US"socketpair";
8621 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8625 if ((pid = fork()) < 0)
8628 else if (pid == 0) /* child: fork again to totally disconnect */
8630 if (f.running_in_test_harness) millisleep(100); /* let parent debug out */
8631 /* does not return */
8632 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8636 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8638 waitpid(pid, NULL, 0);
8639 (void) close(channel_fd); /* release the client socket */
8640 channel_fd = pfd[1];
8644 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8645 cutthrough.host.address, message_id, channel_fd);
8649 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8650 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8652 return; /* compiler quietening; control does not reach here. */
8657 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8658 "delivery re-exec %s failed: %s", where, strerror(errno));
8660 /* Get here if exec_type == CEE_EXEC_EXIT.
8661 Note: this must be _exit(), not exit(). */
8663 _exit(EX_EXECFAILED);
8669 /* End of deliver.c */