1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_senddsn = NULL;
71 static FILE *message_log = NULL;
72 static BOOL update_spool;
73 static BOOL remove_journal;
74 static int parcount = 0;
75 static pardata *parlist = NULL;
76 static int return_count;
77 static uschar *frozen_info = US"";
78 static uschar *used_return_path = NULL;
82 /*************************************************
83 * read as much as requested *
84 *************************************************/
86 /* The syscall read(2) doesn't always returns as much as we want. For
87 several reasons it might get less. (Not talking about signals, as syscalls
88 are restartable). When reading from a network or pipe connection the sender
89 might send in smaller chunks, with delays between these chunks. The read(2)
90 may return such a chunk.
92 The more the writer writes and the smaller the pipe between write and read is,
93 the more we get the chance of reading leass than requested. (See bug 2130)
95 This function read(2)s until we got all the data we *requested*.
97 Note: This function may block. Use it only if you're sure about the
98 amount of data you will get.
101 fd the file descriptor to read from
102 buffer pointer to a buffer of size len
103 len the requested(!) amount of bytes
105 Returns: the amount of bytes read
108 readn(int fd, void * buffer, size_t len)
110 uschar * next = buffer;
111 uschar * end = next + len;
115 ssize_t got = read(fd, next, end - next);
117 /* I'm not sure if there are signals that can interrupt us,
118 for now I assume the worst */
119 if (got == -1 && errno == EINTR) continue;
120 if (got <= 0) return next - US buffer;
128 /*************************************************
129 * Make a new address item *
130 *************************************************/
132 /* This function gets the store and initializes with default values. The
133 transport_return value defaults to DEFER, so that any unexpected failure to
134 deliver does not wipe out the message. The default unique string is set to a
135 copy of the address, so that its domain can be lowercased.
138 address the RFC822 address string
139 copy force a copy of the address
141 Returns: a pointer to an initialized address_item
145 deliver_make_addr(uschar *address, BOOL copy)
147 address_item *addr = store_get(sizeof(address_item), FALSE);
148 *addr = address_defaults;
149 if (copy) address = string_copy(address);
150 addr->address = address;
151 addr->unique = string_copy(address);
158 /*************************************************
159 * Set expansion values for an address *
160 *************************************************/
162 /* Certain expansion variables are valid only when handling an address or
163 address list. This function sets them up or clears the values, according to its
167 addr the address in question, or NULL to clear values
172 deliver_set_expansions(address_item *addr)
176 const uschar ***p = address_expansions;
177 while (*p) **p++ = NULL;
181 /* Exactly what gets set depends on whether there is one or more addresses, and
182 what they contain. These first ones are always set, taking their values from
183 the first address. */
185 if (!addr->host_list)
187 deliver_host = deliver_host_address = US"";
188 deliver_host_port = 0;
192 deliver_host = addr->host_list->name;
193 deliver_host_address = addr->host_list->address;
194 deliver_host_port = addr->host_list->port;
197 deliver_recipients = addr;
198 deliver_address_data = addr->prop.address_data;
199 deliver_domain_data = addr->prop.domain_data;
200 deliver_localpart_data = addr->prop.localpart_data;
201 router_var = addr->prop.variables;
203 /* These may be unset for multiple addresses */
205 deliver_domain = addr->domain;
206 self_hostname = addr->self_hostname;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver = 1; /* deliver by default */
210 bmi_alt_location = NULL;
211 bmi_base64_verdict = NULL;
212 bmi_base64_tracker_verdict = NULL;
215 /* If there's only one address we can set everything. */
219 address_item *addr_orig;
221 deliver_localpart = addr->local_part;
222 deliver_localpart_prefix = addr->prefix;
223 deliver_localpart_prefix_v = addr->prefix_v;
224 deliver_localpart_suffix = addr->suffix;
225 deliver_localpart_suffix_v = addr->suffix_v;
227 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
228 deliver_domain_orig = addr_orig->domain;
230 /* Re-instate any prefix and suffix in the original local part. In all
231 normal cases, the address will have a router associated with it, and we can
232 choose the caseful or caseless version accordingly. However, when a system
233 filter sets up a pipe, file, or autoreply delivery, no router is involved.
234 In this case, though, there won't be any prefix or suffix to worry about. */
236 deliver_localpart_orig = !addr_orig->router
237 ? addr_orig->local_part
238 : addr_orig->router->caseful_local_part
239 ? addr_orig->cc_local_part
240 : addr_orig->lc_local_part;
242 /* If there's a parent, make its domain and local part available, and if
243 delivering to a pipe or file, or sending an autoreply, get the local
244 part from the parent. For pipes and files, put the pipe or file string
245 into address_pipe and address_file. */
249 deliver_domain_parent = addr->parent->domain;
250 deliver_localpart_parent = !addr->parent->router
251 ? addr->parent->local_part
252 : addr->parent->router->caseful_local_part
253 ? addr->parent->cc_local_part
254 : addr->parent->lc_local_part;
256 /* File deliveries have their own flag because they need to be picked out
257 as special more often. */
259 if (testflag(addr, af_pfr))
261 if (testflag(addr, af_file)) address_file = addr->local_part;
262 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
263 deliver_localpart = addr->parent->local_part;
264 deliver_localpart_prefix = addr->parent->prefix;
265 deliver_localpart_prefix_v = addr->parent->prefix_v;
266 deliver_localpart_suffix = addr->parent->suffix;
267 deliver_localpart_suffix_v = addr->parent->suffix_v;
271 #ifdef EXPERIMENTAL_BRIGHTMAIL
272 /* Set expansion variables related to Brightmail AntiSpam */
273 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
274 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
275 /* get message delivery status (0 - don't deliver | 1 - deliver) */
276 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
277 /* if message is to be delivered, get eventual alternate location */
278 if (bmi_deliver == 1)
279 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
284 /* For multiple addresses, don't set local part, and leave the domain and
285 self_hostname set only if it is the same for all of them. It is possible to
286 have multiple pipe and file addresses, but only when all addresses have routed
287 to the same pipe or file. */
291 if (testflag(addr, af_pfr))
293 if (testflag(addr, af_file)) address_file = addr->local_part;
294 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
296 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
298 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
299 deliver_domain = NULL;
301 && ( !addr2->self_hostname
302 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
304 self_hostname = NULL;
305 if (!deliver_domain && !self_hostname) break;
313 /*************************************************
314 * Open a msglog file *
315 *************************************************/
317 /* This function is used both for normal message logs, and for files in the
318 msglog directory that are used to catch output from pipes. Try to create the
319 directory if it does not exist. From release 4.21, normal message logs should
320 be created when the message is received.
322 Called from deliver_message(), can be operating as root.
325 filename the file name
326 mode the mode required
327 error used for saying what failed
329 Returns: a file descriptor, or -1 (with errno set)
333 open_msglog_file(uschar *filename, int mode, uschar **error)
335 if (Ustrstr(filename, US"/../"))
336 log_write(0, LOG_MAIN|LOG_PANIC,
337 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
339 for (int i = 2; i > 0; i--)
341 int fd = Uopen(filename,
348 O_WRONLY|O_APPEND|O_CREAT, mode);
351 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
352 function is called as root). Double check the mode, because the group setting
353 doesn't always get set automatically. */
356 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
358 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
363 if (fchmod(fd, mode) < 0)
373 (void)directory_make(spool_directory,
374 spool_sname(US"msglog", message_subdir),
375 MSGLOG_DIRECTORY_MODE, TRUE);
378 *error = US"create or open";
385 /*************************************************
386 * Write to msglog if required *
387 *************************************************/
389 /* Write to the message log, if configured. This function may also be called
393 format a string format
399 deliver_msglog(const char *format, ...)
402 if (!message_logs) return;
403 va_start(ap, format);
404 vfprintf(message_log, format, ap);
412 /*************************************************
413 * Replicate status for batch *
414 *************************************************/
416 /* When a transport handles a batch of addresses, it may treat them
417 individually, or it may just put the status in the first one, and return FALSE,
418 requesting that the status be copied to all the others externally. This is the
419 replication function. As well as the status, it copies the transport pointer,
420 which may have changed if appendfile passed the addresses on to a different
423 Argument: pointer to the first address in a chain
428 replicate_status(address_item *addr)
430 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
432 addr2->transport = addr->transport;
433 addr2->transport_return = addr->transport_return;
434 addr2->basic_errno = addr->basic_errno;
435 addr2->more_errno = addr->more_errno;
436 addr2->delivery_time = addr->delivery_time;
437 addr2->special_action = addr->special_action;
438 addr2->message = addr->message;
439 addr2->user_message = addr->user_message;
445 /*************************************************
446 * Compare lists of hosts *
447 *************************************************/
449 /* This function is given two pointers to chains of host items, and it yields
450 TRUE if the lists refer to the same hosts in the same order, except that
452 (1) Multiple hosts with the same non-negative MX values are permitted to appear
453 in different orders. Round-robinning nameservers can cause this to happen.
455 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
456 permitted to appear in different orders. This is caused by randomizing
459 This enables Exim to use a single SMTP transaction for sending to two entirely
460 different domains that happen to end up pointing at the same hosts.
463 one points to the first host list
464 two points to the second host list
466 Returns: TRUE if the lists refer to the same host set
470 same_hosts(host_item *one, host_item *two)
474 if (Ustrcmp(one->name, two->name) != 0)
477 host_item *end_one = one;
478 host_item *end_two = two;
480 /* Batch up only if there was no MX and the list was not randomized */
482 if (mx == MX_NONE) return FALSE;
484 /* Find the ends of the shortest sequence of identical MX values */
486 while ( end_one->next && end_one->next->mx == mx
487 && end_two->next && end_two->next->mx == mx)
489 end_one = end_one->next;
490 end_two = end_two->next;
493 /* If there aren't any duplicates, there's no match. */
495 if (end_one == one) return FALSE;
497 /* For each host in the 'one' sequence, check that it appears in the 'two'
498 sequence, returning FALSE if not. */
503 for (hi = two; hi != end_two->next; hi = hi->next)
504 if (Ustrcmp(one->name, hi->name) == 0) break;
505 if (hi == end_two->next) return FALSE;
506 if (one == end_one) break;
510 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
511 Ensure both are pointing at the last host, and carry on as for equality. */
516 /* if the names matched but ports do not, mismatch */
517 else if (one->port != two->port)
526 /* True if both are NULL */
533 /*************************************************
534 * Compare header lines *
535 *************************************************/
537 /* This function is given two pointers to chains of header items, and it yields
538 TRUE if they are the same header texts in the same order.
541 one points to the first header list
542 two points to the second header list
544 Returns: TRUE if the lists refer to the same header set
548 same_headers(header_line *one, header_line *two)
550 for (;; one = one->next, two = two->next)
552 if (one == two) return TRUE; /* Includes the case where both NULL */
553 if (!one || !two) return FALSE;
554 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
560 /*************************************************
561 * Compare string settings *
562 *************************************************/
564 /* This function is given two pointers to strings, and it returns
565 TRUE if they are the same pointer, or if the two strings are the same.
568 one points to the first string
569 two points to the second string
571 Returns: TRUE or FALSE
575 same_strings(uschar *one, uschar *two)
577 if (one == two) return TRUE; /* Includes the case where both NULL */
578 if (!one || !two) return FALSE;
579 return (Ustrcmp(one, two) == 0);
584 /*************************************************
585 * Compare uid/gid for addresses *
586 *************************************************/
588 /* This function is given a transport and two addresses. It yields TRUE if the
589 uid/gid/initgroups settings for the two addresses are going to be the same when
594 addr1 the first address
595 addr2 the second address
597 Returns: TRUE or FALSE
601 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
603 if ( !tp->uid_set && !tp->expand_uid
604 && !tp->deliver_as_creator
605 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
606 || ( testflag(addr1, af_uid_set)
607 && ( addr1->uid != addr2->uid
608 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
612 if ( !tp->gid_set && !tp->expand_gid
613 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
614 || ( testflag(addr1, af_gid_set)
615 && addr1->gid != addr2->gid
625 /*************************************************
626 * Record that an address is complete *
627 *************************************************/
629 /* This function records that an address is complete. This is straightforward
630 for most addresses, where the unique address is just the full address with the
631 domain lower cased. For homonyms (addresses that are the same as one of their
632 ancestors) their are complications. Their unique addresses have \x\ prepended
633 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
636 Exim used to record the unique addresses of homonyms as "complete". This,
637 however, fails when the pattern of redirection varies over time (e.g. if taking
638 unseen copies at only some times of day) because the prepended numbers may vary
639 from one delivery run to the next. This problem is solved by never recording
640 prepended unique addresses as complete. Instead, when a homonymic address has
641 actually been delivered via a transport, we record its basic unique address
642 followed by the name of the transport. This is checked in subsequent delivery
643 runs whenever an address is routed to a transport.
645 If the completed address is a top-level one (has no parent, which means it
646 cannot be homonymic) we also add the original address to the non-recipients
647 tree, so that it gets recorded in the spool file and therefore appears as
648 "done" in any spool listings. The original address may differ from the unique
649 address in the case of the domain.
651 Finally, this function scans the list of duplicates, marks as done any that
652 match this address, and calls child_done() for their ancestors.
655 addr address item that has been completed
656 now current time as a string
662 address_done(address_item *addr, uschar *now)
664 update_spool = TRUE; /* Ensure spool gets updated */
666 /* Top-level address */
670 tree_add_nonrecipient(addr->unique);
671 tree_add_nonrecipient(addr->address);
674 /* Homonymous child address */
676 else if (testflag(addr, af_homonym))
679 tree_add_nonrecipient(
680 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
683 /* Non-homonymous child address */
685 else tree_add_nonrecipient(addr->unique);
687 /* Check the list of duplicate addresses and ensure they are now marked
690 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
691 if (Ustrcmp(addr->unique, dup->unique) == 0)
693 tree_add_nonrecipient(dup->unique);
694 child_done(dup, now);
701 /*************************************************
702 * Decrease counts in parents and mark done *
703 *************************************************/
705 /* This function is called when an address is complete. If there is a parent
706 address, its count of children is decremented. If there are still other
707 children outstanding, the function exits. Otherwise, if the count has become
708 zero, address_done() is called to mark the parent and its duplicates complete.
709 Then loop for any earlier ancestors.
712 addr points to the completed address item
713 now the current time as a string, for writing to the message log
719 child_done(address_item *addr, uschar *now)
726 if (--addr->child_count > 0) return; /* Incomplete parent */
727 address_done(addr, now);
729 /* Log the completion of all descendents only when there is no ancestor with
730 the same original address. */
732 for (aa = addr->parent; aa; aa = aa->parent)
733 if (Ustrcmp(aa->address, addr->address) == 0) break;
736 deliver_msglog("%s %s: children all complete\n", now, addr->address);
737 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
743 /*************************************************
744 * Delivery logging support functions *
745 *************************************************/
747 /* The LOGGING() checks in d_log_interface() are complicated for backwards
748 compatibility. When outgoing interface logging was originally added, it was
749 conditional on just incoming_interface (which is off by default). The
750 outgoing_interface option is on by default to preserve this behaviour, but
751 you can enable incoming_interface and disable outgoing_interface to get I=
752 fields on incoming lines only.
756 addr The address to be logged
758 Returns: New value for s
762 d_log_interface(gstring * g)
764 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
765 && sending_ip_address)
767 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
768 if (LOGGING(outgoing_port))
769 g = string_fmt_append(g, ":%d", sending_port);
777 d_hostlog(gstring * g, address_item * addr)
779 host_item * h = addr->host_used;
781 g = string_append(g, 2, US" H=", h->name);
783 if (LOGGING(dnssec) && h->dnssec == DS_YES)
784 g = string_catn(g, US" DS", 3);
786 g = string_append(g, 3, US" [", h->address, US"]");
788 if (LOGGING(outgoing_port))
789 g = string_fmt_append(g, ":%d", h->port);
792 if (LOGGING(proxy) && proxy_local_address)
794 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
795 if (LOGGING(outgoing_port))
796 g = string_fmt_append(g, ":%d", proxy_local_port);
800 g = d_log_interface(g);
802 if (testflag(addr, af_tcp_fastopen))
803 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
814 d_tlslog(gstring * g, address_item * addr)
816 if (LOGGING(tls_cipher) && addr->cipher)
818 g = string_append(g, 2, US" X=", addr->cipher);
819 #ifdef EXPERIMENTAL_TLS_RESUME
820 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
821 g = string_catn(g, US"*", 1);
824 if (LOGGING(tls_certificate_verified) && addr->cipher)
825 g = string_append(g, 2, US" CV=",
826 testflag(addr, af_cert_verified)
829 testflag(addr, af_dane_verified)
835 if (LOGGING(tls_peerdn) && addr->peerdn)
836 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
844 #ifndef DISABLE_EVENT
846 event_raise(uschar * action, const uschar * event, uschar * ev_data)
852 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
854 action, deliver_host_address);
857 event_data = ev_data;
859 if (!(s = expand_string(action)) && *expand_string_message)
860 log_write(0, LOG_MAIN|LOG_PANIC,
861 "failed to expand event_action %s in %s: %s\n",
862 event, transport_name ? transport_name : US"main", expand_string_message);
864 event_name = event_data = NULL;
866 /* If the expansion returns anything but an empty string, flag for
867 the caller to modify his normal processing
872 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
881 msg_event_raise(const uschar * event, const address_item * addr)
883 const uschar * save_domain = deliver_domain;
884 uschar * save_local = deliver_localpart;
885 const uschar * save_host = deliver_host;
886 const uschar * save_address = deliver_host_address;
887 const int save_port = deliver_host_port;
889 router_name = addr->router ? addr->router->name : NULL;
890 deliver_domain = addr->domain;
891 deliver_localpart = addr->local_part;
892 deliver_host = addr->host_used ? addr->host_used->name : NULL;
894 if (!addr->transport)
896 if (Ustrcmp(event, "msg:fail:delivery") == 0)
898 /* An address failed with no transport involved. This happens when
899 a filter was used which triggered a fail command (in such a case
900 a transport isn't needed). Convert it to an internal fail event. */
902 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
907 transport_name = addr->transport->name;
909 (void) event_raise(addr->transport->event_action, event,
911 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
912 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
913 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
914 ? addr->message : NULL);
917 deliver_host_port = save_port;
918 deliver_host_address = save_address;
919 deliver_host = save_host;
920 deliver_localpart = save_local;
921 deliver_domain = save_domain;
922 router_name = transport_name = NULL;
924 #endif /*DISABLE_EVENT*/
928 /******************************************************************************/
931 /*************************************************
932 * Generate local prt for logging *
933 *************************************************/
935 /* This function is a subroutine for use in string_log_address() below.
938 addr the address being logged
939 yield the current dynamic buffer pointer
941 Returns: the new value of the buffer pointer
945 string_get_localpart(address_item * addr, gstring * yield)
950 if (testflag(addr, af_include_affixes) && s)
953 if (testflag(addr, af_utf8_downcvt))
954 s = string_localpart_utf8_to_alabel(s, NULL);
956 yield = string_cat(yield, s);
959 s = addr->local_part;
961 if (testflag(addr, af_utf8_downcvt))
962 s = string_localpart_utf8_to_alabel(s, NULL);
964 yield = string_cat(yield, s);
967 if (testflag(addr, af_include_affixes) && s)
970 if (testflag(addr, af_utf8_downcvt))
971 s = string_localpart_utf8_to_alabel(s, NULL);
973 yield = string_cat(yield, s);
980 /*************************************************
981 * Generate log address list *
982 *************************************************/
984 /* This function generates a list consisting of an address and its parents, for
985 use in logging lines. For saved onetime aliased addresses, the onetime parent
986 field is used. If the address was delivered by a transport with rcpt_include_
987 affixes set, the af_include_affixes bit will be set in the address. In that
988 case, we include the affixes here too.
991 g points to growing-string struct
992 addr bottom (ultimate) address
993 all_parents if TRUE, include all parents
994 success TRUE for successful delivery
996 Returns: a growable string in dynamic store
1000 string_log_address(gstring * g,
1001 address_item *addr, BOOL all_parents, BOOL success)
1003 BOOL add_topaddr = TRUE;
1004 address_item *topaddr;
1006 /* Find the ultimate parent */
1008 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1010 /* We start with just the local part for pipe, file, and reply deliveries, and
1011 for successful local deliveries from routers that have the log_as_local flag
1012 set. File deliveries from filters can be specified as non-absolute paths in
1013 cases where the transport is going to complete the path. If there is an error
1014 before this happens (expansion failure) the local part will not be updated, and
1015 so won't necessarily look like a path. Add extra text for this case. */
1017 if ( testflag(addr, af_pfr)
1019 && addr->router && addr->router->log_as_local
1020 && addr->transport && addr->transport->info->local
1023 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1024 g = string_catn(g, CUS"save ", 5);
1025 g = string_get_localpart(addr, g);
1028 /* Other deliveries start with the full address. It we have split it into local
1029 part and domain, use those fields. Some early failures can happen before the
1030 splitting is done; in those cases use the original field. */
1035 int off = g->ptr; /* start of the "full address" */
1037 if (addr->local_part)
1040 g = string_get_localpart(addr, g);
1041 g = string_catn(g, US"@", 1);
1044 if (testflag(addr, af_utf8_downcvt))
1045 s = string_localpart_utf8_to_alabel(s, NULL);
1047 g = string_cat(g, s);
1050 g = string_cat(g, addr->address);
1052 /* If the address we are going to print is the same as the top address,
1053 and all parents are not being included, don't add on the top address. First
1054 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1055 on the local parts. */
1057 cmp = g->s + off; /* only now, as rebuffer likely done */
1058 string_from_gstring(g); /* ensure nul-terminated */
1059 if ( strcmpic(cmp, topaddr->address) == 0
1060 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1061 && !addr->onetime_parent
1062 && (!all_parents || !addr->parent || addr->parent == topaddr)
1064 add_topaddr = FALSE;
1067 /* If all parents are requested, or this is a local pipe/file/reply, and
1068 there is at least one intermediate parent, show it in brackets, and continue
1069 with all of them if all are wanted. */
1071 if ( (all_parents || testflag(addr, af_pfr))
1073 && addr->parent != topaddr)
1076 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1078 g = string_catn(g, s, 2);
1079 g = string_cat (g, addr2->address);
1080 if (!all_parents) break;
1083 g = string_catn(g, US")", 1);
1086 /* Add the top address if it is required */
1089 g = string_append(g, 3,
1091 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1099 /******************************************************************************/
1103 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1104 this is a nonstandard call; no two-character delivery flag is written
1105 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1108 flags passed to log_write()
1111 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1113 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1116 /* Log the delivery on the main log. We use an extensible string to build up
1117 the log line, and reset the store afterwards. Remote deliveries should always
1118 have a pointer to the host item that succeeded; local deliveries can have a
1119 pointer to a single host item in their host list, for use by the transport. */
1121 #ifndef DISABLE_EVENT
1122 /* presume no successful remote delivery */
1123 lookup_dnssec_authenticated = NULL;
1126 reset_point = store_mark();
1127 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1130 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1133 g->s[0] = logchar; g->ptr = 1;
1134 g = string_catn(g, US"> ", 2);
1136 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1138 if (LOGGING(sender_on_delivery) || msg)
1139 g = string_append(g, 3, US" F=<",
1141 testflag(addr, af_utf8_downcvt)
1142 ? string_address_utf8_to_alabel(sender_address, NULL)
1149 g = string_append(g, 2, US" Q=", queue_name);
1151 #ifdef EXPERIMENTAL_SRS
1152 if(addr->prop.srs_sender)
1153 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1156 /* You might think that the return path must always be set for a successful
1157 delivery; indeed, I did for some time, until this statement crashed. The case
1158 when it is not set is for a delivery to /dev/null which is optimised by not
1159 being run at all. */
1161 if (used_return_path && LOGGING(return_path_on_delivery))
1162 g = string_append(g, 3, US" P=<", used_return_path, US">");
1165 g = string_append(g, 2, US" ", msg);
1167 /* For a delivery from a system filter, there may not be a router */
1169 g = string_append(g, 2, US" R=", addr->router->name);
1171 g = string_append(g, 2, US" T=", addr->transport->name);
1173 if (LOGGING(delivery_size))
1174 g = string_fmt_append(g, " S=%d", transport_count);
1176 /* Local delivery */
1178 if (addr->transport->info->local)
1180 if (addr->host_list)
1181 g = string_append(g, 2, US" H=", addr->host_list->name);
1182 g = d_log_interface(g);
1183 if (addr->shadow_message)
1184 g = string_cat(g, addr->shadow_message);
1187 /* Remote delivery */
1191 if (addr->host_used)
1193 g = d_hostlog(g, addr);
1194 if (continue_sequence > 1)
1195 g = string_catn(g, US"*", 1);
1197 #ifndef DISABLE_EVENT
1198 deliver_host_address = addr->host_used->address;
1199 deliver_host_port = addr->host_used->port;
1200 deliver_host = addr->host_used->name;
1202 /* DNS lookup status */
1203 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1204 : addr->host_used->dnssec==DS_NO ? US"no"
1210 g = d_tlslog(g, addr);
1213 if (addr->authenticator)
1215 g = string_append(g, 2, US" A=", addr->authenticator);
1218 g = string_append(g, 2, US":", addr->auth_id);
1219 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1220 g = string_append(g, 2, US":", addr->auth_sndr);
1224 if (LOGGING(pipelining))
1226 if (testflag(addr, af_pipelining))
1227 g = string_catn(g, US" L", 2);
1228 #ifndef DISABLE_PIPE_CONNECT
1229 if (testflag(addr, af_early_pipe))
1230 g = string_catn(g, US"*", 1);
1234 #ifndef DISABLE_PRDR
1235 if (testflag(addr, af_prdr_used))
1236 g = string_catn(g, US" PRDR", 5);
1239 if (testflag(addr, af_chunking_used))
1240 g = string_catn(g, US" K", 2);
1243 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1245 if ( LOGGING(smtp_confirmation)
1247 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1250 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1251 uschar *p = big_buffer;
1252 uschar *ss = addr->message;
1254 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1256 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1261 g = string_append(g, 2, US" C=", big_buffer);
1264 /* Time on queue and actual time taken to deliver */
1266 if (LOGGING(queue_time))
1267 g = string_append(g, 2, US" QT=",
1268 string_timesince(&received_time));
1270 if (LOGGING(deliver_time))
1271 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1273 /* string_cat() always leaves room for the terminator. Release the
1274 store we used to build the line after writing it. */
1276 log_write(0, flags, "%s", string_from_gstring(g));
1278 #ifndef DISABLE_EVENT
1279 if (!msg) msg_event_raise(US"msg:delivery", addr);
1282 store_reset(reset_point);
1289 deferral_log(address_item * addr, uschar * now,
1290 int logflags, uschar * driver_name, uschar * driver_kind)
1292 rmark reset_point = store_mark();
1293 gstring * g = string_get(256);
1295 /* Build up the line that is used for both the message log and the main
1298 /* Create the address string for logging. Must not do this earlier, because
1299 an OK result may be changed to FAIL when a pipe returns text. */
1301 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1304 g = string_append(g, 2, US" Q=", queue_name);
1306 /* Either driver_name contains something and driver_kind contains
1307 " router" or " transport" (note the leading space), or driver_name is
1308 a null string and driver_kind contains "routing" without the leading
1309 space, if all routing has been deferred. When a domain has been held,
1310 so nothing has been done at all, both variables contain null strings. */
1314 if (driver_kind[1] == 't' && addr->router)
1315 g = string_append(g, 2, US" R=", addr->router->name);
1316 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1318 else if (driver_kind)
1319 g = string_append(g, 2, US" ", driver_kind);
1321 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1323 if (addr->basic_errno > 0)
1324 g = string_append(g, 2, US": ",
1325 US strerror(addr->basic_errno));
1327 if (addr->host_used)
1329 g = string_append(g, 5,
1330 US" H=", addr->host_used->name,
1331 US" [", addr->host_used->address, US"]");
1332 if (LOGGING(outgoing_port))
1334 int port = addr->host_used->port;
1335 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1339 if (LOGGING(deliver_time))
1340 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1343 g = string_append(g, 2, US": ", addr->message);
1345 (void) string_from_gstring(g);
1347 /* Log the deferment in the message log, but don't clutter it
1348 up with retry-time defers after the first delivery attempt. */
1350 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1351 deliver_msglog("%s %s\n", now, g->s);
1353 /* Write the main log and reset the store.
1354 For errors of the type "retry time not reached" (also remotes skipped
1355 on queue run), logging is controlled by L_retry_defer. Note that this kind
1356 of error number is negative, and all the retry ones are less than any
1360 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1363 store_reset(reset_point);
1370 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1372 rmark reset_point = store_mark();
1373 gstring * g = string_get(256);
1375 #ifndef DISABLE_EVENT
1376 /* Message failures for which we will send a DSN get their event raised
1377 later so avoid doing it here. */
1379 if ( !addr->prop.ignore_error
1380 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1382 msg_event_raise(US"msg:fail:delivery", addr);
1385 /* Build up the log line for the message and main logs */
1387 /* Create the address string for logging. Must not do this earlier, because
1388 an OK result may be changed to FAIL when a pipe returns text. */
1390 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1392 if (LOGGING(sender_on_delivery))
1393 g = string_append(g, 3, US" F=<", sender_address, US">");
1396 g = string_append(g, 2, US" Q=", queue_name);
1398 /* Return path may not be set if no delivery actually happened */
1400 if (used_return_path && LOGGING(return_path_on_delivery))
1401 g = string_append(g, 3, US" P=<", used_return_path, US">");
1404 g = string_append(g, 2, US" R=", addr->router->name);
1405 if (addr->transport)
1406 g = string_append(g, 2, US" T=", addr->transport->name);
1408 if (addr->host_used)
1409 g = d_hostlog(g, addr);
1412 g = d_tlslog(g, addr);
1415 if (addr->basic_errno > 0)
1416 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1419 g = string_append(g, 2, US": ", addr->message);
1421 if (LOGGING(deliver_time))
1422 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1424 (void) string_from_gstring(g);
1426 /* Do the logging. For the message log, "routing failed" for those cases,
1427 just to make it clearer. */
1430 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1432 deliver_msglog("%s %s\n", now, g->s);
1434 log_write(0, LOG_MAIN, "** %s", g->s);
1436 store_reset(reset_point);
1442 /*************************************************
1443 * Actions at the end of handling an address *
1444 *************************************************/
1446 /* This is a function for processing a single address when all that can be done
1447 with it has been done.
1450 addr points to the address block
1451 result the result of the delivery attempt
1452 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1453 driver_type indicates which type of driver (transport, or router) was last
1454 to process the address
1455 logchar '=' or '-' for use when logging deliveries with => or ->
1461 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1464 uschar *now = tod_stamp(tod_log);
1465 uschar *driver_kind = NULL;
1466 uschar *driver_name = NULL;
1468 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1470 /* Set up driver kind and name for logging. Disable logging if the router or
1471 transport has disabled it. */
1473 if (driver_type == EXIM_DTYPE_TRANSPORT)
1475 if (addr->transport)
1477 driver_name = addr->transport->name;
1478 driver_kind = US" transport";
1479 f.disable_logging = addr->transport->disable_logging;
1481 else driver_kind = US"transporting";
1483 else if (driver_type == EXIM_DTYPE_ROUTER)
1487 driver_name = addr->router->name;
1488 driver_kind = US" router";
1489 f.disable_logging = addr->router->disable_logging;
1491 else driver_kind = US"routing";
1494 /* If there's an error message set, ensure that it contains only printing
1495 characters - it should, but occasionally things slip in and this at least
1496 stops the log format from getting wrecked. We also scan the message for an LDAP
1497 expansion item that has a password setting, and flatten the password. This is a
1498 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1499 malformed, it won't ever have gone near LDAP.) */
1503 const uschar * s = string_printing(addr->message);
1505 /* deconst cast ok as string_printing known to have alloc'n'copied */
1506 addr->message = expand_hide_passwords(US s);
1509 /* If we used a transport that has one of the "return_output" options set, and
1510 if it did in fact generate some output, then for return_output we treat the
1511 message as failed if it was not already set that way, so that the output gets
1512 returned to the sender, provided there is a sender to send it to. For
1513 return_fail_output, do this only if the delivery failed. Otherwise we just
1514 unlink the file, and remove the name so that if the delivery failed, we don't
1515 try to send back an empty or unwanted file. The log_output options operate only
1516 on a non-empty file.
1518 In any case, we close the message file, because we cannot afford to leave a
1519 file-descriptor for one address while processing (maybe very many) others. */
1521 if (addr->return_file >= 0 && addr->return_filename)
1523 BOOL return_output = FALSE;
1524 struct stat statbuf;
1525 (void)EXIMfsync(addr->return_file);
1527 /* If there is no output, do nothing. */
1529 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1531 transport_instance *tb = addr->transport;
1533 /* Handle logging options */
1536 || result == FAIL && tb->log_fail_output
1537 || result == DEFER && tb->log_defer_output
1541 FILE *f = Ufopen(addr->return_filename, "rb");
1543 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1544 "from %s transport: %s", addr->return_filename, tb->name,
1547 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1549 uschar *p = big_buffer + Ustrlen(big_buffer);
1551 while (p > big_buffer && isspace(p[-1])) p--;
1553 sp = string_printing(big_buffer);
1554 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1555 addr->address, tb->name, sp);
1560 /* Handle returning options, but only if there is an address to return
1563 if (sender_address[0] != 0 || addr->prop.errors_address)
1564 if (tb->return_output)
1566 addr->transport_return = result = FAIL;
1567 if (addr->basic_errno == 0 && !addr->message)
1568 addr->message = US"return message generated";
1569 return_output = TRUE;
1572 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1575 /* Get rid of the file unless it might be returned, but close it in
1580 Uunlink(addr->return_filename);
1581 addr->return_filename = NULL;
1582 addr->return_file = -1;
1585 (void)close(addr->return_file);
1588 /* The success case happens only after delivery by a transport. */
1592 addr->next = addr_succeed;
1593 addr_succeed = addr;
1595 /* Call address_done() to ensure that we don't deliver to this address again,
1596 and write appropriate things to the message log. If it is a child address, we
1597 call child_done() to scan the ancestors and mark them complete if this is the
1598 last child to complete. */
1600 address_done(addr, now);
1601 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1604 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1605 driver_name, driver_kind);
1608 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1609 addr->parent->address, driver_name, driver_kind);
1610 child_done(addr, now);
1613 /* Certificates for logging (via events) */
1615 tls_out.ourcert = addr->ourcert;
1616 addr->ourcert = NULL;
1617 tls_out.peercert = addr->peercert;
1618 addr->peercert = NULL;
1620 tls_out.ver = addr->tlsver;
1621 tls_out.cipher = addr->cipher;
1622 tls_out.peerdn = addr->peerdn;
1623 tls_out.ocsp = addr->ocsp;
1624 # ifdef SUPPORT_DANE
1625 tls_out.dane_verified = testflag(addr, af_dane_verified);
1629 delivery_log(LOG_MAIN, addr, logchar, NULL);
1632 tls_free_cert(&tls_out.ourcert);
1633 tls_free_cert(&tls_out.peercert);
1635 tls_out.cipher = NULL;
1636 tls_out.peerdn = NULL;
1637 tls_out.ocsp = OCSP_NOT_REQ;
1638 # ifdef SUPPORT_DANE
1639 tls_out.dane_verified = FALSE;
1645 /* Soft failure, or local delivery process failed; freezing may be
1648 else if (result == DEFER || result == PANIC)
1650 if (result == PANIC) logflags |= LOG_PANIC;
1652 /* This puts them on the chain in reverse order. Do not change this, because
1653 the code for handling retries assumes that the one with the retry
1654 information is last. */
1656 addr->next = addr_defer;
1659 /* The only currently implemented special action is to freeze the
1660 message. Logging of this is done later, just before the -H file is
1663 if (addr->special_action == SPECIAL_FREEZE)
1665 f.deliver_freeze = TRUE;
1666 deliver_frozen_at = time(NULL);
1667 update_spool = TRUE;
1670 /* If doing a 2-stage queue run, we skip writing to either the message
1671 log or the main log for SMTP defers. */
1673 if (!f.queue_2stage || addr->basic_errno != 0)
1674 deferral_log(addr, now, logflags, driver_name, driver_kind);
1678 /* Hard failure. If there is an address to which an error message can be sent,
1679 put this address on the failed list. If not, put it on the deferred list and
1680 freeze the mail message for human attention. The latter action can also be
1681 explicitly requested by a router or transport. */
1685 /* If this is a delivery error, or a message for which no replies are
1686 wanted, and the message's age is greater than ignore_bounce_errors_after,
1687 force the af_ignore_error flag. This will cause the address to be discarded
1688 later (with a log entry). */
1690 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1691 addr->prop.ignore_error = TRUE;
1693 /* Freeze the message if requested, or if this is a bounce message (or other
1694 message with null sender) and this address does not have its own errors
1695 address. However, don't freeze if errors are being ignored. The actual code
1696 to ignore occurs later, instead of sending a message. Logging of freezing
1697 occurs later, just before writing the -H file. */
1699 if ( !addr->prop.ignore_error
1700 && ( addr->special_action == SPECIAL_FREEZE
1701 || (sender_address[0] == 0 && !addr->prop.errors_address)
1704 frozen_info = addr->special_action == SPECIAL_FREEZE
1706 : f.sender_local && !f.local_error_message
1707 ? US" (message created with -f <>)"
1708 : US" (delivery error message)";
1709 f.deliver_freeze = TRUE;
1710 deliver_frozen_at = time(NULL);
1711 update_spool = TRUE;
1713 /* The address is put on the defer rather than the failed queue, because
1714 the message is being retained. */
1716 addr->next = addr_defer;
1720 /* Don't put the address on the nonrecipients tree yet; wait until an
1721 error message has been successfully sent. */
1725 addr->next = addr_failed;
1729 failure_log(addr, driver_name ? NULL : driver_kind, now);
1732 /* Ensure logging is turned on again in all cases */
1734 f.disable_logging = FALSE;
1740 /*************************************************
1741 * Address-independent error *
1742 *************************************************/
1744 /* This function is called when there's an error that is not dependent on a
1745 particular address, such as an expansion string failure. It puts the error into
1746 all the addresses in a batch, logs the incident on the main and panic logs, and
1747 clears the expansions. It is mostly called from local_deliver(), but can be
1748 called for a remote delivery via findugid().
1751 logit TRUE if (MAIN+PANIC) logging required
1752 addr the first of the chain of addresses
1754 format format string for error message, or NULL if already set in addr
1755 ... arguments for the format
1761 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1763 addr->basic_errno = code;
1770 va_start(ap, format);
1771 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1773 addr->message = string_from_gstring(g);
1776 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1778 addr2->basic_errno = code;
1779 addr2->message = addr->message;
1782 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1783 deliver_set_expansions(NULL);
1789 /*************************************************
1790 * Check a "never users" list *
1791 *************************************************/
1793 /* This function is called to check whether a uid is on one of the two "never
1797 uid the uid to be checked
1798 nusers the list to be scanned; the first item in the list is the count
1800 Returns: TRUE if the uid is on the list
1804 check_never_users(uid_t uid, uid_t *nusers)
1806 if (!nusers) return FALSE;
1807 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1813 /*************************************************
1814 * Find uid and gid for a transport *
1815 *************************************************/
1817 /* This function is called for both local and remote deliveries, to find the
1818 uid/gid under which to run the delivery. The values are taken preferentially
1819 from the transport (either explicit or deliver_as_creator), then from the
1820 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1821 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1822 panic error is logged, and the function fails (which normally leads to delivery
1826 addr the address (possibly a chain)
1828 uidp pointer to uid field
1829 gidp pointer to gid field
1830 igfp pointer to the use_initgroups field
1832 Returns: FALSE if failed - error has been set in address(es)
1836 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1840 BOOL gid_set = FALSE;
1842 /* Default initgroups flag comes from the transport */
1844 *igfp = tp->initgroups;
1846 /* First see if there's a gid on the transport, either fixed or expandable.
1847 The expanding function always logs failure itself. */
1854 else if (tp->expand_gid)
1856 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1859 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1865 /* If the transport did not set a group, see if the router did. */
1867 if (!gid_set && testflag(addr, af_gid_set))
1873 /* Pick up a uid from the transport if one is set. */
1875 if (tp->uid_set) *uidp = tp->uid;
1877 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1878 it does not provide a passwd value from which a gid can be taken. */
1880 else if (tp->expand_uid)
1883 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1884 uidp, &(addr->message)))
1886 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1896 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1898 else if (tp->deliver_as_creator)
1900 *uidp = originator_uid;
1903 *gidp = originator_gid;
1908 /* Otherwise see if the address specifies the uid and if so, take it and its
1911 else if (testflag(addr, af_uid_set))
1914 *igfp = testflag(addr, af_initgroups);
1917 /* Nothing has specified the uid - default to the Exim user, and group if the
1930 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1931 defaulting to the Exim uid. In other words, if the configuration has specified
1932 a uid, it must also provide a gid. */
1936 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1937 "%s transport", tp->name);
1941 /* Check that the uid is not on the lists of banned uids that may not be used
1942 for delivery processes. */
1944 nuname = check_never_users(*uidp, never_users)
1946 : check_never_users(*uidp, fixed_never_users)
1947 ? US"fixed_never_users"
1951 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1952 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1964 /*************************************************
1965 * Check the size of a message for a transport *
1966 *************************************************/
1968 /* Checks that the message isn't too big for the selected transport.
1969 This is called only when it is known that the limit is set.
1973 addr the (first) address being delivered
1976 DEFER expansion failed or did not yield an integer
1977 FAIL message too big
1981 check_message_size(transport_instance *tp, address_item *addr)
1986 deliver_set_expansions(addr);
1987 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1988 deliver_set_expansions(NULL);
1990 if (expand_string_message)
1993 addr->message = size_limit == -1
1994 ? string_sprintf("failed to expand message_size_limit "
1995 "in %s transport: %s", tp->name, expand_string_message)
1996 : string_sprintf("invalid message_size_limit "
1997 "in %s transport: %s", tp->name, expand_string_message);
1999 else if (size_limit > 0 && message_size > size_limit)
2003 string_sprintf("message is too big (transport limit = %d)",
2012 /*************************************************
2013 * Transport-time check for a previous delivery *
2014 *************************************************/
2016 /* Check that this base address hasn't previously been delivered to its routed
2017 transport. If it has been delivered, mark it done. The check is necessary at
2018 delivery time in order to handle homonymic addresses correctly in cases where
2019 the pattern of redirection changes between delivery attempts (so the unique
2020 fields change). Non-homonymic previous delivery is detected earlier, at routing
2021 time (which saves unnecessary routing).
2024 addr the address item
2025 testing TRUE if testing wanted only, without side effects
2027 Returns: TRUE if previously delivered by the transport
2031 previously_transported(address_item *addr, BOOL testing)
2033 uschar * s = string_sprintf("%s/%s",
2034 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2036 if (tree_search(tree_nonrecipients, s) != 0)
2038 DEBUG(D_deliver|D_route|D_transport)
2039 debug_printf("%s was previously delivered (%s transport): discarded\n",
2040 addr->address, addr->transport->name);
2041 if (!testing) child_done(addr, tod_stamp(tod_log));
2050 /******************************************************
2051 * Check for a given header in a header string *
2052 ******************************************************/
2054 /* This function is used when generating quota warnings. The configuration may
2055 specify any header lines it likes in quota_warn_message. If certain of them are
2056 missing, defaults are inserted, so we need to be able to test for the presence
2060 hdr the required header name
2061 hstring the header string
2063 Returns: TRUE the header is in the string
2064 FALSE the header is not in the string
2068 contains_header(uschar *hdr, uschar *hstring)
2070 int len = Ustrlen(hdr);
2071 uschar *p = hstring;
2074 if (strncmpic(p, hdr, len) == 0)
2077 while (*p == ' ' || *p == '\t') p++;
2078 if (*p == ':') return TRUE;
2080 while (*p != 0 && *p != '\n') p++;
2081 if (*p == '\n') p++;
2089 /*************************************************
2090 * Perform a local delivery *
2091 *************************************************/
2093 /* Each local delivery is performed in a separate process which sets its
2094 uid and gid as specified. This is a safer way than simply changing and
2095 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2096 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2097 all systems have seteuid().
2099 If the uid/gid are specified in the transport_instance, they are used; the
2100 transport initialization must ensure that either both or neither are set.
2101 Otherwise, the values associated with the address are used. If neither are set,
2102 it is a configuration error.
2104 The transport or the address may specify a home directory (transport over-
2105 rides), and if they do, this is set as $home. If neither have set a working
2106 directory, this value is used for that as well. Otherwise $home is left unset
2107 and the cwd is set to "/" - a directory that should be accessible to all users.
2109 Using a separate process makes it more complicated to get error information
2110 back. We use a pipe to pass the return code and also an error code and error
2111 text string back to the parent process.
2114 addr points to an address block for this delivery; for "normal" local
2115 deliveries this is the only address to be delivered, but for
2116 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2117 a number of addresses can be handled simultaneously, and in this
2118 case addr will point to a chain of addresses with the same
2121 shadowing TRUE if running a shadow transport; this causes output from pipes
2128 deliver_local(address_item *addr, BOOL shadowing)
2130 BOOL use_initgroups;
2133 int status, len, rc;
2136 uschar *working_directory;
2137 address_item *addr2;
2138 transport_instance *tp = addr->transport;
2140 /* Set up the return path from the errors or sender address. If the transport
2141 has its own return path setting, expand it and replace the existing value. */
2143 if(addr->prop.errors_address)
2144 return_path = addr->prop.errors_address;
2145 #ifdef EXPERIMENTAL_SRS
2146 else if (addr->prop.srs_sender)
2147 return_path = addr->prop.srs_sender;
2150 return_path = sender_address;
2152 if (tp->return_path)
2154 uschar *new_return_path = expand_string(tp->return_path);
2155 if (!new_return_path)
2157 if (!f.expand_string_forcedfail)
2159 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2160 US"Failed to expand return path \"%s\" in %s transport: %s",
2161 tp->return_path, tp->name, expand_string_message);
2165 else return_path = new_return_path;
2168 /* For local deliveries, one at a time, the value used for logging can just be
2169 set directly, once and for all. */
2171 used_return_path = return_path;
2173 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2174 gets put into the address(es), and the expansions are unset, so we can just
2177 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2179 /* See if either the transport or the address specifies a home directory. A
2180 home directory set in the address may already be expanded; a flag is set to
2181 indicate that. In other cases we must expand it. */
2183 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2184 || ( (deliver_home = addr->home_dir) /* Set in address and */
2185 && !testflag(addr, af_home_expanded) /* not expanded */
2188 uschar *rawhome = deliver_home;
2189 deliver_home = NULL; /* in case it contains $home */
2190 if (!(deliver_home = expand_string(rawhome)))
2192 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2193 "to expand for %s transport: %s", rawhome, tp->name,
2194 expand_string_message);
2197 if (*deliver_home != '/')
2199 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2200 "is not absolute for %s transport", deliver_home, tp->name);
2205 /* See if either the transport or the address specifies a current directory,
2206 and if so, expand it. If nothing is set, use the home directory, unless it is
2207 also unset in which case use "/", which is assumed to be a directory to which
2208 all users have access. It is necessary to be in a visible directory for some
2209 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2210 2.5) require this. */
2212 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2213 if (working_directory)
2215 uschar *raw = working_directory;
2216 if (!(working_directory = expand_string(raw)))
2218 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2219 "failed to expand for %s transport: %s", raw, tp->name,
2220 expand_string_message);
2223 if (*working_directory != '/')
2225 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2226 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2230 else working_directory = deliver_home ? deliver_home : US"/";
2232 /* If one of the return_output flags is set on the transport, create and open a
2233 file in the message log directory for the transport to write its output onto.
2234 This is mainly used by pipe transports. The file needs to be unique to the
2235 address. This feature is not available for shadow transports. */
2238 && ( tp->return_output || tp->return_fail_output
2239 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2244 addr->return_filename =
2245 spool_fname(US"msglog", message_subdir, message_id,
2246 string_sprintf("-%d-%d", getpid(), return_count++));
2248 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2250 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2251 "to return message: %s", error, tp->name, strerror(errno));
2256 /* Create the pipe for inter-process communication. */
2260 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2265 /* Now fork the process to do the real work in the subprocess, but first
2266 ensure that all cached resources are freed so that the subprocess starts with
2267 a clean slate and doesn't interfere with the parent process. */
2271 if ((pid = exim_fork(US"delivery-local")) == 0)
2273 BOOL replicate = TRUE;
2275 /* Prevent core dumps, as we don't want them in users' home directories.
2276 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2277 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2278 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2279 complain if the error is "not supported".
2281 There are two scenarios where changing the max limit has an effect. In one,
2282 the user is using a .forward and invoking a command of their choice via pipe;
2283 for these, we do need the max limit to be 0 unless the admin chooses to
2284 permit an increased limit. In the other, the command is invoked directly by
2285 the transport and is under administrator control, thus being able to raise
2286 the limit aids in debugging. So there's no general always-right answer.
2288 Thus we inhibit core-dumps completely but let individual transports, while
2289 still root, re-raise the limits back up to aid debugging. We make the
2290 default be no core-dumps -- few enough people can use core dumps in
2291 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2298 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2300 # ifdef SETRLIMIT_NOT_SUPPORTED
2301 if (errno != ENOSYS && errno != ENOTSUP)
2303 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2308 /* Reset the random number generator, so different processes don't all
2309 have the same sequence. */
2313 /* If the transport has a setup entry, call this first, while still
2314 privileged. (Appendfile uses this to expand quota, for example, while
2315 able to read private files.) */
2317 if (addr->transport->setup)
2318 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2322 addr->transport_return = DEFER;
2326 addr->transport_return = PANIC;
2330 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2331 when the process becomes unprivileged, it won't be able to write to the
2332 process log. SIGHUP is ignored throughout exim, except when it is being
2335 signal(SIGINT, SIG_IGN);
2336 signal(SIGTERM, SIG_IGN);
2337 signal(SIGUSR1, SIG_IGN);
2339 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2340 half - for transports that exec things (e.g. pipe). Then set the required
2343 (void)close(pfd[pipe_read]);
2344 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2346 exim_setugid(uid, gid, use_initgroups,
2347 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2348 addr->address, addr->transport->name));
2352 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2353 for (address_item * batched = addr->next; batched; batched = batched->next)
2354 debug_printf("additional batched address: %s\n", batched->address);
2357 /* Set an appropriate working directory. */
2359 if (Uchdir(working_directory) < 0)
2361 addr->transport_return = DEFER;
2362 addr->basic_errno = errno;
2363 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2366 /* If successful, call the transport */
2371 set_process_info("delivering %s to %s using %s", message_id,
2372 addr->local_part, addr->transport->name);
2374 /* Setting this global in the subprocess means we need never clear it */
2375 transport_name = addr->transport->name;
2377 /* If a transport filter has been specified, set up its argument list.
2378 Any errors will get put into the address, and FALSE yielded. */
2380 if (addr->transport->filter_command)
2382 ok = transport_set_up_command(&transport_filter_argv,
2383 addr->transport->filter_command,
2384 TRUE, PANIC, addr, US"transport filter", NULL);
2385 transport_filter_timeout = addr->transport->filter_timeout;
2387 else transport_filter_argv = NULL;
2391 debug_print_string(addr->transport->debug_string);
2392 replicate = !(addr->transport->info->code)(addr->transport, addr);
2396 /* Pass the results back down the pipe. If necessary, first replicate the
2397 status in the top address to the others in the batch. The label is the
2398 subject of a goto when a call to the transport's setup function fails. We
2399 pass the pointer to the transport back in case it got changed as a result of
2400 file_format in appendfile. */
2404 if (replicate) replicate_status(addr);
2405 for (addr2 = addr; addr2; addr2 = addr2->next)
2408 int local_part_length = Ustrlen(addr2->local_part);
2412 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2413 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2414 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2415 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2416 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2417 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2418 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2419 || (ret = write(pfd[pipe_write], &addr2->transport,
2420 sizeof(transport_instance *))) != sizeof(transport_instance *)
2422 /* For a file delivery, pass back the local part, in case the original
2423 was only part of the final delivery path. This gives more complete
2426 || (testflag(addr2, af_file)
2427 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2428 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2432 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2433 ret == -1 ? strerror(errno) : "short write");
2435 /* Now any messages */
2437 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2439 int message_length = s ? Ustrlen(s) + 1 : 0;
2440 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2441 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2443 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2444 ret == -1 ? strerror(errno) : "short write");
2448 /* OK, this process is now done. Free any cached resources that it opened,
2449 and close the pipe we were writing down before exiting. */
2451 (void)close(pfd[pipe_write]);
2456 /* Back in the main process: panic if the fork did not succeed. This seems
2457 better than returning an error - if forking is failing it is probably best
2458 not to try other deliveries for this message. */
2461 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2464 /* Read the pipe to get the delivery status codes and error messages. Our copy
2465 of the writing end must be closed first, as otherwise read() won't return zero
2466 on an empty pipe. We check that a status exists for each address before
2467 overwriting the address structure. If data is missing, the default DEFER status
2468 will remain. Afterwards, close the reading end. */
2470 (void)close(pfd[pipe_write]);
2472 for (addr2 = addr; addr2; addr2 = addr2->next)
2474 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2479 addr2->transport_return = status;
2480 len = read(pfd[pipe_read], &transport_count,
2481 sizeof(transport_count));
2482 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2483 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2484 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2485 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2486 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2487 len = read(pfd[pipe_read], &addr2->transport,
2488 sizeof(transport_instance *));
2490 if (testflag(addr2, af_file))
2493 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2494 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2497 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2498 " from delivery subprocess");
2501 /* sanity-checked llen so disable the Coverity error */
2502 /* coverity[tainted_data] */
2503 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2505 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2506 " from delivery subprocess");
2509 big_buffer[llen] = 0;
2510 addr2->local_part = string_copy(big_buffer);
2513 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2516 len = read(pfd[pipe_read], &message_length, sizeof(int));
2517 if (message_length > 0)
2519 len = read(pfd[pipe_read], big_buffer, message_length);
2520 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2521 if (len > 0) *sptr = string_copy(big_buffer);
2528 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2529 "from delivery subprocess", addr2->unique);
2534 (void)close(pfd[pipe_read]);
2536 /* Unless shadowing, write all successful addresses immediately to the journal
2537 file, to ensure they are recorded asap. For homonymic addresses, use the base
2538 address plus the transport name. Failure to write the journal is panic-worthy,
2539 but don't stop, as it may prove possible subsequently to update the spool file
2540 in order to record the delivery. */
2544 for (addr2 = addr; addr2; addr2 = addr2->next)
2545 if (addr2->transport_return == OK)
2547 if (testflag(addr2, af_homonym))
2548 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2550 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2552 /* In the test harness, wait just a bit to let the subprocess finish off
2553 any debug output etc first. */
2555 testharness_pause_ms(300);
2557 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2558 len = Ustrlen(big_buffer);
2559 if (write(journal_fd, big_buffer, len) != len)
2560 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2561 big_buffer, strerror(errno));
2564 /* Ensure the journal file is pushed out to disk. */
2566 if (EXIMfsync(journal_fd) < 0)
2567 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2571 /* Wait for the process to finish. If it terminates with a non-zero code,
2572 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2573 status values of all the addresses as they are. Take care to handle the case
2574 when the subprocess doesn't seem to exist. This has been seen on one system
2575 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2576 happens, wait() doesn't recognize the termination of child processes. Exim now
2577 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2579 while ((rc = wait(&status)) != pid)
2580 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2582 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2583 addr->transport->driver_name);
2588 if ((status & 0xffff) != 0)
2590 int msb = (status >> 8) & 255;
2591 int lsb = status & 255;
2592 int code = (msb == 0)? (lsb & 0x7f) : msb;
2593 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2594 addr->special_action = SPECIAL_FREEZE;
2595 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2596 "status 0x%04x: %s %d",
2597 addr->transport->driver_name,
2599 msb == 0 ? "terminated by signal" : "exit code",
2603 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2605 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2608 uschar *warn_message;
2611 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2613 if (!(warn_message = expand_string(addr->transport->warn_message)))
2614 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2615 "message for %s transport): %s", addr->transport->warn_message,
2616 addr->transport->name, expand_string_message);
2618 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2620 FILE *f = fdopen(fd, "wb");
2621 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2622 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2623 fprintf(f, "Auto-Submitted: auto-replied\n");
2624 if (!contains_header(US"From", warn_message))
2626 fprintf(f, "%s", CS warn_message);
2628 /* Close and wait for child process to complete, without a timeout. */
2631 (void)child_close(pid, 0);
2634 addr->special_action = SPECIAL_NONE;
2641 /* Check transport for the given concurrency limit. Return TRUE if over
2642 the limit (or an expansion failure), else FALSE and if there was a limit,
2643 the key for the hints database used for the concurrency count. */
2646 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2648 unsigned max_parallel;
2650 if (!tp->max_parallel) return FALSE;
2652 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2653 if (expand_string_message)
2655 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2656 "in %s transport (%s): %s", tp->name, addr->address,
2657 expand_string_message);
2661 if (max_parallel > 0)
2663 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2664 if (!enq_start(serialize_key, max_parallel))
2666 address_item * next;
2668 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2669 tp->name, max_parallel);
2673 addr->message = US"concurrency limit reached for transport";
2674 addr->basic_errno = ERRNO_TRETRY;
2675 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2676 } while ((addr = next));
2679 *key = serialize_key;
2686 /*************************************************
2687 * Do local deliveries *
2688 *************************************************/
2690 /* This function processes the list of addresses in addr_local. True local
2691 deliveries are always done one address at a time. However, local deliveries can
2692 be batched up in some cases. Typically this is when writing batched SMTP output
2693 files for use by some external transport mechanism, or when running local
2694 deliveries over LMTP.
2701 do_local_deliveries(void)
2704 open_db *dbm_file = NULL;
2705 time_t now = time(NULL);
2707 /* Loop until we have exhausted the supply of local deliveries */
2711 struct timeval delivery_start;
2712 struct timeval deliver_time;
2713 address_item *addr2, *addr3, *nextaddr;
2714 int logflags = LOG_MAIN;
2715 int logchar = f.dont_deliver? '*' : '=';
2716 transport_instance *tp;
2717 uschar * serialize_key = NULL;
2719 /* Pick the first undelivered address off the chain */
2721 address_item *addr = addr_local;
2722 addr_local = addr->next;
2725 DEBUG(D_deliver|D_transport)
2726 debug_printf("--------> %s <--------\n", addr->address);
2728 /* An internal disaster if there is no transport. Should not occur! */
2730 if (!(tp = addr->transport))
2732 logflags |= LOG_PANIC;
2733 f.disable_logging = FALSE; /* Jic */
2734 addr->message = addr->router
2735 ? string_sprintf("No transport set by %s router", addr->router->name)
2736 : US"No transport set by system filter";
2737 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2741 /* Check that this base address hasn't previously been delivered to this
2742 transport. The check is necessary at this point to handle homonymic addresses
2743 correctly in cases where the pattern of redirection changes between delivery
2744 attempts. Non-homonymic previous delivery is detected earlier, at routing
2747 if (previously_transported(addr, FALSE)) continue;
2749 /* There are weird cases where logging is disabled */
2751 f.disable_logging = tp->disable_logging;
2753 /* Check for batched addresses and possible amalgamation. Skip all the work
2754 if either batch_max <= 1 or there aren't any other addresses for local
2757 if (tp->batch_max > 1 && addr_local)
2759 int batch_count = 1;
2760 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2761 BOOL uses_lp = ( testflag(addr, af_pfr)
2762 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2764 || readconf_depends((driver_instance *)tp, US"local_part");
2765 uschar *batch_id = NULL;
2766 address_item **anchor = &addr_local;
2767 address_item *last = addr;
2770 /* Expand the batch_id string for comparison with other addresses.
2771 Expansion failure suppresses batching. */
2775 deliver_set_expansions(addr);
2776 batch_id = expand_string(tp->batch_id);
2777 deliver_set_expansions(NULL);
2780 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2781 "in %s transport (%s): %s", tp->name, addr->address,
2782 expand_string_message);
2783 batch_count = tp->batch_max;
2787 /* Until we reach the batch_max limit, pick off addresses which have the
2788 same characteristics. These are:
2791 not previously delivered (see comment about 50 lines above)
2792 same local part if the transport's configuration contains $local_part
2793 or if this is a file or pipe delivery from a redirection
2794 same domain if the transport's configuration contains $domain
2796 same additional headers
2797 same headers to be removed
2798 same uid/gid for running the transport
2799 same first host if a host list is set
2802 while ((next = *anchor) && batch_count < tp->batch_max)
2805 tp == next->transport
2806 && !previously_transported(next, TRUE)
2807 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2808 && testflag(addr, af_file) == testflag(next, af_file)
2809 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2810 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2811 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2812 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2813 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2814 && same_ugid(tp, addr, next)
2815 && ( !addr->host_list && !next->host_list
2818 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2821 /* If the transport has a batch_id setting, batch_id will be non-NULL
2822 from the expansion outside the loop. Expand for this address and compare.
2823 Expansion failure makes this address ineligible for batching. */
2828 address_item *save_nextnext = next->next;
2829 next->next = NULL; /* Expansion for a single address */
2830 deliver_set_expansions(next);
2831 next->next = save_nextnext;
2832 bid = expand_string(tp->batch_id);
2833 deliver_set_expansions(NULL);
2836 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2837 "in %s transport (%s): %s", tp->name, next->address,
2838 expand_string_message);
2841 else ok = (Ustrcmp(batch_id, bid) == 0);
2844 /* Take address into batch if OK. */
2848 *anchor = next->next; /* Include the address */
2854 else anchor = &next->next; /* Skip the address */
2858 /* We now have one or more addresses that can be delivered in a batch. Check
2859 whether the transport is prepared to accept a message of this size. If not,
2860 fail them all forthwith. If the expansion fails, or does not yield an
2861 integer, defer delivery. */
2863 if (tp->message_size_limit)
2865 int rc = check_message_size(tp, addr);
2868 replicate_status(addr);
2872 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2875 continue; /* With next batch of addresses */
2879 /* If we are not running the queue, or if forcing, all deliveries will be
2880 attempted. Otherwise, we must respect the retry times for each address. Even
2881 when not doing this, we need to set up the retry key string, and determine
2882 whether a retry record exists, because after a successful delivery, a delete
2883 retry item must be set up. Keep the retry database open only for the duration
2884 of these checks, rather than for all local deliveries, because some local
2885 deliveries (e.g. to pipes) can take a substantial time. */
2887 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2889 DEBUG(D_deliver|D_retry|D_hints_lookup)
2890 debug_printf("no retry data available\n");
2897 BOOL ok = TRUE; /* to deliver this address */
2900 /* Set up the retry key to include the domain or not, and change its
2901 leading character from "R" to "T". Must make a copy before doing this,
2902 because the old key may be pointed to from a "delete" retry item after
2905 retry_key = string_copy(
2906 tp->retry_use_local_part ? addr2->address_retry_key :
2907 addr2->domain_retry_key);
2910 /* Inspect the retry data. If there is no hints file, delivery happens. */
2914 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2916 /* If there is no retry record, delivery happens. If there is,
2917 remember it exists so it can be deleted after a successful delivery. */
2921 setflag(addr2, af_lt_retry_exists);
2923 /* A retry record exists for this address. If queue running and not
2924 forcing, inspect its contents. If the record is too old, or if its
2925 retry time has come, or if it has passed its cutoff time, delivery
2930 debug_printf("retry record exists: age=%s ",
2931 readconf_printtime(now - retry_record->time_stamp));
2932 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2933 debug_printf(" time to retry = %s expired = %d\n",
2934 readconf_printtime(retry_record->next_try - now),
2935 retry_record->expired);
2938 if (f.queue_running && !f.deliver_force)
2940 ok = (now - retry_record->time_stamp > retry_data_expire)
2941 || (now >= retry_record->next_try)
2942 || retry_record->expired;
2944 /* If we haven't reached the retry time, there is one more check
2945 to do, which is for the ultimate address timeout. */
2948 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2952 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2955 /* This address is to be delivered. Leave it on the chain. */
2960 addr2 = addr2->next;
2963 /* This address is to be deferred. Take it out of the chain, and
2964 post-process it as complete. Must take it out of the chain first,
2965 because post processing puts it on another chain. */
2969 address_item *this = addr2;
2970 this->message = US"Retry time not yet reached";
2971 this->basic_errno = ERRNO_LRETRY;
2972 addr2 = addr3 ? (addr3->next = addr2->next)
2973 : (addr = addr2->next);
2974 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2978 if (dbm_file) dbfn_close(dbm_file);
2980 /* If there are no addresses left on the chain, they all deferred. Loop
2981 for the next set of addresses. */
2983 if (!addr) continue;
2985 /* If the transport is limited for parallellism, enforce that here.
2986 We use a hints DB entry, incremented here and decremented after
2987 the transport (and any shadow transport) completes. */
2989 if (tpt_parallel_check(tp, addr, &serialize_key))
2991 if (expand_string_message)
2993 logflags |= LOG_PANIC;
2997 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2998 } while ((addr = addr2));
3000 continue; /* Loop for the next set of addresses. */
3004 /* So, finally, we do have some addresses that can be passed to the
3005 transport. Before doing so, set up variables that are relevant to a
3008 deliver_set_expansions(addr);
3010 gettimeofday(&delivery_start, NULL);
3011 deliver_local(addr, FALSE);
3012 timesince(&deliver_time, &delivery_start);
3014 /* If a shadow transport (which must perforce be another local transport), is
3015 defined, and its condition is met, we must pass the message to the shadow
3016 too, but only those addresses that succeeded. We do this by making a new
3017 chain of addresses - also to keep the original chain uncontaminated. We must
3018 use a chain rather than doing it one by one, because the shadow transport may
3021 NOTE: if the condition fails because of a lookup defer, there is nothing we
3025 && ( !tp->shadow_condition
3026 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3029 transport_instance *stp;
3030 address_item *shadow_addr = NULL;
3031 address_item **last = &shadow_addr;
3033 for (stp = transports; stp; stp = stp->next)
3034 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3037 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3040 /* Pick off the addresses that have succeeded, and make clones. Put into
3041 the shadow_message field a pointer to the shadow_message field of the real
3044 else for (addr2 = addr; addr2; addr2 = addr2->next)
3045 if (addr2->transport_return == OK)
3047 addr3 = store_get(sizeof(address_item), FALSE);
3050 addr3->shadow_message = US &addr2->shadow_message;
3051 addr3->transport = stp;
3052 addr3->transport_return = DEFER;
3053 addr3->return_filename = NULL;
3054 addr3->return_file = -1;
3056 last = &addr3->next;
3059 /* If we found any addresses to shadow, run the delivery, and stick any
3060 message back into the shadow_message field in the original. */
3064 int save_count = transport_count;
3066 DEBUG(D_deliver|D_transport)
3067 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3068 deliver_local(shadow_addr, TRUE);
3070 for(; shadow_addr; shadow_addr = shadow_addr->next)
3072 int sresult = shadow_addr->transport_return;
3073 *(uschar **)shadow_addr->shadow_message =
3075 ? string_sprintf(" ST=%s", stp->name)
3076 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3077 shadow_addr->basic_errno <= 0
3079 : US strerror(shadow_addr->basic_errno),
3080 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3083 shadow_addr->message
3084 ? shadow_addr->message
3085 : shadow_addr->basic_errno <= 0
3089 DEBUG(D_deliver|D_transport)
3090 debug_printf("%s shadow transport returned %s for %s\n",
3091 stp->name, rc_to_string(sresult), shadow_addr->address);
3094 DEBUG(D_deliver|D_transport)
3095 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3097 transport_count = save_count; /* Restore original transport count */
3101 /* Cancel the expansions that were set up for the delivery. */
3103 deliver_set_expansions(NULL);
3105 /* If the transport was parallelism-limited, decrement the hints DB record. */
3107 if (serialize_key) enq_end(serialize_key);
3109 /* Now we can process the results of the real transport. We must take each
3110 address off the chain first, because post_process_one() puts it on another
3113 for (addr2 = addr; addr2; addr2 = nextaddr)
3115 int result = addr2->transport_return;
3116 nextaddr = addr2->next;
3118 DEBUG(D_deliver|D_transport)
3119 debug_printf("%s transport returned %s for %s\n",
3120 tp->name, rc_to_string(result), addr2->address);
3122 /* If there is a retry_record, or if delivery is deferred, build a retry
3123 item for setting a new retry time or deleting the old retry record from
3124 the database. These items are handled all together after all addresses
3125 have been handled (so the database is open just for a short time for
3128 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3130 int flags = result == DEFER ? 0 : rf_delete;
3131 uschar *retry_key = string_copy(tp->retry_use_local_part
3132 ? addr2->address_retry_key : addr2->domain_retry_key);
3134 retry_add_item(addr2, retry_key, flags);
3137 /* Done with this address */
3139 addr2->delivery_time = deliver_time;
3140 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3142 /* If a pipe delivery generated text to be sent back, the result may be
3143 changed to FAIL, and we must copy this for subsequent addresses in the
3146 if (addr2->transport_return != result)
3148 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3150 addr3->transport_return = addr2->transport_return;
3151 addr3->basic_errno = addr2->basic_errno;
3152 addr3->message = addr2->message;
3154 result = addr2->transport_return;
3157 /* Whether or not the result was changed to FAIL, we need to copy the
3158 return_file value from the first address into all the addresses of the
3159 batch, so they are all listed in the error message. */
3161 addr2->return_file = addr->return_file;
3163 /* Change log character for recording successful deliveries. */
3165 if (result == OK) logchar = '-';
3167 } /* Loop back for next batch of addresses */
3173 /*************************************************
3174 * Sort remote deliveries *
3175 *************************************************/
3177 /* This function is called if remote_sort_domains is set. It arranges that the
3178 chain of addresses for remote deliveries is ordered according to the strings
3179 specified. Try to make this shuffling reasonably efficient by handling
3180 sequences of addresses rather than just single ones.
3187 sort_remote_deliveries(void)
3190 address_item **aptr = &addr_remote;
3191 const uschar *listptr = remote_sort_domains;
3196 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3199 address_item *moved = NULL;
3200 address_item **bptr = &moved;
3204 address_item **next;
3205 deliver_domain = (*aptr)->domain; /* set $domain */
3206 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3207 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3209 aptr = &(*aptr)->next;
3213 next = &(*aptr)->next;
3215 && (deliver_domain = (*next)->domain, /* Set $domain */
3216 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3217 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3219 next = &(*next)->next;
3221 /* If the batch of non-matchers is at the end, add on any that were
3222 extracted further up the chain, and end this iteration. Otherwise,
3223 extract them from the chain and hang on the moved chain. */
3235 aptr = &(*aptr)->next;
3238 /* If the loop ended because the final address matched, *aptr will
3239 be NULL. Add on to the end any extracted non-matching addresses. If
3240 *aptr is not NULL, the loop ended via "break" when *next is null, that
3241 is, there was a string of non-matching addresses at the end. In this
3242 case the extracted addresses have already been added on the end. */
3244 if (!*aptr) *aptr = moved;
3249 debug_printf("remote addresses after sorting:\n");
3250 for (address_item * addr = addr_remote; addr; addr = addr->next)
3251 debug_printf(" %s\n", addr->address);
3257 /*************************************************
3258 * Read from pipe for remote delivery subprocess *
3259 *************************************************/
3261 /* This function is called when the subprocess is complete, but can also be
3262 called before it is complete, in order to empty a pipe that is full (to prevent
3263 deadlock). It must therefore keep track of its progress in the parlist data
3266 We read the pipe to get the delivery status codes and a possible error message
3267 for each address, optionally preceded by unusability data for the hosts and
3268 also by optional retry data.
3270 Read in large chunks into the big buffer and then scan through, interpreting
3271 the data therein. In most cases, only a single read will be necessary. No
3272 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3273 that we read the next chunk when there is less than 2500 bytes left in the
3274 non-final chunk, we can assume each item is complete in the buffer before
3275 handling it. Each item is written using a single write(), which is atomic for
3276 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3277 often bigger) so even if we are reading while the subprocess is still going, we
3278 should never have only a partial item in the buffer.
3280 hs12: This assumption is not true anymore, since we get quite large items (certificate
3281 information and such).
3284 poffset the offset of the parlist item
3285 eop TRUE if the process has completed
3287 Returns: TRUE if the terminating 'Z' item has been read,
3288 or there has been a disaster (i.e. no more data needed);
3293 par_read_pipe(int poffset, BOOL eop)
3296 pardata *p = parlist + poffset;
3297 address_item *addrlist = p->addrlist;
3298 address_item *addr = p->addr;
3302 uschar *msg = p->msg;
3303 BOOL done = p->done;
3305 /* Loop through all items, reading from the pipe when necessary. The pipe
3306 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3307 here, as the preceding select() tells us, if data is available for reading.
3309 A read() on a "selected" handle should never block, but(!) it may return
3310 less data then we expected. (The buffer size we pass to read() shouldn't be
3311 understood as a "request", but as a "limit".)
3313 Each separate item is written to the pipe in a timely manner. But, especially for
3314 larger items, the read(2) may already return partial data from the write(2).
3316 The write is atomic mostly (depending on the amount written), but atomic does
3317 not imply "all or noting", it just is "not intermixed" with other writes on the
3318 same channel (pipe).
3322 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3323 (int)p->pid, eop? "ended" : "not ended yet");
3327 retry_item *r, **rp;
3328 uschar pipeheader[PIPE_HEADER_SIZE+1];
3329 uschar *id = &pipeheader[0];
3330 uschar *subid = &pipeheader[1];
3331 uschar *ptr = big_buffer;
3332 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3335 DEBUG(D_deliver) debug_printf(
3336 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3338 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3339 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3340 If we get less, we can assume the subprocess do be done and do not expect any further
3341 information from it. */
3343 if ((got = readn(fd, pipeheader, required)) != required)
3345 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3346 "from transport process %d for transport %s",
3347 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3352 pipeheader[PIPE_HEADER_SIZE] = '\0';
3354 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3358 /* If we can't decode the pipeheader, the subprocess seems to have a
3359 problem, we do not expect any furher information from it. */
3361 required = Ustrtol(pipeheader+2, &endc, 10);
3364 msg = string_sprintf("failed to read pipe "
3365 "from transport process %d for transport %s: error decoding size from header",
3366 pid, addr->transport->driver_name);
3373 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3374 (u_long)required, pid);
3376 /* Same as above, the transport process will write the bytes announced
3377 in a timely manner, so we can just wait for the bytes, getting less than expected
3378 is considered a problem of the subprocess, we do not expect anything else from it. */
3379 if ((got = readn(fd, big_buffer, required)) != required)
3381 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3382 " bytes (pipedata) from transport process %d for transport %s",
3383 got, required, pid, addr->transport->driver_name);
3388 /* Handle each possible type of item, assuming the complete item is
3389 available in store. */
3393 /* Host items exist only if any hosts were marked unusable. Match
3394 up by checking the IP address. */
3397 for (h = addrlist->host_list; h; h = h->next)
3399 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3407 /* Retry items are sent in a preceding R item for each address. This is
3408 kept separate to keep each message short enough to guarantee it won't
3409 be split in the pipe. Hopefully, in the majority of cases, there won't in
3410 fact be any retry items at all.
3412 The complete set of retry items might include an item to delete a
3413 routing retry if there was a previous routing delay. However, routing
3414 retries are also used when a remote transport identifies an address error.
3415 In that case, there may also be an "add" item for the same key. Arrange
3416 that a "delete" item is dropped in favour of an "add" item. */
3419 if (!addr) goto ADDR_MISMATCH;
3421 DEBUG(D_deliver|D_retry)
3422 debug_printf("reading retry information for %s from subprocess\n",
3425 /* Cut out any "delete" items on the list. */
3427 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3428 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3430 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3431 *rp = r->next; /* Excise a delete item */
3432 DEBUG(D_deliver|D_retry)
3433 debug_printf(" existing delete item dropped\n");
3436 /* We want to add a delete item only if there is no non-delete item;
3437 however we still have to step ptr through the data. */
3439 if (!r || !(*ptr & rf_delete))
3441 r = store_get(sizeof(retry_item), FALSE);
3442 r->next = addr->retries;
3445 r->key = string_copy(ptr);
3447 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3448 ptr += sizeof(r->basic_errno);
3449 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3450 ptr += sizeof(r->more_errno);
3451 r->message = *ptr ? string_copy(ptr) : NULL;
3452 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3453 r->flags & rf_delete ? "delete" : "retry");
3458 DEBUG(D_deliver|D_retry)
3459 debug_printf(" delete item not added: non-delete item exists\n");
3462 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3468 /* Put the amount of data written into the parlist block */
3471 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3472 ptr += sizeof(transport_count);
3475 /* Address items are in the order of items on the address chain. We
3476 remember the current address value in case this function is called
3477 several times to empty the pipe in stages. Information about delivery
3478 over TLS is sent in a preceding X item for each address. We don't put
3479 it in with the other info, in order to keep each message short enough to
3480 guarantee it won't be split in the pipe. */
3484 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3488 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3492 addr->cipher = string_copy(ptr);
3493 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3497 addr->peerdn = string_copy(ptr);
3502 (void) tls_import_cert(ptr, &addr->peercert);
3504 addr->peercert = NULL;
3509 (void) tls_import_cert(ptr, &addr->ourcert);
3511 addr->ourcert = NULL;
3514 # ifndef DISABLE_OCSP
3516 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3522 #endif /*DISABLE_TLS*/
3524 case 'C': /* client authenticator information */
3527 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3528 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3529 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3534 #ifndef DISABLE_PRDR
3536 setflag(addr, af_prdr_used);
3543 #ifndef DISABLE_PIPE_CONNECT
3544 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3546 case 1: setflag(addr, af_pipelining); break;
3551 setflag(addr, af_chunking_used);
3555 setflag(addr, af_tcp_fastopen_conn);
3556 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3557 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3561 if (!addr) goto ADDR_MISMATCH;
3562 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3563 ptr += sizeof(addr->dsn_aware);
3564 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3571 msg = string_sprintf("address count mismatch for data read from pipe "
3572 "for transport process %d for transport %s", pid,
3573 addrlist->transport->driver_name);
3580 #ifdef SUPPORT_SOCKS
3581 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3582 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3587 proxy_local_address = string_copy(ptr);
3589 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3590 ptr += sizeof(proxy_local_port);
3595 #ifdef EXPERIMENTAL_DSN_INFO
3596 case '1': /* must arrive before A0, and applies to that addr */
3597 /* Two strings: smtp_greeting and helo_response */
3598 addr->smtp_greeting = string_copy(ptr);
3600 addr->helo_response = string_copy(ptr);
3606 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3607 addr->transport_return = *ptr++;
3608 addr->special_action = *ptr++;
3609 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3610 ptr += sizeof(addr->basic_errno);
3611 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3612 ptr += sizeof(addr->more_errno);
3613 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3614 ptr += sizeof(addr->delivery_time);
3615 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3616 ptr += sizeof(addr->flags);
3617 addr->message = *ptr ? string_copy(ptr) : NULL;
3619 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3622 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3626 h = store_get(sizeof(host_item), FALSE);
3627 h->name = string_copy(ptr);
3629 h->address = string_copy(ptr);
3631 memcpy(&h->port, ptr, sizeof(h->port));
3632 ptr += sizeof(h->port);
3633 h->dnssec = *ptr == '2' ? DS_YES
3634 : *ptr == '1' ? DS_NO
3637 addr->host_used = h;
3641 /* Finished with this address */
3648 /* Local interface address/port */
3650 if (*ptr) sending_ip_address = string_copy(ptr);
3652 if (*ptr) sending_port = atoi(CS ptr);
3656 /* Z marks the logical end of the data. It is followed by '0' if
3657 continue_transport was NULL at the end of transporting, otherwise '1'.
3658 We need to know when it becomes NULL during a delivery down a passed SMTP
3659 channel so that we don't try to pass anything more down it. Of course, for
3660 most normal messages it will remain NULL all the time. */
3665 continue_transport = NULL;
3666 continue_hostname = NULL;
3669 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3672 /* Anything else is a disaster. */
3675 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3676 "process %d for transport %s", ptr[-1], pid,
3677 addr->transport->driver_name);
3683 /* The done flag is inspected externally, to determine whether or not to
3684 call the function again when the process finishes. */
3688 /* If the process hadn't finished, and we haven't seen the end of the data
3689 or if we suffered a disaster, update the rest of the state, and return FALSE to
3690 indicate "not finished". */
3699 /* Close our end of the pipe, to prevent deadlock if the far end is still
3700 pushing stuff into it. */
3705 /* If we have finished without error, but haven't had data for every address,
3706 something is wrong. */
3709 msg = string_sprintf("insufficient address data read from pipe "
3710 "for transport process %d for transport %s", pid,
3711 addr->transport->driver_name);
3713 /* If an error message is set, something has gone wrong in getting back
3714 the delivery data. Put the message into each address and freeze it. */
3717 for (addr = addrlist; addr; addr = addr->next)
3719 addr->transport_return = DEFER;
3720 addr->special_action = SPECIAL_FREEZE;
3721 addr->message = msg;
3722 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3725 /* Return TRUE to indicate we have got all we need from this process, even
3726 if it hasn't actually finished yet. */
3733 /*************************************************
3734 * Post-process a set of remote addresses *
3735 *************************************************/
3737 /* Do what has to be done immediately after a remote delivery for each set of
3738 addresses, then re-write the spool if necessary. Note that post_process_one
3739 puts the address on an appropriate queue; hence we must fish off the next
3740 one first. This function is also called if there is a problem with setting
3741 up a subprocess to do a remote delivery in parallel. In this case, the final
3742 argument contains a message, and the action must be forced to DEFER.
3745 addr pointer to chain of address items
3746 logflags flags for logging
3747 msg NULL for normal cases; -> error message for unexpected problems
3748 fallback TRUE if processing fallback hosts
3754 remote_post_process(address_item *addr, int logflags, uschar *msg,
3757 /* If any host addresses were found to be unusable, add them to the unusable
3758 tree so that subsequent deliveries don't try them. */
3760 for (host_item * h = addr->host_list; h; h = h->next)
3762 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3764 /* Now handle each address on the chain. The transport has placed '=' or '-'
3765 into the special_action field for each successful delivery. */
3769 address_item *next = addr->next;
3771 /* If msg == NULL (normal processing) and the result is DEFER and we are
3772 processing the main hosts and there are fallback hosts available, put the
3773 address on the list for fallback delivery. */
3775 if ( addr->transport_return == DEFER
3776 && addr->fallback_hosts
3781 addr->host_list = addr->fallback_hosts;
3782 addr->next = addr_fallback;
3783 addr_fallback = addr;
3784 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3787 /* If msg is set (=> unexpected problem), set it in the address before
3788 doing the ordinary post processing. */
3794 addr->message = msg;
3795 addr->transport_return = DEFER;
3797 (void)post_process_one(addr, addr->transport_return, logflags,
3798 EXIM_DTYPE_TRANSPORT, addr->special_action);
3806 /* If we have just delivered down a passed SMTP channel, and that was
3807 the last address, the channel will have been closed down. Now that
3808 we have logged that delivery, set continue_sequence to 1 so that
3809 any subsequent deliveries don't get "*" incorrectly logged. */
3811 if (!continue_transport) continue_sequence = 1;
3816 /*************************************************
3817 * Wait for one remote delivery subprocess *
3818 *************************************************/
3820 /* This function is called while doing remote deliveries when either the
3821 maximum number of processes exist and we need one to complete so that another
3822 can be created, or when waiting for the last ones to complete. It must wait for
3823 the completion of one subprocess, empty the control block slot, and return a
3824 pointer to the address chain.
3827 Returns: pointer to the chain of addresses handled by the process;
3828 NULL if no subprocess found - this is an unexpected error
3831 static address_item *
3834 int poffset, status;
3835 address_item *addr, *addrlist;
3838 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3839 "to finish", message_id);
3841 /* Loop until either a subprocess completes, or there are no subprocesses in
3842 existence - in which case give an error return. We cannot proceed just by
3843 waiting for a completion, because a subprocess may have filled up its pipe, and
3844 be waiting for it to be emptied. Therefore, if no processes have finished, we
3845 wait for one of the pipes to acquire some data by calling select(), with a
3846 timeout just in case.
3848 The simple approach is just to iterate after reading data from a ready pipe.
3849 This leads to non-ideal behaviour when the subprocess has written its final Z
3850 item, closed the pipe, and is in the process of exiting (the common case). A
3851 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3852 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3855 To avoid this, if all the data that is needed has been read from a subprocess
3856 after select(), an explicit wait() for it is done. We know that all it is doing
3857 is writing to the pipe and then exiting, so the wait should not be long.
3859 The non-blocking waitpid() is to some extent just insurance; if we could
3860 reliably detect end-of-file on the pipe, we could always know when to do a
3861 blocking wait() for a completed process. However, because some systems use
3862 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3863 use code that functions without the need to recognize EOF.
3865 There's a double loop here just in case we end up with a process that is not in
3866 the list of remote delivery processes. Something has obviously gone wrong if
3867 this is the case. (For example, a process that is incorrectly left over from
3868 routing or local deliveries might be found.) The damage can be minimized by
3869 looping back and looking for another process. If there aren't any, the error
3870 return will happen. */
3872 for (;;) /* Normally we do not repeat this loop */
3874 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3877 fd_set select_pipes;
3878 int maxpipe, readycount;
3880 /* A return value of -1 can mean several things. If errno != ECHILD, it
3881 either means invalid options (which we discount), or that this process was
3882 interrupted by a signal. Just loop to try the waitpid() again.
3884 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3885 in existence. This should never happen, and is an unexpected error.
3886 However, there is a nasty complication when running under Linux. If "strace
3887 -f" is being used under Linux to trace this process and its children,
3888 subprocesses are "stolen" from their parents and become the children of the
3889 tracing process. A general wait such as the one we've just obeyed returns
3890 as if there are no children while subprocesses are running. Once a
3891 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3892 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3895 This does not happen using "truss" on Solaris, nor (I think) with other
3896 tracing facilities on other OS. It seems to be specific to Linux.
3898 What we do to get round this is to use kill() to see if any of our
3899 subprocesses are still in existence. If kill() gives an OK return, we know
3900 it must be for one of our processes - it can't be for a re-use of the pid,
3901 because if our process had finished, waitpid() would have found it. If any
3902 of our subprocesses are in existence, we proceed to use select() as if
3903 waitpid() had returned zero. I think this is safe. */
3907 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3910 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3911 "for process existence\n");
3913 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3915 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3917 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3918 "stolen by strace\n", (int)pid);
3919 break; /* With poffset set */
3923 if (poffset >= remote_max_parallel)
3925 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3926 return NULL; /* This is the error return */
3930 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3931 been handled above. A return value of zero means that there is at least one
3932 subprocess, but there are no completed subprocesses. See if any pipes are
3933 ready with any data for reading. */
3935 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3938 FD_ZERO(&select_pipes);
3939 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3940 if (parlist[poffset].pid != 0)
3942 int fd = parlist[poffset].fd;
3943 FD_SET(fd, &select_pipes);
3944 if (fd > maxpipe) maxpipe = fd;
3947 /* Stick in a 60-second timeout, just in case. */
3952 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3955 /* Scan through the pipes and read any that are ready; use the count
3956 returned by select() to stop when there are no more. Select() can return
3957 with no processes (e.g. if interrupted). This shouldn't matter.
3959 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3960 read, or there was a disaster. In either case, we are finished with this
3961 process. Do an explicit wait() for the process and break the main loop if
3964 It turns out that we have to deal with the case of an interrupted system
3965 call, which can happen on some operating systems if the signal handling is
3966 set up to do that by default. */
3969 readycount > 0 && poffset < remote_max_parallel;
3972 if ( (pid = parlist[poffset].pid) != 0
3973 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3977 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3978 for (;;) /* Loop for signals */
3980 pid_t endedpid = waitpid(pid, &status, 0);
3981 if (endedpid == pid) goto PROCESS_DONE;
3982 if (endedpid != (pid_t)(-1) || errno != EINTR)
3983 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3984 "%d (errno = %d) from waitpid() for process %d",
3985 (int)endedpid, errno, (int)pid);
3990 /* Now go back and look for a completed subprocess again. */
3993 /* A completed process was detected by the non-blocking waitpid(). Find the
3994 data block that corresponds to this subprocess. */
3996 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3997 if (pid == parlist[poffset].pid) break;
3999 /* Found the data block; this is a known remote delivery process. We don't
4000 need to repeat the outer loop. This should be what normally happens. */
4002 if (poffset < remote_max_parallel) break;
4004 /* This situation is an error, but it's probably better to carry on looking
4005 for another process than to give up (as we used to do). */
4007 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4008 "transport process list", pid);
4009 } /* End of the "for" loop */
4011 /* Come here when all the data was completely read after a select(), and
4012 the process in pid has been wait()ed for. */
4019 debug_printf("remote delivery process %d ended\n", (int)pid);
4021 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4025 set_process_info("delivering %s", message_id);
4027 /* Get the chain of processed addresses */
4029 addrlist = parlist[poffset].addrlist;
4031 /* If the process did not finish cleanly, record an error and freeze (except
4032 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4033 in case the delivery did actually happen. */
4035 if ((status & 0xffff) != 0)
4038 int msb = (status >> 8) & 255;
4039 int lsb = status & 255;
4040 int code = (msb == 0)? (lsb & 0x7f) : msb;
4042 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4044 addrlist->transport->driver_name,
4046 (msb == 0)? "terminated by signal" : "exit code",
4049 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4050 addrlist->special_action = SPECIAL_FREEZE;
4052 for (addr = addrlist; addr; addr = addr->next)
4054 addr->transport_return = DEFER;
4055 addr->message = msg;
4058 remove_journal = FALSE;
4061 /* Else complete reading the pipe to get the result of the delivery, if all
4062 the data has not yet been obtained. */
4064 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4066 /* Put the data count and return path into globals, mark the data slot unused,
4067 decrement the count of subprocesses, and return the address chain. */
4069 transport_count = parlist[poffset].transport_count;
4070 used_return_path = parlist[poffset].return_path;
4071 parlist[poffset].pid = 0;
4078 /*************************************************
4079 * Wait for subprocesses and post-process *
4080 *************************************************/
4082 /* This function waits for subprocesses until the number that are still running
4083 is below a given threshold. For each complete subprocess, the addresses are
4084 post-processed. If we can't find a running process, there is some shambles.
4085 Better not bomb out, as that might lead to multiple copies of the message. Just
4086 log and proceed as if all done.
4089 max maximum number of subprocesses to leave running
4090 fallback TRUE if processing fallback hosts
4096 par_reduce(int max, BOOL fallback)
4098 while (parcount > max)
4100 address_item *doneaddr = par_wait();
4103 log_write(0, LOG_MAIN|LOG_PANIC,
4104 "remote delivery process count got out of step");
4109 transport_instance * tp = doneaddr->transport;
4110 if (tp->max_parallel)
4111 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4113 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4119 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4121 uschar pipe_header[PIPE_HEADER_SIZE+1];
4122 size_t total_len = PIPE_HEADER_SIZE + size;
4124 struct iovec iov[2] = {
4125 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4126 { buf, size } /* *the* data */
4131 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4132 /* complain to log if someone tries with buffer sizes we can't handle*/
4134 if (size > BIG_BUFFER_SIZE-1)
4136 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4137 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4139 size = BIG_BUFFER_SIZE;
4142 /* Should we check that we do not write more than PIPE_BUF? What would
4145 /* convert size to human readable string prepended by id and subid */
4146 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4147 id, subid, (long)size))
4148 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4150 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4151 id, subid, (long)size, pipe_header);
4153 if ((ret = writev(fd, iov, 2)) != total_len)
4154 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4155 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4156 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4159 /*************************************************
4160 * Do remote deliveries *
4161 *************************************************/
4163 /* This function is called to process the addresses in addr_remote. We must
4164 pick off the queue all addresses that have the same transport, remote
4165 destination, and errors address, and hand them to the transport in one go,
4166 subject to some configured limitations. If this is a run to continue delivering
4167 to an existing delivery channel, skip all but those addresses that can go to
4168 that channel. The skipped addresses just get deferred.
4170 If mua_wrapper is set, all addresses must be able to be sent in a single
4171 transaction. If not, this function yields FALSE.
4173 In Exim 4, remote deliveries are always done in separate processes, even
4174 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4175 is so that the base process can retain privilege. This makes the
4176 implementation of fallback transports feasible (though not initially done.)
4178 We create up to the configured number of subprocesses, each of which passes
4179 back the delivery state via a pipe. (However, when sending down an existing
4180 connection, remote_max_parallel is forced to 1.)
4183 fallback TRUE if processing fallback hosts
4185 Returns: TRUE normally
4186 FALSE if mua_wrapper is set and the addresses cannot all be sent
4191 do_remote_deliveries(BOOL fallback)
4196 parcount = 0; /* Number of executing subprocesses */
4198 /* When sending down an existing channel, only do one delivery at a time.
4199 We use a local variable (parmax) to hold the maximum number of processes;
4200 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4202 if (continue_transport) remote_max_parallel = 1;
4203 parmax = remote_max_parallel;
4205 /* If the data for keeping a list of processes hasn't yet been
4210 parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4211 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4212 parlist[poffset].pid = 0;
4215 /* Now loop for each remote delivery */
4217 for (int delivery_count = 0; addr_remote; delivery_count++)
4223 int address_count = 1;
4224 int address_count_max;
4226 BOOL use_initgroups;
4227 BOOL pipe_done = FALSE;
4228 transport_instance *tp;
4229 address_item **anchor = &addr_remote;
4230 address_item *addr = addr_remote;
4231 address_item *last = addr;
4234 uschar * serialize_key = NULL;
4236 /* Pull the first address right off the list. */
4238 addr_remote = addr->next;
4241 DEBUG(D_deliver|D_transport)
4242 debug_printf("--------> %s <--------\n", addr->address);
4244 /* If no transport has been set, there has been a big screw-up somewhere. */
4246 if (!(tp = addr->transport))
4248 f.disable_logging = FALSE; /* Jic */
4249 panicmsg = US"No transport set by router";
4250 goto panic_continue;
4253 /* Check that this base address hasn't previously been delivered to this
4254 transport. The check is necessary at this point to handle homonymic addresses
4255 correctly in cases where the pattern of redirection changes between delivery
4256 attempts. Non-homonymic previous delivery is detected earlier, at routing
4259 if (previously_transported(addr, FALSE)) continue;
4261 /* Force failure if the message is too big. */
4263 if (tp->message_size_limit)
4265 int rc = check_message_size(tp, addr);
4268 addr->transport_return = rc;
4269 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4274 /* Get the flag which specifies whether the transport can handle different
4275 domains that nevertheless resolve to the same set of hosts. If it needs
4276 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4277 $host, $host_address, $host_port. */
4278 if (tp->expand_multi_domain)
4279 deliver_set_expansions(addr);
4281 if (exp_bool(addr, US"transport", tp->name, D_transport,
4282 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4283 &multi_domain) != OK)
4285 deliver_set_expansions(NULL);
4286 panicmsg = addr->message;
4287 goto panic_continue;
4290 /* Get the maximum it can handle in one envelope, with zero meaning
4291 unlimited, which is forced for the MUA wrapper case. */
4293 address_count_max = tp->max_addresses;
4294 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4297 /************************************************************************/
4298 /***** This is slightly experimental code, but should be safe. *****/
4300 /* The address_count_max value is the maximum number of addresses that the
4301 transport can send in one envelope. However, the transport must be capable of
4302 dealing with any number of addresses. If the number it gets exceeds its
4303 envelope limitation, it must send multiple copies of the message. This can be
4304 done over a single connection for SMTP, so uses less resources than making
4305 multiple connections. On the other hand, if remote_max_parallel is greater
4306 than one, it is perhaps a good idea to use parallel processing to move the
4307 message faster, even if that results in multiple simultaneous connections to
4310 How can we come to some compromise between these two ideals? What we do is to
4311 limit the number of addresses passed to a single instance of a transport to
4312 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4313 number of addresses routed to remote transports divided by
4314 remote_max_parallel. For example, if the message has 100 remote recipients,
4315 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4316 once. But if rcpt_max is 100, we could send up to 100.
4318 Of course, not all the remotely addresses in a message are going to go to the
4319 same set of hosts (except in smarthost configurations), so this is just a
4320 heuristic way of dividing up the work.
4322 Furthermore (1), because this may not be wanted in some cases, and also to
4323 cope with really pathological cases, there is also a limit to the number of
4324 messages that are sent over one connection. This is the same limit that is
4325 used when sending several different messages over the same connection.
4326 Continue_sequence is set when in this situation, to the number sent so
4327 far, including this message.
4329 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4330 is probably because they are using VERP, in which case they want to pass only
4331 one address at a time to the transport, in order to be able to use
4332 $local_part and $domain in constructing a new return path. We could test for
4333 the use of these variables, but as it is so likely they will be used when the
4334 maximum is 1, we don't bother. Just leave the value alone. */
4336 if ( address_count_max != 1
4337 && address_count_max < remote_delivery_count/remote_max_parallel
4340 int new_max = remote_delivery_count/remote_max_parallel;
4341 int message_max = tp->connection_max_messages;
4342 if (connection_max_messages >= 0) message_max = connection_max_messages;
4343 message_max -= continue_sequence - 1;
4344 if (message_max > 0 && new_max > address_count_max * message_max)
4345 new_max = address_count_max * message_max;
4346 address_count_max = new_max;
4349 /************************************************************************/
4352 /* Pick off all addresses which have the same transport, errors address,
4353 destination, and extra headers. In some cases they point to the same host
4354 list, but we also need to check for identical host lists generated from
4355 entirely different domains. The host list pointers can be NULL in the case
4356 where the hosts are defined in the transport. There is also a configured
4357 maximum limit of addresses that can be handled at once (see comments above
4358 for how it is computed).
4359 If the transport does not handle multiple domains, enforce that also,
4360 and if it might need a per-address check for this, re-evaluate it.
4363 while ((next = *anchor) && address_count < address_count_max)
4366 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4367 && tp == next->transport
4368 && same_hosts(next->host_list, addr->host_list)
4369 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4370 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4371 && same_ugid(tp, next, addr)
4372 && ( next->prop.remove_headers == addr->prop.remove_headers
4373 || ( next->prop.remove_headers
4374 && addr->prop.remove_headers
4375 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4379 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4381 US"transport", next->transport->name, D_transport,
4382 US"multi_domain", next->transport->multi_domain,
4383 next->transport->expand_multi_domain, &md) == OK
4388 *anchor = next->next;
4390 next->first = addr; /* remember top one (for retry processing) */
4395 else anchor = &(next->next);
4396 deliver_set_expansions(NULL);
4399 /* If we are acting as an MUA wrapper, all addresses must go in a single
4400 transaction. If not, put them back on the chain and yield FALSE. */
4402 if (mua_wrapper && addr_remote)
4404 last->next = addr_remote;
4409 /* If the transport is limited for parallellism, enforce that here.
4410 The hints DB entry is decremented in par_reduce(), when we reap the
4411 transport process. */
4413 if (tpt_parallel_check(tp, addr, &serialize_key))
4414 if ((panicmsg = expand_string_message))
4415 goto panic_continue;
4417 continue; /* Loop for the next set of addresses. */
4419 /* Set up the expansion variables for this set of addresses */
4421 deliver_set_expansions(addr);
4423 /* Ensure any transport-set auth info is fresh */
4424 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4426 /* Compute the return path, expanding a new one if required. The old one
4427 must be set first, as it might be referred to in the expansion. */
4429 if(addr->prop.errors_address)
4430 return_path = addr->prop.errors_address;
4431 #ifdef EXPERIMENTAL_SRS
4432 else if(addr->prop.srs_sender)
4433 return_path = addr->prop.srs_sender;
4436 return_path = sender_address;
4438 if (tp->return_path)
4440 uschar *new_return_path = expand_string(tp->return_path);
4441 if (new_return_path)
4442 return_path = new_return_path;
4443 else if (!f.expand_string_forcedfail)
4445 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4446 tp->return_path, expand_string_message);
4451 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4452 logs and sets up error messages, so we just post-process and continue with
4453 the next address. */
4455 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4461 /* If this transport has a setup function, call it now so that it gets
4462 run in this process and not in any subprocess. That way, the results of
4463 any setup that are retained by the transport can be reusable. One of the
4464 things the setup does is to set the fallback host lists in the addresses.
4465 That is why it is called at this point, before the continue delivery
4466 processing, because that might use the fallback hosts. */
4469 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4471 /* If we have a connection still open from a verify stage (lazy-close)
4472 treat it as if it is a continued connection (apart from the counter used
4473 for the log line mark). */
4475 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4478 debug_printf("lazy-callout-close: have conn still open from verification\n");
4479 continue_transport = cutthrough.transport;
4480 continue_hostname = string_copy(cutthrough.host.name);
4481 continue_host_address = string_copy(cutthrough.host.address);
4482 continue_sequence = 1;
4483 sending_ip_address = cutthrough.snd_ip;
4484 sending_port = cutthrough.snd_port;
4485 smtp_peer_options = cutthrough.peer_options;
4488 /* If this is a run to continue delivery down an already-established
4489 channel, check that this set of addresses matches the transport and
4490 the channel. If it does not, defer the addresses. If a host list exists,
4491 we must check that the continue host is on the list. Otherwise, the
4492 host is set in the transport. */
4494 f.continue_more = FALSE; /* In case got set for the last lot */
4495 if (continue_transport)
4497 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4499 /* If the transport is about to override the host list do not check
4500 it here but take the cost of running the transport process to discover
4501 if the continued_hostname connection is suitable. This is a layering
4502 violation which is unfortunate as it requires we haul in the smtp
4507 smtp_transport_options_block * ob;
4509 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4510 && (ob = (smtp_transport_options_block *)tp->options_block)
4511 && ob->hosts_override && ob->hosts
4517 for (host_item * h = addr->host_list; h; h = h->next)
4518 if (Ustrcmp(h->name, continue_hostname) == 0)
4519 /*XXX should also check port here */
4520 { ok = TRUE; break; }
4524 /* Addresses not suitable; defer or queue for fallback hosts (which
4525 might be the continue host) and skip to next address. */
4529 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4530 Ustrcmp(continue_transport, tp->name) != 0
4531 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4532 : string_sprintf("no host matching %s", continue_hostname));
4533 if (serialize_key) enq_end(serialize_key);
4535 if (addr->fallback_hosts && !fallback)
4537 for (next = addr; ; next = next->next)
4539 next->host_list = next->fallback_hosts;
4540 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4541 if (!next->next) break;
4543 next->next = addr_fallback;
4544 addr_fallback = addr;
4549 for (next = addr; ; next = next->next)
4551 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4552 if (!next->next) break;
4554 next->next = addr_defer;
4561 /* Set a flag indicating whether there are further addresses that list
4562 the continued host. This tells the transport to leave the channel open,
4563 but not to pass it to another delivery process. We'd like to do that
4564 for non-continue_transport cases too but the knowlege of which host is
4565 connected to is too hard to manage. Perhaps we need a finer-grain
4566 interface to the transport. */
4568 for (next = addr_remote; next && !f.continue_more; next = next->next)
4569 for (host_item * h = next->host_list; h; h = h->next)
4570 if (Ustrcmp(h->name, continue_hostname) == 0)
4571 { f.continue_more = TRUE; break; }
4574 /* The transports set up the process info themselves as they may connect
4575 to more than one remote machine. They also have to set up the filter
4576 arguments, if required, so that the host name and address are available
4579 transport_filter_argv = NULL;
4581 /* Create the pipe for inter-process communication. If pipe creation
4582 fails, it is probably because the value of remote_max_parallel is so
4583 large that too many file descriptors for pipes have been created. Arrange
4584 to wait for a process to finish, and then try again. If we still can't
4585 create a pipe when all processes have finished, break the retry loop. */
4589 if (pipe(pfd) == 0) pipe_done = TRUE;
4590 else if (parcount > 0) parmax = parcount;
4593 /* We need to make the reading end of the pipe non-blocking. There are
4594 two different options for this. Exim is cunningly (I hope!) coded so
4595 that it can use either of them, though it prefers O_NONBLOCK, which
4596 distinguishes between EOF and no-more-data. */
4598 /* The data appears in a timely manner and we already did a select on
4599 all pipes, so I do not see a reason to use non-blocking IO here
4602 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4604 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4608 /* If the maximum number of subprocesses already exist, wait for a process
4609 to finish. If we ran out of file descriptors, parmax will have been reduced
4610 from its initial value of remote_max_parallel. */
4612 par_reduce(parmax - 1, fallback);
4615 /* If we failed to create a pipe and there were no processes to wait
4616 for, we have to give up on this one. Do this outside the above loop
4617 so that we can continue the main loop. */
4621 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4625 /* Find a free slot in the pardata list. Must do this after the possible
4626 waiting for processes to finish, because a terminating process will free
4629 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4630 if (parlist[poffset].pid == 0)
4633 /* If there isn't one, there has been a horrible disaster. */
4635 if (poffset >= remote_max_parallel)
4637 (void)close(pfd[pipe_write]);
4638 (void)close(pfd[pipe_read]);
4639 panicmsg = US"Unexpectedly no free subprocess slot";
4643 /* Now fork a subprocess to do the remote delivery, but before doing so,
4644 ensure that any cached resources are released so as not to interfere with
4645 what happens in the subprocess. */
4649 DEBUG(D_deliver) debug_printf("forking transport process\n");
4650 if ((pid = exim_fork(US"transport")) == 0)
4652 int fd = pfd[pipe_write];
4655 /* Setting this global in the subprocess means we need never clear it */
4656 transport_name = tp->name;
4658 /* There are weird circumstances in which logging is disabled */
4659 f.disable_logging = tp->disable_logging;
4661 /* Show pids on debug output if parallelism possible */
4663 if (parmax > 1 && (parcount > 0 || addr_remote))
4665 DEBUG(D_any|D_v) debug_selector |= D_pid;
4666 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4669 /* Reset the random number generator, so different processes don't all
4670 have the same sequence. In the test harness we want different, but
4671 predictable settings for each delivery process, so do something explicit
4672 here rather they rely on the fixed reset in the random number function. */
4674 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4676 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4677 a new process that may be forked to do another delivery down the same
4680 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4682 /* Close open file descriptors for the pipes of other processes
4683 that are running in parallel. */
4685 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4686 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4688 /* This process has inherited a copy of the file descriptor
4689 for the data file, but its file pointer is shared with all the
4690 other processes running in parallel. Therefore, we have to re-open
4691 the file in order to get a new file descriptor with its own
4692 file pointer. We don't need to lock it, as the lock is held by
4693 the parent process. There doesn't seem to be any way of doing
4694 a dup-with-new-file-pointer. */
4696 (void)close(deliver_datafile);
4698 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4700 if ((deliver_datafile = Uopen(fname,
4704 O_RDWR | O_APPEND, 0)) < 0)
4705 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4706 "parallel delivery: %s", fname, strerror(errno));
4709 /* Set the close-on-exec flag */
4711 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4715 /* Set the uid/gid of this process; bombs out on failure. */
4717 exim_setugid(uid, gid, use_initgroups,
4718 string_sprintf("remote delivery to %s with transport=%s",
4719 addr->address, tp->name));
4721 /* Close the unwanted half of this process' pipe, set the process state,
4722 and run the transport. Afterwards, transport_count will contain the number
4723 of bytes written. */
4725 (void)close(pfd[pipe_read]);
4726 set_process_info("delivering %s using %s", message_id, tp->name);
4727 debug_print_string(tp->debug_string);
4728 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4730 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4731 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4733 /* Ensure any cached resources that we used are now released */
4737 /* Pass the result back down the pipe. This is a lot more information
4738 than is needed for a local delivery. We have to send back the error
4739 status for each address, the usability status for each host that is
4740 flagged as unusable, and all the retry items. When TLS is in use, we
4741 send also the cipher and peerdn information. Each type of information
4742 is flagged by an identifying byte, and is then in a fixed format (with
4743 strings terminated by zeros), and there is a final terminator at the
4744 end. The host information and retry information is all attached to
4745 the first address, so that gets sent at the start. */
4747 /* Host unusability information: for most success cases this will
4750 for (h = addr->host_list; h; h = h->next)
4752 if (!h->address || h->status < hstatus_unusable) continue;
4753 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4754 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4757 /* The number of bytes written. This is the same for each address. Even
4758 if we sent several copies of the message down the same connection, the
4759 size of each one is the same, and it's that value we have got because
4760 transport_count gets reset before calling transport_write_message(). */
4762 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4763 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4765 /* Information about what happened to each address. Four item types are
4766 used: an optional 'X' item first, for TLS information, then an optional "C"
4767 item for any client-auth info followed by 'R' items for any retry settings,
4768 and finally an 'A' item for the remaining data. */
4770 for(; addr; addr = addr->next)
4774 /* The certificate verification status goes into the flags */
4775 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4777 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4779 # ifdef EXPERIMENTAL_TLS_RESUME
4780 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4783 /* Use an X item only if there's something to send */
4787 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4791 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4793 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4795 else if (continue_proxy_cipher)
4797 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4799 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4805 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4809 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4814 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4818 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4820 # ifndef DISABLE_OCSP
4821 if (addr->ocsp > OCSP_NOT_REQ)
4823 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4824 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4827 #endif /*DISABLE_TLS*/
4829 if (client_authenticator)
4831 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4832 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4834 if (client_authenticated_id)
4836 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4837 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4839 if (client_authenticated_sender)
4841 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4842 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4845 #ifndef DISABLE_PRDR
4846 if (testflag(addr, af_prdr_used))
4847 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4850 if (testflag(addr, af_pipelining))
4851 #ifndef DISABLE_PIPE_CONNECT
4852 if (testflag(addr, af_early_pipe))
4853 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4856 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4858 if (testflag(addr, af_chunking_used))
4859 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4861 if (testflag(addr, af_tcp_fastopen_conn))
4862 rmt_dlv_checked_write(fd, 'T',
4863 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4867 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4868 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4870 /* Retry information: for most success cases this will be null. */
4872 for (retry_item * r = addr->retries; r; r = r->next)
4874 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4875 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4876 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4877 ptr += sizeof(r->basic_errno);
4878 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4879 ptr += sizeof(r->more_errno);
4880 if (!r->message) *ptr++ = 0; else
4882 sprintf(CS ptr, "%.512s", r->message);
4885 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4888 #ifdef SUPPORT_SOCKS
4889 if (LOGGING(proxy) && proxy_session)
4892 if (proxy_local_address)
4894 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4895 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4896 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4897 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4898 ptr += sizeof(proxy_local_port);
4902 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4906 #ifdef EXPERIMENTAL_DSN_INFO
4907 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4908 if (addr->smtp_greeting)
4910 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4911 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4912 if (addr->helo_response)
4914 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4915 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4919 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4923 /* The rest of the information goes in an 'A0' item. */
4925 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4926 ptr = big_buffer + 2;
4927 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4928 ptr += sizeof(addr->basic_errno);
4929 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4930 ptr += sizeof(addr->more_errno);
4931 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4932 ptr += sizeof(addr->delivery_time);
4933 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4934 ptr += sizeof(addr->flags);
4936 if (!addr->message) *ptr++ = 0; else
4937 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4939 if (!addr->user_message) *ptr++ = 0; else
4940 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4942 if (!addr->host_used) *ptr++ = 0; else
4944 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4945 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4946 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4947 ptr += sizeof(addr->host_used->port);
4949 /* DNS lookup status */
4950 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4951 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4954 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4957 /* Local interface address/port */
4958 #ifdef EXPERIMENTAL_DSN_INFO
4959 if (sending_ip_address)
4961 if (LOGGING(incoming_interface) && sending_ip_address)
4965 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4966 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4967 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4970 /* Add termination flag, close the pipe, and that's it. The character
4971 after 'Z' indicates whether continue_transport is now NULL or not.
4972 A change from non-NULL to NULL indicates a problem with a continuing
4975 big_buffer[0] = continue_transport ? '1' : '0';
4976 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4980 DEBUG(D_deliver) debug_printf("forked transport process (%d)\n", pid);
4982 /* Back in the mainline: close the unwanted half of the pipe. */
4984 (void)close(pfd[pipe_write]);
4986 /* If we have a connection still open from a verify stage (lazy-close)
4987 release its TLS library context (if any) as responsibility was passed to
4988 the delivery child process. */
4990 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4993 if (cutthrough.is_tls)
4994 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
4996 (void) close(cutthrough.cctx.sock);
4997 release_cutthrough_connection(US"passed to transport proc");
5000 /* Fork failed; defer with error message */
5004 (void)close(pfd[pipe_read]);
5005 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5006 addr->domain, strerror(errno));
5010 /* Fork succeeded; increment the count, and remember relevant data for
5011 when the process finishes. */
5014 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5015 parlist[poffset].pid = pid;
5016 parlist[poffset].fd = pfd[pipe_read];
5017 parlist[poffset].done = FALSE;
5018 parlist[poffset].msg = NULL;
5019 parlist[poffset].return_path = return_path;
5021 /* If the process we've just started is sending a message down an existing
5022 channel, wait for it now. This ensures that only one such process runs at
5023 once, whatever the value of remote_max parallel. Otherwise, we might try to
5024 send two or more messages simultaneously down the same channel. This could
5025 happen if there are different domains that include the same host in otherwise
5026 different host lists.
5028 Also, if the transport closes down the channel, this information gets back
5029 (continue_transport gets set to NULL) before we consider any other addresses
5032 if (continue_transport) par_reduce(0, fallback);
5034 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5035 newly created process get going before we create another process. This should
5036 ensure repeatability in the tests. Wait long enough for most cases to complete
5039 else testharness_pause_ms(600);
5044 if (serialize_key) enq_end(serialize_key);
5046 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5050 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5051 are still running and post-process their addresses. */
5053 par_reduce(0, fallback);
5060 /*************************************************
5061 * Split an address into local part and domain *
5062 *************************************************/
5064 /* This function initializes an address for routing by splitting it up into a
5065 local part and a domain. The local part is set up twice - once in its original
5066 casing, and once in lower case, and it is dequoted. We also do the "percent
5067 hack" for configured domains. This may lead to a DEFER result if a lookup
5068 defers. When a percent-hacking takes place, we insert a copy of the original
5069 address as a new parent of this address, as if we have had a redirection.
5072 addr points to an addr_item block containing the address
5075 DEFER - could not determine if domain is %-hackable
5079 deliver_split_address(address_item * addr)
5081 uschar * address = addr->address;
5086 if (!(domain = Ustrrchr(address, '@')))
5087 return DEFER; /* should always have a domain, but just in case... */
5089 len = domain - address;
5090 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5092 /* The implication in the RFCs (though I can't say I've seen it spelled out
5093 explicitly) is that quoting should be removed from local parts at the point
5094 where they are locally interpreted. [The new draft "821" is more explicit on
5095 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5096 removing quoting backslashes and any unquoted doublequotes. */
5098 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5102 if (c == '\"') continue;
5112 /* We do the percent hack only for those domains that are listed in
5113 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5115 if (percent_hack_domains)
5118 uschar *new_address = NULL;
5119 uschar *local_part = addr->cc_local_part;
5121 deliver_domain = addr->domain; /* set $domain */
5123 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5124 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5126 && (t = Ustrrchr(local_part, '%')) != NULL
5129 new_address = string_copy(local_part);
5130 new_address[t - local_part] = '@';
5131 deliver_domain = string_copylc(t+1);
5132 local_part = string_copyn(local_part, t - local_part);
5135 if (rc == DEFER) return DEFER; /* lookup deferred */
5137 /* If hackery happened, set up new parent and alter the current address. */
5141 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5142 *new_parent = *addr;
5143 addr->parent = new_parent;
5144 new_parent->child_count = 1;
5145 addr->address = new_address;
5146 addr->unique = string_copy(new_address);
5147 addr->domain = deliver_domain;
5148 addr->cc_local_part = local_part;
5149 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5154 /* Create the lowercased version of the final local part, and make that the
5155 default one to be used. */
5157 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5164 /*************************************************
5165 * Get next error message text *
5166 *************************************************/
5168 /* If f is not NULL, read the next "paragraph", from a customized error message
5169 text file, terminated by a line containing ****, and expand it.
5172 f NULL or a file to read from
5173 which string indicating which string (for errors)
5175 Returns: NULL or an expanded string
5179 next_emf(FILE *f, uschar *which)
5185 if (!f) return NULL;
5187 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5190 para = string_get(256);
5193 para = string_cat(para, buffer);
5194 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5197 if ((yield = expand_string(string_from_gstring(para))))
5200 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5201 "bounce_message_file or warn_message_file (%s): %s", which,
5202 expand_string_message);
5209 /*************************************************
5210 * Close down a passed transport channel *
5211 *************************************************/
5213 /* This function is called when a passed transport channel cannot be used.
5214 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5215 so that the function call can be the argument of a "return" statement.
5218 Returns: DELIVER_NOT_ATTEMPTED
5222 continue_closedown(void)
5224 if (continue_transport)
5225 for (transport_instance * t = transports; t; t = t->next)
5226 if (Ustrcmp(t->name, continue_transport) == 0)
5228 if (t->info->closedown) (t->info->closedown)(t);
5231 return DELIVER_NOT_ATTEMPTED;
5237 /*************************************************
5238 * Print address information *
5239 *************************************************/
5241 /* This function is called to output an address, or information about an
5242 address, for bounce or defer messages. If the hide_child flag is set, all we
5243 output is the original ancestor address.
5246 addr points to the address
5247 f the FILE to print to
5248 si an initial string
5249 sc a continuation string for before "generated"
5252 Returns: TRUE if the address is not hidden
5256 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5260 uschar *printed = US"";
5261 address_item *ancestor = addr;
5262 while (ancestor->parent) ancestor = ancestor->parent;
5264 fprintf(f, "%s", CS si);
5266 if (addr->parent && testflag(addr, af_hide_child))
5268 printed = US"an undisclosed address";
5271 else if (!testflag(addr, af_pfr) || !addr->parent)
5272 printed = addr->address;
5276 uschar *s = addr->address;
5279 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5280 else if (addr->address[0] == '|') ss = US"pipe";
5283 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5284 printed = addr->parent->address;
5287 fprintf(f, "%s", CS string_printing(printed));
5289 if (ancestor != addr)
5291 uschar *original = ancestor->onetime_parent;
5292 if (!original) original= ancestor->address;
5293 if (strcmpic(original, printed) != 0)
5294 fprintf(f, "%s(%sgenerated from %s)", sc,
5295 ancestor != addr->parent ? "ultimately " : "",
5296 string_printing(original));
5299 if (addr->host_used)
5300 fprintf(f, "\n host %s [%s]",
5301 addr->host_used->name, addr->host_used->address);
5303 fprintf(f, "%s", CS se);
5311 /*************************************************
5312 * Print error for an address *
5313 *************************************************/
5315 /* This function is called to print the error information out of an address for
5316 a bounce or a warning message. It tries to format the message reasonably by
5317 introducing newlines. All lines are indented by 4; the initial printing
5318 position must be set before calling.
5320 This function used always to print the error. Nowadays we want to restrict it
5321 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5322 and filter "fail". We no longer pass other information willy-nilly in bounce
5323 and warning messages. Text in user_message is always output; text in message
5324 only if the af_pass_message flag is set.
5328 f the FILE to print on
5335 print_address_error(address_item *addr, FILE *f, uschar *t)
5337 int count = Ustrlen(t);
5338 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5340 if (!s && !(s = addr->user_message))
5343 fprintf(f, "\n %s", t);
5346 if (*s == '\\' && s[1] == 'n')
5356 if (*s++ == ':' && isspace(*s) && count > 45)
5358 fprintf(f, "\n "); /* sic (because space follows) */
5365 /***********************************************************
5366 * Print Diagnostic-Code for an address *
5367 ************************************************************/
5369 /* This function is called to print the error information out of an address for
5370 a bounce or a warning message. It tries to format the message reasonably as
5371 required by RFC 3461 by adding a space after each newline
5373 it uses the same logic as print_address_error() above. if af_pass_message is true
5374 and addr->message is set it uses the remote host answer. if not addr->user_message
5375 is used instead if available.
5379 f the FILE to print on
5385 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5387 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5389 /* af_pass_message and addr->message set ? print remote host answer */
5393 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5395 /* search first ": ". we assume to find the remote-MTA answer there */
5396 if (!(s = Ustrstr(addr->message, ": ")))
5397 return; /* not found, bail out */
5398 s += 2; /* skip ": " */
5399 fprintf(f, "Diagnostic-Code: smtp; ");
5401 /* no message available. do nothing */
5405 if (*s == '\\' && s[1] == 'n')
5407 fputs("\n ", f); /* as defined in RFC 3461 */
5417 /*************************************************
5418 * Check list of addresses for duplication *
5419 *************************************************/
5421 /* This function was introduced when the test for duplicate addresses that are
5422 not pipes, files, or autoreplies was moved from the middle of routing to when
5423 routing was complete. That was to fix obscure cases when the routing history
5424 affects the subsequent routing of identical addresses. This function is called
5425 after routing, to check that the final routed addresses are not duplicates.
5427 If we detect a duplicate, we remember what it is a duplicate of. Note that
5428 pipe, file, and autoreply de-duplication is handled during routing, so we must
5429 leave such "addresses" alone here, as otherwise they will incorrectly be
5432 Argument: address of list anchor
5437 do_duplicate_check(address_item **anchor)
5440 while ((addr = *anchor))
5443 if (testflag(addr, af_pfr))
5445 anchor = &(addr->next);
5447 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5449 DEBUG(D_deliver|D_route)
5450 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5451 *anchor = addr->next;
5452 addr->dupof = tnode->data.ptr;
5453 addr->next = addr_duplicate;
5454 addr_duplicate = addr;
5458 tree_add_duplicate(addr->unique, addr);
5459 anchor = &(addr->next);
5467 /************************************************/
5470 print_dsn_addr_action(FILE * f, address_item * addr,
5471 uschar * action, uschar * status)
5475 if (addr->dsn_orcpt)
5476 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5478 for (pa = addr; pa->parent; ) pa = pa->parent;
5479 fprintf(f, "Action: %s\n"
5480 "Final-Recipient: rfc822;%s\n"
5482 action, pa->address, status);
5487 /* When running in the test harness, there's an option that allows us to
5488 fudge this time so as to get repeatability of the tests. Take the first
5489 time off the list. In queue runs, the list pointer gets updated in the
5493 test_harness_fudged_queue_time(int actual_time)
5496 if ( f.running_in_test_harness && *fudged_queue_times
5497 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5499 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5500 fudged_queue_times);
5506 /*************************************************
5507 * Deliver one message *
5508 *************************************************/
5510 /* This is the function which is called when a message is to be delivered. It
5511 is passed the id of the message. It is possible that the message no longer
5512 exists, if some other process has delivered it, and it is also possible that
5513 the message is being worked on by another process, in which case the data file
5516 If no delivery is attempted for any of the above reasons, the function returns
5517 DELIVER_NOT_ATTEMPTED.
5519 If the give_up flag is set true, do not attempt any deliveries, but instead
5520 fail all outstanding addresses and return the message to the sender (or
5523 A delivery operation has a process all to itself; we never deliver more than
5524 one message in the same process. Therefore we needn't worry too much about
5527 Liable to be called as root.
5530 id the id of the message to be delivered
5531 forced TRUE if delivery was forced by an administrator; this overrides
5532 retry delays and causes a delivery to be tried regardless
5533 give_up TRUE if an administrator has requested that delivery attempts
5536 Returns: When the global variable mua_wrapper is FALSE:
5537 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5538 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5539 When the global variable mua_wrapper is TRUE:
5540 DELIVER_MUA_SUCCEEDED if delivery succeeded
5541 DELIVER_MUA_FAILED if delivery failed
5542 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5546 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5549 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5550 time_t now = time(NULL);
5551 address_item *addr_last = NULL;
5552 uschar *filter_message = NULL;
5553 int process_recipients = RECIP_ACCEPT;
5556 extern int acl_where;
5559 #ifdef MEASURE_TIMING
5560 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5563 info = queue_run_pid == (pid_t)0
5564 ? string_sprintf("delivering %s", id)
5565 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5567 /* If the D_process_info bit is on, set_process_info() will output debugging
5568 information. If not, we want to show this initial information if D_deliver or
5569 D_queue_run is set or in verbose mode. */
5571 set_process_info("%s", info);
5573 if ( !(debug_selector & D_process_info)
5574 && (debug_selector & (D_deliver|D_queue_run|D_v))
5576 debug_printf("%s\n", info);
5578 /* Ensure that we catch any subprocesses that are created. Although Exim
5579 sets SIG_DFL as its initial default, some routes through the code end up
5580 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5581 has been forked, but no re-exec has been done. We use sigaction rather than
5582 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5583 sure it is turned off. (There was a problem on AIX with this.) */
5587 struct sigaction act;
5588 act.sa_handler = SIG_DFL;
5589 sigemptyset(&(act.sa_mask));
5591 sigaction(SIGCHLD, &act, NULL);
5594 signal(SIGCHLD, SIG_DFL);
5597 /* Make the forcing flag available for routers and transports, set up the
5598 global message id field, and initialize the count for returned files and the
5599 message size. This use of strcpy() is OK because the length id is checked when
5600 it is obtained from a command line (the -M or -q options), and otherwise it is
5601 known to be a valid message id. */
5603 if (id != message_id)
5604 Ustrcpy(message_id, id);
5605 f.deliver_force = forced;
5609 /* Initialize some flags */
5611 update_spool = FALSE;
5612 remove_journal = TRUE;
5614 /* Set a known context for any ACLs we call via expansions */
5615 acl_where = ACL_WHERE_DELIVERY;
5617 /* Reset the random number generator, so that if several delivery processes are
5618 started from a queue runner that has already used random numbers (for sorting),
5619 they don't all get the same sequence. */
5623 /* Open and lock the message's data file. Exim locks on this one because the
5624 header file may get replaced as it is re-written during the delivery process.
5625 Any failures cause messages to be written to the log, except for missing files
5626 while queue running - another process probably completed delivery. As part of
5627 opening the data file, message_subdir gets set. */
5629 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5630 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5632 /* The value of message_size at this point has been set to the data length,
5633 plus one for the blank line that notionally precedes the data. */
5635 /* Now read the contents of the header file, which will set up the headers in
5636 store, and also the list of recipients and the tree of non-recipients and
5637 assorted flags. It updates message_size. If there is a reading or format error,
5638 give up; if the message has been around for sufficiently long, remove it. */
5641 uschar * spoolname = string_sprintf("%s-H", id);
5642 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5644 if (errno == ERRNO_SPOOLFORMAT)
5646 struct stat statbuf;
5647 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5649 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5650 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5652 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5655 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5658 /* If we managed to read the envelope data, received_time contains the
5659 time the message was received. Otherwise, we can calculate it from the
5662 if (rc != spool_read_hdrerror)
5664 received_time.tv_sec = received_time.tv_usec = 0;
5665 /*XXX subsec precision?*/
5666 for (i = 0; i < 6; i++)
5667 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5670 /* If we've had this malformed message too long, sling it. */
5672 if (now - received_time.tv_sec > keep_malformed)
5674 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5675 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5676 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5677 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5678 log_write(0, LOG_MAIN, "Message removed because older than %s",
5679 readconf_printtime(keep_malformed));
5682 (void)close(deliver_datafile);
5683 deliver_datafile = -1;
5684 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5688 /* The spool header file has been read. Look to see if there is an existing
5689 journal file for this message. If there is, it means that a previous delivery
5690 attempt crashed (program or host) before it could update the spool header file.
5691 Read the list of delivered addresses from the journal and add them to the
5692 nonrecipients tree. Then update the spool file. We can leave the journal in
5693 existence, as it will get further successful deliveries added to it in this
5694 run, and it will be deleted if this function gets to its end successfully.
5695 Otherwise it might be needed again. */
5698 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5701 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5709 && lseek(journal_fd, 0, SEEK_SET) == 0
5710 && (jread = fdopen(journal_fd, "rb"))
5713 while (Ufgets(big_buffer, big_buffer_size, jread))
5715 int n = Ustrlen(big_buffer);
5716 big_buffer[n-1] = 0;
5717 tree_add_nonrecipient(big_buffer);
5718 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5719 "journal file\n", big_buffer);
5722 if ((journal_fd = dup(fileno(jread))) < 0)
5723 journal_fd = fileno(jread);
5725 (void) fclose(jread); /* Try to not leak the FILE resource */
5727 /* Panic-dies on error */
5728 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5730 else if (errno != ENOENT)
5732 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5733 "%s", strerror(errno));
5734 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5737 /* A null recipients list indicates some kind of disaster. */
5739 if (!recipients_list)
5741 (void)close(deliver_datafile);
5742 deliver_datafile = -1;
5743 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5744 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5749 /* Handle a message that is frozen. There are a number of different things that
5750 can happen, but in the default situation, unless forced, no delivery is
5753 if (f.deliver_freeze)
5755 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5756 /* Moving to another directory removes the message from Exim's view. Other
5757 tools must be used to deal with it. Logging of this action happens in
5758 spool_move_message() and its subfunctions. */
5760 if ( move_frozen_messages
5761 && spool_move_message(id, message_subdir, US"", US"F")
5763 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5766 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5767 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5768 flag causing all recipients to be failed. The time is the age of the
5769 message, not the time since freezing. */
5771 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5773 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5774 process_recipients = RECIP_FAIL_TIMEOUT;
5777 /* For bounce messages (and others with no sender), thaw if the error message
5778 ignore timer is exceeded. The message will be discarded if this delivery
5781 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5782 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5784 /* If this is a bounce message, or there's no auto thaw, or we haven't
5785 reached the auto thaw time yet, and this delivery is not forced by an admin
5786 user, do not attempt delivery of this message. Note that forced is set for
5787 continuing messages down the same channel, in order to skip load checking and
5788 ignore hold domains, but we don't want unfreezing in that case. */
5792 if ( ( sender_address[0] == 0
5794 || now <= deliver_frozen_at + auto_thaw
5796 && ( !forced || !f.deliver_force_thaw
5797 || !f.admin_user || continue_hostname
5800 (void)close(deliver_datafile);
5801 deliver_datafile = -1;
5802 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5803 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5806 /* If delivery was forced (by an admin user), assume a manual thaw.
5807 Otherwise it's an auto thaw. */
5811 f.deliver_manual_thaw = TRUE;
5812 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5814 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5817 /* We get here if any of the rules for unfreezing have triggered. */
5819 f.deliver_freeze = FALSE;
5820 update_spool = TRUE;
5824 /* Open the message log file if we are using them. This records details of
5825 deliveries, deferments, and failures for the benefit of the mail administrator.
5826 The log is not used by exim itself to track the progress of a message; that is
5827 done by rewriting the header spool file. */
5831 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5835 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5837 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5838 fname, strerror(errno));
5839 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5842 /* Make a C stream out of it. */
5844 if (!(message_log = fdopen(fd, "a")))
5846 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5847 fname, strerror(errno));
5848 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5853 /* If asked to give up on a message, log who did it, and set the action for all
5858 struct passwd *pw = getpwuid(real_uid);
5859 log_write(0, LOG_MAIN, "cancelled by %s",
5860 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5861 process_recipients = RECIP_FAIL;
5864 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5866 else if (received_count > received_headers_max)
5867 process_recipients = RECIP_FAIL_LOOP;
5869 /* Otherwise, if a system-wide, address-independent message filter is
5870 specified, run it now, except in the case when we are failing all recipients as
5871 a result of timeout_frozen_after. If the system filter yields "delivered", then
5872 ignore the true recipients of the message. Failure of the filter file is
5873 logged, and the delivery attempt fails. */
5875 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5880 redirect_block redirect;
5882 if (system_filter_uid_set)
5884 ugid.uid = system_filter_uid;
5885 ugid.gid = system_filter_gid;
5886 ugid.uid_set = ugid.gid_set = TRUE;
5889 ugid.uid_set = ugid.gid_set = FALSE;
5891 return_path = sender_address;
5892 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5893 f.system_filtering = TRUE;
5895 /* Any error in the filter file causes a delivery to be abandoned. */
5897 redirect.string = system_filter;
5898 redirect.isfile = TRUE;
5899 redirect.check_owner = redirect.check_group = FALSE;
5900 redirect.owners = NULL;
5901 redirect.owngroups = NULL;
5903 redirect.modemask = 0;
5905 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5908 &redirect, /* Where the data is */
5909 RDO_DEFER | /* Turn on all the enabling options */
5910 RDO_FAIL | /* Leave off all the disabling options */
5915 NULL, /* No :include: restriction (not used in filter) */
5916 NULL, /* No sieve vacation directory (not sieve!) */
5917 NULL, /* No sieve enotify mailto owner (not sieve!) */
5918 NULL, /* No sieve user address (not sieve!) */
5919 NULL, /* No sieve subaddress (not sieve!) */
5920 &ugid, /* uid/gid data */
5921 &addr_new, /* Where to hang generated addresses */
5922 &filter_message, /* Where to put error message */
5923 NULL, /* Don't skip syntax errors */
5924 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5925 US"system filter"); /* For error messages */
5927 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5929 if (rc == FF_ERROR || rc == FF_NONEXIST)
5931 (void)close(deliver_datafile);
5932 deliver_datafile = -1;
5933 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5934 string_printing(filter_message));
5935 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5938 /* Reset things. If the filter message is an empty string, which can happen
5939 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5941 f.system_filtering = FALSE;
5942 f.enable_dollar_recipients = FALSE;
5943 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5945 /* Save the values of the system filter variables so that user filters
5948 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5950 /* The filter can request that delivery of the original addresses be
5955 process_recipients = RECIP_DEFER;
5956 deliver_msglog("Delivery deferred by system filter\n");
5957 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5960 /* The filter can request that a message be frozen, but this does not
5961 take place if the message has been manually thawed. In that case, we must
5962 unset "delivered", which is forced by the "freeze" command to make -bF
5965 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5967 f.deliver_freeze = TRUE;
5968 deliver_frozen_at = time(NULL);
5969 process_recipients = RECIP_DEFER;
5970 frozen_info = string_sprintf(" by the system filter%s%s",
5971 filter_message ? US": " : US"",
5972 filter_message ? filter_message : US"");
5975 /* The filter can request that a message be failed. The error message may be
5976 quite long - it is sent back to the sender in the bounce - but we don't want
5977 to fill up the log with repetitions of it. If it starts with << then the text
5978 between << and >> is written to the log, with the rest left for the bounce
5981 else if (rc == FF_FAIL)
5983 uschar *colon = US"";
5984 uschar *logmsg = US"";
5987 process_recipients = RECIP_FAIL_FILTER;
5993 if ( filter_message[0] == '<'
5994 && filter_message[1] == '<'
5995 && (logend = Ustrstr(filter_message, ">>"))
5998 logmsg = filter_message + 2;
5999 loglen = logend - logmsg;
6000 filter_message = logend + 2;
6001 if (filter_message[0] == 0) filter_message = NULL;
6005 logmsg = filter_message;
6006 loglen = Ustrlen(filter_message);
6010 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6014 /* Delivery can be restricted only to those recipients (if any) that the
6015 filter specified. */
6017 else if (rc == FF_DELIVERED)
6019 process_recipients = RECIP_IGNORE;
6021 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6023 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6026 /* If any new addresses were created by the filter, fake up a "parent"
6027 for them. This is necessary for pipes, etc., which are expected to have
6028 parents, and it also gives some sensible logging for others. Allow
6029 pipes, files, and autoreplies, and run them as the filter uid if set,
6030 otherwise as the current uid. */
6034 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6035 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6037 /* The text "system-filter" is tested in transport_set_up_command() and in
6038 set_up_shell_command() in the pipe transport, to enable them to permit
6039 $recipients, so don't change it here without also changing it there. */
6041 address_item *p = addr_new;
6042 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6044 parent->domain = string_copylc(qualify_domain_recipient);
6045 parent->local_part = US"system-filter";
6047 /* As part of this loop, we arrange for addr_last to end up pointing
6048 at the final address. This is used if we go on to add addresses for the
6049 original recipients. */
6053 if (parent->child_count == USHRT_MAX)
6054 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6055 "than %d delivery addresses", USHRT_MAX);
6056 parent->child_count++;
6059 if (testflag(p, af_pfr))
6065 setflag(p, af_uid_set);
6066 setflag(p, af_gid_set);
6067 setflag(p, af_allow_file);
6068 setflag(p, af_allow_pipe);
6069 setflag(p, af_allow_reply);
6071 /* Find the name of the system filter's appropriate pfr transport */
6073 if (p->address[0] == '|')
6076 tpname = system_filter_pipe_transport;
6077 address_pipe = p->address;
6079 else if (p->address[0] == '>')
6082 tpname = system_filter_reply_transport;
6086 if (p->address[Ustrlen(p->address)-1] == '/')
6088 type = US"directory";
6089 tpname = system_filter_directory_transport;
6094 tpname = system_filter_file_transport;
6096 address_file = p->address;
6099 /* Now find the actual transport, first expanding the name. We have
6100 set address_file or address_pipe above. */
6104 uschar *tmp = expand_string(tpname);
6105 address_file = address_pipe = NULL;
6107 p->message = string_sprintf("failed to expand \"%s\" as a "
6108 "system filter transport name", tpname);
6109 if (is_tainted(tmp))
6110 p->message = string_sprintf("attempt to used tainted value '%s' for"
6111 "transport '%s' as a system filter", tmp, tpname);
6115 p->message = string_sprintf("system_filter_%s_transport is unset",
6120 transport_instance *tp;
6121 for (tp = transports; tp; tp = tp->next)
6122 if (Ustrcmp(tp->name, tpname) == 0)
6128 p->message = string_sprintf("failed to find \"%s\" transport "
6129 "for system filter delivery", tpname);
6132 /* If we couldn't set up a transport, defer the delivery, putting the
6133 error on the panic log as well as the main log. */
6137 address_item *badp = p;
6139 if (!addr_last) addr_new = p; else addr_last->next = p;
6140 badp->local_part = badp->address; /* Needed for log line */
6141 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6144 } /* End of pfr handling */
6146 /* Either a non-pfr delivery, or we found a transport */
6148 DEBUG(D_deliver|D_filter)
6149 debug_printf("system filter added %s\n", p->address);
6153 } /* Loop through all addr_new addresses */
6158 /* Scan the recipients list, and for every one that is not in the non-
6159 recipients tree, add an addr item to the chain of new addresses. If the pno
6160 value is non-negative, we must set the onetime parent from it. This which
6161 points to the relevant entry in the recipients list.
6163 This processing can be altered by the setting of the process_recipients
6164 variable, which is changed if recipients are to be ignored, failed, or
6165 deferred. This can happen as a result of system filter activity, or if the -Mg
6166 option is used to fail all of them.
6168 Duplicate addresses are handled later by a different tree structure; we can't
6169 just extend the non-recipients tree, because that will be re-written to the
6170 spool if the message is deferred, and in any case there are casing
6171 complications for local addresses. */
6173 if (process_recipients != RECIP_IGNORE)
6174 for (i = 0; i < recipients_count; i++)
6175 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6177 recipient_item *r = recipients_list + i;
6178 address_item *new = deliver_make_addr(r->address, FALSE);
6179 new->prop.errors_address = r->errors_to;
6181 if ((new->prop.utf8_msg = message_smtputf8))
6183 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6184 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6185 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6186 new->prop.utf8_downcvt ? "yes"
6187 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6193 new->onetime_parent = recipients_list[r->pno].address;
6195 /* If DSN support is enabled, set the dsn flags and the original receipt
6196 to be passed on to other DSN enabled MTAs */
6198 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6199 new->dsn_orcpt = r->orcpt;
6200 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6201 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6203 switch (process_recipients)
6205 /* RECIP_DEFER is set when a system filter freezes a message. */
6208 new->next = addr_defer;
6213 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6216 case RECIP_FAIL_FILTER:
6218 filter_message ? filter_message : US"delivery cancelled";
6219 setflag(new, af_pass_message);
6220 goto RECIP_QUEUE_FAILED; /* below */
6223 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6224 than the value in timeout_frozen_after. Treat non-bounce messages
6225 similarly to -Mg; for bounce messages we just want to discard, so
6226 don't put the address on the failed list. The timeout has already
6229 case RECIP_FAIL_TIMEOUT:
6230 new->message = US"delivery cancelled; message timed out";
6231 goto RECIP_QUEUE_FAILED; /* below */
6234 /* RECIP_FAIL is set when -Mg has been used. */
6237 new->message = US"delivery cancelled by administrator";
6240 /* Common code for the failure cases above. If this is not a bounce
6241 message, put the address on the failed list so that it is used to
6242 create a bounce. Otherwise do nothing - this just discards the address.
6243 The incident has already been logged. */
6246 if (sender_address[0])
6248 new->next = addr_failed;
6254 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6255 in the message. Process each address as a routing failure; if this
6256 is a bounce message, it will get frozen. */
6258 case RECIP_FAIL_LOOP:
6259 new->message = US"Too many \"Received\" headers - suspected mail loop";
6260 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6264 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6267 if (!addr_new) addr_new = new; else addr_last->next = new;
6272 #ifndef DISABLE_EVENT
6273 if (process_recipients != RECIP_ACCEPT && event_action)
6275 uschar * save_local = deliver_localpart;
6276 const uschar * save_domain = deliver_domain;
6277 uschar * addr = new->address, * errmsg = NULL;
6278 int start, end, dom;
6280 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6281 log_write(0, LOG_MAIN|LOG_PANIC,
6282 "failed to parse address '%.100s': %s\n", addr, errmsg);
6286 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6287 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6289 event_raise(event_action, US"msg:fail:internal", new->message);
6291 deliver_localpart = save_local;
6292 deliver_domain = save_domain;
6300 debug_printf("Delivery address list:\n");
6301 for (address_item * p = addr_new; p; p = p->next)
6302 debug_printf(" %s %s\n", p->address,
6303 p->onetime_parent ? p->onetime_parent : US"");
6306 /* Set up the buffers used for copying over the file when delivering. */
6308 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6309 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6313 /* Until there are no more new addresses, handle each one as follows:
6315 . If this is a generated address (indicated by the presence of a parent
6316 pointer) then check to see whether it is a pipe, file, or autoreply, and
6317 if so, handle it directly here. The router that produced the address will
6318 have set the allow flags into the address, and also set the uid/gid required.
6319 Having the routers generate new addresses and then checking them here at
6320 the outer level is tidier than making each router do the checking, and
6321 means that routers don't need access to the failed address queue.
6323 . Break up the address into local part and domain, and make lowercased
6324 versions of these strings. We also make unquoted versions of the local part.
6326 . Handle the percent hack for those domains for which it is valid.
6328 . For child addresses, determine if any of the parents have the same address.
6329 If so, generate a different string for previous delivery checking. Without
6330 this code, if the address spqr generates spqr via a forward or alias file,
6331 delivery of the generated spqr stops further attempts at the top level spqr,
6332 which is not what is wanted - it may have generated other addresses.
6334 . Check on the retry database to see if routing was previously deferred, but
6335 only if in a queue run. Addresses that are to be routed are put on the
6336 addr_route chain. Addresses that are to be deferred are put on the
6337 addr_defer chain. We do all the checking first, so as not to keep the
6338 retry database open any longer than necessary.
6340 . Now we run the addresses through the routers. A router may put the address
6341 on either the addr_local or the addr_remote chain for local or remote
6342 delivery, respectively, or put it on the addr_failed chain if it is
6343 undeliveable, or it may generate child addresses and put them on the
6344 addr_new chain, or it may defer an address. All the chain anchors are
6345 passed as arguments so that the routers can be called for verification
6348 . If new addresses have been generated by the routers, da capo.
6351 f.header_rewritten = FALSE; /* No headers rewritten yet */
6352 while (addr_new) /* Loop until all addresses dealt with */
6354 address_item *addr, *parent;
6356 /* Failure to open the retry database is treated the same as if it does
6357 not exist. In both cases, dbm_file is NULL. */
6359 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6360 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6361 debug_printf("no retry data available\n");
6363 /* Scan the current batch of new addresses, to handle pipes, files and
6364 autoreplies, and determine which others are ready for routing. */
6371 dbdata_retry *domain_retry_record;
6372 dbdata_retry *address_retry_record;
6375 addr_new = addr->next;
6377 DEBUG(D_deliver|D_retry|D_route)
6379 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6380 debug_printf("Considering: %s\n", addr->address);
6383 /* Handle generated address that is a pipe or a file or an autoreply. */
6385 if (testflag(addr, af_pfr))
6387 /* If an autoreply in a filter could not generate a syntactically valid
6388 address, give up forthwith. Set af_ignore_error so that we don't try to
6389 generate a bounce. */
6391 if (testflag(addr, af_bad_reply))
6393 addr->basic_errno = ERRNO_BADADDRESS2;
6394 addr->local_part = addr->address;
6396 US"filter autoreply generated syntactically invalid recipient";
6397 addr->prop.ignore_error = TRUE;
6398 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6399 continue; /* with the next new address */
6402 /* If two different users specify delivery to the same pipe or file or
6403 autoreply, there should be two different deliveries, so build a unique
6404 string that incorporates the original address, and use this for
6405 duplicate testing and recording delivery, and also for retrying. */
6408 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6409 (testflag(addr->parent, af_homonym)? 3:0));
6411 addr->address_retry_key = addr->domain_retry_key =
6412 string_sprintf("T:%s", addr->unique);
6414 /* If a filter file specifies two deliveries to the same pipe or file,
6415 we want to de-duplicate, but this is probably not wanted for two mail
6416 commands to the same address, where probably both should be delivered.
6417 So, we have to invent a different unique string in that case. Just
6418 keep piling '>' characters on the front. */
6420 if (addr->address[0] == '>')
6421 while (tree_search(tree_duplicates, addr->unique))
6422 addr->unique = string_sprintf(">%s", addr->unique);
6424 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6426 DEBUG(D_deliver|D_route)
6427 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6428 addr->dupof = tnode->data.ptr;
6429 addr->next = addr_duplicate;
6430 addr_duplicate = addr;
6434 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6436 /* Check for previous delivery */
6438 if (tree_search(tree_nonrecipients, addr->unique))
6440 DEBUG(D_deliver|D_route)
6441 debug_printf("%s was previously delivered: discarded\n", addr->address);
6442 child_done(addr, tod_stamp(tod_log));
6446 /* Save for checking future duplicates */
6448 tree_add_duplicate(addr->unique, addr);
6450 /* Set local part and domain */
6452 addr->local_part = addr->address;
6453 addr->domain = addr->parent->domain;
6455 /* Ensure that the delivery is permitted. */
6457 if (testflag(addr, af_file))
6459 if (!testflag(addr, af_allow_file))
6461 addr->basic_errno = ERRNO_FORBIDFILE;
6462 addr->message = US"delivery to file forbidden";
6463 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6464 continue; /* with the next new address */
6467 else if (addr->address[0] == '|')
6469 if (!testflag(addr, af_allow_pipe))
6471 addr->basic_errno = ERRNO_FORBIDPIPE;
6472 addr->message = US"delivery to pipe forbidden";
6473 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6474 continue; /* with the next new address */
6477 else if (!testflag(addr, af_allow_reply))
6479 addr->basic_errno = ERRNO_FORBIDREPLY;
6480 addr->message = US"autoreply forbidden";
6481 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6482 continue; /* with the next new address */
6485 /* If the errno field is already set to BADTRANSPORT, it indicates
6486 failure to expand a transport string, or find the associated transport,
6487 or an unset transport when one is required. Leave this test till now so
6488 that the forbid errors are given in preference. */
6490 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6492 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6496 /* Treat /dev/null as a special case and abandon the delivery. This
6497 avoids having to specify a uid on the transport just for this case.
6498 Arrange for the transport name to be logged as "**bypassed**". */
6500 if (Ustrcmp(addr->address, "/dev/null") == 0)
6502 uschar *save = addr->transport->name;
6503 addr->transport->name = US"**bypassed**";
6504 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6505 addr->transport->name = save;
6506 continue; /* with the next new address */
6509 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6512 DEBUG(D_deliver|D_route)
6513 debug_printf("queued for %s transport\n", addr->transport->name);
6514 addr->next = addr_local;
6516 continue; /* with the next new address */
6519 /* Handle normal addresses. First, split up into local part and domain,
6520 handling the %-hack if necessary. There is the possibility of a defer from
6521 a lookup in percent_hack_domains. */
6523 if ((rc = deliver_split_address(addr)) == DEFER)
6525 addr->message = US"cannot check percent_hack_domains";
6526 addr->basic_errno = ERRNO_LISTDEFER;
6527 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6531 /* Check to see if the domain is held. If so, proceed only if the
6532 delivery was forced by hand. */
6534 deliver_domain = addr->domain; /* set $domain */
6535 if ( !forced && hold_domains
6536 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6537 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6543 addr->message = US"hold_domains lookup deferred";
6544 addr->basic_errno = ERRNO_LISTDEFER;
6548 addr->message = US"domain is held";
6549 addr->basic_errno = ERRNO_HELD;
6551 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6555 /* Now we can check for duplicates and previously delivered addresses. In
6556 order to do this, we have to generate a "unique" value for each address,
6557 because there may be identical actual addresses in a line of descendents.
6558 The "unique" field is initialized to the same value as the "address" field,
6559 but gets changed here to cope with identically-named descendents. */
6561 for (parent = addr->parent; parent; parent = parent->parent)
6562 if (strcmpic(addr->address, parent->address) == 0) break;
6564 /* If there's an ancestor with the same name, set the homonym flag. This
6565 influences how deliveries are recorded. Then add a prefix on the front of
6566 the unique address. We use \n\ where n starts at 0 and increases each time.
6567 It is unlikely to pass 9, but if it does, it may look odd but will still
6568 work. This means that siblings or cousins with the same names are treated
6569 as duplicates, which is what we want. */
6573 setflag(addr, af_homonym);
6574 if (parent->unique[0] != '\\')
6575 addr->unique = string_sprintf("\\0\\%s", addr->address);
6577 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6581 /* Ensure that the domain in the unique field is lower cased, because
6582 domains are always handled caselessly. */
6584 p = Ustrrchr(addr->unique, '@');
6585 while (*p != 0) { *p = tolower(*p); p++; }
6587 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6589 if (tree_search(tree_nonrecipients, addr->unique))
6591 DEBUG(D_deliver|D_route)
6592 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6593 child_done(addr, tod_stamp(tod_log));
6597 /* Get the routing retry status, saving the two retry keys (with and
6598 without the local part) for subsequent use. If there is no retry record for
6599 the standard address routing retry key, we look for the same key with the
6600 sender attached, because this form is used by the smtp transport after a
6601 4xx response to RCPT when address_retry_include_sender is true. */
6603 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6604 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6609 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6610 if ( domain_retry_record
6611 && now - domain_retry_record->time_stamp > retry_data_expire
6614 DEBUG(D_deliver|D_retry)
6615 debug_printf("domain retry record present but expired\n");
6616 domain_retry_record = NULL; /* Ignore if too old */
6619 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6620 if ( address_retry_record
6621 && now - address_retry_record->time_stamp > retry_data_expire
6624 DEBUG(D_deliver|D_retry)
6625 debug_printf("address retry record present but expired\n");
6626 address_retry_record = NULL; /* Ignore if too old */
6629 if (!address_retry_record)
6631 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6633 address_retry_record = dbfn_read(dbm_file, altkey);
6634 if ( address_retry_record
6635 && now - address_retry_record->time_stamp > retry_data_expire)
6637 DEBUG(D_deliver|D_retry)
6638 debug_printf("address<sender> retry record present but expired\n");
6639 address_retry_record = NULL; /* Ignore if too old */
6644 domain_retry_record = address_retry_record = NULL;
6646 DEBUG(D_deliver|D_retry)
6648 if (!domain_retry_record)
6649 debug_printf("no domain retry record\n");
6651 debug_printf("have domain retry record; next_try = now%+d\n",
6652 f.running_in_test_harness ? 0 :
6653 (int)(domain_retry_record->next_try - now));
6655 if (!address_retry_record)
6656 debug_printf("no address retry record\n");
6658 debug_printf("have address retry record; next_try = now%+d\n",
6659 f.running_in_test_harness ? 0 :
6660 (int)(address_retry_record->next_try - now));
6663 /* If we are sending a message down an existing SMTP connection, we must
6664 assume that the message which created the connection managed to route
6665 an address to that connection. We do not want to run the risk of taking
6666 a long time over routing here, because if we do, the server at the other
6667 end of the connection may time it out. This is especially true for messages
6668 with lots of addresses. For this kind of delivery, queue_running is not
6669 set, so we would normally route all addresses. We take a pragmatic approach
6670 and defer routing any addresses that have any kind of domain retry record.
6671 That is, we don't even look at their retry times. It doesn't matter if this
6672 doesn't work occasionally. This is all just an optimization, after all.
6674 The reason for not doing the same for address retries is that they normally
6675 arise from 4xx responses, not DNS timeouts. */
6677 if (continue_hostname && domain_retry_record)
6679 addr->message = US"reusing SMTP connection skips previous routing defer";
6680 addr->basic_errno = ERRNO_RRETRY;
6681 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6683 addr->message = domain_retry_record->text;
6684 setflag(addr, af_pass_message);
6687 /* If we are in a queue run, defer routing unless there is no retry data or
6688 we've passed the next retry time, or this message is forced. In other
6689 words, ignore retry data when not in a queue run.
6691 However, if the domain retry time has expired, always allow the routing
6692 attempt. If it fails again, the address will be failed. This ensures that
6693 each address is routed at least once, even after long-term routing
6696 If there is an address retry, check that too; just wait for the next
6697 retry time. This helps with the case when the temporary error on the
6698 address was really message-specific rather than address specific, since
6699 it allows other messages through.
6701 We also wait for the next retry time if this is a message sent down an
6702 existing SMTP connection (even though that will be forced). Otherwise there
6703 will be far too many attempts for an address that gets a 4xx error. In
6704 fact, after such an error, we should not get here because, the host should
6705 not be remembered as one this message needs. However, there was a bug that
6706 used to cause this to happen, so it is best to be on the safe side.
6708 Even if we haven't reached the retry time in the hints, there is one more
6709 check to do, which is for the ultimate address timeout. We only do this
6710 check if there is an address retry record and there is not a domain retry
6711 record; this implies that previous attempts to handle the address had the
6712 retry_use_local_parts option turned on. We use this as an approximation
6713 for the destination being like a local delivery, for example delivery over
6714 LMTP to an IMAP message store. In this situation users are liable to bump
6715 into their quota and thereby have intermittently successful deliveries,
6716 which keep the retry record fresh, which can lead to us perpetually
6717 deferring messages. */
6719 else if ( ( f.queue_running && !f.deliver_force
6720 || continue_hostname
6722 && ( ( domain_retry_record
6723 && now < domain_retry_record->next_try
6724 && !domain_retry_record->expired
6726 || ( address_retry_record
6727 && now < address_retry_record->next_try
6729 && ( domain_retry_record
6730 || !address_retry_record
6731 || !retry_ultimate_address_timeout(addr->address_retry_key,
6732 addr->domain, address_retry_record, now)
6735 addr->message = US"retry time not reached";
6736 addr->basic_errno = ERRNO_RRETRY;
6737 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6739 /* For remote-retry errors (here and just above) that we've not yet
6740 hit the retry time, use the error recorded in the retry database
6741 as info in the warning message. This lets us send a message even
6742 when we're not failing on a fresh attempt. We assume that this
6743 info is not sensitive. */
6745 addr->message = domain_retry_record
6746 ? domain_retry_record->text : address_retry_record->text;
6747 setflag(addr, af_pass_message);
6750 /* The domain is OK for routing. Remember if retry data exists so it
6751 can be cleaned up after a successful delivery. */
6755 if (domain_retry_record || address_retry_record)
6756 setflag(addr, af_dr_retry_exists);
6757 addr->next = addr_route;
6759 DEBUG(D_deliver|D_route)
6760 debug_printf("%s: queued for routing\n", addr->address);
6764 /* The database is closed while routing is actually happening. Requests to
6765 update it are put on a chain and all processed together at the end. */
6767 if (dbm_file) dbfn_close(dbm_file);
6769 /* If queue_domains is set, we don't even want to try routing addresses in
6770 those domains. During queue runs, queue_domains is forced to be unset.
6771 Optimize by skipping this pass through the addresses if nothing is set. */
6773 if (!f.deliver_force && queue_domains)
6775 address_item *okaddr = NULL;
6778 address_item *addr = addr_route;
6779 addr_route = addr->next;
6781 deliver_domain = addr->domain; /* set $domain */
6782 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6783 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6787 addr->basic_errno = ERRNO_LISTDEFER;
6788 addr->message = US"queue_domains lookup deferred";
6789 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6793 addr->next = okaddr;
6798 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6799 addr->message = US"domain is in queue_domains";
6800 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6804 addr_route = okaddr;
6807 /* Now route those addresses that are not deferred. */
6812 address_item *addr = addr_route;
6813 const uschar *old_domain = addr->domain;
6814 uschar *old_unique = addr->unique;
6815 addr_route = addr->next;
6818 /* Just in case some router parameter refers to it. */
6820 if (!(return_path = addr->prop.errors_address))
6821 return_path = sender_address;
6823 /* If a router defers an address, add a retry item. Whether or not to
6824 use the local part in the key is a property of the router. */
6826 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6827 &addr_succeed, v_none)) == DEFER)
6828 retry_add_item(addr,
6829 addr->router->retry_use_local_part
6830 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6831 : string_sprintf("R:%s", addr->domain),
6834 /* Otherwise, if there is an existing retry record in the database, add
6835 retry items to delete both forms. We must also allow for the possibility
6836 of a routing retry that includes the sender address. Since the domain might
6837 have been rewritten (expanded to fully qualified) as a result of routing,
6838 ensure that the rewritten form is also deleted. */
6840 else if (testflag(addr, af_dr_retry_exists))
6842 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6844 retry_add_item(addr, altkey, rf_delete);
6845 retry_add_item(addr, addr->address_retry_key, rf_delete);
6846 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6847 if (Ustrcmp(addr->domain, old_domain) != 0)
6848 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6851 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6852 logged, but we need to ensure the address (and maybe parents) is marked
6857 address_done(addr, tod_stamp(tod_log));
6858 continue; /* route next address */
6861 /* The address is finished with (failed or deferred). */
6865 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6866 continue; /* route next address */
6869 /* The address has been routed. If the router changed the domain, it will
6870 also have changed the unique address. We have to test whether this address
6871 has already been delivered, because it's the unique address that finally
6874 if ( addr->unique != old_unique
6875 && tree_search(tree_nonrecipients, addr->unique) != 0
6878 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6879 "discarded\n", addr->address);
6880 if (addr_remote == addr) addr_remote = addr->next;
6881 else if (addr_local == addr) addr_local = addr->next;
6884 /* If the router has same_domain_copy_routing set, we are permitted to copy
6885 the routing for any other addresses with the same domain. This is an
6886 optimisation to save repeated DNS lookups for "standard" remote domain
6887 routing. The option is settable only on routers that generate host lists.
6888 We play it very safe, and do the optimization only if the address is routed
6889 to a remote transport, there are no header changes, and the domain was not
6890 modified by the router. */
6892 if ( addr_remote == addr
6893 && addr->router->same_domain_copy_routing
6894 && !addr->prop.extra_headers
6895 && !addr->prop.remove_headers
6896 && old_domain == addr->domain
6899 address_item **chain = &addr_route;
6902 address_item *addr2 = *chain;
6903 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6905 chain = &(addr2->next);
6909 /* Found a suitable address; take it off the routing list and add it to
6910 the remote delivery list. */
6912 *chain = addr2->next;
6913 addr2->next = addr_remote;
6914 addr_remote = addr2;
6916 /* Copy the routing data */
6918 addr2->domain = addr->domain;
6919 addr2->router = addr->router;
6920 addr2->transport = addr->transport;
6921 addr2->host_list = addr->host_list;
6922 addr2->fallback_hosts = addr->fallback_hosts;
6923 addr2->prop.errors_address = addr->prop.errors_address;
6924 copyflag(addr2, addr, af_hide_child);
6925 copyflag(addr2, addr, af_local_host_removed);
6927 DEBUG(D_deliver|D_route)
6928 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6930 "Routing for %s copied from %s\n",
6931 addr2->address, addr2->address, addr->address);
6934 } /* Continue with routing the next address. */
6935 } /* Loop to process any child addresses that the routers created, and
6936 any rerouted addresses that got put back on the new chain. */
6939 /* Debugging: show the results of the routing */
6941 DEBUG(D_deliver|D_retry|D_route)
6943 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6944 debug_printf("After routing:\n Local deliveries:\n");
6945 for (address_item * p = addr_local; p; p = p->next)
6946 debug_printf(" %s\n", p->address);
6948 debug_printf(" Remote deliveries:\n");
6949 for (address_item * p = addr_remote; p; p = p->next)
6950 debug_printf(" %s\n", p->address);
6952 debug_printf(" Failed addresses:\n");
6953 for (address_item * p = addr_failed; p; p = p->next)
6954 debug_printf(" %s\n", p->address);
6956 debug_printf(" Deferred addresses:\n");
6957 for (address_item * p = addr_defer; p; p = p->next)
6958 debug_printf(" %s\n", p->address);
6961 /* Free any resources that were cached during routing. */
6966 /* These two variables are set only during routing, after check_local_user.
6967 Ensure they are not set in transports. */
6969 local_user_gid = (gid_t)(-1);
6970 local_user_uid = (uid_t)(-1);
6972 /* Check for any duplicate addresses. This check is delayed until after
6973 routing, because the flexibility of the routing configuration means that
6974 identical addresses with different parentage may end up being redirected to
6975 different addresses. Checking for duplicates too early (as we previously used
6976 to) makes this kind of thing not work. */
6978 do_duplicate_check(&addr_local);
6979 do_duplicate_check(&addr_remote);
6981 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6982 remote transport. The check that they all end up in one transaction happens in
6983 the do_remote_deliveries() function. */
6986 && (addr_local || addr_failed || addr_defer)
6990 uschar *which, *colon, *msg;
6997 else if (addr_defer)
7000 which = US"deferred";
7008 while (addr->parent) addr = addr->parent;
7013 msg = addr->message;
7015 else colon = msg = US"";
7017 /* We don't need to log here for a forced failure as it will already
7018 have been logged. Defer will also have been logged, but as a defer, so we do
7019 need to do the failure logging. */
7021 if (addr != addr_failed)
7022 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7023 addr->address, which);
7025 /* Always write an error to the caller */
7027 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7030 final_yield = DELIVER_MUA_FAILED;
7031 addr_failed = addr_defer = NULL; /* So that we remove the message */
7032 goto DELIVERY_TIDYUP;
7036 /* If this is a run to continue deliveries to an external channel that is
7037 already set up, defer any local deliveries. */
7039 if (continue_transport)
7043 address_item *addr = addr_defer;
7044 while (addr->next) addr = addr->next;
7045 addr->next = addr_local;
7048 addr_defer = addr_local;
7053 /* Because address rewriting can happen in the routers, we should not really do
7054 ANY deliveries until all addresses have been routed, so that all recipients of
7055 the message get the same headers. However, this is in practice not always
7056 possible, since sometimes remote addresses give DNS timeouts for days on end.
7057 The pragmatic approach is to deliver what we can now, saving any rewritten
7058 headers so that at least the next lot of recipients benefit from the rewriting
7059 that has already been done.
7061 If any headers have been rewritten during routing, update the spool file to
7062 remember them for all subsequent deliveries. This can be delayed till later if
7063 there is only address to be delivered - if it succeeds the spool write need not
7066 if ( f.header_rewritten
7067 && ( addr_local && (addr_local->next || addr_remote)
7068 || addr_remote && addr_remote->next
7071 /* Panic-dies on error */
7072 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7073 f.header_rewritten = FALSE;
7077 /* If there are any deliveries to do and we do not already have the journal
7078 file, create it. This is used to record successful deliveries as soon as
7079 possible after each delivery is known to be complete. A file opened with
7080 O_APPEND is used so that several processes can run simultaneously.
7082 The journal is just insurance against crashes. When the spool file is
7083 ultimately updated at the end of processing, the journal is deleted. If a
7084 journal is found to exist at the start of delivery, the addresses listed
7085 therein are added to the non-recipients. */
7087 if (addr_local || addr_remote)
7091 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7093 if ((journal_fd = Uopen(fname,
7097 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7099 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7100 fname, strerror(errno));
7101 return DELIVER_NOT_ATTEMPTED;
7104 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7105 that the mode is correct - the group setting doesn't always seem to get
7106 set automatically. */
7108 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7109 || fchmod(journal_fd, SPOOL_MODE)
7111 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7115 int ret = Uunlink(fname);
7116 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7117 fname, strerror(errno));
7118 if(ret && errno != ENOENT)
7119 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7120 fname, strerror(errno));
7121 return DELIVER_NOT_ATTEMPTED;
7125 else if (journal_fd >= 0)
7133 /* Now we can get down to the business of actually doing deliveries. Local
7134 deliveries are done first, then remote ones. If ever the problems of how to
7135 handle fallback transports are figured out, this section can be put into a loop
7136 for handling fallbacks, though the uid switching will have to be revised. */
7138 /* Precompile a regex that is used to recognize a parameter in response
7139 to an LHLO command, if is isn't already compiled. This may be used on both
7140 local and remote LMTP deliveries. */
7142 if (!regex_IGNOREQUOTA)
7144 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7146 /* Handle local deliveries */
7150 DEBUG(D_deliver|D_transport)
7151 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7152 do_local_deliveries();
7153 f.disable_logging = FALSE;
7156 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7157 so just queue them all. */
7159 if (f.queue_run_local)
7162 address_item *addr = addr_remote;
7163 addr_remote = addr->next;
7165 addr->basic_errno = ERRNO_LOCAL_ONLY;
7166 addr->message = US"remote deliveries suppressed";
7167 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7170 /* Handle remote deliveries */
7174 DEBUG(D_deliver|D_transport)
7175 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7177 /* Precompile some regex that are used to recognize parameters in response
7178 to an EHLO command, if they aren't already compiled. */
7180 smtp_deliver_init();
7182 /* Now sort the addresses if required, and do the deliveries. The yield of
7183 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7184 cannot be delivered in one transaction. */
7186 if (remote_sort_domains) sort_remote_deliveries();
7187 if (!do_remote_deliveries(FALSE))
7189 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7190 "be delivered in one transaction");
7191 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7193 final_yield = DELIVER_MUA_FAILED;
7194 addr_failed = addr_defer = NULL; /* So that we remove the message */
7195 goto DELIVERY_TIDYUP;
7198 /* See if any of the addresses that failed got put on the queue for delivery
7199 to their fallback hosts. We do it this way because often the same fallback
7200 host is used for many domains, so all can be sent in a single transaction
7201 (if appropriately configured). */
7203 if (addr_fallback && !mua_wrapper)
7205 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7206 addr_remote = addr_fallback;
7207 addr_fallback = NULL;
7208 if (remote_sort_domains) sort_remote_deliveries();
7209 do_remote_deliveries(TRUE);
7211 f.disable_logging = FALSE;
7215 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7216 phase, to minimize cases of half-done things. */
7219 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7220 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7222 /* Root privilege is no longer needed */
7224 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7226 set_process_info("tidying up after delivering %s", message_id);
7227 signal(SIGTERM, SIG_IGN);
7229 /* When we are acting as an MUA wrapper, the smtp transport will either have
7230 succeeded for all addresses, or failed them all in normal cases. However, there
7231 are some setup situations (e.g. when a named port does not exist) that cause an
7232 immediate exit with deferral of all addresses. Convert those into failures. We
7233 do not ever want to retry, nor do we want to send a bounce message. */
7239 address_item * nextaddr;
7240 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7242 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7243 "delivery", addr->address);
7244 nextaddr = addr->next;
7245 addr->next = addr_failed;
7251 /* Now all should either have succeeded or failed. */
7254 final_yield = DELIVER_MUA_SUCCEEDED;
7258 uschar *s = addr_failed->user_message;
7260 if (!s) s = addr_failed->message;
7262 fprintf(stderr, "Delivery failed: ");
7263 if (addr_failed->basic_errno > 0)
7265 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7266 if (s) fprintf(stderr, ": ");
7268 if ((host = addr_failed->host_used))
7269 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7271 fprintf(stderr, "%s", CS s);
7272 else if (addr_failed->basic_errno <= 0)
7273 fprintf(stderr, "unknown error");
7274 fprintf(stderr, "\n");
7276 final_yield = DELIVER_MUA_FAILED;
7281 /* In a normal configuration, we now update the retry database. This is done in
7282 one fell swoop at the end in order not to keep opening and closing (and
7283 locking) the database. The code for handling retries is hived off into a
7284 separate module for convenience. We pass it the addresses of the various
7285 chains, because deferred addresses can get moved onto the failed chain if the
7286 retry cutoff time has expired for all alternative destinations. Bypass the
7287 updating of the database if the -N flag is set, which is a debugging thing that
7288 prevents actual delivery. */
7290 else if (!f.dont_deliver)
7291 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7293 /* Send DSN for successful messages if requested */
7294 addr_senddsn = NULL;
7296 for (address_item * a = addr_succeed; a; a = a->next)
7298 /* af_ignore_error not honored here. it's not an error */
7299 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7300 "DSN: processing successful delivery address: %s\n"
7301 "DSN: Sender_address: %s\n"
7302 "DSN: orcpt: %s flags: 0x%x\n"
7303 "DSN: envid: %s ret: %d\n"
7304 "DSN: Final recipient: %s\n"
7305 "DSN: Remote SMTP server supports DSN: %d\n",
7306 a->router ? a->router->name : US"(unknown)",
7309 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7311 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7316 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7317 and a report was requested */
7319 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7320 && a->dsn_flags & rf_notify_success
7323 /* copy and relink address_item and send report with all of them at once later */
7324 address_item * addr_next = addr_senddsn;
7325 addr_senddsn = store_get(sizeof(address_item), FALSE);
7327 addr_senddsn->next = addr_next;
7330 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7338 /* create exim process to send message */
7339 pid = child_open_exim(&fd, US"DSN");
7341 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7343 if (pid < 0) /* Creation of child failed */
7345 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7346 "create child process to send success-dsn message: %s", getpid(),
7347 getppid(), strerror(errno));
7349 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7351 else /* Creation of child succeeded */
7353 FILE * f = fdopen(fd, "wb");
7354 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7356 transport_ctx tctx = {{0}};
7359 debug_printf("sending success-dsn to: %s\n", sender_address);
7361 /* build unique id for MIME boundary */
7362 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7363 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7365 if (errors_reply_to)
7366 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7369 fprintf(f, "Auto-Submitted: auto-generated\n"
7371 "Subject: Delivery Status Notification\n",
7373 moan_write_references(f, NULL);
7374 fprintf(f, "Content-Type: multipart/report;"
7375 " report-type=delivery-status; boundary=%s\n"
7376 "MIME-Version: 1.0\n\n"
7379 "Content-type: text/plain; charset=us-ascii\n\n"
7381 "This message was created automatically by mail delivery software.\n"
7382 " ----- The following addresses had successful delivery notifications -----\n",
7385 for (address_item * a = addr_senddsn; a; a = a->next)
7386 fprintf(f, "<%s> (relayed %s)\n\n",
7388 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7389 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7390 : "via non \"Remote SMTP\" router"
7394 "Content-type: message/delivery-status\n\n"
7395 "Reporting-MTA: dns; %s\n",
7396 bound, smtp_active_hostname);
7399 { /* must be decoded from xtext: see RFC 3461:6.3a */
7401 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7402 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7404 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7408 for (address_item * a = addr_senddsn; a; a = a->next)
7412 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7414 if ((hu = a->host_used) && hu->name)
7415 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7418 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7419 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7422 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7425 transport_filter_argv = NULL; /* Just in case */
7426 return_path = sender_address; /* In case not previously set */
7428 /* Write the original email out */
7431 tctx.options = topt_add_return_path | topt_no_body;
7432 /*XXX hmm, FALSE(fail) retval ignored.
7433 Could error for any number of reasons, and they are not handled. */
7434 transport_write_message(&tctx, 0);
7437 fprintf(f,"\n--%s--\n", bound);
7441 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7445 /* If any addresses failed, we must send a message to somebody, unless
7446 af_ignore_error is set, in which case no action is taken. It is possible for
7447 several messages to get sent if there are addresses with different
7454 uschar *logtod = tod_stamp(tod_log);
7456 address_item *handled_addr = NULL;
7457 address_item **paddr;
7458 address_item *msgchain = NULL;
7459 address_item **pmsgchain = &msgchain;
7461 /* There are weird cases when logging is disabled in the transport. However,
7462 there may not be a transport (address failed by a router). */
7464 f.disable_logging = FALSE;
7465 if (addr_failed->transport)
7466 f.disable_logging = addr_failed->transport->disable_logging;
7469 debug_printf("processing failed address %s\n", addr_failed->address);
7471 /* There are only two ways an address in a bounce message can get here:
7473 (1) When delivery was initially deferred, but has now timed out (in the call
7474 to retry_update() above). We can detect this by testing for
7475 af_retry_timedout. If the address does not have its own errors address,
7476 we arrange to ignore the error.
7478 (2) If delivery failures for bounce messages are being ignored. We can detect
7479 this by testing for af_ignore_error. This will also be set if a bounce
7480 message has been autothawed and the ignore_bounce_errors_after time has
7481 passed. It might also be set if a router was explicitly configured to
7482 ignore errors (errors_to = "").
7484 If neither of these cases obtains, something has gone wrong. Log the
7485 incident, but then ignore the error. */
7487 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7489 if ( !testflag(addr_failed, af_retry_timedout)
7490 && !addr_failed->prop.ignore_error)
7491 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7492 "failure is neither frozen nor ignored (it's been ignored)");
7494 addr_failed->prop.ignore_error = TRUE;
7497 /* If the first address on the list has af_ignore_error set, just remove
7498 it from the list, throw away any saved message file, log it, and
7499 mark the recipient done. */
7501 if ( addr_failed->prop.ignore_error
7502 || addr_failed->dsn_flags & rf_dsnflags
7503 && !(addr_failed->dsn_flags & rf_notify_failure)
7507 addr_failed = addr->next;
7508 if (addr->return_filename) Uunlink(addr->return_filename);
7510 #ifndef DISABLE_EVENT
7511 msg_event_raise(US"msg:fail:delivery", addr);
7513 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7515 !addr->parent ? US"" : US" <",
7516 !addr->parent ? US"" : addr->parent->address,
7517 !addr->parent ? US"" : US">",
7518 addr->prop.ignore_error
7519 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7521 address_done(addr, logtod);
7522 child_done(addr, logtod);
7523 /* Panic-dies on error */
7524 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7527 /* Otherwise, handle the sending of a message. Find the error address for
7528 the first address, then send a message that includes all failed addresses
7529 that have the same error address. Note the bounce_recipient is a global so
7530 that it can be accessed by $bounce_recipient while creating a customized
7535 if (!(bounce_recipient = addr_failed->prop.errors_address))
7536 bounce_recipient = sender_address;
7538 /* Make a subprocess to send a message */
7540 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7541 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7542 "create child process to send failure message: %s", getpid(),
7543 getppid(), strerror(errno));
7545 /* Creation of child succeeded */
7552 uschar *bcc, *emf_text;
7553 FILE * fp = fdopen(fd, "wb");
7555 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7556 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7557 DELIVER_IN_BUFFER_SIZE;
7559 uschar *dsnlimitmsg;
7560 uschar *dsnnotifyhdr;
7564 debug_printf("sending error message to: %s\n", bounce_recipient);
7566 /* Scan the addresses for all that have the same errors address, removing
7567 them from the addr_failed chain, and putting them on msgchain. */
7569 paddr = &addr_failed;
7570 for (addr = addr_failed; addr; addr = *paddr)
7571 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7572 ? addr->prop.errors_address : sender_address) == 0)
7573 { /* The same - dechain */
7574 *paddr = addr->next;
7577 pmsgchain = &(addr->next);
7580 paddr = &addr->next; /* Not the same; skip */
7582 /* Include X-Failed-Recipients: for automatic interpretation, but do
7583 not let any one header line get too long. We do this by starting a
7584 new header every 50 recipients. Omit any addresses for which the
7585 "hide_child" flag is set. */
7587 for (addr = msgchain; addr; addr = addr->next)
7589 if (testflag(addr, af_hide_child)) continue;
7597 ? "X-Failed-Recipients: "
7599 testflag(addr, af_pfr) && addr->parent
7600 ? string_printing(addr->parent->address)
7601 : string_printing(addr->address));
7603 if (rcount > 0) fprintf(fp, "\n");
7605 /* Output the standard headers */
7607 if (errors_reply_to)
7608 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7609 fprintf(fp, "Auto-Submitted: auto-replied\n");
7610 moan_write_from(fp);
7611 fprintf(fp, "To: %s\n", bounce_recipient);
7612 moan_write_references(fp, NULL);
7614 /* generate boundary string and output MIME-Headers */
7615 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7617 fprintf(fp, "Content-Type: multipart/report;"
7618 " report-type=delivery-status; boundary=%s\n"
7619 "MIME-Version: 1.0\n",
7622 /* Open a template file if one is provided. Log failure to open, but
7623 carry on - default texts will be used. */
7625 if (bounce_message_file)
7626 if (!(emf = Ufopen(bounce_message_file, "rb")))
7627 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7628 "message texts: %s", bounce_message_file, strerror(errno));
7630 /* Quietly copy to configured additional addresses if required. */
7632 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7633 fprintf(fp, "Bcc: %s\n", bcc);
7635 /* The texts for the message can be read from a template file; if there
7636 isn't one, or if it is too short, built-in texts are used. The first
7637 emf text is a Subject: and any other headers. */
7639 if ((emf_text = next_emf(emf, US"header")))
7640 fprintf(fp, "%s\n", emf_text);
7642 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7643 to_sender? ": returning message to sender" : "");
7645 /* output human readable part as text/plain section */
7646 fprintf(fp, "--%s\n"
7647 "Content-type: text/plain; charset=us-ascii\n\n",
7650 if ((emf_text = next_emf(emf, US"intro")))
7651 fprintf(fp, "%s", CS emf_text);
7655 /* This message has been reworded several times. It seems to be confusing to
7656 somebody, however it is worded. I have retreated to the original, simple
7658 "This message was created automatically by mail delivery software.\n");
7660 if (bounce_message_text)
7661 fprintf(fp, "%s", CS bounce_message_text);
7664 "\nA message that you sent could not be delivered to one or more of its\n"
7665 "recipients. This is a permanent error. The following address(es) failed:\n");
7668 "\nA message sent by\n\n <%s>\n\n"
7669 "could not be delivered to one or more of its recipients. The following\n"
7670 "address(es) failed:\n", sender_address);
7674 /* Process the addresses, leaving them on the msgchain if they have a
7675 file name for a return message. (There has already been a check in
7676 post_process_one() for the existence of data in the message file.) A TRUE
7677 return from print_address_information() means that the address is not
7681 for (addr = msgchain; addr; addr = *paddr)
7683 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7684 print_address_error(addr, fp, US"");
7686 /* End the final line for the address */
7690 /* Leave on msgchain if there's a return file. */
7692 if (addr->return_file >= 0)
7694 paddr = &(addr->next);
7698 /* Else save so that we can tick off the recipient when the
7703 *paddr = addr->next;
7704 addr->next = handled_addr;
7705 handled_addr = addr;
7711 /* Get the next text, whether we need it or not, so as to be
7712 positioned for the one after. */
7714 emf_text = next_emf(emf, US"generated text");
7716 /* If there were any file messages passed by the local transports,
7717 include them in the message. Then put the address on the handled chain.
7718 In the case of a batch of addresses that were all sent to the same
7719 transport, the return_file field in all of them will contain the same
7720 fd, and the return_filename field in the *last* one will be set (to the
7721 name of the file). */
7725 address_item *nextaddr;
7728 fprintf(fp, "%s", CS emf_text);
7731 "The following text was generated during the delivery "
7732 "attempt%s:\n", (filecount > 1)? "s" : "");
7734 for (addr = msgchain; addr; addr = nextaddr)
7737 address_item *topaddr = addr;
7739 /* List all the addresses that relate to this file */
7742 while(addr) /* Insurance */
7744 print_address_information(addr, fp, US"------ ", US"\n ",
7746 if (addr->return_filename) break;
7751 /* Now copy the file */
7753 if (!(fm = Ufopen(addr->return_filename, "rb")))
7754 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7758 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7761 Uunlink(addr->return_filename);
7763 /* Can now add to handled chain, first fishing off the next
7764 address on the msgchain. */
7766 nextaddr = addr->next;
7767 addr->next = handled_addr;
7768 handled_addr = topaddr;
7773 /* output machine readable part */
7775 if (message_smtputf8)
7776 fprintf(fp, "--%s\n"
7777 "Content-type: message/global-delivery-status\n\n"
7778 "Reporting-MTA: dns; %s\n",
7779 bound, smtp_active_hostname);
7782 fprintf(fp, "--%s\n"
7783 "Content-type: message/delivery-status\n\n"
7784 "Reporting-MTA: dns; %s\n",
7785 bound, smtp_active_hostname);
7789 /* must be decoded from xtext: see RFC 3461:6.3a */
7791 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7792 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7794 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7798 for (addr = handled_addr; addr; addr = addr->next)
7802 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7804 if ((hu = addr->host_used) && hu->name)
7806 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7807 #ifdef EXPERIMENTAL_DSN_INFO
7812 uschar * p = hu->port == 25
7813 ? US"" : string_sprintf(":%d", hu->port);
7814 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7816 if ((s = addr->smtp_greeting) && *s)
7817 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7818 if ((s = addr->helo_response) && *s)
7819 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7820 if ((s = addr->message) && *s)
7821 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7824 print_dsn_diagnostic_code(addr, fp);
7829 /* Now copy the message, trying to give an intelligible comment if
7830 it is too long for it all to be copied. The limit isn't strictly
7831 applied because of the buffering. There is, however, an option
7832 to suppress copying altogether. */
7834 emf_text = next_emf(emf, US"copy");
7837 we ignore the intro text from template and add
7838 the text for bounce_return_size_limit at the end.
7840 bounce_return_message is ignored
7841 in case RET= is defined we honor these values
7842 otherwise bounce_return_body is honored.
7844 bounce_return_size_limit is always honored.
7847 fprintf(fp, "--%s\n", bound);
7849 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7850 dsnnotifyhdr = NULL;
7851 topt = topt_add_return_path;
7853 /* RET=HDRS? top priority */
7854 if (dsn_ret == dsn_ret_hdrs)
7855 topt |= topt_no_body;
7858 struct stat statbuf;
7860 /* no full body return at all? */
7861 if (!bounce_return_body)
7863 topt |= topt_no_body;
7864 /* add header if we overrule RET=FULL */
7865 if (dsn_ret == dsn_ret_full)
7866 dsnnotifyhdr = dsnlimitmsg;
7868 /* line length limited... return headers only if oversize */
7869 /* size limited ... return headers only if limit reached */
7870 else if ( max_received_linelength > bounce_return_linesize_limit
7871 || ( bounce_return_size_limit > 0
7872 && fstat(deliver_datafile, &statbuf) == 0
7873 && statbuf.st_size > max
7876 topt |= topt_no_body;
7877 dsnnotifyhdr = dsnlimitmsg;
7882 if (message_smtputf8)
7883 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7884 : "Content-type: message/global\n\n",
7888 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7889 : "Content-type: message/rfc822\n\n",
7893 transport_filter_argv = NULL; /* Just in case */
7894 return_path = sender_address; /* In case not previously set */
7895 { /* Dummy transport for headers add */
7896 transport_ctx tctx = {{0}};
7897 transport_instance tb = {0};
7899 tctx.u.fd = fileno(fp);
7901 tctx.options = topt;
7902 tb.add_headers = dsnnotifyhdr;
7904 /*XXX no checking for failure! buggy! */
7905 transport_write_message(&tctx, 0);
7909 /* we never add the final text. close the file */
7913 fprintf(fp, "\n--%s--\n", bound);
7915 /* Close the file, which should send an EOF to the child process
7916 that is receiving the message. Wait for it to finish. */
7919 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7921 /* If the process failed, there was some disaster in setting up the
7922 error message. Unless the message is very old, ensure that addr_defer
7923 is non-null, which will have the effect of leaving the message on the
7924 spool. The failed addresses will get tried again next time. However, we
7925 don't really want this to happen too often, so freeze the message unless
7926 there are some genuine deferred addresses to try. To do this we have
7927 to call spool_write_header() here, because with no genuine deferred
7928 addresses the normal code below doesn't get run. */
7933 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7935 addr_defer = (address_item *)(+1);
7936 f.deliver_freeze = TRUE;
7937 deliver_frozen_at = time(NULL);
7938 /* Panic-dies on error */
7939 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7942 deliver_msglog("Process failed (%d) when writing error message "
7943 "to %s%s", rc, bounce_recipient, s);
7944 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7945 "to %s%s", rc, bounce_recipient, s);
7948 /* The message succeeded. Ensure that the recipients that failed are
7949 now marked finished with on the spool and their parents updated. */
7953 for (addr = handled_addr; addr; addr = addr->next)
7955 address_done(addr, logtod);
7956 child_done(addr, logtod);
7958 /* Panic-dies on error */
7959 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7965 f.disable_logging = FALSE; /* In case left set */
7967 /* Come here from the mua_wrapper case if routing goes wrong */
7971 /* If there are now no deferred addresses, we are done. Preserve the
7972 message log if so configured, and we are using them. Otherwise, sling it.
7973 Then delete the message itself. */
7981 fname = spool_fname(US"msglog", message_subdir, id, US"");
7982 if (preserve_message_logs)
7985 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7987 if ((rc = Urename(fname, moname)) < 0)
7989 (void)directory_make(spool_directory,
7990 spool_sname(US"msglog.OLD", US""),
7991 MSGLOG_DIRECTORY_MODE, TRUE);
7992 rc = Urename(fname, moname);
7995 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7996 "msglog.OLD directory", fname);
7999 if (Uunlink(fname) < 0)
8000 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8001 fname, strerror(errno));
8004 /* Remove the two message files. */
8006 fname = spool_fname(US"input", message_subdir, id, US"-D");
8007 if (Uunlink(fname) < 0)
8008 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8009 fname, strerror(errno));
8010 fname = spool_fname(US"input", message_subdir, id, US"-H");
8011 if (Uunlink(fname) < 0)
8012 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8013 fname, strerror(errno));
8015 /* Log the end of this message, with queue time if requested. */
8017 if (LOGGING(queue_time_overall))
8018 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8020 log_write(0, LOG_MAIN, "Completed");
8022 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8023 f.deliver_freeze = FALSE;
8025 #ifndef DISABLE_EVENT
8026 (void) event_raise(event_action, US"msg:complete", NULL);
8030 /* If there are deferred addresses, we are keeping this message because it is
8031 not yet completed. Lose any temporary files that were catching output from
8032 pipes for any of the deferred addresses, handle one-time aliases, and see if
8033 the message has been on the queue for so long that it is time to send a warning
8034 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8035 have the same domain, we can set deliver_domain for the expansion of
8036 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8037 the parent's domain.
8039 If all the deferred addresses have an error number that indicates "retry time
8040 not reached", skip sending the warning message, because it won't contain the
8041 reason for the delay. It will get sent at the next real delivery attempt.
8042 Exception: for retries caused by a remote peer we use the error message
8043 store in the retry DB as the reason.
8044 However, if at least one address has tried, we'd better include all of them in
8047 If we can't make a process to send the message, don't worry.
8049 For mailing list expansions we want to send the warning message to the
8050 mailing list manager. We can't do a perfect job here, as some addresses may
8051 have different errors addresses, but if we take the errors address from
8052 each deferred address it will probably be right in most cases.
8054 If addr_defer == +1, it means there was a problem sending an error message
8055 for failed addresses, and there were no "real" deferred addresses. The value
8056 was set just to keep the message on the spool, so there is nothing to do here.
8059 else if (addr_defer != (address_item *)(+1))
8061 uschar *recipients = US"";
8062 BOOL want_warning_msg = FALSE;
8064 deliver_domain = testflag(addr_defer, af_pfr)
8065 ? addr_defer->parent->domain : addr_defer->domain;
8067 for (address_item * addr = addr_defer; addr; addr = addr->next)
8069 address_item *otaddr;
8071 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8075 const uschar *d = testflag(addr, af_pfr)
8076 ? addr->parent->domain : addr->domain;
8078 /* The domain may be unset for an address that has never been routed
8079 because the system filter froze the message. */
8081 if (!d || Ustrcmp(d, deliver_domain) != 0)
8082 deliver_domain = NULL;
8085 if (addr->return_filename) Uunlink(addr->return_filename);
8087 /* Handle the case of one-time aliases. If any address in the ancestry
8088 of this one is flagged, ensure it is in the recipients list, suitably
8089 flagged, and that its parent is marked delivered. */
8091 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8092 if (otaddr->onetime_parent) break;
8097 int t = recipients_count;
8099 for (i = 0; i < recipients_count; i++)
8101 uschar *r = recipients_list[i].address;
8102 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8103 if (Ustrcmp(otaddr->address, r) == 0) break;
8106 /* Didn't find the address already in the list, and did find the
8107 ultimate parent's address in the list, and they really are different
8108 (i.e. not from an identity-redirect). After adding the recipient,
8109 update the errors address in the recipients list. */
8111 if ( i >= recipients_count && t < recipients_count
8112 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8114 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8115 otaddr->address, otaddr->parent->address);
8116 receive_add_recipient(otaddr->address, t);
8117 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8118 tree_add_nonrecipient(otaddr->parent->address);
8119 update_spool = TRUE;
8123 /* Except for error messages, ensure that either the errors address for
8124 this deferred address or, if there is none, the sender address, is on the
8125 list of recipients for a warning message. */
8127 if (sender_address[0])
8129 uschar * s = addr->prop.errors_address;
8130 if (!s) s = sender_address;
8131 if (Ustrstr(recipients, s) == NULL)
8132 recipients = string_sprintf("%s%s%s", recipients,
8133 recipients[0] ? "," : "", s);
8137 /* Send a warning message if the conditions are right. If the condition check
8138 fails because of a lookup defer, there is nothing we can do. The warning
8139 is not sent. Another attempt will be made at the next delivery attempt (if
8142 if ( !f.queue_2stage
8144 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8145 || addr_defer->dsn_flags & rf_notify_delay
8147 && delay_warning[1] > 0
8148 && sender_address[0] != 0
8149 && ( !delay_warning_condition
8150 || expand_check_condition(delay_warning_condition,
8151 US"delay_warning", US"option")
8157 int queue_time = time(NULL) - received_time.tv_sec;
8159 queue_time = test_harness_fudged_queue_time(queue_time);
8161 /* See how many warnings we should have sent by now */
8163 for (count = 0; count < delay_warning[1]; count++)
8164 if (queue_time < delay_warning[count+2]) break;
8166 show_time = delay_warning[count+1];
8168 if (count >= delay_warning[1])
8171 int last_gap = show_time;
8172 if (count > 1) last_gap -= delay_warning[count];
8173 extra = (queue_time - delay_warning[count+1])/last_gap;
8174 show_time += last_gap * extra;
8180 debug_printf("time on queue = %s id %s addr %s\n",
8181 readconf_printtime(queue_time), message_id, addr_defer->address);
8182 debug_printf("warning counts: required %d done %d\n", count,
8186 /* We have computed the number of warnings there should have been by now.
8187 If there haven't been enough, send one, and up the count to what it should
8190 if (warning_count < count)
8194 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8200 FILE *f = fdopen(fd, "wb");
8202 transport_ctx tctx = {{0}};
8204 if (warn_message_file)
8205 if (!(wmf = Ufopen(warn_message_file, "rb")))
8206 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8207 "message texts: %s", warn_message_file, strerror(errno));
8209 warnmsg_recipients = recipients;
8210 warnmsg_delay = queue_time < 120*60
8211 ? string_sprintf("%d minutes", show_time/60)
8212 : string_sprintf("%d hours", show_time/3600);
8214 if (errors_reply_to)
8215 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8216 fprintf(f, "Auto-Submitted: auto-replied\n");
8218 fprintf(f, "To: %s\n", recipients);
8219 moan_write_references(f, NULL);
8221 /* generated boundary string and output MIME-Headers */
8222 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8224 fprintf(f, "Content-Type: multipart/report;"
8225 " report-type=delivery-status; boundary=%s\n"
8226 "MIME-Version: 1.0\n",
8229 if ((wmf_text = next_emf(wmf, US"header")))
8230 fprintf(f, "%s\n", wmf_text);
8232 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8233 message_id, warnmsg_delay);
8235 /* output human readable part as text/plain section */
8237 "Content-type: text/plain; charset=us-ascii\n\n",
8240 if ((wmf_text = next_emf(wmf, US"intro")))
8241 fprintf(f, "%s", CS wmf_text);
8245 "This message was created automatically by mail delivery software.\n");
8247 if (Ustrcmp(recipients, sender_address) == 0)
8249 "A message that you sent has not yet been delivered to one or more of its\n"
8250 "recipients after more than ");
8254 "A message sent by\n\n <%s>\n\n"
8255 "has not yet been delivered to one or more of its recipients after more than \n",
8258 fprintf(f, "%s on the queue on %s.\n\n"
8259 "The message identifier is: %s\n",
8260 warnmsg_delay, primary_hostname, message_id);
8262 for (h = header_list; h; h = h->next)
8263 if (strncmpic(h->text, US"Subject:", 8) == 0)
8264 fprintf(f, "The subject of the message is: %s", h->text + 9);
8265 else if (strncmpic(h->text, US"Date:", 5) == 0)
8266 fprintf(f, "The date of the message is: %s", h->text + 6);
8269 fprintf(f, "The address%s to which the message has not yet been "
8271 !addr_defer->next ? "" : "es",
8272 !addr_defer->next ? "is": "are");
8275 /* List the addresses, with error information if allowed */
8278 for (address_item * addr = addr_defer; addr; addr = addr->next)
8280 if (print_address_information(addr, f, US" ", US"\n ", US""))
8281 print_address_error(addr, f, US"Delay reason: ");
8290 if ((wmf_text = next_emf(wmf, US"final")))
8291 fprintf(f, "%s", CS wmf_text);
8297 "No action is required on your part. Delivery attempts will continue for\n"
8298 "some time, and this warning may be repeated at intervals if the message\n"
8299 "remains undelivered. Eventually the mail delivery software will give up,\n"
8300 "and when that happens, the message will be returned to you.\n");
8303 /* output machine readable part */
8304 fprintf(f, "\n--%s\n"
8305 "Content-type: message/delivery-status\n\n"
8306 "Reporting-MTA: dns; %s\n",
8308 smtp_active_hostname);
8313 /* must be decoded from xtext: see RFC 3461:6.3a */
8315 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8316 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8318 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8322 for (address_item * addr = addr_defer; addr; addr = addr->next)
8326 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8328 if ((hu = addr->host_used) && hu->name)
8330 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8331 print_dsn_diagnostic_code(addr, f);
8337 "Content-type: text/rfc822-headers\n\n",
8341 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8342 tctx.u.fd = fileno(f);
8343 tctx.options = topt_add_return_path | topt_no_body;
8344 transport_filter_argv = NULL; /* Just in case */
8345 return_path = sender_address; /* In case not previously set */
8347 /* Write the original email out */
8348 /*XXX no checking for failure! buggy! */
8349 transport_write_message(&tctx, 0);
8352 fprintf(f,"\n--%s--\n", bound);
8356 /* Close and wait for child process to complete, without a timeout.
8357 If there's an error, don't update the count. */
8360 if (child_close(pid, 0) == 0)
8362 warning_count = count;
8363 update_spool = TRUE; /* Ensure spool rewritten */
8369 /* Clear deliver_domain */
8371 deliver_domain = NULL;
8373 /* If this was a first delivery attempt, unset the first time flag, and
8374 ensure that the spool gets updated. */
8376 if (f.deliver_firsttime)
8378 f.deliver_firsttime = FALSE;
8379 update_spool = TRUE;
8382 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8383 message, unless the message is a local error message (to avoid loops). Then
8384 log the freezing. If the text in "frozen_info" came from a system filter,
8385 it has been escaped into printing characters so as not to mess up log lines.
8386 For the "tell" message, we turn \n back into newline. Also, insert a newline
8387 near the start instead of the ": " string. */
8389 if (f.deliver_freeze)
8391 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8393 uschar *s = string_copy(frozen_info);
8394 uschar *ss = Ustrstr(s, " by the system filter: ");
8405 if (*ss == '\\' && ss[1] == 'n')
8412 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8413 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8417 /* Log freezing just before we update the -H file, to minimize the chance
8418 of a race problem. */
8420 deliver_msglog("*** Frozen%s\n", frozen_info);
8421 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8424 /* If there have been any updates to the non-recipients list, or other things
8425 that get written to the spool, we must now update the spool header file so
8426 that it has the right information for the next delivery attempt. If there
8427 was more than one address being delivered, the header_change update is done
8428 earlier, in case one succeeds and then something crashes. */
8431 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8432 update_spool, f.header_rewritten);
8434 if (update_spool || f.header_rewritten)
8435 /* Panic-dies on error */
8436 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8439 /* Finished with the message log. If the message is complete, it will have
8440 been unlinked or renamed above. */
8442 if (message_logs) (void)fclose(message_log);
8444 /* Now we can close and remove the journal file. Its only purpose is to record
8445 successfully completed deliveries asap so that this information doesn't get
8446 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8447 not serious, as trying it again is not harmful. The journal might not be open
8448 if all addresses were deferred at routing or directing. Nevertheless, we must
8449 remove it if it exists (may have been lying around from a crash during the
8450 previous delivery attempt). We don't remove the journal if a delivery
8451 subprocess failed to pass back delivery information; this is controlled by
8452 the remove_journal flag. When the journal is left, we also don't move the
8453 message off the main spool if frozen and the option is set. It should get moved
8454 at the next attempt, after the journal has been inspected. */
8456 if (journal_fd >= 0) (void)close(journal_fd);
8460 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8462 if (Uunlink(fname) < 0 && errno != ENOENT)
8463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8466 /* Move the message off the spool if requested */
8468 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8469 if (f.deliver_freeze && move_frozen_messages)
8470 (void)spool_move_message(id, message_subdir, US"", US"F");
8474 /* Closing the data file frees the lock; if the file has been unlinked it
8475 will go away. Otherwise the message becomes available for another process
8478 (void)close(deliver_datafile);
8479 deliver_datafile = -1;
8480 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8481 #ifdef MEASURE_TIMING
8482 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8485 /* It is unlikely that there will be any cached resources, since they are
8486 released after routing, and in the delivery subprocesses. However, it's
8487 possible for an expansion for something afterwards (for example,
8488 expand_check_condition) to do a lookup. We must therefore be sure everything is
8492 acl_where = ACL_WHERE_UNKNOWN;
8501 #ifdef EXIM_TFO_PROBE
8504 f.tcp_fastopen_ok = TRUE;
8510 deliver_get_sender_address (uschar * id)
8513 uschar * new_sender_address,
8514 * save_sender_address;
8515 BOOL save_qr = f.queue_running;
8518 /* make spool_open_datafile non-noisy on fail */
8520 f.queue_running = TRUE;
8522 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8524 deliver_datafile = spool_open_datafile(id);
8525 f.queue_running = save_qr;
8526 if (deliver_datafile < 0)
8529 /* Save and restore the global sender_address. I'm not sure if we should
8530 not save/restore all the other global variables too, because
8531 spool_read_header() may change all of them. But OTOH, when this
8532 deliver_get_sender_address() gets called, the current message is done
8533 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8535 spoolname = string_sprintf("%s-H", id);
8536 save_sender_address = sender_address;
8538 rc = spool_read_header(spoolname, TRUE, TRUE);
8540 new_sender_address = sender_address;
8541 sender_address = save_sender_address;
8543 if (rc != spool_read_OK)
8546 assert(new_sender_address);
8548 (void)close(deliver_datafile);
8549 deliver_datafile = -1;
8551 return new_sender_address;
8557 delivery_re_exec(int exec_type)
8561 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8563 int channel_fd = cutthrough.cctx.sock;
8565 smtp_peer_options = cutthrough.peer_options;
8566 continue_sequence = 0;
8569 if (cutthrough.is_tls)
8573 smtp_peer_options |= OPTION_TLS;
8574 sending_ip_address = cutthrough.snd_ip;
8575 sending_port = cutthrough.snd_port;
8577 where = US"socketpair";
8578 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8582 testharness_pause_ms(150);
8583 if ((pid = exim_fork(US"tls-proxy interproc")) < 0)
8586 if (pid == 0) /* child: will fork again to totally disconnect */
8588 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8590 /* does not return */
8593 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8595 waitpid(pid, NULL, 0);
8596 (void) close(channel_fd); /* release the client socket */
8597 channel_fd = pfd[1];
8601 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8602 cutthrough.host.address, message_id, channel_fd);
8606 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8607 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8609 return; /* compiler quietening; control does not reach here. */
8614 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8615 "delivery re-exec %s failed: %s", where, strerror(errno));
8617 /* Get here if exec_type == CEE_EXEC_EXIT.
8618 Note: this must be _exit(), not exit(). */
8620 _exit(EX_EXECFAILED);
8626 /* End of deliver.c */